כדי להגביר את רמת העניין באפליקציה, כדאי להגיע למשתמשים במקומות שבהם הם נמצאים. אפשר לשלב את Engage SDK כדי להציג המלצות מותאמות אישית ותוכן המשך ישירות למשתמשים בכמה פלטפורמות במכשיר, כמו אוספים, חבילת הבידור וחנות Play. השילוב מוסיף פחות מ-50KB (דחוס) לחבילת ה-APK הממוצעת, וברוב האפליקציות הוא דורש כשבוע של זמן פיתוח. מידע נוסף מופיע באתר העסקי שלנו.
המדריך הזה מכיל הוראות לשותפי פיתוח להעברת תוכן אודיו (מוזיקה, פודקאסטים, ספרי אודיו, רדיו בשידור חי) לממשקי תוכן של Engage.
פרטי השילוב
טרמינולוגיה
השילוב הזה כולל את שלושת סוגי האשכולות הבאים: המלצה, המשך ומומלצים.
באשכולות המלצות מוצגות הצעות מותאמות אישית לתוכן לקריאה ממפתח שותף ספציפי.
ההמלצות שלכם בנויות באופן הבא:
אוסף המלצות: תצוגה בממשק המשתמש שמכילה קבוצה של המלצות מאותו שותף מפתח.
איור 1. ממשק המשתמש של חבילת הבידור שבו מוצגות המלצות של שותף יחיד. ישות: אובייקט שמייצג פריט יחיד באשכול. ישות יכולה להיות פלייליסט, ספר אודיו, פודקאסט ועוד. רשימה של סוגי ישויות נתמכים מופיעה בקטע הוספת נתוני ישויות.
איור 2. ממשק המשתמש של חבילת הבידור שבו מוצג ישות אחת באשכול המלצות של שותף אחד.
באוסף ההמשכים מוצג תוכן אודיו שהמשתמשים התעניינו בו לאחרונה מכמה שותפי פיתוח בקבוצה אחת בממשק המשתמש. כל שותף מפתח יוכל לשדר עד 10 ישויות באשכול ההמשך.
איור 3. ממשק המשתמש של מרכז הבידור שבו מוצג אוסף ההמשכים עם המלצות שלא סיימתם לצפות בהן מכמה שותפים (רק המלצה אחת מוצגת כרגע). באוסף המומלצים מוצגים פריטים נבחרים מכמה שותפי פיתוח בקבוצה אחת בממשק המשתמש. יהיה אשכול אחד של המלצות נבחרות, שיוצג בחלק העליון של ממשק המשתמש עם מיקום עדיפות מעל כל אשכולות ההמלצות. כל שותף מפתח יוכל לשדר עד 10 ישויות באשכול 'מומלצים'.
איור 4. ממשק המשתמש של Entertainment Space שבו מוצג מקבץ של תוכן מומלץ עם המלצות מכמה שותפים (רק המלצה אחת מוצגת כרגע).
עבודה מקדימה
רמת ה-API המינימלית: 19
להוסיף את ספריית com.google.android.engage:engage-core
לאפליקציה:
dependencies {
// Make sure you also include that repository in your project's build.gradle file.
implementation 'com.google.android.engage:engage-core:1.5.2'
}
סיכום
העיצוב מבוסס על הטמעה של שירות קשור.
הנתונים שלקוח יכול לפרסם כפופים למגבלות הבאות עבור סוגים שונים של אשכולות:
סוג האשכול | מגבלות על אשכולות | מגבלות מקסימליות על ישויות באשכול |
---|---|---|
אשכולות של המלצות | עד 7 | עד 50 |
אשכול המשכיות | עד 1 | עד 20 |
אשכול מוצג | עד 1 | עד 20 |
שלב 1: הזנת נתוני הישות
ב-SDK מוגדרות ישויות שונות שמייצגות כל סוג פריט. אנחנו תומכים בישויות הבאות בקטגוריה 'האזנה':
MusicAlbumEntity
MusicArtistEntity
MusicTrackEntity
MusicVideoEntity
PlaylistEntity
PodcastSeriesEntity
PodcastEpisodeEntity
LiveRadioStationEntity
AudiobookEntity
בתרשימים הבאים מפורטים המאפיינים הזמינים והדרישות לכל סוג.
MusicAlbumEntity
אובייקט MusicAlbumEntity
מייצג אלבום מוזיקה (לדוגמה, Midnights של טיילור סוויפט).
מאפיין | דרישה | פתקים |
---|---|---|
שם | חובה | שם אלבום המוזיקה. |
תמונות פוסטר | חובה | צריך לספק לפחות תמונה אחת. הנחיות זמינות במאמר בנושא מפרט לתמונות. |
URI של דף המידע | חובה |
קישור העומק לאפליקציית הספק עם פרטים על אלבום המוזיקה. הערה: אפשר להשתמש בקישורי עומק לשיוך (Attribution). אפשר לעיין בשאלות הנפוצות |
אומנים | חובה | רשימת האומנים באלבום המוזיקה. |
URI של ההפעלה | אופציונלי |
קישור עומק שמתחיל להפעיל את האלבום באפליקציה של הספק. הערה: אפשר להשתמש בקישורי עומק לשיוך (Attribution). אפשר לעיין בשאלות הנפוצות |
תיאור | אופציונלי | אם מציינים את התיאור, הוא צריך לכלול עד 200 תווים. |
מספר השירים | אופציונלי | מספר השירים באלבום המוזיקה. |
ז'אנרים | אופציונלי | רשימת הז'אנרים באלבום המוזיקה. |
פורמט האלבום | אופציונלי |
אלבום (כולל תקליט LP ותקליט LP כפול) מיני-אלבום SINGLE מיקסטייפ |
תוויות מוזיקה | אופציונלי | רשימת לייבלים של מוזיקה שמשויכים לאלבום. |
הורדה במכשיר | אופציונלי | ערך בוליאני שמציין אם אלבום המוזיקה הורד למכשיר. |
תוכן בוטה | אופציונלי |
ערך בוליאני שמציין אם התוכן בוטה או לא פריטים שמכילים תוכן בוטה או שיש להם אזהרה להורים צריכים להיות מוגדרים כ-TRUE. פריטים עם תוכן בוטה מופיעים עם התג 'E'. |
תאריך הפצה | אופציונלי | תאריך ההפצה של האלבום באלפיות השנייה לפי תקופה של זמן מערכת. |
משך הזמן | אופציונלי | משך האלבום באלפיות השנייה. |
זמן האינטראקציה האחרונה | אופציונלי |
מומלץ לפריטים באוסף ההמשכים. יכול לשמש לדירוג. באפוקה באלפיות השנייה |
אחוז ההתקדמות | אופציונלי |
מומלץ לפריטים באוסף ההמשכים. מספר שלם בין 0 ל-100 |
MusicArtistEntity
האובייקט MusicArtistEntity
מייצג אומן מוזיקה (לדוגמה, אדל).
מאפיין | דרישה | פתקים |
---|---|---|
שם | חובה | שם אומן המוזיקה. |
תמונות פוסטר | חובה | צריך לספק לפחות תמונה אחת. הנחיות זמינות במאמר בנושא מפרט לתמונות. |
URI של דף המידע | חובה |
קישור העומק לאפליקציית הספק עם פרטים על אומן המוזיקה. הערה: אפשר להשתמש בקישורי עומק לשיוך (Attribution). אפשר לעיין בשאלות הנפוצות |
URI של ההפעלה | אופציונלי |
קישור העומק שמתחיל להפעיל את השירים של האומן באפליקציה של הספק. הערה: אפשר להשתמש בקישורי עומק לשיוך (Attribution). אפשר לעיין בשאלות הנפוצות |
תיאור | אופציונלי | אם מציינים את התיאור, הוא צריך לכלול עד 200 תווים. |
זמן האינטראקציה האחרונה | אופציונלי |
מומלץ לפריטים באוסף ההמשכים. יכול לשמש לדירוג. באפוקה של אלפיות השנייה |
MusicTrackEntity
אובייקט MusicTrackEntity
מייצג טראק מוזיקלי (לדוגמה, Yellow של Coldplay).
מאפיין | דרישה | פתקים |
---|---|---|
שם | חובה | שם טראק המוזיקה. |
תמונות פוסטר | חובה | צריך לספק לפחות תמונה אחת. הנחיות זמינות במאמר בנושא מפרט לתמונות. |
URI של ההפעלה | חובה |
קישור עומק שמתחיל להפעיל את רצועת המוזיקה באפליקציה של הספק. הערה: אפשר להשתמש בקישורי עומק לשיוך (Attribution). אפשר לעיין בשאלות הנפוצות |
אומנים | חובה | רשימת האומנים בטראק המוזיקה. |
URI של דף המידע | אופציונלי |
קישור עומק לאפליקציה של הספק עם פרטים על טראק המוזיקה. הערה: אפשר להשתמש בקישורי עומק לשיוך (Attribution). אפשר לעיין בשאלות הנפוצות |
תיאור | אופציונלי | אם מציינים את התיאור, הוא צריך לכלול עד 200 תווים. |
משך הזמן | אופציונלי | משך הרצועה באלפיות השנייה. |
אלבום | אופציונלי | שם האלבום שאליו השיר שייך. |
הורדה במכשיר | אופציונלי | ערך בוליאני שמציין אם רצועת המוזיקה הורדה למכשיר. |
תוכן בוטה | אופציונלי |
ערך בוליאני שמציין אם התוכן בוטה או לא פריטים שמכילים תוכן בוטה או שיש להם אזהרה להורים צריכים להיות מוגדרים כ-TRUE. פריטים עם תוכן בוטה מופיעים עם התג 'E'. |
זמן האינטראקציה האחרונה | אופציונלי |
מומלץ לפריטים באוסף ההמשכים. יכול לשמש לדירוג. באפוקה באלפיות השנייה |
אחוז ההתקדמות | אופציונלי |
מומלץ לפריטים באוסף ההמשכים. מספר שלם בין 0 ל-100 |
MusicVideoEntity
אובייקט MusicVideoEntity
מייצג סרטון מוזיקה (לדוגמה, The Weeknd - Take My Breath (Official Music Video)).
מאפיין | דרישה | פתקים |
---|---|---|
שם | חובה | שם הקליפ. |
תמונות פוסטר | חובה | צריך לספק לפחות תמונה אחת. הנחיות זמינות במאמר בנושא מפרט לתמונות. |
URI של ההפעלה | חובה |
קישור עומק שמתחיל להפעיל את הקליפ באפליקציה של הספק. הערה: אפשר להשתמש בקישורי עומק לשיוך (Attribution). אפשר לעיין בשאלות הנפוצות |
URI של דף המידע | אופציונלי |
קישור עומק לאפליקציה של הספק עם פרטים על הקליפ. הערה: אפשר להשתמש בקישורי עומק לשיוך (Attribution). אפשר לעיין בשאלות הנפוצות |
משך הזמן | אופציונלי | משך הסרטון באלפיות השנייה. |
מספר צפיות | אופציונלי | מספר הצפיות בסרטון בפורמט טקסט חופשי. |
אומנים | אופציונלי | רשימת האומנים של סרטון המוזיקה. |
סיווג התוכן | אופציונלי | רשימה של סיווגי התוכן של הרצועה. |
תיאור | אופציונלי | אם מציינים את התיאור, הוא צריך לכלול עד 200 תווים. |
הורדה במכשיר | אופציונלי | ערך בוליאני שמציין אם הקליפ הורד למכשיר. |
תוכן בוטה | אופציונלי |
ערך בוליאני שמציין אם התוכן בוטה או לא פריטים שמכילים תוכן בוטה או שיש להם אזהרה להורים צריכים להיות מוגדרים כ-TRUE. פריטים עם תוכן בוטה מופיעים עם התג 'E'. |
זמן האינטראקציה האחרונה | אופציונלי |
מומלץ לפריטים באוסף ההמשכים. יכול לשמש לדירוג. באפוקה באלפיות השנייה |
אחוז ההתקדמות | אופציונלי |
מומלץ לפריטים באוסף ההמשכים. מספר שלם בין 0 ל-100 |
PlaylistEntity
אובייקט PlaylistEntity
מייצג פלייליסט של מוזיקה (לדוגמה, הפלייליסט '10 הלהיטים המובילים בארה"ב').
מאפיין | דרישה | פתקים |
---|---|---|
שם | חובה | שם הפלייליסט. |
תמונות פוסטר | חובה | צריך לספק לפחות תמונה אחת. הנחיות זמינות במאמר בנושא מפרט לתמונות. |
URI של ההפעלה | חובה |
קישור עמוק שמתחיל להפעיל את פלייליסט המוזיקה באפליקציה של הספק. הערה: אפשר להשתמש בקישורי עומק לשיוך (Attribution). אפשר לעיין בשאלות הנפוצות |
URI של דף המידע | אופציונלי |
קישור עומק לאפליקציה של הספק עם פרטים על פלייליסט המוזיקה. הערה: אפשר להשתמש בקישורי עומק לשיוך (Attribution). אפשר לעיין בשאלות הנפוצות |
משך הזמן | אופציונלי | משך הפלייליסט באלפיות השנייה. |
מספר השירים | אופציונלי | מספר השירים בפלייליסט המוזיקה. |
תיאור | אופציונלי | אם מציינים את התיאור, הוא צריך לכלול עד 200 תווים. |
הורדה במכשיר | אופציונלי | ערך בוליאני שמציין אם הפלייליסט הורד למכשיר. |
תוכן בוטה | אופציונלי |
ערך בוליאני שמציין אם התוכן בוטה או לא פריטים שמכילים תוכן בוטה או שיש להם אזהרה להורים צריכים להיות מוגדרים כ-TRUE. פריטים עם תוכן בוטה מופיעים עם התג 'E'. |
זמן האינטראקציה האחרונה | אופציונלי |
מומלץ לפריטים באוסף ההמשכים. יכול לשמש לדירוג. באפוקה באלפיות השנייה |
אחוז ההתקדמות | אופציונלי |
מומלץ לפריטים באוסף ההמשכים. מספר שלם בין 0 ל-100 |
PodcastSeriesEntity
אובייקט PodcastSeriesEntity
מייצג סדרת פודקאסטים (לדוגמה, This
American Life).
מאפיין | דרישה | פתקים |
---|---|---|
שם | חובה | שם סדרת הפודקאסט. |
תמונות פוסטר | חובה | צריך לספק לפחות תמונה אחת. הנחיות זמינות במאמר בנושא מפרט לתמונות. |
URI של דף המידע | חובה |
קישור עומק לאפליקציה של הספק עם פרטים על סדרת הפודקאסטים. הערה: אפשר להשתמש בקישורי עומק לשיוך (Attribution). אפשר לעיין בשאלות הנפוצות |
URI של ההפעלה | אופציונלי |
קישור עומק שמתחיל להפעיל את סדרת הפודקאסטים באפליקציית הספק. הערה: אפשר להשתמש בקישורי עומק לשיוך (Attribution). אפשר לעיין בשאלות הנפוצות |
מספר הפרקים | אופציונלי | מספר הפרקים בסדרת הפודקאסט. |
שם ההפקה | אופציונלי | שם ההפקה של סדרת הפודקאסטים. |
מארחים | אופציונלי | רשימת המארחים של סדרת הפודקאסטים. |
ז'אנרים | אופציונלי | רשימת הז'אנרים של סדרת הפודקאסטים. |
הורדה במכשיר | אופציונלי | ערך בוליאני שמציין אם הפודקאסט הורד למכשיר. |
תיאור | אופציונלי | אם מציינים את התיאור, הוא צריך לכלול עד 200 תווים. |
תוכן בוטה | אופציונלי |
ערך בוליאני שמציין אם התוכן בוטה או לא פריטים שמכילים תוכן בוטה או שיש להם אזהרה להורים צריכים להיות מוגדרים כ-TRUE. פריטים עם תוכן בוטה מופיעים עם התג 'E'. |
זמן האינטראקציה האחרונה | אופציונלי |
מומלץ לפריטים באוסף ההמשכים. יכול לשמש לדירוג. באפוקה באלפיות השנייה |
PodcastEpisodeEntity
אובייקט PodcastEpisodeEntity
מייצג סדרת פודקאסטים (לדוגמה, Spark Bird, Episode 754: This American Life).
מאפיין | דרישה | פתקים |
---|---|---|
שם | חובה | השם של פרק הפודקאסט. |
תמונות פוסטר | חובה | צריך לספק לפחות תמונה אחת. הנחיות זמינות במאמר בנושא מפרט לתמונות. |
URI של ההפעלה | חובה |
קישור עומק שמתחיל להפעיל את הפרק של הפודקאסט באפליקציה של הספק. הערה: אפשר להשתמש בקישורי עומק לשיוך (Attribution). אפשר לעיין בשאלות הנפוצות |
שם סדרת הפודקאסט | חובה | שם סדרת הפודקאסטים שאליה הפרק שייך. |
משך הזמן | חובה | משך פרק הפודקאסט באלפיות השנייה. |
תאריך הפרסום | חובה | תאריך הפרסום של הפודקאסט (באלפיות שנייה מאז תקופת ה-Epoch) |
URI של דף המידע | אופציונלי |
קישור עומק לאפליקציה של הספק עם פרטים על הפרק של הפודקאסט. הערה: אפשר להשתמש בקישורי עומק לשיוך (Attribution). אפשר לעיין בשאלות הנפוצות |
שם ההפקה | אופציונלי | שם ההפקה של סדרת הפודקאסטים. |
אינדקס הפרקים | אופציונלי | האינדקס של הפרק בסדרה (האינדקס הראשון הוא 1). |
מארחים | אופציונלי | רשימה של המארחים של פרק הפודקאסט. |
ז'אנרים | אופציונלי | רשימה של ז'אנרים של פרק הפודקאסט. |
הורדה במכשיר | אופציונלי | ערך בוליאני שמציין אם פרק הפודקאסט הורד למכשיר. |
תיאור | אופציונלי | אם מציינים את התיאור, הוא צריך לכלול עד 200 תווים. |
פודקאסט וידאו | אופציונלי | ערך בוליאני שמציין אם פרק הפודקאסט מכיל תוכן וידאו |
תוכן בוטה | אופציונלי |
ערך בוליאני שמציין אם התוכן בוטה או לא פריטים שמכילים תוכן בוטה או שיש להם אזהרה להורים צריכים להיות מוגדרים כ-TRUE. פריטים עם תוכן בוטה מופיעים עם התג 'E'. |
סוג הפריט הבא להאזנה | אופציונלי |
מומלץ לפריטים באוסף ההמשכים TYPE_CONTINUE – המשך של פריט אודיו שלא הסתיים. TYPE_NEXT – המשך בספר חדש בסדרה. TYPE_NEW – תוכן שפורסם לאחרונה. |
זמן האינטראקציה האחרונה | אופציונלי |
מומלץ לפריטים באוסף ההמשכים. יכול לשמש לדירוג. באפוקה באלפיות השנייה |
אחוז ההתקדמות | אופציונלי |
מומלץ לפריטים באוסף ההמשכים. מספר שלם בין 0 ל-100 |
LiveRadioStationEntity
אובייקט LiveRadioStationEntity
מייצג תחנת רדיו בשידור חי (לדוגמה, 98.1 The Breeze).
מאפיין | דרישה | פתקים |
---|---|---|
שם | חובה | שם תחנת הרדיו בשידור חי. |
תמונות פוסטר | חובה | צריך לספק לפחות תמונה אחת. הנחיות זמינות במאמר בנושא מפרט לתמונות. |
URI של ההפעלה | חובה |
קישור עומק שמתחיל להפעיל את תחנת הרדיו באפליקציה של הספק. הערה: אפשר להשתמש בקישורי עומק לשיוך (Attribution). אפשר לעיין בשאלות הנפוצות |
URI של דף המידע | אופציונלי |
קישור עומק לאפליקציה של הספק, שבה אפשר למצוא פרטים על תחנת הרדיו. הערה: אפשר להשתמש בקישורי עומק לשיוך (Attribution). אפשר לעיין בשאלות הנפוצות |
תדירות | אופציונלי | התדירות שבה תחנת הרדיו משודרת (לדוגמה, 98.1 FM). |
שם התוכנית | אופציונלי | התוכנית שמופעלת כרגע בתחנת הרדיו. |
מארחים | אופציונלי | רשימת המארחים של תחנת הרדיו. |
תיאור | אופציונלי | אם מציינים את התיאור, הוא צריך לכלול עד 200 תווים. |
זמן האינטראקציה האחרונה | אופציונלי |
מומלץ לפריטים באוסף ההמשכים. יכול לשמש לדירוג. באפוקה באלפיות השנייה |
AudiobookEntity
אובייקט AudiobookEntity
מייצג ספר אודיו (לדוגמה, ספר האודיו של Becoming מאת מישל אובמה).
מאפיין | דרישה | פתקים |
---|---|---|
שם | חובה | |
תמונות פוסטר | חובה | צריך לספק לפחות תמונה אחת. הנחיות זמינות במאמר בנושא מפרטים של תמונות. |
מחבר | חובה | צריך לציין לפחות שם מחבר אחד. |
URI של קישור לפעולה | חובה |
קישור העומק לאפליקציה של הספק לספר האודיו. הערה: אפשר להשתמש בקישורי עומק לשיוך (Attribution). אפשר לעיין בשאלות הנפוצות |
Narrator | אופציונלי | צריך לציין לפחות שם אחד של קריין. |
תאריך פרסום | אופציונלי | באופן כללי, באלפיות השנייה לפי תקופה של זמן מערכת. |
תיאור | אופציונלי | אם מציינים את התיאור, הוא צריך לכלול עד 200 תווים. |
מחיר | אופציונלי | טקסט חופשי |
משך הזמן | אופציונלי | אם מציינים ערך, הוא חייב להיות חיובי. |
ז'אנר | אופציונלי | רשימת הז'אנרים שמשויכים לספר. |
שם הסדרה | אופציונלי | שם הסדרה שאליה הספר הדיגיטלי שייך (לדוגמה, Harry Potter). |
אינדקס יחידות של סדרות | אופציונלי | האינדקס של ספר האודיו בסדרה, כאשר 1 הוא ספר האודיו הראשון בסדרה. לדוגמה, אם הארי פוטר והאסיר מאזקבאן הוא הספר השלישי בסדרה, צריך להגדיר את הערך 3. |
סוג הספר להמשך | אופציונלי |
TYPE_CONTINUE – המשך קריאה של ספר לא גמור. TYPE_NEXT – המשך בספר חדש בסדרה. TYPE_NEW – תוכן שפורסם לאחרונה. |
מועד האינטראקציה האחרונה | חובה להזין ערך באופן מותנה | חובה לציין את הערך הזה אם הפריט נמצא באוסף ההמשכים. באפוקה באלפיות השנייה. |
אחוז ההתקדמות שהושלם | חובה להזין ערך באופן מותנה |
חובה לציין את הערך הזה אם הפריט נמצא באוסף ההמשכים. ספרי אודיו שנרכשו *לאחרונה* יכולים להיות חלק מהאוסף 'המשך קריאה'. הערך חייב להיות גדול מ-0 וקטן מ-100. |
DisplayTimeWindow – הגדרת חלון זמן להצגת תוכן בפלטפורמה | ||
חותמת זמן של התחלה | אופציונלי |
חותמת הזמן של התקופה שאחריה התוכן יוצג בממשק. אם לא מוגדרת מדיניות, התוכן עומד בדרישות להצגה בפלטפורמה. באפוקה באלפיות השנייה. |
חותמת זמן של סיום | אופציונלי |
חותמת הזמן של התקופה שאחריה התוכן לא יוצג יותר בממשק. אם לא מוגדרת מדיניות, התוכן עומד בדרישות להצגה בפלטפורמה. באפוקה באלפיות השנייה. |
מפרט לתמונות
בהמשך מפורטות הדרישות לגבי נכסי תמונות:
יחס גובה-רוחב | דרישה | מספר פיקסלים מינימלי | מספר פיקסלים מומלץ |
---|---|---|---|
ריבוע (1x1) | חובה | 300x300 | 1,200x1,200 |
תמונה לרוחב (1.91x1) | אופציונלי | 600x314 | 1,200x628 |
לאורך (4x5) | אופציונלי | 480x600 | 960x1200 |
פורמטים של קבצים
PNG, JPG, GIF סטטי, WebP
גודל קובץ מקסימלי
5120 KB
המלצות נוספות
- האזור הבטוח לתמונות: התוכן החשוב צריך להופיע ב-80% המרכזיים של התמונה.
דוגמאות
MusicAlbumEntity musicAlbumEntity =
new MusicAlbumEntity.Builder()
.setName(NAME)
.addPosterImage(new Image.Builder()
.setImageUri(Uri.parse("http://www.x.com/image.png"))
.setImageHeightInPixel(960)
.setImageWidthInPixel(408)
.build())
.setPlayBackUri("https://play.google/album/play")
.setInfoPageUri("https://play.google/album/info")
.setDescription("A description of this album.")
.addArtist("Artist")
.addGenre("Genre")
.addMusicLabel("Label")
.addContentRating("Rating")
.setSongsCount(960)
.setReleaseDateEpochMillis(1633032895L)
.setDurationMillis(1633L)
.build();
AudiobookEntity audiobookEntity =
new AudiobookEntity.Builder()
.setName("Becoming")
.addPosterImage(new Image.Builder()
.setImageUri(Uri.parse("http://www.x.com/image.png"))
.setImageHeightInPixel(960)
.setImageWidthInPixel(408)
.build())
.addAuthor("Michelle Obama")
.addNarrator("Michelle Obama")
.setActionLinkUri(
Uri.parse("https://play.google/audiobooks/1"))
.setDurationMillis(16335L)
.setPublishDateEpochMillis(1633032895L)
.setDescription("An intimate, powerful, and inspiring memoir")
.setPrice("$16.95")
.addGenre("biography")
.build();
שלב 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("Trending music")
.build())
.build())
Java
client.publishRecommendationClusters(
new PublishRecommendationClustersRequest.Builder()
.addRecommendationCluster(
new RecommendationCluster.Builder()
.addEntity(entity1)
.addEntity(entity2)
.setTitle("Trending music")
.build())
.build());
כשהשירות מקבל את הבקשה, הפעולות הבאות מתבצעות במסגרת עסקה אחת:
- הנתונים הקיימים של
RecommendationCluster
משותף המפתחים יוסרו. - הנתונים מהבקשה מנותחים ומאוחסנים ב-RecommendationCluster המעודכן.
במקרה של שגיאה, הבקשה כולה נדחית והמצב הקיים נשמר.
publishFeaturedCluster
ה-API הזה משמש לפרסום רשימה של אובייקטים מסוג FeaturedCluster
.
Kotlin
client.publishFeaturedCluster(
PublishFeaturedClusterRequest.Builder()
.setFeaturedCluster(
FeaturedCluster.Builder()
...
.build())
.build())
Java
client.publishFeaturedCluster(
new PublishFeaturedClusterRequest.Builder()
.setFeaturedCluster(
new FeaturedCluster.Builder()
...
.build())
.build());
כשהשירות מקבל את הבקשה, הפעולות הבאות מתבצעות במסגרת עסקה אחת:
- הנתונים הקיימים של
FeaturedCluster
משותף המפתחים יוסרו. - הנתונים מהבקשה מנותחים ונשמרים באוסף המאמרים המומלצים המעודכן.
במקרה של שגיאה, הבקשה כולה נדחית והמצב הקיים נשמר.
publishContinuationCluster
משתמשים ב-API הזה כדי לפרסם אובייקט ContinuationCluster
.
Kotlin
client.publishContinuationCluster(
PublishContinuationClusterRequest.Builder()
.setContinuationCluster(
ContinuationCluster.Builder()
.addEntity(entity1)
.addEntity(entity2)
.build())
.build())
Java
client.publishContinuationCluster(
PublishContinuationClusterRequest.Builder()
.setContinuationCluster(
ContinuationCluster.Builder()
.addEntity(entity1)
.addEntity(entity2)
.build())
.build())
כשהשירות מקבל את הבקשה, הפעולות הבאות מתבצעות במסגרת עסקה אחת:
- הנתונים הקיימים של
ContinuationCluster
משותף המפתחים יוסרו. - הנתונים מהבקשה מנותחים ומאוחסנים ב-ContinuationCluster המעודכן.
במקרה של שגיאה, הבקשה כולה נדחית והמצב הקיים נשמר.
publishUserAccountManagementRequest
ה-API הזה משמש לפרסום כרטיס כניסה . פעולת הכניסה מפנה את המשתמשים לדף הכניסה של האפליקציה כדי שהאפליקציה תוכל לפרסם תוכן (או לספק תוכן מותאם אישית יותר)
המטא-נתונים הבאים הם חלק מכרטיס הכניסה –
מאפיין | דרישה | תיאור |
---|---|---|
URI של הפעולה | חובה | קישור עומק לפעולה (כלומר, מעבר לדף הכניסה לאפליקציה) |
תמונה | אופציונלי – אם לא מספקים את הערך הזה, חובה לספק את הערך Title (שם). |
התמונה שמוצגת בכרטיס תמונות ביחס גובה-רוחב של 16x9 וברזולוציה של 1264x712 |
כותרת | אופציונלי – אם לא מספקים את הערך הזה, חובה לספק את הערך של תמונה | השם שמופיע בכרטיס |
טקסט הפעולה | אופציונלי | הטקסט שמוצג ב-CTA (למשל: כניסה) |
כותרת משנה | אופציונלי | כתובית אופציונלית בכרטיס |
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
אם מסיבה עסקית פנימית כלשהי אף אחת מהקבוצות לא פורסמה, מומלץ מאוד לעדכן את סטטוס הפרסום באמצעות API updatePublishStatus. הדבר חשוב כי :
- חשוב לספק את הסטטוס בכל התרחישים, גם כשהתוכן מתפרסם (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
אם התוכן לא פורסם כי המשתמש לא מחובר לחשבון, Google תמליץ לפרסם את כרטיס הכניסה. אם מסיבה כלשהי הספקים לא יכולים לפרסם את כרטיס הכניסה, מומלץ לקרוא ל-API updatePublishStatus עם קוד הסטטוס 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 הזה משמש למחיקת התוכן של Continuation Cluster.
Kotlin
client.deleteContinuationCluster()
Java
client.deleteContinuationCluster();
כשהשירות מקבל את הבקשה, הוא מסיר את הנתונים הקיימים מ-Continuation Cluster. במקרה של שגיאה, הבקשה כולה נדחית והמצב הקיים נשמר.
deleteUserManagementCluster
ממשק ה-API הזה משמש למחיקת התוכן של UserAccountManagement Cluster.
Kotlin
client.deleteUserManagementCluster()
Java
client.deleteUserManagementCluster();
כשהשירות מקבל את הבקשה, הוא מסיר את הנתונים הקיימים מהאשכול UserAccountManagement. במקרה של שגיאה, הבקשה כולה נדחית והמצב הקיים נשמר.
deleteClusters
ממשק ה-API הזה משמש למחיקת התוכן של סוג מסוים של אשכול.
Kotlin
client.deleteClusters(
DeleteClustersRequest.Builder()
.addClusterType(ClusterType.TYPE_FEATURED)
.addClusterType(ClusterType.TYPE_RECOMMENDATION)
...
.build())
Java
client.deleteClusters(
new DeleteClustersRequest.Builder()
.addClusterType(ClusterType.TYPE_FEATURED)
.addClusterType(ClusterType.TYPE_RECOMMENDATION)
...
.build());
כשהשירות מקבל את הבקשה, הוא מסיר את הנתונים הקיימים מכל האשכולות שתואמים לסוגי האשכולות שצוינו. הלקוחות יכולים לבחור להעביר סוג אחד או כמה סוגים של אשכולות. במקרה של שגיאה, הבקשה כולה נדחית והמצב הקיים נשמר.
טיפול בשגיאות
מומלץ מאוד להאזין לתוצאת המשימה מממשקי ה-API של הפרסום, כדי שאפשר יהיה לבצע פעולת המשך לשחזור ולשליחה מחדש של משימה שהושלמה בהצלחה.
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
עם הסיבה שכלולה כקוד שגיאה.
קוד שגיאה | שם השגיאה | הערה |
---|---|---|
1 |
SERVICE_NOT_FOUND |
השירות לא זמין במכשיר הנתון. |
2 |
SERVICE_NOT_AVAILABLE |
השירות זמין במכשיר הנתון, אבל הוא לא זמין בזמן השיחה (לדוגמה, הוא מושבת באופן מפורש). |
3 |
SERVICE_CALL_EXECUTION_FAILURE |
הפעלת המשימה נכשלה בגלל בעיות בשרשור. במקרה כזה, אפשר לנסות שוב. |
4 |
SERVICE_CALL_PERMISSION_DENIED |
למתקשר אין הרשאה לבצע את הקריאה לשירות. |
5 |
SERVICE_CALL_INVALID_ARGUMENT |
הבקשה מכילה נתונים לא תקינים (לדוגמה, מספר האשכולות חורג מהמספר המותר). |
6 |
SERVICE_CALL_INTERNAL |
יש שגיאה בצד השירות. |
7 |
SERVICE_CALL_RESOURCE_EXHAUSTED |
הקריאה לשירות מתבצעת בתדירות גבוהה מדי. |
שלב 3: טיפול ב-Intents של שידור
בנוסף לקריאות ל-API לפרסום תוכן דרך משימה, צריך גם להגדיר BroadcastReceiver
כדי לקבל את הבקשה לפרסום תוכן.
המטרה העיקרית של כוונות שידור היא הפעלה מחדש של אפליקציות וכפייה של סנכרון נתונים. ה-Intents של שידור לא נועדו להישלח בתדירות גבוהה מאוד. ההתראה מופעלת רק כשהשירות של Engage קובע שהתוכן עשוי להיות לא עדכני (לדוגמה, אם הוא נוצר לפני שבוע). כך המשתמשים יכולים להיות בטוחים שהם יקבלו חוויית תוכן עדכנית, גם אם האפליקציה לא הופעלה במשך תקופה ארוכה.
צריך להגדיר את BroadcastReceiver
באחת משתי הדרכים הבאות:
רישום דינמי של מופע של המחלקה
BroadcastReceiver
באמצעותContext.registerReceiver()
. ההרשאה הזו מאפשרת תקשורת מאפליקציות שעדיין פעילות בזיכרון.
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),
com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
/*scheduler=*/null)
// Register Featured Cluster Publish Intent
context.registerReceiver(AppEngageBroadcastReceiver(),
IntentFilter(Intents.ACTION_PUBLISH_FEATURED),
com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
/*scheduler=*/null)
// Register Continuation Cluster Publish Intent
context.registerReceiver(AppEngageBroadcastReceiver(),
IntentFilter(Intents.ACTION_PUBLISH_CONTINUATION),
com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
/*scheduler=*/null)
}
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),
com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
/*scheduler=*/null);
// Register Featured Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
new IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_FEATURED),
com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
/*scheduler=*/null);
// Register Continuation Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
new IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_CONTINUATION),
com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
/*scheduler=*/null);
}
מצהירים באופן סטטי על הטמעה באמצעות התג
<receiver>
בקובץAndroidManifest.xml
. ההרשאה הזו מאפשרת לאפליקציה לקבל שידורי Intent כשהיא לא פועלת, וגם מאפשרת לאפליקציה לפרסם את התוכן.
<application>
<receiver
android:name=".AppEngageBroadcastReceiver"
android:permission="com.google.android.engage.REQUEST_ENGAGE_DATA"
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-developers@google.com
. הצוות שלנו ישיב בהקדם האפשרי.
השלבים הבאים
אחרי שמסיימים את השילוב, השלבים הבאים הם:
- שולחים אימייל לכתובת
engage-developers@google.com
ומצרפים את קובץ ה-APK המשולב שמוכן לבדיקה על ידי Google. - Google תבצע אימות ובדיקה פנימיים כדי לוודא שהשילוב פועל כמו שצריך. אם יהיה צורך בשינויים, Google תיצור איתכם קשר ותספק את כל הפרטים הנדרשים.
- כשהבדיקה תסתיים ולא יהיה צורך בשינויים, Google תיצור איתכם קשר כדי להודיע לכם שתוכלו להתחיל לפרסם את קובץ ה-APK המעודכן והמשולב ב-Play Store.
- אחרי ש-Google תאשר שה-APK המעודכן פורסם ב-Play Store, קבוצות התוצאות המומלצות, המוצגות וההמשך יפורסמו ויוצגו למשתמשים.