כדי להגביר את רמת העניין באפליקציה, כדאי להגיע למשתמשים במקומות שבהם הם נמצאים. אפשר לשלב את Engage SDK כדי להציג המלצות מותאמות אישית ותוכן המשך ישירות למשתמשים בכמה פלטפורמות במכשיר, כמו אוספים, חבילת הבידור וחנות Play. השילוב מוסיף פחות מ-50KB (דחוס) לחבילת ה-APK הממוצעת, וברוב האפליקציות הוא דורש כשבוע של זמן פיתוח. מידע נוסף מופיע באתר העסקי שלנו.
המדריך הזה כולל הוראות לשותפים מפתחים להעברת תוכן של נסיעות ואירועים לממשקי תוכן של Engage.
פרטי השילוב
טרמינולוגיה
השילוב הזה כולל את סוגי האשכולות הבאים: המלצה, מומלץ, הזמנה והמשך החיפוש.
באשכולות המלצות מוצגות הצעות מותאמות אישית לנסיעות ולאירועים ממפתח שותף ספציפי. ההמלצות האלה יכולות להיות מותאמות אישית למשתמש או כלליות (למשל, פריטים פופולריים). הם משמשים להצגת המלצות למאמרים, לאירועים, למקומות לינה או למקומות מעניינים.
- אוסף ההמלצות יכול לכלול
ArticleEntity
,EventEntity
,LodgingEntity
,PointOfInterestEntity
אוStoreEntity
כרטיסי מוצר, אבל לא שילוב של סוגי ישויות שונים.
ההמלצות שלכם בנויות באופן הבא:
אשכול המלצות: תצוגת ממשק משתמש שמכילה קבוצה של המלצות מאותו שותף מפתח.
ישות: אובייקט שמייצג פריט יחיד באשכול. השילוב הזה מציע כמה ישויות שיוצגו באמצעות אשכול ההמלצות:
ArticleEntity: ArticleEntity מייצג המלצה לתוכן מבוסס-טקסט שקשור לנסיעות ולאירועים. אפשר להשתמש בו כדי ליצור מאמרים, פוסטים בבלוג, תוכן שיווקי, קטעי חדשות ועוד.
איור 1: ממשק משתמש שבו מוצג ArticleEntity יחיד באשכול Recommendations. EventEntity: EventEntity מייצג אירוע שיתרחש בעתיד. שעת ההתחלה של האירוע היא מידע חשוב שצריך להעביר למשתמשים.
איור 2: ממשק משתמש שבו מוצג EventEntity יחיד באוסף Recommendations. LodgingEntity: LodgingEntity מייצג מקום לינה, כמו מלון, דירה או בית נופש להשכרה לטווח קצר או ארוך.
איור 3: ממשק משתמש שבו מוצג LodgingEntity יחיד באוסף ההמלצות. StoreEntity: StoreEntity מייצג חנות, מסעדה, בית קפה וכו'. הוא מדגיש תוכן שבו מקום לאכילה או חנות הם פריט המידע החשוב שצריך להעביר למשתמשים.
איור 4: ממשק משתמש שבו מוצג StoreEntity יחיד באשכול Recommendations. PointOfInterestEntity: PointOfInterestEntity מייצג מקום שמעניין את המשתמש, כמו תחנת דלק, מקום לאירועים, פארק שעשועים, מוזיאון, אטרקציה תיירותית, מסלול טיולים וכו'. הוא מדגיש תוכן שבו המיקום הוא חלק חיוני מהמידע שצריך להעביר למשתמשים. אין להשתמש בהם למקומות לינה, לחנויות או למסעדות.
איור 5: ממשק משתמש שבו רואים PointOfInterestEntity יחיד באשכול ההמלצות.
- אוסף ההמלצות יכול לכלול
באוסף הזמנה מוצג תוכן שמשתמשים הביעו בו עניין לאחרונה, מכמה שותפי פיתוח, בקבוצה אחת בממשק המשתמש. כל שותף מפתח יוכל לשדר עד 10 ישויות באשכול Reservation.
תוכן ההזמנה יכול להיות במבנה הבא:
RestaurantReservationEntity: RestaurantReservationEntity מייצג הזמנה למסעדה או לבית קפה, ועוזר למשתמשים לעקוב אחרי הזמנות קרובות או פעילות למסעדות.
איור 6. ממשק משתמש שבו מוצג RestaurantReservationEntity יחיד באשכול Reservation. EventReservationEntity: EventReservationEntity מייצג הזמנה לאירוע ועוזר למשתמשים לעקוב אחרי הזמנות לאירועים קרובים או לאירועים שמתקיימים כרגע. האירועים יכולים לכלול, בין היתר, את הדברים הבאים:
- אירועי ספורט, כמו הזמנה למשחק כדורגל
- אירועים שקשורים לגיימינג, כמו הזמנה לטורניר ספורט אלקטרוני
- אירועי בידור כמו הזמנה לסרט בקולנוע, להופעה, לתיאטרון או לחתימה על ספר
- הזמנות לנסיעות או למוקדי עניין, כמו סיורים מודרכים, כרטיסים למוזיאון
- הזמנות לאירועים חברתיים / סמינרים / כנסים
- הזמנות להדרכות או למפגשי לימוד
איור 7. ממשק משתמש שמוצג בו EventReservationEntity יחיד באשכול Reservation. LodgingReservationEntity: LodgingEntityReservation מייצג הזמנה של מקום לינה במהלך נסיעה, ועוזר למשתמשים לעקוב אחרי הזמנות קרובות או פעילות של בתי מלון או יחידות אירוח.
איור 8. ממשק משתמש שבו רואים את LodgingReservationEntity בתוך אשכול Reservation. TransportationReservationEntity: TransportationReservationEntity מייצג הזמנה של תחבורה בכל אמצעי תחבורה, ועוזר למשתמשים לעקוב אחרי הזמנות של טיסות, מעבורות, רכבות, אוטובוסים, מוניות או הפלגות קרובות או כאלה שמתבצעות כרגע.
איור 9. ממשק משתמש שבו מוצג TransportationReservationEntity יחיד באשכול Reservation. VehicleRentalReservationEntity: VehicleRentalReservationEntity מייצג הזמנה להשכרת רכב ועוזר למשתמשים לעקוב אחרי הזמנות להשכרת רכב שיתבצעו בעתיד או שמתבצעות כרגע.
איור 10. ממשק משתמש שבו רואים את הישות VehicleRentalReservationEntity בתוך קבוצת הזמנות.
באשכול מומלצים מוצגת קבוצה של ישויות מכמה שותפי פיתוח בממשק משתמש אחד. יהיה אשכול אחד של המלצות נבחרות, שיוצג בחלק העליון של ממשק המשתמש עם מיקום עדיפות מעל כל אשכולות ההמלצות. כל שותף מפתח יוכל לשדר עד 10 ישויות באשכול 'מומלצים'.
GenericFeaturedEntity: הרכיב GenericFeaturedEntity שונה מהרכיב Recommendation item בכך שהרכיב Featured item צריך לשמש לתוכן מוביל יחיד ממפתחים, והוא צריך לייצג את התוכן החשוב ביותר שיהיה מעניין ורלוונטי למשתמשים.
איור 11: ממשק משתמש שבו מוצג FeaturedCluster עם רשימה של GenericFeaturedEntity
האוסף המשך החיפוש עוזר למשתמשים להמשיך את תהליך החיפוש הקודם שלהם בנושא נסיעות. הוא מציג רשימה של שאילתות חיפוש שהמשתמש חיפש לאחרונה בכל אפליקציות הנסיעות שלו. הבלוק יוצמד למקום השני, אחרי בלוקים של הזמנות ולפני בלוקים של המלצות ושל עסקים מומלצים. כל שותף מפתח יוכל לשדר עד 3 ישויות באשכול 'המשך החיפוש'.
- PointOfInterestEntity: PointOfInterestEntity מייצג מקום מעניין כמו תחנת דלק, מקום לאירועים, פארק שעשועים, מוזיאון, אטרקציה תיירותית, מסלול טיולים וכו'. הוא מדגיש תוכן שהמשתמש חיפש בעבר.
עבודה מקדימה
רמת 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 | לפחות 1 | עד 50 (ArticleEntity , EventEntity ,
LodgingEntity , StoreEntity או
PointOfInterestEntity ) |
אשכול הזמנות | עד 1 | לפחות 1 | עד 20 (RestaurantReservationEntity ,
EventReservationEntity ,
LodgingReservationEntity ,
TransportationReservationEntity או
VehicleRentalReservationEntity ) |
אשכול מוצג | עד 1 | לפחות 1 | עד 20 (GenericFeaturedEntity ) |
המשך חיפוש באשכול | עד 1 | לפחות 1 | עד 3 (PointOfInterestEntity ) |
שלב 1: הזנת נתוני הישות
ב-SDK הוגדרו ישויות שונות שמייצגות כל סוג פריט. אנחנו תומכים בישויות הבאות בקטגוריה 'נסיעות ואירועים':
GenericFeaturedEntity
ArticleEntity
EventEntity
LodgingEntity
StoreEntity
PointOfInterestEntity
RestaurantReservationEntity
EventReservationEntity
LodgingReservationEntity
TransportationReservationEntity
VehicleRentalReservationEntity
בתרשימים הבאים מפורטים המאפיינים הזמינים והדרישות לכל סוג.
GenericFeaturedEntity
מאפיין | דרישה | תיאור | פורמט |
---|---|---|---|
URI של הפעולה | חובה |
קישור עומק לישות באפליקציה של הספק. הערה: אפשר להשתמש בקישורי עומק לשיוך (Attribution). אפשר לעיין בשאלות הנפוצות |
URI |
תמונות פוסטר | חובה | אם תספקו כמה תמונות, נציג רק אחת מהן. יחס הגובה-רוחב המומלץ הוא 16:9 הערה: אם מספקים תג, צריך לוודא שיש שטח בטוח של 24 נקודות dps בחלק העליון והתחתון של התמונה. |
הנחיות זמינות במאמר בנושא מפרט לתמונות. |
כותרת | אופציונלי | השם של הישות. | טקסט חופשי גודל מומלץ של הטקסט: 50 תווים |
תיאור | אופציונלי | פסקה אחת של טקסט שמתארת את הישות. הערה: למשתמש תוצג רשימת התיאורים או רשימת הכתוביות, אבל לא שתיהן. |
טקסט חופשי גודל מומלץ של טקסט: 180 תווים |
רשימת כתוביות | אופציונלי | עד 3 כתוביות, כאשר כל כתובית היא שורה אחת של טקסט. הערה: למשתמש תוצג רשימת התיאורים או רשימת הכתוביות, אבל לא שתיהן. |
טקסט חופשי גודל הטקסט המומלץ לכל כתובית: עד 50 תווים |
תגים | אופציונלי | כל תג יכול להיות טקסט חופשי (עד 15 תווים) או תמונה קטנה. טיפול מיוחד בחוויית המשתמש מעל תמונה או סרטון, לדוגמה, כשכבת-על של תג על התמונה
|
|
תג – טקסט | אופציונלי | השם של התג הערה: חובה להוסיף לתג טקסט או תמונה |
טקסט חופשי גודל טקסט מומלץ: עד 15 תווים |
תג – תמונה | אופציונלי | תמונה קטנה טיפול מיוחד בחוויית המשתמש, למשל הצגת תג כשכבת-על בתמונה הממוזערת של התמונה או הסרטון. הערה: חובה להוסיף לתג טקסט או תמונה |
הנחיות זמינות במאמר בנושא מפרט לתמונות. |
קטגוריות תוכן | אופציונלי | תתאר את קטגוריית התוכן בישות. | רשימת סוגי הנתונים המנויים (enums) אפשר לקבל הנחיות נוספות בקטע בנושא קטגוריית תוכן. |
DisplayTimeWindow (אופציונלי) – הגדרת חלון זמן להצגת התוכן בפלטפורמה | |||
חותמת זמן של התחלה | אופציונלי |
חותמת הזמן של התקופה שאחריה התוכן צריך להיות מוצג במשטח. אם לא מוגדרת מדיניות, התוכן עומד בדרישות להצגה בפלטפורמה. |
חותמת זמן של מערכת Unix באלפיות השנייה |
חותמת זמן של סיום | אופציונלי |
חותמת הזמן של העידן שאחריה התוכן לא יוצג יותר במשטח. אם לא מוגדרת מדיניות, התוכן עומד בדרישות להצגה בפלטפורמה. |
חותמת זמן של מערכת Unix באלפיות השנייה |
ArticleEntity
מאפיין | דרישה | תיאור | פורמט |
---|---|---|---|
URI של הפעולה | חובה |
קישור עומק לישות באפליקציה של הספק. הערה: אפשר להשתמש בקישורי עומק לשיוך (Attribution). אפשר לעיין בשאלות הנפוצות |
URI |
כותרת | חובה | השם של הישות. | טקסט חופשי גודל מומלץ של הטקסט: 50 תווים לכל היותר |
תמונות פוסטר | אופציונלי | אם תספקו כמה תמונות, נציג רק אחת מהן. יחס הגובה-רוחב המומלץ הוא 16:9 הערה: מומלץ מאוד להוסיף תמונה. אם מספקים תג, צריך לוודא שיש מרווח בטוח של 24 נקודות לשנייה בחלק העליון ובחלק התחתון של התמונה. |
הנחיות זמינות במאמר בנושא מפרט לתמונות. |
מקור – שם | אופציונלי | השם של המחבר, הארגון או הכתב | טקסט חופשי גודל מומלץ של הטקסט: פחות מ-25 תווים |
מקור – תמונה | אופציונלי | תמונה של המקור, למשל המחבר, הארגון או הכתב | הנחיות זמינות במאמר בנושא מפרט לתמונות. |
תיאור | אופציונלי | פסקה אחת של טקסט שמתארת את הישות. הערה: למשתמש תוצג רשימת התיאורים או רשימת הכתוביות, אבל לא שתיהן. |
טקסט חופשי גודל מומלץ של טקסט: 180 תווים |
רשימת כתוביות | אופציונלי | עד 3 כתוביות, כאשר כל כתובית היא שורה אחת של טקסט. הערה: למשתמש תוצג רשימת התיאורים או רשימת הכתוביות, אבל לא שתיהן. |
טקסט חופשי גודל הטקסט המומלץ לכל כתובית: עד 50 תווים |
תגים | אופציונלי | כל תג יכול להיות טקסט חופשי (עד 15 תווים) או תמונה קטנה. טיפול מיוחד בחוויית המשתמש מעל תמונה או סרטון, למשל כשכבת-על של תג על התמונה
|
|
תג – טקסט | אופציונלי | השם של התג הערה: חובה להוסיף לתג טקסט או תמונה |
טקסט חופשי גודל טקסט מומלץ: עד 15 תווים |
תג – תמונה | אופציונלי | תמונה קטנה טיפול מיוחד בחוויית המשתמש, למשל הצגת תג כשכבת-על בתמונה הממוזערת של התמונה או הסרטון. הערה: חובה להוסיף לתג טקסט או תמונה |
הנחיות זמינות במאמר בנושא מפרט לתמונות. |
מועד פרסום התוכן | אופציונלי | חותמת הזמן של התקופה באלפיות השנייה שבה התוכן פורסם או עודכן באפליקציה. | חותמת זמן של מערכת Unix באלפיות השנייה |
מועד האינטראקציה האחרונה | אופציונלי | חותמת הזמן של העידן באלפיות השנייה שבה הייתה למשתמש אינטראקציה עם הישות הזו בפעם האחרונה. |
חותמת זמן של מערכת Unix באלפיות השנייה |
אחוז התקדמות | אופציונלי | אחוז התוכן המלא שהמשתמש צרך עד היום. |
ערך מסוג int בין 0 ל-100, כולל. |
קטגוריות תוכן | אופציונלי | תתאר את קטגוריית התוכן בישות. | רשימת סוגי הנתונים המנויים (enums) אפשר לקבל הנחיות נוספות בקטע בנושא קטגוריית תוכן. |
DisplayTimeWindow (אופציונלי) – הגדרת חלון זמן להצגת התוכן בפלטפורמה | |||
חותמת זמן של התחלה | אופציונלי |
חותמת הזמן של התקופה שאחריה התוכן צריך להיות מוצג במשטח. אם לא מוגדרת מדיניות, התוכן עומד בדרישות להצגה בפלטפורמה. |
חותמת זמן של מערכת Unix באלפיות השנייה |
חותמת זמן של סיום | אופציונלי |
חותמת הזמן של העידן שאחריה התוכן לא יוצג יותר במשטח. אם לא מוגדרת מדיניות, התוכן עומד בדרישות להצגה בפלטפורמה. |
חותמת זמן של מערכת Unix באלפיות השנייה |
EventEntity
מאפיין | דרישה | תיאור | פורמט |
---|---|---|---|
URI של הפעולה | חובה |
קישור עומק לישות באפליקציה של הספק. הערה: אפשר להשתמש בקישורי עומק לשיוך (Attribution). אפשר לעיין בשאלות הנפוצות |
URI |
כותרת | חובה | השם של הישות. | מחרוזת גודל מומלץ של הטקסט: 50 תווים לכל היותר |
שעת התחלה מקומית – חותמת זמן | חובה |
חותמת הזמן של העידן שבו האירוע צפוי להתחיל. |
Joda-Time Instant |
שעת התחלה מקומית – אזור זמן | חובה |
אזור הזמן שבו האירוע צפוי להתחיל. |
Joda-Time DateTimeZone הנחיות זמינות במאמר מפרטים של אזורי זמן. |
מצב אירוע | חובה | שדה שמציין אם האירוע יהיה וירטואלי, פרונטלי או גם וירטואלי וגם פרונטלי. |
ערכי Enum: VIRTUAL, IN_PERSON או HYBRID |
תמונות פוסטר | חובה | אם תספקו כמה תמונות, נציג רק אחת מהן. יחס הגובה-רוחב המומלץ הוא 16:9 הערה: מומלץ מאוד להוסיף תמונה. אם מספקים תג, צריך לוודא שיש מרווח בטוח של 24 נקודות לשנייה בחלק העליון ובחלק התחתון של התמונה. |
הנחיות זמינות במאמר בנושא מפרט לתמונות. |
מיקום – מדינה | חובה להזין ערך באופן מותנה | המדינה שבה מתקיים האירוע. הערה: חובה להשתמש בפרמטר הזה לאירועים מסוג IN_PERSON או HYBRID |
טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים |
מיקום – עיר | חובה להזין ערך באופן מותנה | העיר שבה מתקיים האירוע. הערה: חובה להשתמש בפרמטר הזה לאירועים מסוג IN_PERSON או HYBRID |
טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים |
מיקום – כתובת להצגה | חובה להזין ערך באופן מותנה | הכתובת או שם המקום שבו האירוע יתקיים, שיוצגו למשתמש. הערה: חובה להשתמש בפרמטר הזה לאירועים מסוג IN_PERSON או HYBRID |
טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים |
מיקום – כתובת | אופציונלי | כתובת הרחוב (אם רלוונטי) של המיקום שבו מתקיים האירוע. | טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים |
מיקום – מדינה | אופציונלי | המדינה או המחוז (אם רלוונטי) שבהם מתקיים האירוע. | טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים |
מיקום – מיקוד | אופציונלי | המיקוד (אם רלוונטי) של המיקום שבו מתקיים האירוע. | טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים |
מיקום – שכונה | אופציונלי | השכונה (אם רלוונטי) שבה מתקיים האירוע. | טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים |
שעת סיום | אופציונלי |
חותמת הזמן של מערכת Unix שבה האירוע צפוי להסתיים. הערה: הערך הזה יוצג באלפיות השנייה. |
חותמת זמן של מערכת Unix באלפיות השנייה |
תיאור | אופציונלי | פסקה אחת של טקסט שמתארת את הישות. הערה: למשתמש תוצג רשימת התיאורים או רשימת הכתוביות, אבל לא שתיהן. |
טקסט חופשי גודל מומלץ של טקסט: 180 תווים |
רשימת כתוביות | אופציונלי | עד 3 כתוביות, כאשר כל כתובית היא שורה אחת של טקסט. הערה: למשתמש תוצג רשימת התיאורים או רשימת הכתוביות, אבל לא שתיהן. |
טקסט חופשי גודל הטקסט המומלץ לכל כתובית: עד 50 תווים |
תגים | אופציונלי |
כל תג יכול להיות טקסט חופשי (עד 15 תווים) או תמונה קטנה. |
|
תג – טקסט | אופציונלי | השם של התג הערה: חובה להוסיף לתג טקסט או תמונה |
טקסט חופשי גודל טקסט מומלץ: עד 15 תווים |
תג – תמונה | אופציונלי | תמונה קטנה טיפול מיוחד בחוויית המשתמש, למשל הצגת תג כשכבת-על בתמונה הממוזערת של התמונה או הסרטון. הערה: חובה להוסיף לתג טקסט או תמונה |
הנחיות זמינות במאמר בנושא מפרט לתמונות. |
מחיר – CurrentPrice | חובה להזין ערך באופן מותנה |
המחיר הנוכחי של הכרטיס לאירוע. חובה לציין את המחיר הקודם אם מציינים מחיר קודם מחוק. |
טקסט חופשי |
מחיר – מחיר קודם מחוק | אופציונלי | המחיר המקורי של הכרטיס לאירוע. | טקסט חופשי |
נכס יתרונות מרכזיים של מחיר | אופציונלי | הצגת מחיר מוזל כדי להבליט מבצע, אירוע או הנחה לחברי מועדון, אם יש כאלה. | טקסט חופשי גודל הטקסט המומלץ: פחות מ-45 תווים (טקסט ארוך מדי עשוי להציג שלוש נקודות) |
קטגוריות תוכן | אופציונלי | תתאר את קטגוריית התוכן בישות. | רשימה של טיפוסים בני מנייה כשירים
אפשר לקבל הנחיות נוספות בקטע בנושא קטגוריית תוכן. |
DisplayTimeWindow (אופציונלי) – הגדרת חלון זמן להצגת התוכן בפלטפורמה | |||
חותמת זמן של התחלה | אופציונלי |
חותמת הזמן של התקופה שאחריה התוכן צריך להיות מוצג במשטח. אם לא מוגדרת מדיניות, התוכן עומד בדרישות להצגה בפלטפורמה. |
חותמת זמן של מערכת Unix באלפיות השנייה |
חותמת זמן של סיום | אופציונלי |
חותמת הזמן של העידן שאחריה התוכן לא יוצג יותר במשטח. אם לא מוגדרת מדיניות, התוכן עומד בדרישות להצגה בפלטפורמה. |
חותמת זמן של מערכת Unix באלפיות השנייה |
LodgingEntity
מאפיין | דרישה | תיאור | פורמט |
---|---|---|---|
URI של הפעולה | חובה |
קישור עומק לישות באפליקציה של הספק. הערה: אפשר להשתמש בקישורי עומק לשיוך (Attribution). אפשר לעיין בשאלות הנפוצות |
URI |
כותרת | חובה | השם של הישות. | מחרוזת גודל מומלץ של הטקסט: 50 תווים לכל היותר |
תמונות פוסטר | חובה |
אם תספקו כמה תמונות, נציג רק אחת מהן. יחס גובה-רוחב מומלץ: 16:9 הערה: אם מספקים תג, צריך לוודא שיש שטח בטוח של 24 נקודות dps בחלק העליון והתחתון של התמונה. |
הנחיות זמינות במאמר בנושא מפרט לתמונות. |
מיקום – מדינה | חובה | המדינה שבה מתבצעת השהייה. | טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים |
מיקום – עיר | חובה | העיר שבה מתבצעת הלינה. | טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים |
מיקום – כתובת להצגה | חובה | הכתובת שתוצג למשתמש. ברוב תרחישי השימוש, מומלץ לכלול את שם העיר ואולי גם את שם המדינה. לכלול רק את כתובת הרחוב או השכונה אם המשתמש נמצא בקרבת המיקום, אם המשתמש מכיר את המיקום או אם העיר כלולה בכותרת של האשכול. אם אתם כוללים את הכתובת, עליכם לספק כתובת תמציתית, ולהשתמש בקיצורים איפה שאפשר (לדוגמה, 'רח' במקום 'רחוב'). | טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים |
מיקום – כתובת | אופציונלי | כתובת הרחוב של מקום האירוח (אם רלוונטי). | טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים |
מיקום – מדינה | אופציונלי | המדינה (State) או המחוז (אם רלוונטי) שבהם נמצא מקום האירוח. | טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים |
מיקום – מיקוד | אופציונלי | המיקוד (אם רלוונטי) של מקום האירוח. | טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים |
מיקום – שכונה | אופציונלי | השכונה (אם רלוונטי) של מקום האירוח. | טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים |
תגים | אופציונלי |
כל תג יכול להיות טקסט חופשי (עד 15 תווים) או תמונה קטנה. |
|
תג – טקסט | אופציונלי | השם של התג הערה: חובה להוסיף לתג טקסט או תמונה |
טקסט חופשי גודל טקסט מומלץ: עד 15 תווים |
תג – תמונה | אופציונלי | תמונה קטנה טיפול מיוחד בחוויית המשתמש, למשל הצגת תג כשכבת-על בתמונה הממוזערת של התמונה או הסרטון. הערה: חובה להוסיף לתג טקסט או תמונה |
הנחיות זמינות במאמר בנושא מפרט לתמונות. |
תיאור | אופציונלי | פסקה אחת של טקסט שמתארת את הישות. הערה: למשתמש תוצג רשימת התיאורים או רשימת הכתוביות, אבל לא שתיהן. |
טקסט חופשי גודל מומלץ של טקסט: 180 תווים |
רשימת כתוביות | אופציונלי | עד 3 כתוביות, כאשר כל כתובית היא שורה אחת של טקסט. הערה: למשתמש תוצג רשימת התיאורים או רשימת הכתוביות, אבל לא שתיהן. |
טקסט חופשי גודל הטקסט המומלץ לכל כתובית: עד 50 תווים |
AvailabilityTimeWindow – שעת התחלה מקומית – חותמת זמן | אופציונלי | חותמת הזמן של תקופת ה-Epoch שבה מקום האירוח צפוי להיות פתוח או זמין. | Joda-Time Instant |
AvailabilityTimeWindow – שעת התחלה מקומית – אזור זמן | אופציונלי | אזור הזמן שבו מקום האירוח צפוי להיות פתוח או זמין. |
Joda-Time DateTimeZone הנחיות זמינות במאמר מפרטים של אזורי זמן. |
AvailabilityTimeWindow - Localized End Time - Timestamp | אופציונלי | חותמת הזמן של התקופה שבה מקום האירוח צפוי להיות פתוח או זמין. | Joda-Time Instant |
AvailabilityTimeWindow – שעת סיום מקומית – אזור זמן | אופציונלי | אזור הזמן שבו מקום האירוח צפוי להיות פתוח או זמין. |
Joda-Time DateTimeZone הנחיות זמינות במאמר מפרטים של אזורי זמן. |
דירוג – ערך מקסימלי | אופציונלי | הערך המקסימלי בסולם הדירוג. חובה לציין את המאפיין הזה אם מציינים גם את הערך הנוכחי של הסיווג. |
מספר >= 0.0 |
דירוג – ערך נוכחי | אופציונלי | הערך הנוכחי של סולם הדירוג. חובה לציין את המאפיין הזה אם מציינים גם את הערך המקסימלי של הסיווג. |
מספר >= 0.0 |
דירוג – ספירה | אופציונלי | מספר הדירוגים של מקום האירוח. הערה: צריך לספק את השדה הזה אם רוצים שהאפליקציה תשלוט באופן שבו המידע הזה מוצג למשתמשים. מזינים את המחרוזת התמציתית שאפשר להציג למשתמש. לדוגמה, אם המספר הוא 1,000,000, כדאי להשתמש בקיצורים כמו 1M, כדי שהמספר לא ייחתך בגדלים קטנים יותר של מסכים. |
מחרוזת |
דירוג – ערך הספירה | אופציונלי | מספר הדירוגים של מקום האירוח. הערה: צריך לספק את השדה הזה אם לא רוצים לטפל בעצמכם בלוגיקה של קיצור התצוגה. אם מופיעים גם Count וגם Count Value, נשתמש ב-Count כדי להציג למשתמשים |
ארוך |
מחיר – CurrentPrice | חובה להזין ערך באופן מותנה | המחיר הנוכחי של מקום האירוח. חובה לציין את המאפיין הזה אם מציינים מחיר קודם מחוק. |
טקסט חופשי |
מחיר – מחיר קודם מחוק | אופציונלי | המחיר המקורי של מקום האירוח, שיוצג עם קו חוצה בממשק המשתמש. | טקסט חופשי |
נכס יתרונות מרכזיים של מחיר | אופציונלי | הצגת מחיר מוזל כדי להבליט מבצע, אירוע או הנחה לחברי מועדון, אם יש כאלה. | טקסט חופשי גודל הטקסט המומלץ: פחות מ-45 תווים (טקסט ארוך מדי עשוי להציג שלוש נקודות) |
DisplayTimeWindow (אופציונלי) – הגדרת חלון זמן להצגת התוכן בפלטפורמה | |||
חותמת זמן של התחלה | אופציונלי |
חותמת הזמן של התקופה שאחריה התוכן צריך להיות מוצג במשטח. אם לא מוגדרת מדיניות, התוכן עומד בדרישות להצגה בפלטפורמה. |
חותמת זמן של מערכת Unix באלפיות השנייה |
חותמת זמן של סיום | אופציונלי |
חותמת הזמן של העידן שאחריה התוכן לא יוצג יותר במשטח. אם לא מוגדרת מדיניות, התוכן עומד בדרישות להצגה בפלטפורמה. |
חותמת זמן של מערכת Unix באלפיות השנייה |
StoreEntity
אובייקט StoreEntity
מייצג חנות ספציפית שמפתחים שותפים רוצים לפרסם, כמו מסעדה פופולרית או בית קפה שרלוונטיים לחוויית הנסיעה של מישהו.
מאפיין | דרישה | תיאור | פורמט |
---|---|---|---|
תמונות פוסטר | חובה | צריך לספק לפחות תמונה אחת. | הנחיות זמינות במאמר בנושא מפרט לתמונות. |
URI של הפעולה | חובה |
קישור עומק לישות באפליקציה של הספק. הערה: אפשר להשתמש בקישורי עומק לשיוך (Attribution). אפשר לעיין בשאלות הנפוצות |
URI |
כותרת | אופציונלי | שם החנות. | טקסט חופשי גודל הטקסט המומלץ: פחות מ-45 תווים (אם הטקסט ארוך מדי, יכול להיות שיוצגו שלוש נקודות) |
מיקום | אופציונלי | מיקום החנות. | טקסט חופשי גודל הטקסט המומלץ: פחות מ-45 תווים (אם הטקסט ארוך מדי, יכול להיות שיוצגו שלוש נקודות) |
הסבר | אופציונלי | הדגשת מבצע, אירוע או עדכון בחנות, אם יש כאלה. | טקסט חופשי גודל הטקסט המומלץ: פחות מ-45 תווים (אם הטקסט ארוך מדי, יכול להיות שיוצגו שלוש נקודות) |
האותיות הקטנות של היתרונות המרכזיים | אופציונלי | הטקסט של האותיות הקטנות של היתרון המרכזי. | טקסט חופשי גודל הטקסט המומלץ: פחות מ-45 תווים (אם הטקסט ארוך מדי, יכול להיות שיוצגו שלוש נקודות) |
תיאור | אופציונלי | תיאור של החנות. | טקסט חופשי גודל הטקסט המומלץ: פחות מ-90 תווים (אם הטקסט ארוך מדי, יכול להיות שיוצגו שלוש נקודות) |
קטגוריה | אופציונלי | קטגוריה של חנות. בהקשר של מקומות לאכול, יכול להיות שזה סוג המטבח כמו 'צרפתי', 'אמריקאי חדש', 'ראמן', 'מסעדת יוקרה'. |
טקסט חופשי גודל הטקסט המומלץ: פחות מ-45 תווים (אם הטקסט ארוך מדי, יכול להיות שיוצגו שלוש נקודות) |
דירוג – ערך מקסימלי | אופציונלי | הערך המקסימלי בסולם הדירוג. חובה לציין את המאפיין הזה אם מציינים גם את הערך הנוכחי של הסיווג. |
מספר >= 0.0 |
דירוג – ערך נוכחי | אופציונלי | הערך הנוכחי של סולם הדירוג. חובה לציין את המאפיין הזה אם מציינים גם את הערך המקסימלי של הסיווג. |
מספר >= 0.0 |
דירוג – ספירה | אופציונלי | מספר הדירוגים של מקום האירוח. הערה: צריך לספק את השדה הזה אם רוצים שהאפליקציה תשלוט באופן שבו המידע הזה מוצג למשתמשים. מזינים את המחרוזת התמציתית שאפשר להציג למשתמש. לדוגמה, אם המספר הוא 1,000,000, כדאי להשתמש בקיצורים כמו 1M, כדי שהמספר לא ייחתך בגדלים קטנים יותר של מסכים. |
מחרוזת |
דירוג – ערך הספירה | אופציונלי | מספר הדירוגים של מקום האירוח. הערה: צריך לספק את השדה הזה אם לא רוצים לטפל בעצמכם בלוגיקה של קיצור התצוגה. אם מופיעים גם Count וגם Count Value, נשתמש ב-Count כדי להציג למשתמשים |
ארוך |
DisplayTimeWindow (אופציונלי) – הגדרת חלון זמן להצגת התוכן בפלטפורמה | |||
חותמת זמן של התחלה | אופציונלי |
חותמת הזמן של התקופה שאחריה התוכן צריך להיות מוצג במשטח. אם לא מוגדרת מדיניות, התוכן עומד בדרישות להצגה בפלטפורמה. |
חותמת זמן של מערכת Unix באלפיות השנייה |
חותמת זמן של סיום | אופציונלי |
חותמת הזמן של העידן שאחריה התוכן לא יוצג יותר במשטח. אם לא מוגדרת מדיניות, התוכן עומד בדרישות להצגה בפלטפורמה. |
חותמת זמן של מערכת Unix באלפיות השנייה |
PointOfInterestEntity
מאפיין | דרישה | תיאור | פורמט |
---|---|---|---|
URI של הפעולה | חובה |
קישור עומק לישות באפליקציה של הספק. הערה: אפשר להשתמש בקישורי עומק לשיוך (Attribution). אפשר לעיין בשאלות הנפוצות |
URI |
כותרת | חובה | השם של הישות. | מחרוזת גודל מומלץ של הטקסט: 50 תווים לכל היותר |
תמונות פוסטר | חובה להזין ערך באופן מותנה |
אם תספקו כמה תמונות, נציג רק אחת מהן. יחס הגובה-רוחב המומלץ הוא 16:9 הערה: חובה להוסיף תמונה אם הישות היא חלק מאוסף המלצות. אם מספקים תג, צריך לוודא שיש מרווח בטוח של 24 נקודות (dps) בחלק העליון ובחלק התחתון של התמונה |
הנחיות זמינות במאמר בנושא מפרט לתמונות. |
מועד האינטראקציה האחרונה | חובה להזין ערך באופן מותנה |
חותמת הזמן של התקופה שחלפה מאז האינטראקציה האחרונה של המשתמש עם הישות הזו. הערה: השדה הזה הוא חובה אם הישות היא חלק מאשכול של המשך חיפוש. |
Joda-Time Instant |
מיקום – מדינה | חובה להזין ערך באופן מותנה |
המדינה שבה מתרחשת נקודת העניין. הערה: השדה הזה נדרש אם הישות היא חלק מקבוצת המלצות. |
טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים |
מיקום – עיר | חובה להזין ערך באופן מותנה |
העיר שבה מתרחשת נקודת העניין. הערה: השדה הזה נדרש אם הישות היא חלק מקבוצת המלצות. |
טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים |
מיקום – כתובת להצגה | חובה להזין ערך באופן מותנה |
הכתובת שתוצג למשתמש. צריך לספק כתובת תמציתית, ולהשתמש בקיצורים איפה שאפשר (למשל, St במקום Street, Ave במקום Avenue). יכול להיות שהמחרוזת הזו תיחתך, בהתאם למכשיר ולהגדרות של המשתמש. כדי לזהות את המיקום בקלות, כדאי לכלול את שם העיר. הערה: השדה הזה נדרש אם הישות היא חלק מקבוצת המלצות. |
טקסט חופשי גודל מומלץ של הטקסט: עד 35 תווים |
מיקום – כתובת | אופציונלי | הכתובת (אם רלוונטי) של נקודת העניין. | טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים |
מיקום – מדינה | אופציונלי | המדינה או המחוז (אם רלוונטי) שבהם נמצאת נקודת העניין. | טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים |
מיקום – מיקוד | אופציונלי | המיקוד (אם רלוונטי) של נקודת העניין. | טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים |
מיקום – שכונה | אופציונלי | השכונה (אם רלוונטי) של נקודת העניין. | טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים |
AvailabilityTimeWindow – שעת התחלה מקומית – חותמת זמן | אופציונלי | חותמת הזמן של תקופת ה-Epoch שבה המקום המעניין צפוי להיות פתוח או זמין. | Joda-Time Instant |
AvailabilityTimeWindow – שעת התחלה מקומית – אזור זמן | אופציונלי | אזור הזמן שבו המקום המעניין צפוי להיות פתוח או זמין. |
Joda-Time DateTimeZone הנחיות זמינות במאמר מפרטים של אזורי זמן. |
AvailabilityTimeWindow - Localized End Time - Timestamp | אופציונלי | חותמת הזמן של תקופת ה-Epoch שעד אליה המקום צפוי להיות פתוח או זמין. | Joda-Time Instant |
AvailabilityTimeWindow – שעת סיום מקומית – אזור זמן | אופציונלי | אזור הזמן שבו המקום המעניין צפוי להיות פתוח או זמין. |
Joda-Time DateTimeZone הנחיות זמינות במאמר מפרטים של אזורי זמן. |
תגים | אופציונלי |
כל תג יכול להיות טקסט חופשי (עד 15 תווים) או תמונה קטנה. |
|
תג – טקסט | אופציונלי | השם של התג הערה: חובה להוסיף לתג טקסט או תמונה |
טקסט חופשי גודל טקסט מומלץ: עד 15 תווים |
תג – תמונה | אופציונלי | תמונה קטנה טיפול מיוחד בחוויית המשתמש, למשל הצגת תג כשכבת-על בתמונה הממוזערת של התמונה או הסרטון. הערה: חובה להוסיף לתג טקסט או תמונה |
הנחיות זמינות במאמר בנושא מפרט לתמונות. |
תיאור | אופציונלי | פסקה אחת של טקסט שמתארת את הישות. הערה: למשתמש תוצג רשימת התיאורים או רשימת הכתוביות, אבל לא שתיהן. |
טקסט חופשי גודל מומלץ של טקסט: 180 תווים |
רשימת כתוביות | אופציונלי | עד 3 כתוביות, כאשר כל כתובית היא שורה אחת של טקסט. הערה: למשתמש תוצג רשימת התיאורים או רשימת הכתוביות, אבל לא שתיהן. |
טקסט חופשי גודל הטקסט המומלץ לכל כתובית: עד 50 תווים |
דירוג – ערך מקסימלי | אופציונלי | הערך המקסימלי בסולם הדירוג. חובה לציין את המאפיין הזה אם מציינים גם את הערך הנוכחי של הסיווג. |
מספר >= 0.0 |
דירוג – ערך נוכחי | אופציונלי | הערך הנוכחי של סולם הדירוג. חובה לציין את המאפיין הזה אם מציינים גם את הערך המקסימלי של הסיווג. |
מספר >= 0.0 |
דירוג – ספירה | אופציונלי | מספר הדירוגים של נקודת העניין. הערה: צריך לספק את השדה הזה אם רוצים שהאפליקציה תשלוט באופן שבו המידע הזה מוצג למשתמשים. מזינים את המחרוזת התמציתית שאפשר להציג למשתמש. לדוגמה, אם המספר הוא 1,000,000, כדאי להשתמש בקיצורים כמו 1M, כדי שהמספר לא ייחתך בגדלים קטנים יותר של מסכים. |
מחרוזת |
דירוג – ערך הספירה | אופציונלי | מספר הדירוגים של נקודת העניין. הערה: צריך לספק את השדה הזה אם לא רוצים לטפל בעצמכם בלוגיקה של קיצור התצוגה. אם מופיעים גם Count וגם Count Value, נשתמש ב-Count כדי להציג למשתמשים |
ארוך |
מחיר – CurrentPrice | חובה להזין ערך באופן מותנה |
המחיר הנוכחי של הכרטיסים או של כרטיס הכניסה לנקודת העניין. חובה לציין את המחיר הקודם אם מציינים מחיר קודם מחוק. |
טקסט חופשי |
מחיר – מחיר קודם מחוק | אופציונלי | המחיר המקורי של הכרטיסים או של כרטיס הכניסה לנקודת העניין. | טקסט חופשי |
נכס יתרונות מרכזיים של מחיר | אופציונלי | הצגת מחיר מוזל כדי להבליט מבצע, אירוע או הנחה לחברי מועדון, אם יש כאלה. |
טקסט חופשי גודל הטקסט המומלץ: פחות מ-45 תווים (אם הטקסט ארוך מדי, יכול להיות שיוצגו שלוש נקודות) |
קטגוריות תוכן | אופציונלי | תתאר את קטגוריית התוכן בישות. | רשימה של טיפוסים בני מנייה כשירים
אפשר לקבל הנחיות נוספות בקטע בנושא קטגוריית תוכן. |
DisplayTimeWindow (אופציונלי) – הגדרת חלון זמן להצגת התוכן בפלטפורמה | |||
חותמת זמן של התחלה | אופציונלי |
חותמת הזמן של התקופה שאחריה התוכן צריך להיות מוצג במשטח. אם לא מוגדרת מדיניות, התוכן עומד בדרישות להצגה בפלטפורמה. |
חותמת זמן של מערכת Unix באלפיות השנייה |
חותמת זמן של סיום | אופציונלי |
חותמת הזמן של העידן שאחריה התוכן לא יוצג יותר במשטח. אם לא מוגדרת מדיניות, התוכן עומד בדרישות להצגה בפלטפורמה. |
חותמת זמן של מערכת Unix באלפיות השנייה |
RestaurantReservationEntity
מאפיין | דרישה | תיאור | פורמט |
---|---|---|---|
URI של הפעולה | חובה |
קישור עומק לישות באפליקציה של הספק. הערה: אפשר להשתמש בקישורי עומק לשיוך (Attribution). אפשר לעיין בשאלות הנפוצות |
URI |
כותרת | חובה | השם של הישות. | מחרוזת גודל מומלץ של הטקסט: 50 תווים לכל היותר |
שעת ההתחלה של ההזמנה בשעון המקומי – חותמת זמן | חובה | חותמת הזמן של תקופת ה-epoch שבה ההזמנה צפויה להתחיל. | Joda-Time Instant |
שעת התחלת ההזמנה בשעון המקומי – אזור זמן | חובה | אזור הזמן שבו ההזמנה צפויה להתחיל. |
Joda-Time DateTimeZone הנחיות זמינות במאמר מפרטים של אזורי זמן. |
מיקום – מדינה | חובה | המדינה שבה נמצאת המסעדה. | טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים |
מיקום – עיר | חובה | העיר שבה נמצאת המסעדה. | טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים |
מיקום – כתובת להצגה | חובה | הכתובת של המסעדה שתוצג למשתמש. | טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים |
מיקום – כתובת | אופציונלי | הכתובת של המסעדה (אם רלוונטי). | טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים |
מיקום – מדינה | אופציונלי | המדינה או המחוז (אם רלוונטי) שבהם המסעדה ממוקמת. | טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים |
מיקום – מיקוד | אופציונלי | המיקוד (אם רלוונטי) של המסעדה. | טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים |
מיקום – שכונה | אופציונלי | השכונה (אם רלוונטי) שבה נמצאת המסעדה. | טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים |
תמונות פוסטר | אופציונלי | אם תספקו כמה תמונות, נציג רק אחת מהן. יחס גובה-רוחב מומלץ: 16:9 | הנחיות זמינות במאמר בנושא מפרט לתמונות. |
תיאור | אופציונלי | פסקה אחת של טקסט שמתארת את הישות. הערה: למשתמש תוצג רשימת התיאורים או רשימת הכתוביות, אבל לא שתיהן. |
טקסט חופשי גודל מומלץ של טקסט: 180 תווים |
רשימת כתוביות | אופציונלי | עד 3 כתוביות, כאשר כל כתובית היא שורה אחת של טקסט. הערה: למשתמש תוצג רשימת התיאורים או רשימת הכתוביות, אבל לא שתיהן. |
טקסט חופשי גודל הטקסט המומלץ לכל כתובית: עד 50 תווים |
גודל השולחן | אופציונלי | מספר האנשים בקבוצת ההזמנה | מספר שלם > 0 |
DisplayTimeWindow (אופציונלי) – הגדרת חלון זמן להצגת התוכן בפלטפורמה | |||
חותמת זמן של התחלה | אופציונלי |
חותמת הזמן של התקופה שאחריה התוכן צריך להיות מוצג במשטח. אם לא מוגדרת מדיניות, התוכן עומד בדרישות להצגה בפלטפורמה. |
חותמת זמן של מערכת Unix באלפיות השנייה |
חותמת זמן של סיום | אופציונלי |
חותמת הזמן של העידן שאחריה התוכן לא יוצג יותר במשטח. אם לא מוגדרת מדיניות, התוכן עומד בדרישות להצגה בפלטפורמה. |
חותמת זמן של מערכת Unix באלפיות השנייה |
EventReservationEntity
מאפיין | דרישה | תיאור | פורמט |
---|---|---|---|
URI של הפעולה | חובה |
קישור עומק לישות באפליקציה של הספק. הערה: אפשר להשתמש בקישורי עומק לשיוך (Attribution). אפשר לעיין בשאלות הנפוצות |
URI |
כותרת | חובה | השם של הישות. | מחרוזת גודל מומלץ של הטקסט: 50 תווים לכל היותר |
שעת התחלה מקומית – חותמת זמן | חובה |
חותמת הזמן של העידן שבו האירוע צפוי להתחיל. |
Joda-Time Instant |
שעת התחלה מקומית – אזור זמן | חובה |
אזור הזמן שבו האירוע צפוי להתחיל. |
Joda-Time DateTimeZone הנחיות זמינות במאמר מפרטים של אזורי זמן. |
מצב אירוע | חובה | שדה שמציין אם האירוע יהיה וירטואלי, פרונטלי או גם וירטואלי וגם פרונטלי. |
ערכי Enum: VIRTUAL, IN_PERSON או HYBRID |
מיקום – מדינה | חובה להזין ערך באופן מותנה | המדינה שבה מתקיים האירוע. הערה: חובה להשתמש בפרמטר הזה לאירועים מסוג IN_PERSON או HYBRID |
טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים |
מיקום – עיר | חובה להזין ערך באופן מותנה | העיר שבה מתקיים האירוע. הערה: חובה להשתמש בפרמטר הזה לאירועים מסוג IN_PERSON או HYBRID |
טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים |
מיקום – כתובת להצגה | חובה להזין ערך באופן מותנה | הכתובת או שם המקום שבו האירוע יתקיים, שיוצגו למשתמש. הערה: חובה להשתמש בפרמטר הזה לאירועים מסוג IN_PERSON או HYBRID |
טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים |
מיקום – כתובת | אופציונלי | כתובת הרחוב (אם רלוונטי) של המיקום שבו מתקיים האירוע. | טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים |
מיקום – מדינה | אופציונלי | המדינה או המחוז (אם רלוונטי) שבהם מתקיים האירוע. | טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים |
מיקום – מיקוד | אופציונלי | המיקוד (אם רלוונטי) של המיקום שבו מתקיים האירוע. | טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים |
מיקום – שכונה | אופציונלי | השכונה (אם רלוונטי) שבה מתקיים האירוע. | טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים |
תמונות פוסטר | אופציונלי | אם תספקו כמה תמונות, נציג רק אחת מהן. יחס הגובה-רוחב המומלץ הוא 16:9 הערה: מומלץ מאוד להוסיף תמונה. אם מספקים תג, צריך לוודא שיש מרווח בטוח של 24 נקודות לשנייה בחלק העליון ובחלק התחתון של התמונה. |
הנחיות זמינות במאמר בנושא מפרט לתמונות. |
שעת סיום מקומית – חותמת זמן | אופציונלי |
חותמת הזמן של מערכת Unix שבה האירוע צפוי להסתיים. |
Joda-Time Instant |
שעת סיום מקומית – אזור זמן | אופציונלי |
אזור הזמן שבו האירוע צפוי להסתיים. |
Joda-Time DateTimeZone הנחיות זמינות במאמר מפרטים של אזורי זמן. |
ספק שירות – שם | אופציונלי |
השם של ספק השירות. הערה: חובה להוסיף טקסט או תמונה לספק השירות. |
טקסט חופשי. לדוגמה, שם מארגן האירוע או שם הסיור |
ספק שירות – תמונה | אופציונלי |
הלוגו או התמונה של ספק השירות. הערה: חובה להוסיף טקסט או תמונה לספק השירות. |
הנחיות זמינות במאמר בנושא מפרט לתמונות. |
תיאור | אופציונלי | פסקה אחת של טקסט שמתארת את הישות. הערה: למשתמש תוצג רשימת התיאורים או רשימת הכתוביות, אבל לא שתיהן. |
טקסט חופשי גודל מומלץ של טקסט: 180 תווים |
רשימת כתוביות | אופציונלי | עד 3 כתוביות, כאשר כל כתובית היא שורה אחת של טקסט. הערה: למשתמש תוצג רשימת התיאורים או רשימת הכתוביות, אבל לא שתיהן. |
טקסט חופשי גודל הטקסט המומלץ לכל כתובית: עד 50 תווים |
תגים | אופציונלי |
כל תג יכול להיות טקסט חופשי (עד 15 תווים) או תמונה קטנה. |
|
תג – טקסט | אופציונלי | השם של התג הערה: חובה להוסיף לתג טקסט או תמונה |
טקסט חופשי גודל טקסט מומלץ: עד 15 תווים |
תג – תמונה | אופציונלי | תמונה קטנה טיפול מיוחד בחוויית המשתמש, למשל הצגת תג כשכבת-על בתמונה הממוזערת של התמונה או הסרטון. הערה: חובה להוסיף לתג טקסט או תמונה |
הנחיות זמינות במאמר בנושא מפרט לתמונות. |
מזהה הזמנה | אופציונלי | מזהה ההזמנה של ההזמנה לאירוע. | טקסט חופשי |
מחיר – CurrentPrice | חובה להזין ערך באופן מותנה |
המחיר הנוכחי של הכרטיס לאירוע. חובה לציין את המחיר הקודם אם מציינים מחיר קודם מחוק. |
טקסט חופשי |
מחיר – מחיר קודם מחוק | אופציונלי | המחיר המקורי של הכרטיס לאירוע. | טקסט חופשי |
נכס יתרונות מרכזיים של מחיר | אופציונלי | הצגת מחיר מוזל כדי להבליט מבצע, אירוע או הנחה לחברי מועדון, אם יש כאלה. | טקסט חופשי גודל הטקסט המומלץ: פחות מ-45 תווים (טקסט ארוך מדי עשוי להציג שלוש נקודות) |
דירוג – ערך מקסימלי | אופציונלי | הערך המקסימלי בסולם הדירוג. חובה לציין את המאפיין הזה אם מציינים גם את הערך הנוכחי של הסיווג. |
מספר >= 0.0 |
דירוג – ערך נוכחי | אופציונלי | הערך הנוכחי של סולם הדירוג. חובה לציין את המאפיין הזה אם מציינים גם את הערך המקסימלי של הסיווג. |
מספר >= 0.0 |
דירוג – ספירה | אופציונלי | מספר הדירוגים של האירוע. הערה: צריך לספק את השדה הזה אם רוצים שהאפליקציה תשלוט באופן שבו המידע הזה מוצג למשתמשים. מזינים את המחרוזת התמציתית שאפשר להציג למשתמש. לדוגמה, אם המספר הוא 1,000,000, כדאי להשתמש בקיצורים כמו 1M, כדי שהמספר לא ייחתך בגדלים קטנים יותר של מסכים. |
מחרוזת |
דירוג – ערך הספירה | אופציונלי | מספר הדירוגים של האירוע. הערה: צריך לספק את השדה הזה אם לא רוצים לטפל בעצמכם בלוגיקה של קיצור התצוגה. אם מופיעים גם Count וגם Count Value, נשתמש ב-Count כדי להציג למשתמשים |
ארוך |
קטגוריות תוכן | אופציונלי | תתאר את קטגוריית התוכן בישות. | רשימה של טיפוסים בני מנייה כשירים
אפשר לקבל הנחיות נוספות בקטע בנושא קטגוריית תוכן. |
DisplayTimeWindow (אופציונלי) – הגדרת חלון זמן להצגת התוכן בפלטפורמה | |||
חותמת זמן של התחלה | אופציונלי |
חותמת הזמן של התקופה שאחריה התוכן צריך להיות מוצג במשטח. אם לא מוגדרת מדיניות, התוכן עומד בדרישות להצגה בפלטפורמה. |
חותמת זמן של מערכת Unix באלפיות השנייה |
חותמת זמן של סיום | אופציונלי |
חותמת הזמן של העידן שאחריה התוכן לא יוצג יותר במשטח. אם לא מוגדרת מדיניות, התוכן עומד בדרישות להצגה בפלטפורמה. |
חותמת זמן של מערכת Unix באלפיות השנייה |
LodgingReservationEntity
מאפיין | דרישה | תיאור | פורמט |
---|---|---|---|
URI של הפעולה | חובה |
קישור עומק לישות באפליקציה של הספק. הערה: אפשר להשתמש בקישורי עומק לשיוך (Attribution). אפשר לעיין בשאלות הנפוצות |
URI |
כותרת | חובה | השם של הישות. | טקסט חופשי. לדוגמה, "השהייה שלך מ-12 בדצמבר" גודל מומלץ של הטקסט: 50 תווים לכל היותר |
שעת הצ'ק-אין המקומית – חותמת זמן | חובה | חותמת הזמן של התקופה שמייצגת את זמן הצ'ק-אין של ההזמנה. | Joda-Time Instant |
שעת צ'ק-אין מקומית – אזור זמן | חובה | אזור הזמן שבו מוגדרת שעת הצ'ק אין בהזמנה. |
Joda-Time DateTimeZone הנחיות זמינות במאמר מפרטים של אזורי זמן. |
שעת צ'ק-אאוט מקומית – חותמת זמן | חובה | חותמת הזמן של התקופה שמייצגת את שעת הצ'ק-אאוט של ההזמנה. | Joda-Time Instant |
שעת הצ'ק-אאוט המקומית – אזור זמן | חובה | אזור הזמן שבו מוגדרת שעת הצ'ק-אאוט של ההזמנה. |
Joda-Time DateTimeZone הנחיות זמינות במאמר מפרטים של אזורי זמן. |
מיקום – מדינה | חובה | המדינה שבה נמצא מקום האירוח. | טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים |
מיקום – עיר | חובה | העיר שבה נמצא מקום האירוח. | טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים |
מיקום – כתובת להצגה | חובה | הכתובת שתוצג למשתמש. צריך לספק כתובת תמציתית, ולהשתמש בקיצורים איפה שאפשר (למשל, 'St' במקום 'Street', 'Ave' במקום 'Avenue'). יכול להיות שהמחרוזת הזו תיחתך, בהתאם למכשיר ולהגדרות של המשתמש. כדי לזהות את העיר בקלות, כדאי לכלול את השם שלה. | טקסט חופשי גודל מומלץ של הטקסט: עד 35 תווים |
מיקום – כתובת | אופציונלי | כתובת הרחוב של מקום האירוח (אם רלוונטי). | טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים |
מיקום – מדינה | אופציונלי | המדינה (State) או המחוז (אם רלוונטי) שבהם נמצא מקום האירוח. | טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים |
מיקום – מיקוד | אופציונלי | המיקוד (אם רלוונטי) של מקום האירוח. | טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים |
מיקום – שכונה | אופציונלי | השכונה (אם רלוונטי) של מקום האירוח. | טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים |
תמונות פוסטר | אופציונלי |
אם תספקו כמה תמונות, נציג רק אחת מהן. יחס גובה-רוחב מומלץ: 16:9 הערה: אם מספקים תג, צריך לוודא שיש שטח בטוח של 24 נקודות לכל אינץ' (dps) בחלק העליון והתחתון של התמונה. |
הנחיות זמינות במאמר בנושא מפרט לתמונות. |
תיאור | אופציונלי | פסקה אחת של טקסט שמתארת את הישות. הערה: למשתמש תוצג רשימת התיאורים או רשימת הכתוביות, אבל לא שתיהן. |
טקסט חופשי גודל מומלץ של טקסט: 180 תווים |
רשימת כתוביות | אופציונלי | עד 3 כתוביות, כאשר כל כתובית היא שורה אחת של טקסט. הערה: למשתמש תוצג רשימת התיאורים או רשימת הכתוביות, אבל לא שתיהן. |
טקסט חופשי גודל הטקסט המומלץ לכל כתובית: עד 50 תווים |
מזהה הזמנה | אופציונלי | מזהה ההזמנה של הזמנת מקום האירוח. | טקסט חופשי |
דירוג – ערך מקסימלי | אופציונלי | הערך המקסימלי בסולם הדירוג. חובה לציין את המאפיין הזה אם מציינים גם את הערך הנוכחי של הסיווג. |
מספר >= 0.0 |
דירוג – ערך נוכחי | אופציונלי | הערך הנוכחי של סולם הדירוג. חובה לציין את המאפיין הזה אם מציינים גם את הערך המקסימלי של הסיווג. |
מספר >= 0.0 |
דירוג – ספירה | אופציונלי | מספר הדירוגים של מקום האירוח. הערה: צריך לספק את השדה הזה אם רוצים שהאפליקציה תשלוט באופן שבו המידע הזה מוצג למשתמשים. מזינים את המחרוזת התמציתית שאפשר להציג למשתמש. לדוגמה, אם המספר הוא 1,000,000, כדאי להשתמש בקיצורים כמו 1M, כדי שהמספר לא ייחתך בגדלים קטנים יותר של מסכים. |
מחרוזת |
דירוג – ערך הספירה | אופציונלי | מספר הדירוגים של מקום האירוח. הערה: צריך לספק את השדה הזה אם לא רוצים לטפל בעצמכם בלוגיקה של קיצור התצוגה. אם מופיעים גם Count וגם Count Value, נשתמש ב-Count כדי להציג למשתמשים |
ארוך |
מחיר – CurrentPrice | חובה להזין ערך באופן מותנה | המחיר הנוכחי של מקום האירוח. חובה לציין את המאפיין הזה אם מציינים מחיר קודם מחוק. |
טקסט חופשי |
מחיר – מחיר קודם מחוק | אופציונלי | המחיר המקורי של מקום האירוח, שיוצג עם קו חוצה בממשק המשתמש. | טקסט חופשי |
נכס יתרונות מרכזיים של מחיר | אופציונלי | הצגת מחיר מוזל כדי להבליט מבצע, אירוע או הנחה לחברי מועדון, אם יש כאלה. | טקסט חופשי גודל הטקסט המומלץ: פחות מ-45 תווים (טקסט ארוך מדי עשוי להציג שלוש נקודות) |
DisplayTimeWindow (אופציונלי) – הגדרת חלון זמן להצגת התוכן בפלטפורמה | |||
חותמת זמן של התחלה | אופציונלי |
חותמת הזמן של התקופה שאחריה התוכן צריך להיות מוצג במשטח. אם לא מוגדרת מדיניות, התוכן עומד בדרישות להצגה בפלטפורמה. |
חותמת זמן של מערכת Unix באלפיות השנייה |
חותמת זמן של סיום | אופציונלי |
חותמת הזמן של העידן שאחריה התוכן לא יוצג יותר במשטח. אם לא מוגדרת מדיניות, התוכן עומד בדרישות להצגה בפלטפורמה. |
חותמת זמן של מערכת Unix באלפיות השנייה |
TransportationReservationEntity
מאפיין | דרישה | תיאור | פורמט |
---|---|---|---|
URI של הפעולה | חובה |
קישור עומק לישות באפליקציה של הספק. הערה: אפשר להשתמש בקישורי עומק לשיוך (Attribution). אפשר לעיין בשאלות הנפוצות |
URI |
כותרת | חובה | השם של הישות. | טקסט חופשי. לדוגמה, "SFO to SAN" גודל מומלץ של הטקסט: 50 תווים לכל היותר |
סוג תחבורה | חובה | אמצעי התחבורה או סוג התחבורה שרלוונטיים להזמנה. | דוגמאות: FLIGHT, TRAIN, BUS או FERRY |
שעת יציאה מקומית – חותמת זמן | חובה | חותמת הזמן של התקופה שמייצגת את שעת היציאה. | Joda-Time Instant |
שעת יציאה מקומית – אזור זמן | חובה | אזור הזמן של שעת היציאה. |
Joda-Time DateTimeZone הנחיות זמינות במאמר מפרטים של אזורי זמן. |
שעת הגעה מקומית – חותמת זמן | חובה | חותמת הזמן של התקופה שמייצגת את שעת ההגעה. | Joda-Time Instant |
שעת הגעה מקומית – אזור זמן | חובה | אזור הזמן של שעת ההגעה. |
Joda-Time DateTimeZone הנחיות זמינות במאמר מפרטים של אזורי זמן. |
מספר כרטיס תחבורה | חובה | מספר הטיסה, מספר האוטובוס, מספר הרכבת או מספר המעבורת/השייט. | טקסט חופשי |
שעת עלייה למטוס בשעון המקומי – חותמת זמן | חובה | חותמת הזמן של התקופה שמייצגת את זמן העלייה למטוס בהזמנה (אם רלוונטי) | Joda-Time Instant |
שעת עלייה למטוס בשעון המקומי – אזור זמן | חובה | אזור הזמן של שעת העלייה למטוס בהזמנה (אם רלוונטי) |
Joda-Time DateTimeZone הנחיות זמינות במאמר מפרטים של אזורי זמן. |
מיקום היציאה – מדינה | אופציונלי | מדינת המוצא. | טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים |
מיקום היציאה – עיר | אופציונלי | עיר המוצא. | טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים |
מיקום היציאה – הצגת הכתובת | אופציונלי | מיקום היציאה שיוצג למשתמש. | טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים |
מיקום היציאה – כתובת | אופציונלי | כתובת הרחוב (אם רלוונטי) של מיקום ההמראה. | טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים |
מיקום ההמראה – מדינה | אופציונלי | המדינה או המחוז (אם רלוונטי) של מיקום ההמראה. | טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים |
מיקום ההמראה – מיקוד | אופציונלי | המיקוד (אם רלוונטי) של נקודת המוצא. | טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים |
מיקום היציאה – שכונה | אופציונלי | השכונה (אם רלוונטי) של מיקום ההמראה. | טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים |
מיקום ההגעה – מדינה | אופציונלי | מדינת ההגעה. | טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים |
מיקום ההגעה – עיר | אופציונלי | העיר שבה נוחתים. | טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים |
מיקום ההגעה – כתובת לתצוגה | אופציונלי | מיקום ההגעה שיוצג למשתמש. | טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים |
מיקום ההגעה – כתובת | אופציונלי | הכתובת (אם רלוונטי) של מקום ההגעה. | טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים |
מיקום ההגעה – מדינה | אופציונלי | המדינה או המחוז (אם רלוונטי) של מיקום ההגעה. | טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים |
מיקום ההגעה – מיקוד | אופציונלי | המיקוד (אם רלוונטי) של מיקום ההגעה. | טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים |
מיקום ההגעה – שכונה | אופציונלי | השכונה (אם רלוונטי) של מיקום ההגעה. | טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים |
ספק שירות – שם | אופציונלי |
השם של ספק השירות. הערה: חובה להוסיף טקסט או תמונה לספק השירות. |
טקסט חופשי. לדוגמה, שם חברת התעופה |
ספק שירות – תמונה | אופציונלי |
הלוגו או התמונה של ספק השירות. הערה: חובה להוסיף טקסט או תמונה לספק השירות. |
הנחיות זמינות במאמר בנושא מפרט לתמונות. |
תמונות פוסטר | אופציונלי |
אם תספקו כמה תמונות, נציג רק אחת מהן. יחס גובה-רוחב מומלץ: 16:9 |
הנחיות זמינות במאמר בנושא מפרט לתמונות. |
תיאור | אופציונלי | פסקה אחת של טקסט שמתארת את הישות. הערה: למשתמש תוצג רשימת התיאורים או רשימת הכתוביות, אבל לא שתיהן. |
טקסט חופשי גודל מומלץ של טקסט: 180 תווים |
רשימת כתוביות | אופציונלי | עד 3 כתוביות, כאשר כל כתובית היא שורה אחת של טקסט. הערה: למשתמש תוצג רשימת התיאורים או רשימת הכתוביות, אבל לא שתיהן. |
טקסט חופשי גודל הטקסט המומלץ לכל כתובית: עד 50 תווים |
מזהה הזמנה | אופציונלי | מזהה ההזמנה של הזמנת מקום באמצעי תחבורה. | טקסט חופשי |
מחיר – CurrentPrice | חובה להזין ערך באופן מותנה | המחיר הנוכחי של ההזמנה. חובה לציין את המאפיין הזה אם מציינים מחיר קודם מחוק. |
טקסט חופשי |
מחיר – מחיר קודם מחוק | אופציונלי | המחיר המקורי של ההזמנה, שיוצג עם קו חוצה בממשק המשתמש. | טקסט חופשי |
נכס יתרונות מרכזיים של מחיר | אופציונלי | הצגת מחיר מוזל כדי להבליט מבצע, אירוע או הנחה לחברי מועדון, אם יש כאלה. | טקסט חופשי גודל הטקסט המומלץ: פחות מ-45 תווים (טקסט ארוך מדי עשוי להציג שלוש נקודות) |
DisplayTimeWindow (אופציונלי) – הגדרת חלון זמן להצגת התוכן בפלטפורמה | |||
חותמת זמן של התחלה | אופציונלי |
חותמת הזמן של התקופה שאחריה התוכן צריך להיות מוצג במשטח. אם לא מוגדרת מדיניות, התוכן עומד בדרישות להצגה בפלטפורמה. |
חותמת זמן של מערכת Unix באלפיות השנייה |
חותמת זמן של סיום | אופציונלי |
חותמת הזמן של העידן שאחריה התוכן לא יוצג יותר במשטח. אם לא מוגדרת מדיניות, התוכן עומד בדרישות להצגה בפלטפורמה. |
חותמת זמן של מערכת Unix באלפיות השנייה |
VehicleRentalReservationEntity
מאפיין | דרישה | תיאור | פורמט |
---|---|---|---|
URI של הפעולה | חובה |
קישור עומק לישות באפליקציה של הספק. הערה: אפשר להשתמש בקישורי עומק לשיוך (Attribution). אפשר לעיין בשאלות הנפוצות |
URI |
כותרת | חובה | השם של הישות. | טקסט חופשי. לדוגמה, "Avis Union Square SF" גודל מומלץ של הטקסט: 50 תווים לכל היותר |
שעת האיסוף המקומית – חותמת זמן | חובה | חותמת הזמן של תקופת ה-Epoch שמייצגת את זמן האיסוף של ההזמנה. | Joda-Time Instant |
שעת האיסוף המקומית – אזור זמן | חובה | אזור הזמן של שעת האיסוף בהזמנה. |
Joda-Time DateTimeZone הנחיות זמינות במאמר מפרטים של אזורי זמן. |
שעת החזרה המקומית – חותמת זמן | אופציונלי | חותמת הזמן של תקופת ה-epoch שמייצגת את שעת הצ'ק-אאוט של ההזמנה. | Joda-Time Instant |
שעת החזרה המקומית – אזור זמן | אופציונלי | אזור הזמן של שעת הצ'ק-אאוט בהזמנה. |
Joda-Time DateTimeZone הנחיות זמינות במאמר מפרטים של אזורי זמן. |
כתובת האיסוף – מדינה | אופציונלי | המדינה שבה נמצאת נקודת האיסוף. | טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים |
כתובת האיסוף – עיר | אופציונלי | העיר שבה נמצא מקום האיסוף. | טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים |
כתובת איסוף – כתובת להצגה | אופציונלי | מיקום האיסוף שיוצג למשתמש. | טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים |
כתובת האיסוף – רחוב | אופציונלי | הכתובת (אם רלוונטי) של נקודת האיסוף. | טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים |
כתובת האיסוף – מדינה | אופציונלי | המדינה או המחוז (אם רלוונטי) של נקודת האיסוף. | טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים |
כתובת האיסוף – מיקוד | אופציונלי | המיקוד (אם רלוונטי) של מיקום האיסוף. | טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים |
כתובת האיסוף – שכונה | אופציונלי | השכונה (אם רלוונטי) של מיקום האיסוף. | טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים |
כתובת להחזרת מוצרים – מדינה | אופציונלי | המדינה של מיקום החזרת המוצרים. | טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים |
כתובת להחזרת מוצרים – עיר | אופציונלי | העיר שבה נמצא מיקום ההחזרה. | טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים |
כתובת להחזרת מוצרים – כתובת לתצוגה | אופציונלי | מיקום ההחזרה שיוצג למשתמש. | טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים |
כתובת להחזרת מוצרים – רחוב | אופציונלי | הכתובת (אם רלוונטית) של המיקום להחזרת מוצרים. | טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים |
כתובת להחזרת מוצרים – מדינה | אופציונלי | המדינה או המחוז (אם רלוונטי) של מיקום ההחזרה. | טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים |
כתובת להחזרת מוצרים – מיקוד | אופציונלי | המיקוד (אם רלוונטי) של מיקום ההחזרה. | טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים |
כתובת להחזרת מוצרים – שכונה | אופציונלי | השכונה (אם רלוונטי) של מיקום ההחזרה. | טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים |
ספק שירות – שם | אופציונלי |
השם של ספק השירות. הערה: חובה להוסיף טקסט או תמונה לספק השירות. |
טקסט חופשי. לדוגמה, "Avis Car Rental" |
ספק שירות – תמונה | אופציונלי |
הלוגו או התמונה של ספק השירות. הערה: חובה להוסיף טקסט או תמונה לספק השירות. |
הנחיות זמינות במאמר בנושא מפרט לתמונות. |
תמונות פוסטר | אופציונלי |
אם תספקו כמה תמונות, נציג רק אחת מהן. יחס גובה-רוחב מומלץ: 16:9 |
הנחיות זמינות במאמר בנושא מפרט לתמונות. |
תיאור | אופציונלי | פסקה אחת של טקסט שמתארת את הישות. הערה: למשתמש תוצג רשימת התיאורים או רשימת הכתוביות, אבל לא שתיהן. |
טקסט חופשי גודל מומלץ של טקסט: 180 תווים |
רשימת כתוביות | אופציונלי | עד 3 כתוביות, כאשר כל כתובית היא שורה אחת של טקסט. הערה: למשתמש תוצג רשימת התיאורים או רשימת הכתוביות, אבל לא שתיהן. |
טקסט חופשי גודל הטקסט המומלץ לכל כתובית: עד 50 תווים |
מזהה האישור | אופציונלי | מזהה האישור של הזמנת השכרת הרכב. | טקסט חופשי |
מחיר – CurrentPrice | חובה להזין ערך באופן מותנה | המחיר הנוכחי של ההזמנה. חובה לציין את המאפיין הזה אם מציינים מחיר קודם מחוק. |
טקסט חופשי |
מחיר – מחיר קודם מחוק | אופציונלי | המחיר המקורי של ההזמנה, שיוצג עם קו חוצה בממשק המשתמש. | טקסט חופשי |
נכס יתרונות מרכזיים של מחיר | אופציונלי | הצגת מחיר מוזל כדי להבליט מבצע, אירוע או הנחה לחברי מועדון, אם יש כאלה. | טקסט חופשי גודל הטקסט המומלץ: פחות מ-45 תווים (טקסט ארוך מדי עשוי להציג שלוש נקודות) |
DisplayTimeWindow (אופציונלי) – הגדרת חלון זמן להצגת התוכן בפלטפורמה | |||
חותמת זמן של התחלה | אופציונלי |
חותמת הזמן של התקופה שאחריה התוכן צריך להיות מוצג במשטח. אם לא מוגדרת מדיניות, התוכן עומד בדרישות להצגה בפלטפורמה. |
חותמת זמן של מערכת Unix באלפיות השנייה |
חותמת זמן של סיום | אופציונלי |
חותמת הזמן של העידן שאחריה התוכן לא יוצג יותר במשטח. אם לא מוגדרת מדיניות, התוכן עומד בדרישות להצגה בפלטפורמה. |
חותמת זמן של מערכת Unix באלפיות השנייה |
מפרט לתמונות
בטבלה הזו מפורטים המפרטים הנדרשים לנכסי תמונות:
יחס גובה-רוחב | מספר פיקסלים מינימלי | מספר פיקסלים מומלץ |
---|---|---|
ריבוע (1x1) מועדף |
300x300 | 1,200x1,200 |
תמונה לרוחב (1.91x1) | 600x314 | 1,200x628 |
לאורך (4x5) | 480x600 | 960x1200 |
התמונות צריכות להיות מאוחסנות ברשתות CDN ציבוריות כדי ש-Google תוכל לגשת אליהן.
פורמטים של קבצים
PNG, JPG, GIF סטטי, WebP
גודל קובץ מקסימלי
5120 KB
המלצות נוספות
- האזור הבטוח לתמונות: התוכן החשוב צריך להופיע ב-80% המרכזיים של התמונה.
- כדאי להשתמש ברקע שקוף כדי שהתמונה תוצג בצורה תקינה בהגדרות של עיצוב כהה ובהיר.
מפרטים של אזורי זמן
עדיף להשתמש במזהה (לדוגמה, America/Los_Angeles) במקום בהיסט (לדוגמה, -07:00).
דוגמה לשימוש: DateTimeZone.forID("America/Los_Angeles")
קטגוריית תוכן
קטגוריית התוכן מאפשרת לאפליקציות לפרסם תוכן ששייך לכמה קטגוריות. המיפוי הזה מתבצע עם חלק מהקטגוריות המוגדרות מראש, כלומר:
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 ו-PointOfInterestEntity, רק קבוצת משנה של הקטגוריות האלה עומדת בדרישות. לפני שממלאים את הרשימה, כדאי לעיין ברשימת הקטגוריות שמתאימות לסוג הישות.
בקטגוריות תוכן מסוימות, כדאי להשתמש בסוג הישות הספציפי במקום בשילוב של הישויות הגנריות והמאפיין ContentCategory:
- TYPE_MOVIES_AND_TV_SHOWS – לפני שמשתמשים בישויות כלליות, כדאי לעיין בישויות מתוך מדריך השילוב של Watch.
- TYPE_BOOKS – לפני שמשתמשים בישויות גנריות, כדאי לעיין ב-EbookEntity.
- TYPE_AUDIOBOOKS – לפני שמשתמשים בישויות כלליות, כדאי לעיין ב-AudiobookEntity.
- TYPE_SHOPPING – מעבר לתשלום לפני השימוש בישויות כלליות, צריך לעיין ב-ShoppingEntity.
- TYPE_FOOD_AND_DRINK – לפני שמשתמשים בישויות כלליות, כדאי לעיין בישויות מתוך מדריך השילוב של הזמנת אוכל.
השדה ContentCategory הוא אופציונלי, ואם התוכן לא שייך לאף אחת מהקטגוריות שצוינו קודם, צריך להשאיר אותו ריק.
אם מציינים כמה קטגוריות תוכן, צריך לציין אותן לפי סדר הרלוונטיות לתוכן, כשהקטגוריה הרלוונטית ביותר מופיעה ראשונה ברשימה.
שלב 2: מספקים נתונים של אשכול
מומלץ להריץ את משימת פרסום התוכן ברקע (לדוגמה, באמצעות WorkManager) ולתזמן אותה על בסיס קבוע או על בסיס אירוע (לדוגמה, בכל פעם שהמשתמש פותח את האפליקציה או כשהמשתמש מוסיף פריט לעגלת הקניות).
AppEngageTravelClient
אחראי לפרסום אשכולות.
יש ממשקי API שמאפשרים לפרסם אשכולות בלקוח:
isServiceAvailable
publishRecommendationClusters
publishFeaturedCluster
publishReservationCluster
publishContinueSearchCluster
publishUserAccountManagementRequest
updatePublishStatus
deleteRecommendationsClusters
deleteFeaturedCluster
deleteReservationCluster
deleteContinueSearchCluster
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
משותף המפתחים יוסרו. - הנתונים מהבקשה מנותחים ומאוחסנים ב-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
משותף המפתחים יוסרו. - הנתונים מהבקשה מנותחים ונשמרים באוסף המאמרים המומלצים המעודכן.
במקרה של שגיאה, הבקשה כולה נדחית והמצב הקיים נשמר.
publishReservationCluster
משתמשים ב-API הזה כדי לפרסם אובייקט ReservationCluster
.
Kotlin
client.publishReservationCluster(
PublishReservationClusterRequest.Builder()
.setReservationCluster(
ReservationCluster.Builder()
.addLodgingReservationEntity(lodgingReservationEntity)
.addVehicleRentalReservationEntity(vehicleRentalReservationEntity)
.addTransportationReservationEntity(transportationReservationEntity)
.addEventReservationEntity(eventReservationEntity)
.addRestaurantReservationEntity(restaurantReservationEntity)
.build())
.build())
Java
client.publishReservationCluster(
new PublishReservationClusterRequest.Builder()
.setReservationCluster(
new ReservationCluster.Builder()
.addLodgingReservationEntity(lodgingReservationEntity)
.addVehicleRentalReservationEntity(vehicleRentalReservationEntity)
.addTransportationReservationEntity(transportationReservationEntity)
.addEventReservationEntity(eventReservationEntity)
.addRestaurantReservationEntity(restaurantReservationEntity)
.build())
.build());
כשהשירות מקבל את הבקשה, הפעולות הבאות מתבצעות במסגרת עסקה אחת:
- הנתונים הקיימים של
ReservationCluster
משותף המפתחים יוסרו. - הנתונים מהבקשה מנותחים ונשמרים ב-ReservationCluster המעודכן.
במקרה של שגיאה, הבקשה כולה נדחית והמצב הקיים נשמר.
publishContinueSearchCluster
ה-API הזה משמש לפרסום רשימה של אובייקטים מסוג ContinueSearchCluster
.
Kotlin
client.publishContinueSearchCluster(
PublishContinueSearchClusterRequest.Builder()
.setContinueSearchCluster(
ContinueSearchCluster.Builder()
.addPointOfInterestEntity(entity1)
.addPointOfInterestEntity(entity2)
.build())
.build())
Java
client.publishContinueSearchCluster(
new PublishContinueSearchClusterRequest.Builder()
.setContinueSearchCluster(
new ContinueSearchCluster.Builder()
.addPointOfInterestEntity(entity1)
.addPointOfInterestEntity(entity2)
.build())
.build());
כשהשירות מקבל את הבקשה, הפעולות הבאות מתבצעות במסגרת עסקה אחת:
- הנתונים הקיימים של
ContinueSearchCluster
משותף המפתחים יוסרו. - הנתונים מהבקשה מנותחים ומאוחסנים באשכול המעודכן של 'המשך החיפוש'.
במקרה של שגיאה, הבקשה כולה נדחית והמצב הקיים נשמר.
publishUserAccountManagementRequest
ה-API הזה משמש לפרסום כרטיס כניסה . פעולת הכניסה מפנה את המשתמשים לדף הכניסה של האפליקציה כדי שהאפליקציה תוכל לפרסם תוכן (או לספק תוכן מותאם אישית יותר)
המטא-נתונים הבאים הם חלק מכרטיס הכניסה –
מאפיין | דרישה | תיאור |
---|---|---|
URI של הפעולה | חובה | קישור עומק לפעולה (כלומר, מעבר לדף הכניסה לאפליקציה) |
תמונה | אופציונלי – אם לא מספקים את השם, חובה לספק את הכותרת |
התמונה שמוצגת בכרטיס תמונות ביחס גובה-רוחב של 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();
כשהשירות מקבל את הבקשה, הוא מסיר את הנתונים הקיימים מהאשכול המומלץ. במקרה של שגיאה, הבקשה כולה נדחית והמצב הקיים נשמר.
deleteReservationCluster
ממשק ה-API הזה משמש למחיקת התוכן של Reservation Cluster.
Kotlin
client.deleteReservationCluster()
Java
client.deleteReservationCluster();
כשהשירות מקבל את הבקשה, הוא מסיר את הנתונים הקיימים מ-Reservation Cluster. במקרה של שגיאה, הבקשה כולה נדחית והמצב הקיים נשמר.
deleteUserManagementCluster
ממשק ה-API הזה משמש למחיקת התוכן של UserAccountManagement Cluster.
Kotlin
client.deleteUserManagementCluster()
Java
client.deleteUserManagementCluster();
כשהשירות מקבל את הבקשה, הוא מסיר את הנתונים הקיימים מהאשכול UserAccountManagement. במקרה של שגיאה, הבקשה כולה נדחית והמצב הקיים נשמר.
deleteContinueSearchCluster
ממשק ה-API הזה משמש למחיקת התוכן של Continue Search Cluster.
Kotlin
client.deleteContinueSearchCluster()
Java
client.deleteContinueSearchCluster();
כשהשירות מקבל את הבקשה, הוא מסיר את הנתונים הקיימים מ-Continue Search Cluster. במקרה של שגיאה, הבקשה כולה נדחית והמצב הקיים נשמר.
deleteClusters
ממשק ה-API הזה משמש למחיקת התוכן של סוג מסוים של אשכול.
Kotlin
client.deleteClusters(
DeleteClustersRequest.Builder()
.addClusterType(ClusterType.TYPE_RESERVATION)
.addClusterType(ClusterType.TYPE_FEATURED)
.addClusterType(ClusterType.TYPE_RECOMMENDATION)
.addClusterType(ClusterType.TYPE_CONTINUE_SEARCH)
.build())
Java
client.deleteClusters(
new DeleteClustersRequest.Builder()
.addClusterType(ClusterType.TYPE_RESERVATION)
.addClusterType(ClusterType.TYPE_FEATURED)
.addClusterType(ClusterType.TYPE_RECOMMENDATION)
.addClusterType(ClusterType.TYPE_CONTINUE_SEARCH)
.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
עם הסיבה שכלולה כקוד שגיאה.
קוד שגיאה | שם השגיאה | הערה |
---|---|---|
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 continue search cluster publish when PUBLISH_CONTINUE_SEARCH
// broadcast is received
// Trigger reservation cluster publish when PUBLISH_RESERVATION broadcast is
// received
}
fun registerBroadcastReceivers(context: Context){
var context = context
context = context.applicationContext
// Register Recommendation Cluster Publish Intent
context.registerReceiver(AppEngageBroadcastReceiver(),
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(AppEngageBroadcastReceiver(),
IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_FEATURED),
com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
/*scheduler=*/null)
// Register Continue Search Cluster Publish Intent
context.registerReceiver(AppEngageBroadcastReceiver(),
IntentFilter(com.google.android.engage.travel.service.Intents.ACTION_PUBLISH_CONTINUE_SEARCH),
com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
/*scheduler=*/null)
// Register Reservation Cluster Publish Intent
context.registerReceiver(AppEngageBroadcastReceiver(),
IntentFilter(com.google.android.engage.travel.service.Intents.ACTION_PUBLISH_RESERVATION),
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 continue search cluster publish when PUBLISH_CONTINUE_SEARCH
// broadcast is received
// Trigger reservation cluster publish when PUBLISH_RESERVATION 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 Continue Search Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
new IntentFilter(com.google.android.engage.travel.service.Intents.ACTION_PUBLISH_CONTINUE_SEARCH),
com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
/*scheduler=*/null);
// Register Reservation Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
new IntentFilter(com.google.android.engage.travel.service.Intents.ACTION_PUBLISH_RESERVATION),
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.travel.PUBLISH_CONTINUE_SEARCH" />
</intent-filter>
<intent-filter>
<action android:name="com.google.android.engage.action.travel.PUBLISH_RESERVATION" />
</intent-filter>
</receiver>
</application>
השירות שולח את ה-Intents הבאים:
com.google.android.engage.action.PUBLISH_RECOMMENDATION
מומלץ להתחיל שיחהpublishRecommendationClusters
כשמקבלים את הכוונה הזו.com.google.android.engage.action.PUBLISH_FEATURED
מומלץ להתחיל שיחה ב-publishFeaturedCluster
כשמתקבלת הכוונה הזו.com.google.android.engage.action.travel.PUBLISH_CONTINUE_SEARCH
מומלץ להתחיל שיחתpublishContinueSearchCluster
כשמקבלים את הכוונה הזו.com.google.android.engage.action.travel.PUBLISH_RESERVATION
מומלץ להתחיל שיחתpublishReservationCluster
כשמתקבלת הכוונה הזו.
תהליך עבודה של שילוב
מדריך מפורט לאימות השילוב אחרי שהוא הושלם זמין במאמר בנושא תהליך העבודה של שילוב Engage למפתחים.
שאלות נפוצות
איש/אשת הקשר
אם יש לכם שאלות במהלך תהליך השילוב, אתם יכולים לפנות לכתובת engage-developers@google.com.
השלבים הבאים
אחרי שמסיימים את השילוב, השלבים הבאים הם:
- שולחים אימייל לכתובת engage-developers@google.com ומצרפים את קובץ ה-APK המשולב שמוכן לבדיקה על ידי Google.
- Google מבצעת אימות ובדיקה פנימית כדי לוודא שהשילוב פועל כמו שצריך. אם צריך לבצע שינויים, Google תיצור איתכם קשר ותספק את כל הפרטים הנדרשים.
- בסיום הבדיקה, אם לא נדרשים שינויים, Google תיצור איתכם קשר כדי להודיע לכם שאפשר להתחיל לפרסם את קובץ ה-APK המעודכן והמשולב בחנות Play.
- אחרי ש-Google תאשר שקובץ ה-APK המעודכן פורסם בחנות Play, יכול להיות שקטעי ההמלצות, התוצאות הנבחרות, ההזמנות והמשך החיפוש יפורסמו ויוצגו למשתמשים.