Google 正在建構的裝置端途徑會依產業別將使用者的應用程式分門別類,並提供全新沉浸式體驗,可供使用者取用及瀏覽個人化應用程式內容。開發合作夥伴可以利用全螢幕體驗,在應用程式以外的專屬管道展示最精彩的多媒體內容。本指南適用對象為開發合作夥伴,提供透過 Engage SDK 填入這個新途徑區域,整合交友內容的操作說明。
整合詳情
術語
這項整合包含以下三個叢集類型:推薦、精選和接續。
「推薦」叢集會顯示個別開發合作夥伴提供的個人化約會建議。這些推薦內容可能會符合使用者的需求。
- 推薦叢集可由
ArticleEntity
、PersonEntity
或EventEntity
組成,但不能混合不同實體類型的混合。
推薦內容採用以下結構:
推薦叢集:此 UI 檢視畫面包含相同開發合作夥伴提供的一組推薦內容。
實體:代表叢集中單一項目的物件。這項整合作業提供部分會透過推薦叢集顯示的實體:
ArticleEntity:ArticleEntity 表示與交友相關的文字內容,ArticleEntity 項目可讓開發人員提供各種文字和圖片內容,並附上更多中繼資料,以便向使用者顯示資訊。
PersonEntity:PersonEntity 代表個人。建議可以主打約會交友潛在客戶。
EventEntity:EventEntity 代表未來的事件。事件開始時間是需要向使用者傳達的重要資訊。
- 推薦叢集可由
「接續」叢集會在一個 UI 群組中,顯示多個開發合作夥伴使用者最近互動的內容。每個開發合作夥伴最多可在接續叢集中播送 10 個實體。
接續內容採用以下結構:
ArticleEntity:ArticleEntity 表示建議,針對交友相關的文字內容。這個實體可用來代表未結束的新聞報導或其他內容,讓使用者能繼續從哪裡繼續存取這些內容。
EventReservationEntity:EventReservationEntity 代表活動的預訂,可協助使用者追蹤近期或正在進行的聚會與聚會活動預訂。
「精選」叢集是 UI 檢視畫面,會在一個 UI 群組中展示多個開發合作夥伴提供的精選主打
GenericFeaturedEntity
。這個單一精選叢集會顯示在靠近 UI 頂端的位置,並且優先放置在所有推薦叢集的上方。每個開發合作夥伴可在精選叢集中播送支援類型的單一實體,因此在精選叢集中,可能會有來自多個應用程式開發人員的多個不同類型實體。一般精選實體:一般精選實體與推薦項目不同,精選項目應用於開發人員提供的單一熱門內容,且應代表對使用者有趣且相關的最重要內容。
事前作業
最低 API 級別:19
將 com.google.android.play:engage
程式庫新增至應用程式:
dependencies {
// Make sure you also include that repository in your project's build.gradle file.
implementation 'com.google.android.engage:engage-core:1.4.1'
}
摘要
這項設計是以繫結服務的實作為基礎。
用戶端可發布的資料受到不同叢集類型的限制,如下所示:
叢集類型 | 叢集限制 | 單一叢集中的實體數量下限 | 單一叢集中的實體數量上限 |
---|---|---|---|
推薦叢集 | 最多 5 個 | 至少 5 個 | 最多 25 個 (ArticleEntity 、PersonEntity 或 EventEntity ) |
接續叢集 | 最多 1 個 | 至少 1 個 | 最多 10 個 (ArticleEntity 或 EventReservationEntity ) |
精選叢集 | 最多 1 個 | 至少 1 個 | 最多 10 個 (GenericFeaturedEntity ) |
步驟 1:提供實體資料
SDK 定義了不同實體,用來代表各種項目類型。「交友」類別支援下列實體:
GenericFeaturedEntity
ArticleEntity
PersonEntity
EventEntity
EventReservationEntity
下方圖表列出各類型的可用屬性和必要性。
GenericFeaturedEntity
屬性 | 必要性 | 說明 | 格式 |
---|---|---|---|
動作 URI | 必要 |
服務供應商應用程式中實體的深層連結。 注意:您可以使用深層連結追蹤歸因。 請參閱常見問題 |
URI |
代表圖片 | 必要 | 當您提供多張圖片時,系統只會顯示 1 張圖片。 建議長寬比為 16:9 注意:如有提供徽章,請確保圖片頂端和底部皆留有 24 dp 的安全空間 |
如需相關指南,請參閱「圖片規格」一節。 |
標題 | 選用 | 實體的標題。 | 任意文字 建議文字長度:50 個半形字元 |
說明 | 選用 | 用來描述實體的單一文字段落。 注意:系統會向使用者顯示說明或字幕清單,不會同時顯示兩者。 |
任意文字 建議文字長度:180 個半形字元 |
字幕清單 | 選用 | 最多 3 則字幕,每行字幕。 注意:系統會向使用者顯示說明或字幕清單,不會同時顯示兩者。 |
任意文字 每個副標題的建議文字長度:最多 50 個半形字元 |
徽章 | 選用 | 每個徽章都是任意文字 (最多 15 個半形字元) 或小型圖片。 在圖片/影片上進行特殊的使用者體驗,例如在圖片上疊加徽章
|
|
徽章 - 文字 | 選用 | 徽章標題 注意:徽章必須搭配文字或圖片, |
任意文字 建議文字長度:最多 15 個半形字元 |
徽章 - 圖片 | 選用 | 小型圖片 特殊的使用者體驗,例如在圖片/影片縮圖上疊加徽章。 注意:徽章必須搭配文字或圖片, |
如需相關指南,請參閱「圖片規格」一節。 |
內容類別 | 選用 | 說明實體中的內容類別。 | 列舉清單 如需相關指南,請參閱內容類別一節。 |
ArticleEntity
屬性 | 必要性 | 說明 | 格式 |
---|---|---|---|
動作 URI | 必要 |
服務供應商應用程式中實體的深層連結。 注意:您可以使用深層連結追蹤歸因。 請參閱常見問題 |
URI |
標題 | 必要 | 實體的標題。 | 任意文字 建議文字長度:最多 50 個半形字元 |
代表圖片 | 選用 | 當您提供多張圖片時,系統只會顯示 1 張圖片。 建議長寬比為 16:9 注意:強烈建議使用圖片。如果提供徽章,請確保圖片頂端和底部皆留有 24 dp 的安全空間 |
如需相關指南,請參閱「圖片規格」一節。 |
來源 - 標題 | 選用 | 作者、機構或記者的名稱 | 任意文字 建議文字長度:最多 25 個半形字元 |
來源 - 圖片 | 選用 | 來源圖片,例如作者、機構、記者 | 如需相關指南,請參閱「圖片規格」一節。 |
說明 | 選用 | 用來描述實體的單一文字段落。 注意:系統會向使用者顯示說明或字幕清單,不會同時顯示兩者。 |
任意文字 建議文字長度:180 個半形字元 |
字幕清單 | 選用 | 最多 3 則字幕,每行字幕。 注意:系統會向使用者顯示說明或字幕清單,不會同時顯示兩者。 |
任意文字 每個副標題的建議文字長度:最多 50 個半形字元 |
徽章 | 選用 | 每個徽章都是任意文字 (最多 15 個半形字元) 或小型圖片。 在圖片/影片上進行特殊的使用者體驗,例如在圖片上疊加徽章
|
|
徽章 - 文字 | 選用 | 徽章標題 注意:徽章必須搭配文字或圖片, |
任意文字 建議文字長度:最多 15 個半形字元 |
徽章 - 圖片 | 選用 | 小型圖片 特殊的使用者體驗,例如在圖片/影片縮圖上疊加徽章。 注意:徽章必須搭配文字或圖片, |
如需相關指南,請參閱「圖片規格」一節。 |
內容發布時間 | 選用 | 這是應用程式發布 / 更新內容時的 Epoch 時間戳記 (以毫秒為單位)。 | 以毫秒為單位的 Epoch 紀元時間戳記 |
上次互動時間 | 某些情況下必填 | 使用者上次與這個實體互動時的 Epoch 時間戳記 (以毫秒為單位)。 注意:如果這個實體屬於接續叢集,則為必要欄位。 |
以毫秒為單位的 Epoch 紀元時間戳記 |
進度百分比 | 某些情況下必填 | 使用者至今所耗用的完整內容百分比。 注意:如果這個實體屬於接續叢集,則為必要欄位。 |
介於 0 到 100 (含) 之間的 int 值。 |
內容類別 | 選用 | 說明實體中的內容類別。 | 列舉清單 如需相關指南,請參閱內容類別一節。 |
PersonEntity
屬性 | 必要性 | 說明 | 格式 |
---|---|---|---|
動作 URI | 必要 |
服務供應商應用程式中實體的深層連結。 注意:您可以使用深層連結追蹤歸因。 請參閱常見問題 |
URI |
設定檔 - 名稱 | 必要 | 個人資料名稱,或 ID/帳號代碼,例如「John Doe」、「@TeamPixel」等。 | 字串 建議文字長度:最多 50 個半形字元 |
個人資料 - 顯示圖片 | 必要 |
使用者的個人資料相片或顯示圖片。 注意:必須為正方形 1:1 圖片。 |
如需相關指南,請參閱「圖片規格」一節。 |
個人資料 - 其他文字 | 選用 | 個人資料帳號代碼等任意文字。 | 任意文字 建議文字長度:最多 15 個半形字元 |
個人資料 - 其他圖片 | 選用 | 小型圖片,就像通過驗證的徽章。 | 如需相關指南,請參閱「圖片規格」一節。 |
標題圖片 | 選用 | 當您提供多張圖片時,系統只會顯示 1 張圖片。 建議長寬比為 16:9 注意:強烈建議使用圖片。如果提供徽章,請確保圖片頂端和底部皆留有 24 dp 的安全空間 |
如需相關指南,請參閱「圖片規格」一節。 |
熱銷度 - 次數 | 選用 |
代表標題圖片。必須與個人資料圖片不同。如有其他圖片,可以用來凸顯對方與其作品相似的人。 注意:必須是 16:9 的圖片。如果提供徽章,請確保圖片頂端和底部皆留有 24 dp 的安全空間 |
字串 建議文字長度:最多 20 個半形字元,數量 + 標籤合計 |
熱門程度 - 次數值 | 選用 | 追蹤者人數或熱門程度值。 注意:如果應用程式不想處理針對不同顯示大小最佳化大型數字的邏輯,請提供計數值。如果同時提供計數和計數值,系統會使用計數。 |
長整數 |
熱門程度 - 標籤 | 選用 | 指出熱門程度標籤,例如「按讚」。 | 字串 建議文字長度:最多 20 個半形字元,數量 + 標籤合計 |
熱門程度 - 影像 | 選用 |
指出互動目的,例如:顯示喜歡圖示、表情符號的圖片。 可以提供多張圖片,但不一定在所有板型規格上都能顯示。 注意:必須是正方形 1:1 圖片 |
如需相關指南,請參閱「圖片規格」一節。 |
評分 - 最高值 | 必要 | 分級量表的最高值。 如果同時提供目前的評分值,則必須提供這項屬性。 |
大於或等於 0.0 的數字 |
評分 - 目前的值 | 必要 | 分級量表目前的值。 如果同時提供最高評分值,則須提供這項屬性。 |
大於或等於 0.0 的數字 |
評分 - 次數 | 選用 | 實體的評分次數。 注意:如果應用程式想控制向使用者顯示的方式,請提供這個欄位。請提供可向使用者顯示的簡明字串。舉例來說,如果計數是 1,000,000,請考慮使用 1M 這類縮寫,以免無法在尺寸較小的螢幕上遭到截斷。 |
字串 |
評分 - 計數值 | 選用 | 實體的評分次數。 注意:如果不想自行處理顯示縮寫邏輯,請提供這個欄位。如果同時有「計數」和「計數值」,我們將使用「計數」向使用者顯示 |
長整數 |
位置 - 國家/地區 | 選用 | 聯絡人所在的國家/地區。 | 任意文字 建議文字長度:最多 20 個半形字元 |
地點 - 城市 | 選用 | 使用者所在或服務的城市。 | 任意文字 建議文字長度:最多 20 個半形字元 |
位置 - 顯示地址 | 選用 | 使用者會看到聯絡人所在位置或提供服務的地址。 | 任意文字 建議文字長度:最多 20 個半形字元 |
位置 - 街道地址 | 選用 | 聯絡人所在位置或提供服務的街道地址 (如適用)。 | 任意文字 建議文字長度:最多 20 個半形字元 |
位置 - 州/省 | 選用 | 使用者所在的州別 (如適用)。 | 任意文字 建議文字長度:最多 20 個半形字元 |
位置 - 郵遞區號 | 選用 | 聯絡人所在位置或服務範圍的郵遞區號 (如適用)。 | 任意文字 建議文字長度:最多 20 個半形字元 |
位置 - 鄰近地區 | 選用 | 使用者所在的社區 (如適用)。 | 任意文字 建議文字長度:最多 20 個半形字元 |
徽章 | 選用 |
每個徽章都是任意文字 (最多 15 個半形字元) 或小型圖片。 |
|
徽章 - 文字 | 選用 | 徽章標題 注意:徽章必須搭配文字或圖片, |
任意文字 建議文字長度:最多 15 個半形字元 |
徽章 - 圖片 | 選用 | 小型圖片 特殊的使用者體驗,例如在圖片/影片縮圖上疊加徽章。 注意:徽章必須搭配文字或圖片, |
如需相關指南,請參閱「圖片規格」一節。 |
說明 | 選用 | 用來描述實體的單一文字段落。 注意:系統會向使用者顯示說明或字幕清單,不會同時顯示兩者。 |
任意文字 建議文字長度:180 個半形字元 |
字幕清單 | 選用 | 最多 3 則字幕,每行字幕。 注意:系統會向使用者顯示說明或字幕清單,不會同時顯示兩者。 |
任意文字 每個副標題的建議文字長度:最多 50 個半形字元 |
內容類別 | 選用 | 說明實體中的內容類別。 | 符合資格的列舉清單
如需相關指南,請參閱內容類別一節。 |
EventEntity
屬性 | 必要性 | 說明 | 格式 |
---|---|---|---|
動作 URI | 必要 |
服務供應商應用程式中實體的深層連結。 注意:您可以使用深層連結追蹤歸因。 請參閱常見問題 |
URI |
標題 | 必要 | 實體的標題。 | 字串 建議文字長度:最多 50 個半形字元 |
開始時間 | 必要 |
事件預計開始的 Epoch 時間戳記。 注意:系統會以毫秒為單位。 |
以毫秒為單位的 Epoch 紀元時間戳記 |
事件模式 | 必要 | 用於標示活動是線上活動、現場活動或兩者皆進行的欄位。 |
例如:VIRTUAL、IN_PERSON 或 HYBRID |
代表圖片 | 必要 | 當您提供多張圖片時,系統只會顯示 1 張圖片。 建議長寬比為 16:9 注意:強烈建議使用圖片。如果提供徽章,請確保圖片頂端和底部皆留有 24 dp 的安全空間 |
如需相關指南,請參閱「圖片規格」一節。 |
位置 - 國家/地區 | 某些情況下必填 | 發生事件的國家/地區。 注意:如果事件為 IN_PERSON 或 HYBRID,就必須提供這個屬性 |
任意文字 建議文字長度:最多 20 個半形字元 |
地點 - 城市 | 某些情況下必填 | 活動發生的城市。 注意:如果事件為 IN_PERSON 或 HYBRID,就必須提供這個屬性 |
任意文字 建議文字長度:最多 20 個半形字元 |
位置 - 顯示地址 | 某些情況下必填 | 要向使用者顯示活動的地址或場地名稱。 注意:如果事件為 IN_PERSON 或 HYBRID,就必須提供這個屬性 |
任意文字 建議文字長度:最多 20 個半形字元 |
位置 - 街道地址 | 選用 | 活動代管地點的街道地址 (如適用)。 | 任意文字 建議文字長度:最多 20 個半形字元 |
位置 - 州/省 | 選用 | 活動託管的州或省 (如適用)。 | 任意文字 建議文字長度:最多 20 個半形字元 |
位置 - 郵遞區號 | 選用 | 事件代管地點的郵遞區號 (如適用)。 | 任意文字 建議文字長度:最多 20 個半形字元 |
位置 - 鄰近地區 | 選用 | 活動舉辦地點的社區 (如適用)。 | 任意文字 建議文字長度:最多 20 個半形字元 |
結束時間 | 選用 |
事件預計結束的 Epoch 時間戳記。 注意:系統會以毫秒為單位。 |
以毫秒為單位的 Epoch 紀元時間戳記 |
說明 | 選用 | 用來描述實體的單一文字段落。 注意:系統會向使用者顯示說明或字幕清單,不會同時顯示兩者。 |
任意文字 建議文字長度:180 個半形字元 |
字幕清單 | 選用 | 最多 3 則字幕,每行字幕。 注意:系統會向使用者顯示說明或字幕清單,不會同時顯示兩者。 |
任意文字 每個副標題的建議文字長度:最多 50 個半形字元 |
徽章 | 選用 |
每個徽章都是任意文字 (最多 15 個半形字元) 或小型圖片。 |
|
徽章 - 文字 | 選用 | 徽章標題 注意:徽章必須搭配文字或圖片, |
任意文字 建議文字長度:最多 15 個半形字元 |
徽章 - 圖片 | 選用 | 小型圖片 特殊的使用者體驗,例如在圖片/影片縮圖上疊加徽章。 注意:徽章必須搭配文字或圖片, |
如需相關指南,請參閱「圖片規格」一節。 |
價格 - 目前價格 | 在特定情況下為必要 |
活動票券/票證目前的價格。 如果提供了附帶刪除線的價格,則必須提供這項屬性。 |
任意文字 |
價格 - 刪除線價格 | 選用 | 活動票券/票證的原始價格。 | 任意文字 |
價格摘要 | 選用 | 主打促銷、活動、會員折扣 (如有) 的價格摘要。 | 任意文字 建議文字長度:最多 45 個半形字元,過長部分會以刪節號顯示 |
內容類別 | 選用 | 說明實體中的內容類別。 | 符合資格的列舉清單
如需相關指南,請參閱內容類別一節。 |
EventReservationEntity
屬性 | 必要性 | 說明 | 格式 |
---|---|---|---|
動作 URI | 必要 |
服務供應商應用程式中實體的深層連結。 注意:您可以使用深層連結追蹤歸因。 請參閱常見問題 |
URI |
標題 | 必要 | 實體的標題。 | 字串 建議文字長度:最多 50 個半形字元 |
開始時間 | 必要 |
事件預計開始的 Epoch 時間戳記。 注意:系統會以毫秒為單位。 |
以毫秒為單位的 Epoch 紀元時間戳記 |
事件模式 | 必要 | 用於標示活動是線上活動、現場活動或兩者皆進行的欄位。 |
例如:VIRTUAL、IN_PERSON 或 HYBRID |
位置 - 國家/地區 | 某些情況下必填 | 發生事件的國家/地區。 注意:如果事件為 IN_PERSON 或 HYBRID,就必須提供這個屬性 |
任意文字 建議文字長度:最多 20 個半形字元 |
地點 - 城市 | 某些情況下必填 | 活動發生的城市。 注意:如果事件為 IN_PERSON 或 HYBRID,就必須提供這個屬性 |
任意文字 建議文字長度:最多 20 個半形字元 |
位置 - 顯示地址 | 某些情況下必填 | 要向使用者顯示活動的地址或場地名稱。 注意:如果事件為 IN_PERSON 或 HYBRID,就必須提供這個屬性 |
任意文字 建議文字長度:最多 20 個半形字元 |
位置 - 街道地址 | 選用 | 活動代管地點的街道地址 (如適用)。 | 任意文字 建議文字長度:最多 20 個半形字元 |
位置 - 州/省 | 選用 | 活動託管的州或省 (如適用)。 | 任意文字 建議文字長度:最多 20 個半形字元 |
位置 - 郵遞區號 | 選用 | 事件代管地點的郵遞區號 (如適用)。 | 任意文字 建議文字長度:最多 20 個半形字元 |
位置 - 鄰近地區 | 選用 | 活動舉辦地點的社區 (如適用)。 | 任意文字 建議文字長度:最多 20 個半形字元 |
代表圖片 | 選用 | 當您提供多張圖片時,系統只會顯示 1 張圖片。 建議長寬比為 16:9 注意:強烈建議使用圖片。如果提供徽章,請確保圖片頂端和底部皆留有 24 dp 的安全空間 |
如需相關指南,請參閱「圖片規格」一節。 |
結束時間 | 選用 |
事件預計結束的 Epoch 時間戳記。 注意:系統會以毫秒為單位。 |
以毫秒為單位的 Epoch 紀元時間戳記 |
服務供應商 - 名稱 | 選用 |
服務供應商的名稱。 注意:服務供應商必須要有文字或圖片。 |
任意文字。例如:活動發起人/巡迴演出的名稱 |
服務供應商 - 圖片 | 選用 |
服務供應商的標誌/圖片。 注意:服務供應商必須要有文字或圖片。 |
如需相關指南,請參閱「圖片規格」一節。 |
說明 | 選用 | 用來描述實體的單一文字段落。 注意:系統會向使用者顯示說明或字幕清單,不會同時顯示兩者。 |
任意文字 建議文字長度:180 個半形字元 |
字幕清單 | 選用 | 最多 3 則字幕,每行字幕。 注意:系統會向使用者顯示說明或字幕清單,不會同時顯示兩者。 |
任意文字 每個副標題的建議文字長度:最多 50 個半形字元 |
徽章 | 選用 |
每個徽章都是任意文字 (最多 15 個半形字元) 或小型圖片。 |
|
徽章 - 文字 | 選用 | 徽章標題 注意:徽章必須搭配文字或圖片, |
任意文字 建議文字長度:最多 15 個半形字元 |
徽章 - 圖片 | 選用 | 小型圖片 特殊的使用者體驗,例如在圖片/影片縮圖上疊加徽章。 注意:徽章必須搭配文字或圖片, |
如需相關指南,請參閱「圖片規格」一節。 |
預留項目 ID | 選用 | 活動預訂項目的預訂 ID。 | 任意文字 |
價格 - 目前價格 | 在特定情況下為必要 |
活動票券/票證目前的價格。 如果提供了附帶刪除線的價格,則必須提供這項屬性。 |
任意文字 |
價格 - 刪除線價格 | 選用 | 活動票券/票證的原始價格。 | 任意文字 |
價格摘要 | 選用 | 主打促銷、活動、會員折扣 (如有) 的價格摘要。 | 任意文字 建議文字長度:最多 45 個半形字元,過長部分會以刪節號顯示 |
評分 - 最高值 | 選用 | 分級量表的最高值。 如果同時提供目前的評分值,則必須提供這項屬性。 |
大於或等於 0.0 的數字 |
評分 - 目前的值 | 選用 | 分級量表目前的值。 如果同時提供最高評分值,則須提供這項屬性。 |
大於或等於 0.0 的數字 |
評分 - 次數 | 選用 | 事件的評分次數。 注意:如果應用程式想控制向使用者顯示的方式,請提供這個欄位。請提供可向使用者顯示的簡明字串。舉例來說,如果計數是 1,000,000,請考慮使用 1M 這類縮寫,以免無法在尺寸較小的螢幕上遭到截斷。 |
字串 |
評分 - 計數值 | 選用 | 事件的評分次數。 注意:如果不想自行處理顯示縮寫邏輯,請提供這個欄位。如果同時有「計數」和「計數值」,我們將使用「計數」向使用者顯示 |
長整數 |
內容類別 | 選用 | 說明實體中的內容類別。 | 符合資格的列舉清單
如需相關指南,請參閱內容類別一節。 |
圖片規格
下表列出圖片素材資源的必要規格:
顯示比例 | 最低像素 | 建議的像素 |
---|---|---|
正方形 (1x1) 建議採用 |
300x300 | 1200x1200 |
橫向 (1.91x1) | 600x314 | 1200x628 |
直向 (4x5) | 480x600 | 960x1200 |
圖片必須在公開 CDN 上代管,以便 Google 存取。
檔案格式
PNG、JPG、靜態 GIF、WebP
檔案大小上限
5120 KB
其他建議
- 圖片安全區域:將重要內容放在圖片中央 80% 的範圍內。
- 使用透明背景,讓圖片正確顯示在深色和淺色主題設定中。
內容類別
內容類別可讓應用程式發布屬於多個類別的內容。這會將內容與部分預先定義的類別對應:
TYPE_EDUCATION
TYPE_SPORTS
TYPE_MOVIES_AND_TV_SHOWS
TYPE_BOOKS
TYPE_AUDIOBOOKS
TYPE_MUSIC
TYPE_DIGITAL_GAMES
TYPE_TRAVEL_AND_LOCAL
TYPE_HOME_AND_AUTO
TYPE_BUSINESS
TYPE_NEWS
TYPE_FOOD_AND_DRINK
TYPE_SHOPPING
TYPE_HEALTH_AND_FITENESS
TYPE_MEDICAL
TYPE_PARENTING
TYPE_DATING
圖片必須在公開 CDN 上代管,以便 Google 存取。
內容類別使用規範
- 部分實體 (例如 ArticleEntity 和 GenericFeaturedEntity) 可以使用任何內容類別。如果是 EventEntity、EventReservationEntity、PersonEntity 等其他實體,則只有這些類別的子集符合資格。填入清單前,請先查看適用於特定實體類型的類別清單。
相較於一般實體和 ContentCategory 的組合,部分內容類別需使用特定實體類型:
- TYPE_MovieS_AND_TV_SHOWS - 請先參閱觀看整合指南中的實體,再使用一般實體。
- TYPE_BOOKS - 使用一般實體前,請先參閱 EbookEntity。
- TYPE_AUDIOBOOKS - 使用一般實體前,請先參閱 AudiobookEntity。
- TYPE_SHOPPING - 使用一般實體前,請先參閱 ShoppingEntity。
- TYPE_FOOD_AND_DRINK - 使用一般實體前,請先查看食物整合指南中的實體。
ContentCategory 欄位是選填欄位,如果內容不屬於先前提及的任何類別,則應留空。
如果同時提供多個內容類別,請按照內容與內容的關聯性順序,在清單中優先顯示最相關的內容類別。
步驟 2:提供叢集資料
建議您在背景執行內容發布工作 (例如使用 WorkManager),並安排定期執行或根據事件排程 (例如使用者每次開啟應用程式,或剛將商品加入購物車時)。
AppEngagePublishClient
負責發布叢集。
以下 API 可用於在用戶端發布叢集:
isServiceAvailable
publishRecommendationClusters
publishFeaturedCluster
publishContinuationCluster
publishUserAccountManagementRequest
updatePublishStatus
deleteRecommendationsClusters
deleteFeaturedCluster
deleteContinuationCluster
deleteUserManagementCluster
deleteClusters
isServiceAvailable
這個 API 可用於檢查服務是否可供整合,以及內容是否能在裝置上顯示。
Kotlin
client.isServiceAvailable.addOnCompleteListener { task -> if (task.isSuccessful) { // Handle IPC call success if(task.result) { // Service is available on the device, proceed with content publish // calls. } else { // Service is not available, no further action is needed. } } else { // The IPC call itself fails, proceed with error handling logic here, // such as retry. } }
Java
client.isServiceAvailable().addOnCompleteListener(task - > { if (task.isSuccessful()) { // Handle success if(task.getResult()) { // Service is available on the device, proceed with content publish // calls. } else { // Service is not available, no further action is needed. } } else { // The IPC call itself fails, proceed with error handling logic here, // such as retry. } });
publishRecommendationClusters
這個 API 可用於發布 RecommendationCluster
物件清單。
Kotlin
client.publishRecommendationClusters( PublishRecommendationClustersRequest.Builder() .addRecommendationCluster( RecommendationCluster.Builder() .addEntity(entity1) .addEntity(entity2) .setTitle("Top Picks For You") .build() ) .build() )
Java
client.publishRecommendationClusters( new PublishRecommendationClustersRequest.Builder() .addRecommendationCluster( new RecommendationCluster.Builder() .addEntity(entity1) .addEntity(entity2) .setTitle("Top Picks For You") .build()) .build());
服務收到要求後,系統會在單一交易中執行以下動作:
- 移除開發合作夥伴提供的現有
RecommendationCluster
資料。 - 剖析要求所提供的資料並儲存在更新後的推薦叢集中。
如果發生錯誤,整個要求都會遭到拒絕,現有狀態則維持不變。
publishFeaturedCluster
這個 API 可用於發布 FeaturedCluster
物件清單。
Kotlin
client.publishFeaturedCluster( PublishFeaturedClusterRequest.Builder() .setFeaturedCluster( FeaturedCluster.Builder() .addEntity(entity1) .addEntity(entity2) .build()) .build())
Java
client.publishFeaturedCluster( new PublishFeaturedClustersRequest.Builder() .addFeaturedCluster( new FeaturedCluster.Builder() .addEntity(entity1) .addEntity(entity2) .build()) .build());
服務收到要求後,系統會在單一交易中執行以下動作:
- 移除開發合作夥伴提供的現有
FeaturedCluster
資料。 - 剖析要求所提供的資料並儲存在更新後的精選叢集中。
如果發生錯誤,整個要求都會遭到拒絕,現有狀態則維持不變。
publishContinuationCluster
這個 API 可用來發布 ContinuationCluster
物件。
Kotlin
client.publishContinuationCluster( PublishContinuationClusterRequest.Builder() .setContinuationCluster( ContinuationCluster.Builder() .addEntity(entity1) .addEntity(entity2) .build()) .build())
Java
client.publishContinuationCluster( new PublishContinuationClusterRequest.Builder() .setContinuationCluster( new ContinuationCluster.Builder() .addEntity(entity1) .addEntity(entity2) .build()) .build());
服務收到要求後,系統會在單一交易中執行以下動作:
- 移除開發合作夥伴提供的現有
ContinuationCluster
資料。 - 剖析要求所提供的資料並儲存在更新後的接續叢集中。
如果發生錯誤,整個要求都會遭到拒絕,現有狀態則維持不變。
publishUserAccountManagementRequest
這個 API 是用來發布「登入」資訊卡。登入動作會將使用者導向應用程式的登入頁面,方便應用程式發布內容 (或提供更個人化的內容)
登入資訊卡包含下列中繼資料:
屬性 | 必要性 | 說明 |
---|---|---|
動作 URI | 必要 | 導向動作的深層連結,也就是前往應用程式登入頁面 |
圖片 | 選用 - 如未提供,則必須提供標題 |
資訊卡上顯示的圖片 解析度 1264x712、顯示比例 16x9 的圖片 |
標題 | 選用 - 如未提供,則必須提供圖片 | 資訊卡上的標題 |
動作文字 | 選用 | 行動號召中顯示的文字,也就是「登入」 |
副標題 | 選用 | 資訊卡上的選用副標題 |
Kotlin
var SIGN_IN_CARD_ENTITY = SignInCardEntity.Builder() .addPosterImage( Image.Builder() .setImageUri(Uri.parse("http://www.x.com/image.png")) .setImageHeightInPixel(500) .setImageWidthInPixel(500) .build()) .setActionText("Sign In") .setActionUri(Uri.parse("http://xx.com/signin")) .build() client.publishUserAccountManagementRequest( PublishUserAccountManagementRequest.Builder() .setSignInCardEntity(SIGN_IN_CARD_ENTITY) .build());
Java
SignInCardEntity SIGN_IN_CARD_ENTITY = new SignInCardEntity.Builder() .addPosterImage( new Image.Builder() .setImageUri(Uri.parse("http://www.x.com/image.png")) .setImageHeightInPixel(500) .setImageWidthInPixel(500) .build()) .setActionText("Sign In") .setActionUri(Uri.parse("http://xx.com/signin")) .build(); client.publishUserAccountManagementRequest( new PublishUserAccountManagementRequest.Builder() .setSignInCardEntity(SIGN_IN_CARD_ENTITY) .build());
服務收到要求後,系統會在單一交易中執行以下動作:
- 移除開發合作夥伴提供的現有
UserAccountManagementCluster
資料。 - 剖析要求所提供的資料並儲存在更新後的 UserAccountManagementCluster 叢集中。
如果發生錯誤,整個要求都會遭到拒絕,現有狀態則維持不變。
updatePublishStatus
如因內部業務原因,導致無法發布任何叢集,我們強烈建議使用 updatePublishStatus API 更新發布狀態。這麼做很重要,因為:
- 在所有情況下,提供狀態都至關重要,即使內容已發布 (STATUS == PUBLISHED) 也一樣。如此一來,才能為資訊主頁填入資料,並以明確的狀態表示整合項目的健康度和其他指標。
- 如未發布內容,但整合狀態未遭中斷 (STATUS == NOT_PUBLISHED),Google 便可避免在應用程式健康資訊主頁中觸發快訊。這可從提供者的角度確認內容是因預期的情況而未發布。
- 這有助開發人員深入瞭解資料何時已發布或未發布。
- Google 可能會使用狀態碼來提醒使用者在應用程式中執行特定動作,以便查看或克服應用程式內容。
以下為符合資格的發布狀態碼清單:
// Content is published
AppEngagePublishStatusCode.PUBLISHED,
// Content is not published as user is not signed in
AppEngagePublishStatusCode.NOT_PUBLISHED_REQUIRES_SIGN_IN,
// Content is not published as user is not subscribed
AppEngagePublishStatusCode.NOT_PUBLISHED_REQUIRES_SUBSCRIPTION,
// Content is not published as user location is ineligible
AppEngagePublishStatusCode.NOT_PUBLISHED_INELIGIBLE_LOCATION,
// Content is not published as there is no eligible content
AppEngagePublishStatusCode.NOT_PUBLISHED_NO_ELIGIBLE_CONTENT,
// Content is not published as the feature is disabled by the client
// Available in v1.3.1
AppEngagePublishStatusCode.NOT_PUBLISHED_FEATURE_DISABLED_BY_CLIENT,
// Content is not published as the feature due to a client error
// Available in v1.3.1
AppEngagePublishStatusCode.NOT_PUBLISHED_CLIENT_ERROR,
// Content is not published as the feature due to a service error
// Available in v1.3.1
AppEngagePublishStatusCode.NOT_PUBLISHED_SERVICE_ERROR,
// Content is not published due to some other reason
// Reach out to engage-developers@ before using this enum.
AppEngagePublishStatusCode.NOT_PUBLISHED_OTHER
如果內容因使用者未登入而未發布,建議您發布登入資訊卡。如因任何原因導致提供者無法發布登入資訊卡,建議您呼叫 updatePublishStatus API,並使用狀態碼 NOT_PUBLISHED_REQUIRES_SIGN_IN。
Kotlin
client.updatePublishStatus( PublishStatusRequest.Builder() .setStatusCode(AppEngagePublishStatusCode.NOT_PUBLISHED_REQUIRES_SIGN_IN) .build())
Java
client.updatePublishStatus( new PublishStatusRequest.Builder() .setStatusCode(AppEngagePublishStatusCode.NOT_PUBLISHED_REQUIRES_SIGN_IN) .build());
deleteRecommendationClusters
這個 API 可用來刪除推薦叢集的內容。
Kotlin
client.deleteRecommendationClusters()
Java
client.deleteRecommendationClusters();
服務收到要求後,會從推薦叢集中移除現有資料。如果發生錯誤,整個要求都會遭到拒絕,現有狀態則維持不變。
deleteFeaturedCluster
這個 API 可用來刪除精選叢集的內容。
Kotlin
client.deleteFeaturedCluster()
Java
client.deleteFeaturedCluster();
服務收到要求後,會從精選叢集中移除現有資料。如果發生錯誤,整個要求都會遭到拒絕,現有狀態則維持不變。
deleteContinuationCluster
這個 API 可用來刪除接續叢集的內容。
Kotlin
client.deleteContinuationCluster()
Java
client.deleteContinuationCluster();
服務收到要求後,會從接續叢集中移除現有資料。如果發生錯誤,整個要求都會遭到拒絕,現有狀態則維持不變。
deleteUserManagementCluster
這個 API 可用來刪除 UserAccountManagement 叢集的內容。
Kotlin
client.deleteUserManagementCluster()
Java
client.deleteUserManagementCluster();
服務收到要求後,會從 UserAccountManagement 叢集中移除現有資料。如果發生錯誤,整個要求都會遭到拒絕,現有狀態則維持不變。
deleteClusters
這個 API 可用於刪除指定叢集類型的內容。
Kotlin
client.deleteClusters( DeleteClustersRequest.Builder() .addClusterType(ClusterType.TYPE_CONTINUATION) .addClusterType(ClusterType.TYPE_FEATURED) .addClusterType(ClusterType.TYPE_RECOMMENDATION) .build())
Java
client.deleteClusters( new DeleteClustersRequest.Builder() .addClusterType(ClusterType.TYPE_CONTINUATION) .addClusterType(ClusterType.TYPE_FEATURED) .addClusterType(ClusterType.TYPE_RECOMMENDATION) .build());
服務收到要求後,會從符合指定叢集類型的所有叢集中移除現有資料。用戶端可以選擇傳遞一或多個叢集類型。如果發生錯誤,整個要求都會遭到拒絕,現有狀態則維持不變。
處理錯誤
強烈建議您監聽來自發布 API 的工作結果,據以採取後續動作來復原及重新提交能順利執行的工作。
Kotlin
client.publishRecommendationClusters( PublishRecommendationClustersRequest.Builder() .addRecommendationCluster(..) .build()) .addOnCompleteListener { task -> if (task.isSuccessful) { // do something } else { val exception = task.exception if (exception is AppEngageException) { @AppEngageErrorCode val errorCode = exception.errorCode if (errorCode == AppEngageErrorCode.SERVICE_NOT_FOUND) { // do something } } } }
Java
client.publishRecommendationClusters( new PublishRecommendationClustersRequest.Builder() .addRecommendationCluster(...) .build()) .addOnCompleteListener( task -> { if (task.isSuccessful()) { // do something } else { Exception exception = task.getException(); if (exception instanceof AppEngageException) { @AppEngageErrorCode int errorCode = ((AppEngageException) exception).getErrorCode(); if (errorCode == AppEngageErrorCode.SERVICE_NOT_FOUND) { // do something } } } });
發生錯誤時會傳回 AppEngageException
,並提供原因的錯誤代碼。
錯誤代碼 | 附註 |
---|---|
SERVICE_NOT_FOUND |
這項服務不適用於指定裝置。 |
SERVICE_NOT_AVAILABLE |
這項服務適用於指定裝置,但無法於呼叫期間使用 (例如服務已明確停用)。 |
SERVICE_CALL_EXECUTION_FAILURE |
執行緒發生問題,因此工作執行失敗。在這種情況下,您可以重試。 |
SERVICE_CALL_PERMISSION_DENIED |
呼叫端未獲准發出服務呼叫。 |
SERVICE_CALL_INVALID_ARGUMENT |
要求包含無效的資料 (例如,超過允許的叢集數量上限)。 |
SERVICE_CALL_INTERNAL |
服務端發生錯誤。 |
SERVICE_CALL_RESOURCE_EXHAUSTED |
服務呼叫過於頻繁。 |
步驟 3:處理廣播意圖
除了透過工作發出發布內容 API 呼叫,您還需要設定 BroadcastReceiver
來接收內容發布要求。
廣播意圖的目標主要用於應用程式重新啟動及強制同步處理資料。廣播意圖的傳送頻率通常不高。觸發廣播意圖的唯一時機,就是 Engage Service 判定內容可能過時 (例如已滿一週)。這樣一來,即使應用程式已有長時間未執行,使用者也能獲得最新的內容體驗。
BroadcastReceiver
必須透過下列兩種方式進行設定:
- 使用
Context.registerReceiver()
以動態方式註冊BroadcastReceiver
類別的例項。這樣就能接收仍在記憶體中的應用程式訊息。
Kotlin
class AppEngageBroadcastReceiver : BroadcastReceiver(){ // Trigger recommendation cluster publish when PUBLISH_RECOMMENDATION broadcast // is received // Trigger featured cluster publish when PUBLISH_FEATURED broadcast is received // Trigger continuation cluster publish when PUBLISH_CONTINUATION broadcast is // received } fun registerBroadcastReceivers(context: Context){ var context = context context = context.applicationContext // Register Recommendation Cluster Publish Intent context.registerReceiver(AppEngageBroadcastReceiver(), IntentFilter(Intents.ACTION_PUBLISH_RECOMMENDATION)) // Register Featured Cluster Publish Intent context.registerReceiver(AppEngageBroadcastReceiver(), IntentFilter(Intents.ACTION_PUBLISH_FEATURED)) // Register Continuation Cluster Publish Intent context.registerReceiver(AppEngageBroadcastReceiver(), IntentFilter(Intents.ACTION_PUBLISH_CONTINUATION)) }
Java
class AppEngageBroadcastReceiver extends BroadcastReceiver { // Trigger recommendation cluster publish when PUBLISH_RECOMMENDATION broadcast // is received // Trigger featured cluster publish when PUBLISH_FEATURED broadcast is received // Trigger continuation cluster publish when PUBLISH_CONTINUATION broadcast is // received } public static void registerBroadcastReceivers(Context context) { context = context.getApplicationContext(); // Register Recommendation Cluster Publish Intent context.registerReceiver(new AppEngageBroadcastReceiver(), new IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_RECOMMENDATION)); // Register Featured Cluster Publish Intent context.registerReceiver(new AppEngageBroadcastReceiver(), new IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_FEATURED)); // Register Continuation Cluster Publish Intent context.registerReceiver(new AppEngageBroadcastReceiver(), new IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_CONTINUATION)); }
- 在
AndroidManifest.xml
檔案中使用<receiver>
標記,以靜態方式宣告實作項目。這樣應用程式就能在未執行的狀態下接收廣播意圖,也能發布內容。
<application>
<receiver
android:name=".AppEngageBroadcastReceiver"
android:exported="true"
android:enabled="true">
<intent-filter>
<action android:name="com.google.android.engage.action.PUBLISH_RECOMMENDATION" />
</intent-filter>
<intent-filter>
<action android:name="com.google.android.engage.action.PUBLISH_FEATURED" />
</intent-filter>
<intent-filter>
<action android:name="com.google.android.engage.action.PUBLISH_CONTINUATION" />
</intent-filter>
</receiver>
</application>
服務會傳送下列意圖:
com.google.android.engage.action.PUBLISH_RECOMMENDATION
建議在收到此意圖時啟動publishRecommendationClusters
呼叫。com.google.android.engage.action.PUBLISH_FEATURED
建議在收到此意圖時啟動publishFeaturedCluster
呼叫。com.google.android.engage.action.PUBLISH_CONTINUATION
建議在收到此意圖時啟動publishContinuationCluster
呼叫。
整合工作流程
如需整合完成後驗證作業的逐步指南,請參閱「Engage 開發人員整合工作流程」一文。
常見問題
請參閱「Engage SDK 常見問題」。
聯絡資訊
如果在整合過程中有任何問題,請來信至 engage-developers@google.com 與我們聯絡。
後續步驟
完成這項整合後,後續步驟如下:
- 傳送電子郵件至 engage-developers@google.com,並附上整合完成可供 Google 測試的 APK。
- Google 會在內部執行驗證及審查,確認整合項目能夠正常運作。如果需要進行變更,Google 會與您聯絡並提供所有必要詳細資料。
- 測試完成後,如果不需要進行任何變更,Google 會與您聯絡,通知您可以開始將完成整合的更新版 APK 發布至 Play 商店。
- Google 確認您已將更新版 APK 發布至 Play 商店後,就會發布您的推薦、精選和接續叢集供使用者瀏覽。