Google uses AI technology to translate content into your preferred language. AI translations can contain errors.

מעורבות ב-SDK לנסיעות: הוראות לשילוב טכני של צד שלישי

כדי להגביר את רמת העניין באפליקציה, כדאי להגיע למשתמשים במקומות שבהם הם נמצאים. אפשר לשלב את Engage SDK כדי להציג המלצות מותאמות אישית ותוכן המשך ישירות למשתמשים בכמה פלטפורמות במכשיר, כמו אוספים, חבילת הבידור וחנות Play. השילוב מוסיף פחות מ-50KB (לאחר דחיסה) לקובץ ה-APK הממוצע, וברוב האפליקציות הוא דורש כשבוע של עבודת פיתוח. מידע נוסף זמין באתר העסקי שלנו.

המדריך הזה כולל הוראות לשותפים מפתחים להצגת תוכן של נסיעות ואירועים בפלטפורמות של Engage.

פרטי השילוב

הסברים על המונחים

השילוב הזה כולל את סוגי האשכולות הבאים: המלצה, מומלץ, הזמנה והמשך החיפוש.

המלצות מקובצות לפי נושאים ומציגות הצעות מותאמות אישית לנסיעות ולאירועים ממפתחים שותפים. ההמלצות האלה יכולות להיות מותאמות אישית למשתמש או כלליות (למשל, פריטים פופולריים). הם משמשים להצגת המלצות למאמרים, לאירועים, למקומות לינה או למקומות מעניינים.
- אוסף ההמלצות יכול לכלול ArticleEntity, EventEntity,‏ LodgingEntity,‏ PointOfInterestEntity או StoreEntity כרטיסי מוצר, אבל לא שילוב של סוגי ישויות שונים.
ההמלצות שלכם בנויות באופן הבא:
- אשכול המלצות: תצוגת ממשק משתמש שמכילה קבוצה של המלצות מאותו שותף מפתח.
- ישות: אובייקט שמייצג פריט יחיד באשכול. השילוב הזה מציע כמה ישויות שיוצגו באמצעות אשכול ההמלצות:
  - ‫ArticleEntity: ArticleEntity מייצג המלצה לתוכן מבוסס-טקסט שקשור לנסיעות ולאירועים. אפשר להשתמש בו למאמרים, לפוסטים בבלוג, לתוכן שיווקי, לקטעי חדשות וכו'.
    
    איור 1: ממשק משתמש שבו מוצג ArticleEntity יחיד באוסף ההמלצות.
  - ‫EventEntity: EventEntity מייצג אירוע שיתרחש בעתיד. שעת ההתחלה של האירוע היא מידע חשוב שצריך להעביר למשתמשים.
    
    איור 2: ממשק משתמש שבו מוצג EventEntity יחיד באוסף Recommendations.
  - ‫LodgingEntity: LodgingEntity מייצג מקום לינה, כמו מלון, דירה או בית נופש להשכרה לטווח קצר או ארוך.
    
    איור 3: ממשק משתמש שבו מוצג LodgingEntity יחיד באוסף ההמלצות.
  - ‫StoreEntity: StoreEntity מייצג חנות, מסעדה, בית קפה וכו'. הוא מדגיש תוכן שבו מקום לאכילה או חנות הם פריט המידע החשוב שצריך להעביר למשתמשים.
    
    איור 4: ממשק משתמש שבו מוצג StoreEntity יחיד באשכול Recommendations.
  - ‫PointOfInterestEntity: PointOfInterestEntity מייצג מקום עניין כמו תחנת דלק, מקום לאירועים, פארק שעשועים, מוזיאון, אטרקציה תיירותית, מסלול טיולים וכו'. הוא מדגיש תוכן שבו המיקום הוא מידע קריטי שצריך להעביר למשתמשים. אין להשתמש בהן לפרסום מקומות לינה, חנויות או מסעדות.
    
    איור 5: ממשק משתמש שבו רואים PointOfInterestEntity יחיד באשכול Recommendations.
באוסף הזמנה מוצג תוכן שמשתמשים הביעו בו עניין לאחרונה, ממספר שותפי פיתוח, בקבוצה אחת בממשק המשתמש. כל שותף מפתח יוכל לשדר עד 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 בתוך קבוצת Reservation.
באשכול מומלצים מוצגת קבוצה של ישויות מכמה שותפי פיתוח בממשק משתמש אחד. יהיה אשכול אחד של המלצות נבחרות, שיוצג בחלק העליון של ממשק המשתמש עם מיקום עדיפות מעל כל אשכולות ההמלצות. כל שותף מפתח יוכל לשדר עד 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.6.0'
}

סיכום

העיצוב מבוסס על הטמעה של שירות מאוגד.

הנתונים שלקוח יכול לפרסם כפופים למגבלות הבאות עבור סוגים שונים של אשכולות:

סוג האשכול	מגבלות על אשכולות	מגבלות מינימליות על ישויות באשכול	מגבלות מקסימליות של ישויות באשכול
אשכולות של המלצות	עד 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 (אופציונלי) – הגדרת חלון זמן להצגת תוכן בפלטפורמה
חותמת זמן של התחלה	אופציונלי	חותמת הזמן של התקופה שאחריה התוכן צריך להיות מוצג במשטח. אם לא מוגדרת מדיניות, התוכן עומד בדרישות להצגה בפלטפורמה.	חותמת זמן של תקופת זמן המערכת באלפיות השנייה
חותמת זמן של סיום	אופציונלי	חותמת הזמן של העידן שאחריה התוכן לא מוצג יותר בפלטפורמה. אם לא מוגדרת מדיניות, התוכן עומד בדרישות להצגה בפלטפורמה.	חותמת זמן של תקופת זמן המערכת באלפיות השנייה

`ArticleEntity`

מאפיין	דרישה	תיאור	פורמט
‫URI של הפעולה	חובה	קישור עומק לישות באפליקציה לבעלי מקצוע. הערה: אפשר להשתמש בקישורי עומק לשיוך (Attribution). אפשר לעיין בשאלות הנפוצות	URI
כותרת	חובה	השם של הישות.	טקסט חופשי גודל מומלץ של הטקסט: 50 תווים לכל היותר
תמונות פוסטר	אופציונלי	אם מספקים כמה תמונות, אנחנו מציגים רק תמונה אחת. יחס הגובה-רוחב המומלץ הוא 16:9 הערה: מומלץ מאוד להוסיף תמונה. אם מספקים תג, צריך לוודא שיש מרווח בטוח של 24 נקודות לשנייה בחלק העליון ובחלק התחתון של התמונה.	הנחיות זמינות במאמר בנושא מפרט לתמונות.
מקור – שם	אופציונלי	השם של המחבר, הארגון או הכתב	טקסט חופשי גודל מומלץ של הטקסט: פחות מ-25 תווים
מקור – תמונה	אופציונלי	תמונה של המקור, למשל המחבר, הארגון או הכתב	הנחיות זמינות במאמר בנושא מפרט לתמונות.
תיאור	אופציונלי	פסקה אחת של טקסט שמתארת את הישות. הערה: המשתמש יראה את התיאור או את רשימת הכותרות, אבל לא את שניהם.	טקסט חופשי גודל מומלץ של הטקסט: 180 תווים
רשימת כתוביות	אופציונלי	עד 3 כתוביות, כאשר כל כתובית היא שורה אחת של טקסט. הערה: המשתמש יראה את התיאור או את רשימת הכותרות, אבל לא את שניהם.	טקסט חופשי גודל הטקסט המומלץ לכל כתובית: עד 50 תווים
תגים	אופציונלי	כל תג יכול להיות טקסט חופשי (עד 15 תווים) או תמונה קטנה. טיפול מיוחד בחוויית המשתמש מעל תמונה או סרטון, למשל, כשכבת-על של תג על התמונה 'עדכון בזמן אמת' משך הקריאה של המאמר
תג – טקסט	אופציונלי	שם התג הערה: חובה להוסיף טקסט או תמונה לתג	טקסט חופשי גודל טקסט מומלץ: עד 15 תווים
תג – תמונה	אופציונלי	תמונה קטנה טיפול מיוחד בחוויית המשתמש, למשל כשכבת-על של תג על התמונה הממוזערת של התמונה או הסרטון. הערה: חובה להוסיף טקסט או תמונה לתג	הנחיות זמינות במאמר בנושא מפרט לתמונות.
מועד פרסום התוכן	אופציונלי	חותמת הזמן של התקופה (epoch) באלפיות השנייה שבה התוכן פורסם או עודכן באפליקציה.	חותמת זמן של תקופת זמן המערכת באלפיות השנייה
מועד האינטראקציה האחרונה	אופציונלי	חותמת הזמן של העידן באלפיות השנייה שבה הייתה למשתמש אינטראקציה עם הישות הזו בפעם האחרונה.	חותמת זמן של תקופת זמן המערכת באלפיות השנייה
אחוז ההתקדמות	אופציונלי	אחוז התוכן המלא שהמשתמש צרך עד היום.	ערך מסוג int בין 0 ל-100 כולל.
קטגוריות תוכן	אופציונלי	תתאר את הקטגוריה של התוכן בישות.	רשימת Enums אפשר לקבל הנחיות נוספות בקטע בנושא קטגוריית תוכן.
‫DisplayTimeWindow (אופציונלי) – הגדרת חלון זמן להצגת תוכן בפלטפורמה
חותמת זמן של התחלה	אופציונלי	חותמת הזמן של התקופה שאחריה התוכן צריך להיות מוצג במשטח. אם לא מוגדרת מדיניות, התוכן עומד בדרישות להצגה בפלטפורמה.	חותמת זמן של תקופת זמן המערכת באלפיות השנייה
חותמת זמן של סיום	אופציונלי	חותמת הזמן של העידן שאחריה התוכן לא מוצג יותר בפלטפורמה. אם לא מוגדרת מדיניות, התוכן עומד בדרישות להצגה בפלטפורמה.	חותמת זמן של תקופת זמן המערכת באלפיות השנייה

`EventEntity`

מאפיין	דרישה	תיאור	פורמט
‫URI של הפעולה	חובה	קישור עומק לישות באפליקציה לבעלי מקצוע. הערה: אפשר להשתמש בקישורי עומק לשיוך (Attribution). אפשר לעיין בשאלות הנפוצות	URI
כותרת	חובה	השם של הישות.	מחרוזת גודל מומלץ של הטקסט: 50 תווים לכל היותר
שעת התחלה מקומית – חותמת זמן	חובה	חותמת הזמן של תקופת ה-Epoch שבה האירוע צפוי להתחיל.	Joda-Time Instant
שעת התחלה מקומית – אזור זמן	חובה	אזור הזמן שבו האירוע צפוי להתחיל.	Joda-Time DateTimeZone הנחיות זמינות במאמר מפרטים של אזורי זמן.
מצב אירוע	חובה	שדה שמציין אם האירוע יהיה וירטואלי, פרונטלי או שניהם.	ערכים אפשריים: VIRTUAL,‏ IN_PERSON או HYBRID
תמונות פוסטר	חובה	אם מספקים כמה תמונות, אנחנו מציגים רק תמונה אחת. יחס הגובה-רוחב המומלץ הוא 16:9 הערה: מומלץ מאוד להוסיף תמונה. אם מספקים תג, צריך לוודא שיש מרווח בטוח של 24 נקודות לשנייה בחלק העליון ובחלק התחתון של התמונה.	הנחיות זמינות במאמר בנושא מפרט לתמונות.
מיקום – מדינה	חובה באופן מותנה	המדינה שבה מתקיים האירוע. הערה: חובה להשתמש בפרמטר הזה לאירועים מסוג IN_PERSON או HYBRID	טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים
מיקום – עיר	חובה באופן מותנה	העיר שבה מתקיים האירוע. הערה: חובה להשתמש בפרמטר הזה לאירועים מסוג IN_PERSON או HYBRID	טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים
מיקום – כתובת להצגה	חובה באופן מותנה	הכתובת או שם המקום שבו האירוע יתקיים, שיוצגו למשתמש. הערה: חובה להשתמש בפרמטר הזה לאירועים מסוג IN_PERSON או HYBRID	טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים
מיקום – כתובת	אופציונלי	כתובת הרחוב (אם רלוונטי) של המיקום שבו מתקיים האירוע.	טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים
מיקום – מדינה	אופציונלי	המדינה או המחוז (אם רלוונטי) שבהם האירוע מתקיים.	טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים
מיקום – מיקוד	אופציונלי	המיקוד (אם רלוונטי) של המיקום שבו מתקיים האירוע.	טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים
מיקום – שכונה	אופציונלי	השכונה (אם רלוונטי) שבה מתקיים האירוע.	טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים
שעת סיום	אופציונלי	חותמת הזמן של מערכת Unix שבה האירוע צפוי להסתיים. הערה: הערך הזה יוצג באלפיות השנייה.	חותמת זמן של תקופת זמן המערכת באלפיות השנייה
תיאור	אופציונלי	פסקה אחת של טקסט שמתארת את הישות. הערה: המשתמש יראה את התיאור או את רשימת הכותרות, אבל לא את שניהם.	טקסט חופשי גודל מומלץ של הטקסט: 180 תווים
רשימת כתוביות	אופציונלי	עד 3 כתוביות, כאשר כל כתובית היא שורה אחת של טקסט. הערה: המשתמש יראה את התיאור או את רשימת הכותרות, אבל לא את שניהם.	טקסט חופשי גודל הטקסט המומלץ לכל כתובית: עד 50 תווים
תגים	אופציונלי	כל תג יכול להיות טקסט חופשי (עד 15 תווים) או תמונה קטנה.
תג – טקסט	אופציונלי	שם התג הערה: חובה להוסיף טקסט או תמונה לתג	טקסט חופשי גודל טקסט מומלץ: עד 15 תווים
תג – תמונה	אופציונלי	תמונה קטנה טיפול מיוחד בחוויית המשתמש, למשל כשכבת-על של תג על התמונה הממוזערת של התמונה או הסרטון. הערה: חובה להוסיף טקסט או תמונה לתג	הנחיות זמינות במאמר בנושא מפרט לתמונות.
מחיר – מחיר נוכחי	חובה באופן מותנה	המחיר הנוכחי של הכרטיס או הכרטיס העונתי לאירוע. חובה לציין את המאפיין הזה אם מציינים מחיר קודם מחוק.	טקסט חופשי
מחיר – StrikethroughPrice	אופציונלי	המחיר המקורי של הכרטיס לאירוע.	טקסט חופשי
נכס יתרונות מרכזיים של מחיר	אופציונלי	הצגת מבצע, אירוע או הנחה לחברי מועדון, אם יש כאלה.	טקסט חופשי גודל טקסט מומלץ: פחות מ-45 תווים (אם הטקסט ארוך מדי יכול להיות שיוצגו שלוש נקודות)
קטגוריות תוכן	אופציונלי	תתאר את הקטגוריה של התוכן בישות.	רשימה של טיפוסים בני מנייה שעומדים בדרישות ‫TYPE_MOVIES_AND_TV_SHOWS (דוגמה – קולנוע) TYPE_DIGITAL_GAMES (דוגמה – ספורט אלקטרוני) ‫TYPE_MUSIC (דוגמה – קונצרט) ‫TYPE_TRAVEL_AND_LOCAL (לדוגמה – סיור, פסטיבל) TYPE_HEALTH_AND_FITENESS (דוגמה – שיעור יוגה) TYPE_EDUCATION (דוגמה – כיתה) ‫TYPE_SPORTS (דוגמה – משחק פוטבול) TYPE_DATING (דוגמה – מפגש) אפשר לקבל הנחיות נוספות בקטע בנושא קטגוריית תוכן.
‫DisplayTimeWindow (אופציונלי) – הגדרת חלון זמן להצגת תוכן בפלטפורמה
חותמת זמן של התחלה	אופציונלי	חותמת הזמן של התקופה שאחריה התוכן צריך להיות מוצג במשטח. אם לא מוגדרת מדיניות, התוכן עומד בדרישות להצגה בפלטפורמה.	חותמת זמן של תקופת זמן המערכת באלפיות השנייה
חותמת זמן של סיום	אופציונלי	חותמת הזמן של העידן שאחריה התוכן לא מוצג יותר בפלטפורמה. אם לא מוגדרת מדיניות, התוכן עומד בדרישות להצגה בפלטפורמה.	חותמת זמן של תקופת זמן המערכת באלפיות השנייה

`LodgingEntity`

מאפיין	דרישה	תיאור	פורמט
‫URI של הפעולה	חובה	קישור עומק לישות באפליקציה לבעלי מקצוע. הערה: אפשר להשתמש בקישורי עומק לשיוך (Attribution). אפשר לעיין בשאלות הנפוצות	URI
כותרת	חובה	השם של הישות.	מחרוזת גודל מומלץ של הטקסט: 50 תווים לכל היותר
תמונות פוסטר	חובה	אם מספקים כמה תמונות, אנחנו מציגים רק תמונה אחת. יחס הגובה-רוחב המומלץ הוא 16:9 הערה: אם מספקים תג, צריך לוודא שיש שטח בטוח של 24 נקודות dps בחלק העליון והתחתון של התמונה.	הנחיות זמינות במאמר בנושא מפרט לתמונות.
מיקום – מדינה	חובה	המדינה שבה מתבצעת השהייה.	טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים
מיקום – עיר	חובה	העיר שבה מתבצעת השהייה.	טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים
מיקום – כתובת להצגה	חובה	הכתובת שתוצג למשתמש. ברוב תרחישי השימוש, מומלץ לכלול את שם העיר ואולי גם את שם המדינה. אפשר לכלול רק את כתובת הרחוב או השכונה אם המשתמש נמצא בקרבת המיקום, אם המשתמש מכיר את המיקום או אם העיר כלולה בכותרת של האשכול. אם אתם כוללים את הכתובת, עליכם לספק כתובת תמציתית, ולהשתמש בקיצורים איפה שאפשר (לדוגמה, 'רח' במקום 'רחוב').	טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים
מיקום – כתובת	אופציונלי	כתובת הרחוב (אם רלוונטי) של מקום האירוח.	טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים
מיקום – מדינה	אופציונלי	המדינה או המחוז (אם רלוונטי) שבהם נמצא מקום האירוח.	טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים
מיקום – מיקוד	אופציונלי	המיקוד (אם רלוונטי) של מקום הלינה.	טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים
מיקום – שכונה	אופציונלי	השכונה (אם רלוונטי) שבה נמצא מקום האירוח.	טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים
תגים	אופציונלי	כל תג יכול להיות טקסט חופשי (עד 15 תווים) או תמונה קטנה.
תג – טקסט	אופציונלי	שם התג הערה: חובה להוסיף טקסט או תמונה לתג	טקסט חופשי גודל טקסט מומלץ: עד 15 תווים
תג – תמונה	אופציונלי	תמונה קטנה טיפול מיוחד בחוויית המשתמש, למשל כשכבת-על של תג על התמונה הממוזערת של התמונה או הסרטון. הערה: חובה להוסיף טקסט או תמונה לתג	הנחיות זמינות במאמר בנושא מפרט לתמונות.
תיאור	אופציונלי	פסקה אחת של טקסט שמתארת את הישות. הערה: המשתמש יראה את התיאור או את רשימת הכותרות, אבל לא את שניהם.	טקסט חופשי גודל מומלץ של הטקסט: 180 תווים
רשימת כתוביות	אופציונלי	עד 3 כתוביות, כאשר כל כתובית היא שורה אחת של טקסט. הערה: המשתמש יראה את התיאור או את רשימת הכותרות, אבל לא את שניהם.	טקסט חופשי גודל הטקסט המומלץ לכל כתובית: עד 50 תווים
‫AvailabilityTimeWindow – שעת התחלה מקומית – חותמת זמן	אופציונלי	חותמת הזמן של תקופת ה-Epoch שבה מקום האירוח צפוי להיות פתוח או זמין.	Joda-Time Instant
‫AvailabilityTimeWindow – שעת התחלה מקומית – אזור זמן	אופציונלי	אזור הזמן שבו מקום האירוח צפוי להיות פתוח או זמין.	Joda-Time DateTimeZone הנחיות זמינות במאמר מפרטים של אזורי זמן.
‫AvailabilityTimeWindow - Localized End Time - Timestamp	אופציונלי	חותמת הזמן של תקופת ה-epoch שעד אליה מקום האירוח צפוי להיות פתוח או זמין.	Joda-Time Instant
‫AvailabilityTimeWindow – שעת סיום מקומית – אזור זמן	אופציונלי	אזור הזמן שבו מקום האירוח צפוי להיות פתוח או זמין.	Joda-Time DateTimeZone הנחיות זמינות במאמר מפרטים של אזורי זמן.
דירוג – ערך מקסימלי	אופציונלי	הערך המקסימלי בסולם הדירוג. חובה לציין את המאפיין הזה אם מציינים גם את הערך הנוכחי של הדירוג.	מספר ‎ >= 0.0
דירוג – ערך נוכחי	אופציונלי	הערך הנוכחי של סולם הדירוג. חובה לציין את המאפיין הזה אם מציינים גם את הערך המקסימלי של הדירוג.	מספר ‎ >= 0.0
דירוג – ספירה	אופציונלי	מספר הדירוגים של מקום האירוח. הערה: צריך לספק את השדה הזה אם רוצים שהאפליקציה תשלוט באופן שבו השדה מוצג למשתמשים. צריך לציין את המחרוזת התמציתית שאפשר להציג למשתמש. לדוגמה, אם המספר הוא 1,000,000, כדאי להשתמש בקיצורים כמו 1M, כדי שהמספר לא ייחתך בגדלים קטנים יותר של מסכים.	מחרוזת
דירוג – ערך הספירה	אופציונלי	מספר הדירוגים של מקום האירוח. הערה: צריך לספק את השדה הזה אם לא רוצים לטפל בעצמכם בלוגיקה של קיצור התצוגה. אם מופיעים גם Count וגם Count Value, נשתמש ב-Count כדי להציג למשתמשים	ארוך
מחיר – מחיר נוכחי	חובה באופן מותנה	המחיר הנוכחי של מקום האירוח. חובה לציין את המאפיין הזה אם מציינים מחיר קודם מחוק.	טקסט חופשי
מחיר – StrikethroughPrice	אופציונלי	המחיר המקורי של מקום האירוח, שיוצג עם קו חוצה בממשק המשתמש.	טקסט חופשי
נכס יתרונות מרכזיים של מחיר	אופציונלי	הצגת מבצע, אירוע או הנחה לחברי מועדון, אם יש כאלה.	טקסט חופשי גודל טקסט מומלץ: פחות מ-45 תווים (אם הטקסט ארוך מדי יכול להיות שיוצגו שלוש נקודות)
‫DisplayTimeWindow (אופציונלי) – הגדרת חלון זמן להצגת תוכן בפלטפורמה
חותמת זמן של התחלה	אופציונלי	חותמת הזמן של התקופה שאחריה התוכן צריך להיות מוצג במשטח. אם לא מוגדרת מדיניות, התוכן עומד בדרישות להצגה בפלטפורמה.	חותמת זמן של תקופת זמן המערכת באלפיות השנייה
חותמת זמן של סיום	אופציונלי	חותמת הזמן של העידן שאחריה התוכן לא מוצג יותר בפלטפורמה. אם לא מוגדרת מדיניות, התוכן עומד בדרישות להצגה בפלטפורמה.	חותמת זמן של תקופת זמן המערכת באלפיות השנייה

`StoreEntity`

אובייקט StoreEntity מייצג חנות ספציפית ששותפי פיתוח רוצים לפרסם, כמו מקום פופולרי לאכול בו או מסעדה שרלוונטיים לחוויית הנסיעה של מישהו.

מאפיין	דרישה	תיאור	פורמט
תמונות פוסטר	חובה	צריך לספק לפחות תמונה אחת.	הנחיות זמינות במאמר בנושא מפרט לתמונות.
‫URI של הפעולה	חובה	קישור עומק לישות באפליקציה לבעלי מקצוע. הערה: אפשר להשתמש בקישורי עומק לשיוך (Attribution). אפשר לעיין בשאלות הנפוצות	URI
כותרת	אופציונלי	שם החנות.	טקסט חופשי גודל הטקסט המומלץ: פחות מ-45 תווים (אם הטקסט ארוך מדי, יכול להיות שיוצגו שלוש נקודות)
מיקום	אופציונלי	מיקום החנות.	טקסט חופשי גודל הטקסט המומלץ: פחות מ-45 תווים (אם הטקסט ארוך מדי, יכול להיות שיוצגו שלוש נקודות)
יתרונות מרכזיים	אופציונלי	הצגת מבצע, אירוע או עדכון של החנות, אם יש כאלה.	טקסט חופשי גודל הטקסט המומלץ: פחות מ-45 תווים (אם הטקסט ארוך מדי, יכול להיות שיוצגו שלוש נקודות)
האותיות הקטנות של ההסבר	אופציונלי	הטקסט של האותיות הקטנות של היתרון המרכזי.	טקסט חופשי גודל הטקסט המומלץ: פחות מ-45 תווים (אם הטקסט ארוך מדי, יכול להיות שיוצגו שלוש נקודות)
תיאור	אופציונלי	תיאור של החנות.	טקסט חופשי גודל הטקסט המומלץ: פחות מ-90 תווים (אם הטקסט ארוך מדי, יכול להיות שיוצגו שלוש נקודות)
קטגוריה	אופציונלי	קטגוריה של חנות. בהקשר של מקומות לאכול, יכול להיות שזה יהיה סוג המטבח, כמו 'צרפתי', 'אמריקאי חדש', 'ראמן', 'מסעדת יוקרה'.	טקסט חופשי גודל הטקסט המומלץ: פחות מ-45 תווים (אם הטקסט ארוך מדי, יכול להיות שיוצגו שלוש נקודות)
דירוג – ערך מקסימלי	אופציונלי	הערך המקסימלי בסולם הדירוג. חובה לציין את המאפיין הזה אם מציינים גם את הערך הנוכחי של הדירוג.	מספר ‎ >= 0.0
דירוג – ערך נוכחי	אופציונלי	הערך הנוכחי של סולם הדירוג. חובה לציין את המאפיין הזה אם מציינים גם את הערך המקסימלי של הדירוג.	מספר ‎ >= 0.0
דירוג – ספירה	אופציונלי	מספר הדירוגים של מקום האירוח. הערה: צריך לספק את השדה הזה אם רוצים שהאפליקציה תשלוט באופן שבו השדה מוצג למשתמשים. צריך לציין את המחרוזת התמציתית שאפשר להציג למשתמש. לדוגמה, אם המספר הוא 1,000,000, כדאי להשתמש בקיצורים כמו 1M, כדי שהמספר לא ייחתך בגדלים קטנים יותר של מסכים.	מחרוזת
דירוג – ערך הספירה	אופציונלי	מספר הדירוגים של מקום האירוח. הערה: צריך לספק את השדה הזה אם לא רוצים לטפל בעצמכם בלוגיקה של קיצור התצוגה. אם מופיעים גם Count וגם Count Value, נשתמש ב-Count כדי להציג למשתמשים	ארוך
‫DisplayTimeWindow (אופציונלי) – הגדרת חלון זמן להצגת תוכן בפלטפורמה
חותמת זמן של התחלה	אופציונלי	חותמת הזמן של התקופה שאחריה התוכן צריך להיות מוצג במשטח. אם לא מוגדרת מדיניות, התוכן עומד בדרישות להצגה בפלטפורמה.	חותמת זמן של תקופת זמן המערכת באלפיות השנייה
חותמת זמן של סיום	אופציונלי	חותמת הזמן של העידן שאחריה התוכן לא מוצג יותר בפלטפורמה. אם לא מוגדרת מדיניות, התוכן עומד בדרישות להצגה בפלטפורמה.	חותמת זמן של תקופת זמן המערכת באלפיות השנייה

`PointOfInterestEntity`

מאפיין	דרישה	תיאור	פורמט
‫URI של הפעולה	חובה	קישור עומק לישות באפליקציה לבעלי מקצוע. הערה: אפשר להשתמש בקישורי עומק לשיוך (Attribution). אפשר לעיין בשאלות הנפוצות	URI
כותרת	חובה	השם של הישות.	מחרוזת גודל מומלץ של הטקסט: 50 תווים לכל היותר
תמונות פוסטר	חובה באופן מותנה	אם מספקים כמה תמונות, אנחנו מציגים רק תמונה אחת. יחס הגובה-רוחב המומלץ הוא 16:9 הערה: חובה להוסיף תמונה אם הישות היא חלק מקבוצת המלצות. אם מספקים תג, צריך לוודא שיש מרווח בטוח של 24 נקודות dps בחלק העליון ובחלק התחתון של התמונה	הנחיות זמינות במאמר בנושא מפרט לתמונות.
מועד האינטראקציה האחרונה	חובה באופן מותנה	חותמת הזמן של התקופה שבה הייתה למשתמש אינטראקציה עם הישות הזו בפעם האחרונה. הערה: השדה הזה הוא חובה אם הישות היא חלק מאשכול של המשך חיפוש.	Joda-Time Instant
מיקום – מדינה	חובה באופן מותנה	המדינה שבה מתרחשת נקודת העניין. הערה: השדה הזה הוא חובה אם הישות היא חלק מאשכול המלצות.	טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים
מיקום – עיר	חובה באופן מותנה	העיר שבה מתרחשת נקודת העניין. הערה: השדה הזה הוא חובה אם הישות היא חלק מאשכול המלצות.	טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים
מיקום – כתובת להצגה	חובה באופן מותנה	הכתובת שתוצג למשתמש. צריך לספק כתובת תמציתית, ולהשתמש בקיצורים איפה שאפשר (למשל, 'St' במקום 'Street',‏ 'Ave' במקום 'Avenue'). יכול להיות שהמחרוזת הזו תיחתך, בהתאם למכשיר ולהגדרות של המשתמש. כדי לזהות את העיר בקלות, כדאי לכלול את השם שלה. הערה: השדה הזה הוא חובה אם הישות היא חלק מאשכול המלצות.	טקסט חופשי גודל מומלץ של הטקסט: עד 35 תווים
מיקום – כתובת	אופציונלי	הכתובת (אם רלוונטי) של נקודת העניין.	טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים
מיקום – מדינה	אופציונלי	המדינה או המחוז (אם רלוונטי) שבהם נמצאת נקודת העניין.	טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים
מיקום – מיקוד	אופציונלי	המיקוד (אם רלוונטי) של נקודת העניין.	טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים
מיקום – שכונה	אופציונלי	השכונה (אם רלוונטי) של נקודת העניין.	טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים
‫AvailabilityTimeWindow – שעת התחלה מקומית – חותמת זמן	אופציונלי	חותמת הזמן של התקופה שבה המקום המעניין צפוי להיות פתוח או זמין.	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 כדי להציג למשתמשים	ארוך
מחיר – מחיר נוכחי	חובה באופן מותנה	המחיר הנוכחי של הכרטיסים או של כרטיס הכניסה לנקודת העניין. חובה לציין את המאפיין הזה אם מציינים מחיר קודם מחוק.	טקסט חופשי
מחיר – StrikethroughPrice	אופציונלי	המחיר המקורי של הכרטיסים או של כרטיס הכניסה לנקודת העניין.	טקסט חופשי
נכס יתרונות מרכזיים של מחיר	אופציונלי	הצגת מבצע, אירוע או הנחה לחברי מועדון, אם יש כאלה.	טקסט חופשי גודל טקסט מומלץ: פחות מ-45 תווים (אם הטקסט ארוך מדי, יכול להיות שיוצגו שלוש נקודות)
קטגוריות תוכן	אופציונלי	תתאר את הקטגוריה של התוכן בישות.	רשימה של טיפוסים בני מנייה שעומדים בדרישות TYPE_TRAVEL_AND_LOCAL ‫TYPE_MOVIES_AND_TV_SHOWS (דוגמה – קולנוע) TYPE_MEDICAL (דוגמה – בית חולים) TYPE_EDUCATION (דוגמה – בית ספר) TYPE_SPORTS (דוגמה – אצטדיון) אפשר לקבל הנחיות נוספות בקטע בנושא קטגוריית תוכן.
‫DisplayTimeWindow (אופציונלי) – הגדרת חלון זמן להצגת תוכן בפלטפורמה
חותמת זמן של התחלה	אופציונלי	חותמת הזמן של התקופה שאחריה התוכן צריך להיות מוצג במשטח. אם לא מוגדרת מדיניות, התוכן עומד בדרישות להצגה בפלטפורמה.	חותמת זמן של תקופת זמן המערכת באלפיות השנייה
חותמת זמן של סיום	אופציונלי	חותמת הזמן של העידן שאחריה התוכן לא מוצג יותר בפלטפורמה. אם לא מוגדרת מדיניות, התוכן עומד בדרישות להצגה בפלטפורמה.	חותמת זמן של תקופת זמן המערכת באלפיות השנייה

`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 (אופציונלי) – הגדרת חלון זמן להצגת תוכן בפלטפורמה
חותמת זמן של התחלה	אופציונלי	חותמת הזמן של התקופה שאחריה התוכן צריך להיות מוצג במשטח. אם לא מוגדרת מדיניות, התוכן עומד בדרישות להצגה בפלטפורמה.	חותמת זמן של תקופת זמן המערכת באלפיות השנייה
חותמת זמן של סיום	אופציונלי	חותמת הזמן של העידן שאחריה התוכן לא מוצג יותר בפלטפורמה. אם לא מוגדרת מדיניות, התוכן עומד בדרישות להצגה בפלטפורמה.	חותמת זמן של תקופת זמן המערכת באלפיות השנייה

`EventReservationEntity`

מאפיין	דרישה	תיאור	פורמט
‫URI של הפעולה	חובה	קישור עומק לישות באפליקציה לבעלי מקצוע. הערה: אפשר להשתמש בקישורי עומק לשיוך (Attribution). אפשר לעיין בשאלות הנפוצות	URI
כותרת	חובה	השם של הישות.	מחרוזת גודל מומלץ של הטקסט: 50 תווים לכל היותר
שעת התחלה מקומית – חותמת זמן	חובה	חותמת הזמן של תקופת ה-Epoch שבה האירוע צפוי להתחיל.	Joda-Time Instant
שעת התחלה מקומית – אזור זמן	חובה	אזור הזמן שבו האירוע צפוי להתחיל.	Joda-Time DateTimeZone הנחיות זמינות במאמר מפרטים של אזורי זמן.
מצב אירוע	חובה	שדה שמציין אם האירוע יהיה וירטואלי, פרונטלי או שניהם.	ערכים אפשריים: 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 תווים
תג – תמונה	אופציונלי	תמונה קטנה טיפול מיוחד בחוויית המשתמש, למשל כשכבת-על של תג על התמונה הממוזערת של התמונה או הסרטון. הערה: חובה להוסיף טקסט או תמונה לתג	הנחיות זמינות במאמר בנושא מפרט לתמונות.
מזהה הזמנה	אופציונלי	מזהה ההזמנה של ההזמנה לאירוע.	טקסט חופשי
מחיר – מחיר נוכחי	חובה באופן מותנה	המחיר הנוכחי של הכרטיס או הכרטיס העונתי לאירוע. חובה לציין את המאפיין הזה אם מציינים מחיר קודם מחוק.	טקסט חופשי
מחיר – StrikethroughPrice	אופציונלי	המחיר המקורי של הכרטיס לאירוע.	טקסט חופשי
נכס יתרונות מרכזיים של מחיר	אופציונלי	הצגת מבצע, אירוע או הנחה לחברי מועדון, אם יש כאלה.	טקסט חופשי גודל טקסט מומלץ: פחות מ-45 תווים (אם הטקסט ארוך מדי יכול להיות שיוצגו שלוש נקודות)
דירוג – ערך מקסימלי	אופציונלי	הערך המקסימלי בסולם הדירוג. חובה לציין את המאפיין הזה אם מציינים גם את הערך הנוכחי של הדירוג.	מספר ‎ >= 0.0
דירוג – ערך נוכחי	אופציונלי	הערך הנוכחי של סולם הדירוג. חובה לציין את המאפיין הזה אם מציינים גם את הערך המקסימלי של הדירוג.	מספר ‎ >= 0.0
דירוג – ספירה	אופציונלי	מספר הדירוגים של האירוע. הערה: צריך לספק את השדה הזה אם רוצים שהאפליקציה תשלוט באופן שבו השדה מוצג למשתמשים. צריך לציין את המחרוזת התמציתית שאפשר להציג למשתמש. לדוגמה, אם המספר הוא 1,000,000, כדאי להשתמש בקיצורים כמו 1M, כדי שהמספר לא ייחתך בגדלים קטנים יותר של מסכים.	מחרוזת
דירוג – ערך הספירה	אופציונלי	מספר הדירוגים של האירוע. הערה: צריך לספק את השדה הזה אם לא רוצים לטפל בעצמכם בלוגיקה של קיצור התצוגה. אם מופיעים גם Count וגם Count Value, נשתמש ב-Count כדי להציג למשתמשים	ארוך
קטגוריות תוכן	אופציונלי	תתאר את הקטגוריה של התוכן בישות.	רשימה של טיפוסים בני מנייה שעומדים בדרישות ‫TYPE_MOVIES_AND_TV_SHOWS (דוגמה – קולנוע) TYPE_DIGITAL_GAMES (דוגמה – ספורט אלקטרוני) ‫TYPE_MUSIC (דוגמה – קונצרט) ‫TYPE_TRAVEL_AND_LOCAL (לדוגמה – סיור, פסטיבל) TYPE_HEALTH_AND_FITENESS (דוגמה – שיעור יוגה) TYPE_EDUCATION (דוגמה – כיתה) ‫TYPE_SPORTS (דוגמה – משחק פוטבול) TYPE_DATING (דוגמה – מפגש) אפשר לקבל הנחיות נוספות בקטע בנושא קטגוריית תוכן.
‫DisplayTimeWindow (אופציונלי) – הגדרת חלון זמן להצגת תוכן בפלטפורמה
חותמת זמן של התחלה	אופציונלי	חותמת הזמן של התקופה שאחריה התוכן צריך להיות מוצג במשטח. אם לא מוגדרת מדיניות, התוכן עומד בדרישות להצגה בפלטפורמה.	חותמת זמן של תקופת זמן המערכת באלפיות השנייה
חותמת זמן של סיום	אופציונלי	חותמת הזמן של העידן שאחריה התוכן לא מוצג יותר בפלטפורמה. אם לא מוגדרת מדיניות, התוכן עומד בדרישות להצגה בפלטפורמה.	חותמת זמן של תקופת זמן המערכת באלפיות השנייה

`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 תווים
מיקום – מדינה	אופציונלי	המדינה או המחוז (אם רלוונטי) שבהם נמצא מקום האירוח.	טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים
מיקום – מיקוד	אופציונלי	המיקוד (אם רלוונטי) של מקום הלינה.	טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים
מיקום – שכונה	אופציונלי	השכונה (אם רלוונטי) שבה נמצא מקום האירוח.	טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים
תמונות פוסטר	אופציונלי	אם מספקים כמה תמונות, אנחנו מציגים רק תמונה אחת. יחס הגובה-רוחב המומלץ הוא 16:9 הערה: אם מספקים תג, צריך לוודא שיש שטח בטוח של 24 נקודות לכל אינץ' (dps) בחלק העליון והתחתון של התמונה.	הנחיות זמינות במאמר בנושא מפרט לתמונות.
תיאור	אופציונלי	פסקה אחת של טקסט שמתארת את הישות. הערה: המשתמש יראה את התיאור או את רשימת הכותרות, אבל לא את שניהם.	טקסט חופשי גודל מומלץ של הטקסט: 180 תווים
רשימת כתוביות	אופציונלי	עד 3 כתוביות, כאשר כל כתובית היא שורה אחת של טקסט. הערה: המשתמש יראה את התיאור או את רשימת הכותרות, אבל לא את שניהם.	טקסט חופשי גודל הטקסט המומלץ לכל כתובית: עד 50 תווים
מזהה הזמנה	אופציונלי	מזהה ההזמנה של הזמנת מקום הלינה.	טקסט חופשי
דירוג – ערך מקסימלי	אופציונלי	הערך המקסימלי בסולם הדירוג. חובה לציין את המאפיין הזה אם מציינים גם את הערך הנוכחי של הדירוג.	מספר ‎ >= 0.0
דירוג – ערך נוכחי	אופציונלי	הערך הנוכחי של סולם הדירוג. חובה לציין את המאפיין הזה אם מציינים גם את הערך המקסימלי של הדירוג.	מספר ‎ >= 0.0
דירוג – ספירה	אופציונלי	מספר הדירוגים של מקום האירוח. הערה: צריך לספק את השדה הזה אם רוצים שהאפליקציה תשלוט באופן שבו השדה מוצג למשתמשים. צריך לציין את המחרוזת התמציתית שאפשר להציג למשתמש. לדוגמה, אם המספר הוא 1,000,000, כדאי להשתמש בקיצורים כמו 1M, כדי שהמספר לא ייחתך בגדלים קטנים יותר של מסכים.	מחרוזת
דירוג – ערך הספירה	אופציונלי	מספר הדירוגים של מקום האירוח. הערה: צריך לספק את השדה הזה אם לא רוצים לטפל בעצמכם בלוגיקה של קיצור התצוגה. אם מופיעים גם Count וגם Count Value, נשתמש ב-Count כדי להציג למשתמשים	ארוך
מחיר – מחיר נוכחי	חובה באופן מותנה	המחיר הנוכחי של מקום האירוח. חובה לציין את המאפיין הזה אם מציינים מחיר קודם מחוק.	טקסט חופשי
מחיר – StrikethroughPrice	אופציונלי	המחיר המקורי של מקום האירוח, שיוצג עם קו חוצה בממשק המשתמש.	טקסט חופשי
נכס יתרונות מרכזיים של מחיר	אופציונלי	הצגת מבצע, אירוע או הנחה לחברי מועדון, אם יש כאלה.	טקסט חופשי גודל טקסט מומלץ: פחות מ-45 תווים (אם הטקסט ארוך מדי יכול להיות שיוצגו שלוש נקודות)
‫DisplayTimeWindow (אופציונלי) – הגדרת חלון זמן להצגת תוכן בפלטפורמה
חותמת זמן של התחלה	אופציונלי	חותמת הזמן של התקופה שאחריה התוכן צריך להיות מוצג במשטח. אם לא מוגדרת מדיניות, התוכן עומד בדרישות להצגה בפלטפורמה.	חותמת זמן של תקופת זמן המערכת באלפיות השנייה
חותמת זמן של סיום	אופציונלי	חותמת הזמן של העידן שאחריה התוכן לא מוצג יותר בפלטפורמה. אם לא מוגדרת מדיניות, התוכן עומד בדרישות להצגה בפלטפורמה.	חותמת זמן של תקופת זמן המערכת באלפיות השנייה

`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 תווים
מיקום ההגעה – מדינה	אופציונלי	המדינה (State) או המחוז (אם רלוונטי) של מיקום ההגעה.	טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים
מיקום ההגעה – מיקוד	אופציונלי	המיקוד (אם רלוונטי) של מיקום ההגעה.	טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים
מיקום ההגעה – שכונה	אופציונלי	השכונה (אם רלוונטי) של מיקום ההגעה.	טקסט חופשי גודל מומלץ של הטקסט: עד 20 תווים
ספק שירות – שם	אופציונלי	השם של ספק השירות. הערה: חובה להוסיף טקסט או תמונה לספק השירות.	טקסט חופשי. לדוגמה, שם חברת התעופה
ספק שירות – תמונה	אופציונלי	הלוגו או התמונה של ספק השירות. הערה: חובה להוסיף טקסט או תמונה לספק השירות.	הנחיות זמינות במאמר בנושא מפרט לתמונות.
תמונות פוסטר	אופציונלי	אם מספקים כמה תמונות, אנחנו מציגים רק תמונה אחת. יחס הגובה-רוחב המומלץ הוא 16:9	הנחיות זמינות במאמר בנושא מפרט לתמונות.
תיאור	אופציונלי	פסקה אחת של טקסט שמתארת את הישות. הערה: המשתמש יראה את התיאור או את רשימת הכותרות, אבל לא את שניהם.	טקסט חופשי גודל מומלץ של הטקסט: 180 תווים
רשימת כתוביות	אופציונלי	עד 3 כתוביות, כאשר כל כתובית היא שורה אחת של טקסט. הערה: המשתמש יראה את התיאור או את רשימת הכותרות, אבל לא את שניהם.	טקסט חופשי גודל הטקסט המומלץ לכל כתובית: עד 50 תווים
מזהה הזמנה	אופציונלי	מזהה ההזמנה של הזמנת מקום באמצעי תחבורה.	טקסט חופשי
מחיר – מחיר נוכחי	חובה באופן מותנה	המחיר הנוכחי של ההזמנה. חובה לציין את המאפיין הזה אם מציינים מחיר קודם מחוק.	טקסט חופשי
מחיר – StrikethroughPrice	אופציונלי	המחיר המקורי של ההזמנה, שיוצג עם קו חוצה בממשק המשתמש.	טקסט חופשי
נכס יתרונות מרכזיים של מחיר	אופציונלי	הצגת מבצע, אירוע או הנחה לחברי מועדון, אם יש כאלה.	טקסט חופשי גודל טקסט מומלץ: פחות מ-45 תווים (אם הטקסט ארוך מדי יכול להיות שיוצגו שלוש נקודות)
‫DisplayTimeWindow (אופציונלי) – הגדרת חלון זמן להצגת תוכן בפלטפורמה
חותמת זמן של התחלה	אופציונלי	חותמת הזמן של התקופה שאחריה התוכן צריך להיות מוצג במשטח. אם לא מוגדרת מדיניות, התוכן עומד בדרישות להצגה בפלטפורמה.	חותמת זמן של תקופת זמן המערכת באלפיות השנייה
חותמת זמן של סיום	אופציונלי	חותמת הזמן של העידן שאחריה התוכן לא מוצג יותר בפלטפורמה. אם לא מוגדרת מדיניות, התוכן עומד בדרישות להצגה בפלטפורמה.	חותמת זמן של תקופת זמן המערכת באלפיות השנייה

`VehicleRentalReservationEntity`

מאפיין	דרישה	תיאור	פורמט
‫URI של הפעולה	חובה	קישור עומק לישות באפליקציה לבעלי מקצוע. הערה: אפשר להשתמש בקישורי עומק לשיוך (Attribution). אפשר לעיין בשאלות הנפוצות	URI
כותרת	חובה	השם של הישות.	טקסט חופשי. לדוגמה, "Avis Union Square SF" גודל מומלץ של הטקסט: 50 תווים לכל היותר
שעת האיסוף המקומית – חותמת זמן	חובה	חותמת הזמן של התקופה שמייצגת את שעת האיסוף של ההזמנה.	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 תווים
ספק שירות – שם	אופציונלי	השם של ספק השירות. הערה: חובה להוסיף טקסט או תמונה לספק השירות.	טקסט חופשי. לדוגמה, "Avis Car Rental"
ספק שירות – תמונה	אופציונלי	הלוגו או התמונה של ספק השירות. הערה: חובה להוסיף טקסט או תמונה לספק השירות.	הנחיות זמינות במאמר בנושא מפרט לתמונות.
תמונות פוסטר	אופציונלי	אם מספקים כמה תמונות, אנחנו מציגים רק תמונה אחת. יחס הגובה-רוחב המומלץ הוא 16:9	הנחיות זמינות במאמר בנושא מפרט לתמונות.
תיאור	אופציונלי	פסקה אחת של טקסט שמתארת את הישות. הערה: המשתמש יראה את התיאור או את רשימת הכותרות, אבל לא את שניהם.	טקסט חופשי גודל מומלץ של הטקסט: 180 תווים
רשימת כתוביות	אופציונלי	עד 3 כתוביות, כאשר כל כתובית היא שורה אחת של טקסט. הערה: המשתמש יראה את התיאור או את רשימת הכותרות, אבל לא את שניהם.	טקסט חופשי גודל הטקסט המומלץ לכל כתובית: עד 50 תווים
מזהה האישור	אופציונלי	מזהה האישור של הזמנת השכרת הרכב.	טקסט חופשי
מחיר – מחיר נוכחי	חובה באופן מותנה	המחיר הנוכחי של ההזמנה. חובה לציין את המאפיין הזה אם מציינים מחיר קודם מחוק.	טקסט חופשי
מחיר – StrikethroughPrice	אופציונלי	המחיר המקורי של ההזמנה, שיוצג עם קו חוצה בממשק המשתמש.	טקסט חופשי
נכס יתרונות מרכזיים של מחיר	אופציונלי	הצגת מבצע, אירוע או הנחה לחברי מועדון, אם יש כאלה.	טקסט חופשי גודל טקסט מומלץ: פחות מ-45 תווים (אם הטקסט ארוך מדי יכול להיות שיוצגו שלוש נקודות)
‫DisplayTimeWindow (אופציונלי) – הגדרת חלון זמן להצגת תוכן בפלטפורמה
חותמת זמן של התחלה	אופציונלי	חותמת הזמן של התקופה שאחריה התוכן צריך להיות מוצג במשטח. אם לא מוגדרת מדיניות, התוכן עומד בדרישות להצגה בפלטפורמה.	חותמת זמן של תקופת זמן המערכת באלפיות השנייה
חותמת זמן של סיום	אופציונלי	חותמת הזמן של העידן שאחריה התוכן לא מוצג יותר בפלטפורמה. אם לא מוגדרת מדיניות, התוכן עומד בדרישות להצגה בפלטפורמה.	חותמת זמן של תקופת זמן המערכת באלפיות השנייה

מפרט לתמונות

בטבלה הזו מפורטות הדרישות לגבי נכסי תמונות:

יחס גובה-רוחב	מספר פיקסלים מינימלי	מספר פיקסלים מומלץ
ריבוע (1x1) מועדף	300x300	1,200x1,200
תמונה לרוחב (1.91x1)	600x314	1,200x628
לאורך (4x5)	‫480x600	960x1200

יחס גובה-רוחב

מספר פיקסלים מינימלי

מספר פיקסלים מומלץ

ריבוע (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 הזה משמש כדי לבדוק אם השירות זמין לשילוב ואם אפשר להציג את התוכן במכשיר.

‫Engage SDK מגרסה 1.6.0 ואילך (מומלץ)

אתם יכולים לבדוק את זמינות השירות לכל סוג אשכול שאתם מתכוונים לפרסם. ‫isServiceAvailable API מקבל אובייקט בקשה, ServiceAvailabilityRequest, שמכיל את סוגי האשכולות שצריך לבדוק את זמינות השירות שלהם. בטבלה הבאה מפורטים ClusterTypeערכי ה-enum הנדרשים עבור ServiceAvailabilityRequest.

סוג האשכול	קבוע של סוג האשכול	ערך של מספר שלם
לא ידוע	`TYPE_UNKNOWN`	0
אשכול המלצות	`TYPE_RECOMMENDATION`	1
אשכול מוצג	`TYPE_FEATURED`	2
אשכול המשכיות	`TYPE_CONTINUATION`	3
אשכול לניהול משתמשים	`TYPE_ENGAGEMENT`	8
אשכול מינויים	`TYPE_SUBSCRIPTION`	12
המשך חיפוש באשכול	`TYPE_CONTINUE_SEARCH`	13
אשכול הזמנות	`TYPE_RESERVATION`	14

Kotlin

val request = ServiceAvailabilityRequest.Builder()
    .addIntendedClusterType(ClusterType.TYPE_CONTINUATION)
    .addIntendedClusterType(ClusterType.TYPE_RECOMMENDATION)
    .build()

client.isServiceAvailable(request).addOnCompleteListener { task ->
    if (task.isSuccessful) {
        val availabilityMap = task.result
        if (availabilityMap[ClusterType.TYPE_CONTINUATION] == true) {
            // Proceed with publishing continuation content
        }
        if (availabilityMap[ClusterType.TYPE_RECOMMENDATION] == true) {
            // Proceed with publishing recommendation content
        }
    } else {
        // The IPC call itself fails, proceed with error handling logic here,
        // such as retry.
    }
}

Java

ServiceAvailabilityRequest request =
    new ServiceAvailabilityRequest.Builder()
        .addIntendedClusterType(ClusterType.TYPE_CONTINUATION)
        .addIntendedClusterType(ClusterType.TYPE_RECOMMENDATION)
        .build();

client.isServiceAvailable(request).addOnCompleteListener(task -> {
    if (task.isSuccessful()) {
        Map<Integer, Boolean> availabilityMap = task.getResult();
        if (Boolean.TRUE.equals(availabilityMap.get(ClusterType.TYPE_CONTINUATION))) {
            // Proceed with publishing continuation content
        }
        if (Boolean.TRUE.equals(availabilityMap.get(ClusterType.TYPE_RECOMMENDATION))) {
            // Proceed with publishing recommendation content
        }
    } else {
        // The IPC call itself fails, proceed with error handling logic here,
        // such as retry.
    }
});

תכונת זמינות שירות מותנית

אפליקציות משולבות מסוימות מבקשות הגדרה מיוחדת שמאפשרת להפעיל ולהשבית את שירות Engage לסירוגין כדי להפחית את עלות ההצגה שלהן. אסטרטגיית ניתוח התוכן הזו, שמתבצעת לסירוגין, אפשרית אבל היא משפיעה לרעה על המשתמש ועל המוצר – תוכן מיושן (stale) לא יוצג, ובחלק מהפלטפורמות לא יוצגו מודעות בכלל.

החל מגרסה 1.6.0, ה-Engage SDK מאפשר לבדוק את הזמינות של סוגים ספציפיים של אשכולות. כך יש יותר גמישות, ואם אפליקציה מסוימת מאמצת את אסטרטגיית התוכן לסירוגין, חלק מסוגי האוספים יכולים לפעול לפי האסטרטגיה הזו, בעוד שסוגים אחרים של אוספים תמיד מופעלים (כלומר, אוספי המשכים).

אם לא רוצים להפעיל את שירות Engage באופן רציף בכל המכשירים הנתמכים מסיבה כלשהי, והשירות מוגדר להפעלה לסירוגין עבור קבוצת מכשירים כלשהי, כל הפרסומים של אשכול ההמשכיות (למשל, הזמנה והמשך חיפוש) ימשיכו להיות מופעלים בהגדרת ברירת המחדל, ושאר סוגי האשכולות יופעלו ויכובו לסירוגין. אם ההגדרה הזו חלה עליכם אבל היא לא מתאימה לצרכים שלכם, אתם יכולים לפנות לכתובת engage-developers@google.com.

לגרסאות SDK שקודמות לגרסה 1.6.0 (הוצאה משימוש)

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 של הפעולה	חובה	קישור עומק לפעולה (כלומר, מעבר לדף הכניסה לאפליקציה)
תמונה	אופציונלי – אם לא מספקים את הערך הזה, חובה לספק את הערך Title	התמונה שמוצגת בכרטיס תמונות עם יחס גובה-רוחב של 16:9 ורזולוציה של ‎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>

השירות שולח את הכוונה הבאה:

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 SDK

יצירת קשר

אם יש לכם שאלות במהלך תהליך האינטגרציה, אתם יכולים לפנות אל engage-developers@google.com.

השלבים הבאים

אחרי שמסיימים את השילוב, השלבים הבאים הם:

שולחים אימייל לכתובת engage-developers@google.com ומצרפים את קובץ ה-APK המשולב שמוכן לבדיקה על ידי Google.
‫Google מבצעת אימות ובדיקה פנימית כדי לוודא שהשילוב פועל כמו שצריך. אם יהיה צורך בשינויים, Google תיצור איתכם קשר ותספק את כל הפרטים הנדרשים.
בסיום הבדיקה, אם לא נדרשים שינויים, Google תיצור איתכם קשר כדי להודיע לכם שאתם יכולים להתחיל לפרסם את קובץ ה-APK המעודכן והמשולב בחנות Play.
אחרי ש-Google תאשר שקובץ ה-APK המעודכן פורסם בחנות Play, יכול להיות שקטעי המידע המלצה, הצגה, הזמנה והמשך החיפוש יפורסמו ויוצגו למשתמשים.

מעורבות ב-SDK לנסיעות: הוראות לשילוב טכני של צד שלישי קל לארגן דפים בעזרת אוספים אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.

פרטי השילוב

הסברים על המונחים

עבודה מקדימה

סיכום

שלב 1: הזנת נתוני הישות

GenericFeaturedEntity

ArticleEntity

EventEntity

LodgingEntity

StoreEntity

PointOfInterestEntity

RestaurantReservationEntity

EventReservationEntity

LodgingReservationEntity

TransportationReservationEntity

VehicleRentalReservationEntity

מפרט לתמונות

מפרטים של אזורי זמן

קטגוריית תוכן

שלב 2: ציון נתונים של אוסף ההמשכים

isServiceAvailable

‫Engage SDK מגרסה 1.6.0 ואילך (מומלץ)

Kotlin

Java

תכונת זמינות שירות מותנית

לגרסאות SDK שקודמות לגרסה 1.6.0 (הוצאה משימוש)

Kotlin

Java

publishRecommendationClusters

Kotlin

Java

publishFeaturedCluster

Kotlin

Java

publishReservationCluster

Kotlin

Java

publishContinueSearchCluster

Kotlin

Java

publishUserAccountManagementRequest

Kotlin

Java

updatePublishStatus

Kotlin

Java

deleteRecommendationClusters

Kotlin

Java

deleteFeaturedCluster

Kotlin

Java

deleteReservationCluster

Kotlin

Java

deleteUserManagementCluster

Kotlin

Java

deleteContinueSearchCluster

Kotlin

Java

deleteClusters

Kotlin

Java

טיפול בשגיאות

Kotlin

Java

שלב 3: טיפול ב-Intents של שידור

Kotlin

Java

תהליך עבודה של שילוב

שאלות נפוצות

יצירת קשר

השלבים הבאים

מעורבות ב-SDK לנסיעות: הוראות לשילוב טכני של צד שלישי

`GenericFeaturedEntity`

`ArticleEntity`

`EventEntity`

`LodgingEntity`

`StoreEntity`

`PointOfInterestEntity`

`RestaurantReservationEntity`

`EventReservationEntity`

`LodgingReservationEntity`

`TransportationReservationEntity`

`VehicleRentalReservationEntity`

`isServiceAvailable`

`publishRecommendationClusters`

`publishFeaturedCluster`

`publishReservationCluster`

`publishContinueSearchCluster`

`publishUserAccountManagementRequest`

`updatePublishStatus`

`deleteRecommendationClusters`

`deleteFeaturedCluster`

`deleteReservationCluster`

`deleteUserManagementCluster`

`deleteContinueSearchCluster`

`deleteClusters`