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

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

פרטי השילוב

טרמינולוגיה

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

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

    • אשכול המלצות יכול להיות מורכב מנכסי ArticleEntity,‏ EventEntity,‏ LodgingEntity,‏ PointOfInterestEntity או StoreEntity, אבל לא משילוב של סוגי ישויות שונים.

    ההמלצות מופיעות במבנה הבא:

    • אשכול המלצות: תצוגת ממשק משתמש שמכילה קבוצה של המלצות מאותו שותף פיתוח.

    • ישות: אובייקט שמייצג פריט יחיד באשכול. השילוב הזה מציע כמה ישויות שיוצגו באמצעות אשכול ההמלצות:

      • ArticleEntity: ArticleEntity מייצג המלצה לתוכן מבוסס-טקסט שקשור לנסיעות ולאירועים. אפשר להשתמש בו במאמרים, בפוסטים בבלוג, בתוכן שיווקי, בקטעי חדשות וכו'.

        איור 1: ממשק משתמש שבו מוצג אובייקט ArticleEntity יחיד בתוך אשכול ההמלצות.

      • EventEntity: רכיב EventEntity מייצג אירוע שיתרחש בעתיד. שעת ההתחלה של האירוע היא פרט קריטי שצריך להעביר למשתמשים.

        איור 2: ממשק משתמש שבו מוצג אובייקט EventEntity יחיד באשכול ההמלצות.

      • LodgingEntity: LodgingEntity מייצג מקום לינה, כמו מלון, דירה, בית נופש להשכרה לטווח קצר ולטווח ארוך.

        איור 3: ממשק משתמש שבו מוצג ישות Lodging אחת בתוך אשכול ההמלצות.

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

        איור 4: ממשק משתמש שבו מוצג אובייקט StoreEntity יחיד בתוך אשכול ההמלצות.

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

        איור 5: ממשק משתמש שבו מוצג אובייקט PointOfInterestEntity יחיד באשכול ההמלצות.

  • באשכול Reservation מוצג תוכן שהמשתמשים התעניינו בו לאחרונה מכמה שותפי פיתוח, בקבוצה אחת בממשק המשתמש. כל שותף מפתח יוכל לשדר עד 10 ישויות באשכול הזמנות.

    תוכן ההזמנה יכול להיות במבנה הבא:

    • RestaurantReservationEntity: הישות RestaurantReservationEntity מייצגת הזמנת מקום במסעדה או בבית קפה, ומאפשרת למשתמשים לעקוב אחרי הזמנות קיימות או עתידיות למסעדות.

      איור 6. ממשק משתמש שבו מוצג אובייקט RestaurantReservationEntity יחיד באשכול של הזמנות.

    • EventReservationEntity: ה-EventReservationEntity מייצג הזמנה לאירוע, ועוזר למשתמשים לעקוב אחרי הזמנות לאירועים קרובים או מתמשכים. האירועים יכולים לכלול, בין היתר, את האירועים הבאים:

      • אירועי ספורט, כמו הזמנה למשחק כדורגל
      • אירועי גיימינג, כמו הזמנה לאירועי eSports
      • אירועי בידור, כמו הזמנה לסרט בקולנוע, הופעה, הצגה בתיאטרון, חתימה על ספר
      • הזמנות לנסיעות או למקומות מעניינים, כמו סיורים מודרכים וכרטיסים למוזיאונים
      • הזמנות לאירועים חברתיים, סמינרים או כנסים
      • הזמנות של סשנים של הדרכה או לימוד
      איור 7. ממשק משתמש שבו מוצג אובייקט EventReservationEntity יחיד בתוך אשכול של הזמנות.

    • LodgingReservationEntity: LodgingEntityReservation מייצג הזמנה לינה בנסיעות, ומאפשר למשתמשים לעקוב אחרי הזמנות קיימות או עתידיות של מלונות או יחידות אירוח.

      איור 8. ממשק משתמש שבו מוצג אובייקט LodgingReservationEntity יחיד באשכול של הזמנות.

    • TransportationReservationEntity: ‏TransportationReservationEntity מייצג הזמנה לתחבורה בכל אמצעי, ומאפשר למשתמשים לעקוב אחרי הזמנות לטיסה, למעבורת, לרכבת, לאוטובוס, לנסיעה במונית שירות או לשייט קרובות או מתמשכות.

      איור 9. ממשק משתמש שבו מוצג אובייקט יחיד מסוג TransportationReservationEntity באשכול של הזמנות.

    • VehicleRentalReservationEntity: ה-Entity VehicleRentalReservationEntity מייצג הזמנה להשכרת רכב ומאפשר למשתמשים לעקוב אחרי הזמנות קיימות או עתידיות להשכרת רכב.

      איור 10. ממשק משתמש שבו מוצג אובייקט יחיד מסוג VehicleRentalReservationEntity באשכול של הזמנות.

  • באשכול מומלצים מוצגת מבחר ישויות מכמה שותפי פיתוח במקבץ אחד בממשק המשתמש. יהיה אשכול אחד של 'מומלצים', שיוצג בחלק העליון של ממשק המשתמש במיקום בעל עדיפות מעל כל אשכולות ההמלצות. כל שותף מפתח יוכל לשדר עד 10 ישויות באשכול 'מומלצים'.

    • GenericFeaturedEntity: הבדלים בין GenericFeaturedEntity לבין פריט המלצה: צריך להשתמש בפריט 'תכונה' לתוכן מוביל אחד של מפתחים, והוא צריך לייצג את התוכן החשוב ביותר שיהיה מעניין ורלוונטי למשתמשים.

      איור 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'
}

סיכום

התכנון מבוסס על הטמעה של שירות מחויב.

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

סוג האשכול מגבלות על אשכולות מגבלות מינימום על ישויות באשכול מגבלות מקסימליות של ישויות באשכול
אשכולות של המלצות 5 לכל היותר לפחות 5 עד 25 (ArticleEntity,‏ EventEntity,‏ LodgingEntity,‏ StoreEntity או PointOfInterestEntity)
אשכול של שמירת מקום 1 לכל היותר לפחות 1 עד 10 (RestaurantReservationEntity,‏ EventReservationEntity,‏ LodgingReservationEntity,‏ TransportationReservationEntity או VehicleRentalReservationEntity)
אשכול מומלץ 1 לכל היותר לפחות 1 עד 10 (GenericFeaturedEntity)
Continue Search Cluster 1 לכל היותר לפחות 1 עד 3 (PointOfInterestEntity)

שלב 1: מציינים את נתוני הישות

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

  1. GenericFeaturedEntity
  2. ArticleEntity
  3. EventEntity
  4. LodgingEntity
  5. StoreEntity
  6. PointOfInterestEntity
  7. RestaurantReservationEntity
  8. EventReservationEntity
  9. LodgingReservationEntity
  10. TransportationReservationEntity
  11. VehicleRentalReservationEntity

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

GenericFeaturedEntity

מאפיין דרישה תיאור פורמט
URI של פעולה חובה

קישור עומק לישות באפליקציית הספק.

הערה: אפשר להשתמש בקישורי עומק לצורך שיוך. אפשר לעיין בשאלות הנפוצות האלה

URI
תמונות של פוסטרים חובה

אם תספקו כמה תמונות, נציג רק תמונה אחת. יחס הגובה-רוחב המומלץ הוא 16:9

הערה: אם אתם מספקים תג, חשוב לוודא שיש מרווח בטוח של 24 דפים לדקה בחלק העליון ובחלק התחתון של התמונה.

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

טקסט חופשי

גודל טקסט מומלץ: 50 תווים
תיאור אופציונלי

פסקה אחת של טקסט לתיאור הישות.

הערה: המשתמש יראה רק את התיאור או את רשימת הכתוביות, ולא את שניהם.

טקסט חופשי

גודל טקסט מומלץ: 180 תווים
רשימת כתוביות אופציונלי

עד 3 כתוביות, כאשר כל כתוביות היא שורה אחת של טקסט.

הערה: המשתמש יראה רק את התיאור או את רשימת הכתוביות, ולא את שניהם.

טקסט חופשי

גודל הטקסט המומלץ לכל כתוביות: 50 תווים לכל היותר
תגים אופציונלי

כל תג יכול להיות טקסט חופשי (עד 15 תווים) או תמונה קטנה.

טיפול מיוחד בחוויית המשתמש מעל התמונה או הסרטון, לדוגמה, כשכבת-על של תג בתמונה

  • 'עדכון בזמן אמת'
  • משך הקריאה של המאמר
תג – טקסט אופציונלי

שם התג

הערה: חובה להוסיף טקסט או תמונה לתג.

טקסט חופשי

גודל טקסט מומלץ: עד 15 תווים
תג – תמונה אופציונלי

תמונה קטנה

טיפול מיוחד בחוויית המשתמש, למשל כשכבת-על של תג על התמונה הממוזערת או הסרטון.

הערה: חובה להוסיף טקסט או תמונה לתג.

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

רשימה של Enums

אפשר לעיין בהנחיות בקטע קטגוריית תוכן.

ArticleEntity

מאפיין דרישה תיאור פורמט
URI של פעולה חובה

קישור עומק לישות באפליקציית הספק.

הערה: אפשר להשתמש בקישורי עומק לצורך שיוך. אפשר לעיין בשאלות הנפוצות האלה

URI
כותרת חובה שם הישות.

טקסט חופשי

גודל טקסט מומלץ: 50 תווים לכל היותר
תמונות של פוסטרים אופציונלי

אם תספקו כמה תמונות, נציג רק תמונה אחת. יחס הגובה-רוחב המומלץ הוא 16:9

הערה: מומלץ מאוד להוסיף תמונה. אם מוצגת תג, צריך לוודא שיש מרווח בטוח של 24 דפים לשעה בחלק העליון ובחלק התחתון של התמונה.

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

טקסט חופשי

גודל טקסט מומלץ: פחות מ-25 תווים
מקור – תמונה אופציונלי תמונה של המקור, כמו המחבר, הארגון או הכתב לקבלת הנחיות, אפשר לעיין במפרט לתמונות.
תיאור אופציונלי

פסקה אחת של טקסט לתיאור הישות.

הערה: המשתמש יראה רק את התיאור או את רשימת הכתוביות, ולא את שניהם.

טקסט חופשי

גודל טקסט מומלץ: 180 תווים
רשימת כתוביות אופציונלי

עד 3 כתוביות, כאשר כל כתוביות היא שורה אחת של טקסט.

הערה: המשתמש יראה רק את התיאור או את רשימת הכתוביות, ולא את שניהם.

טקסט חופשי

גודל הטקסט המומלץ לכל כתוביות: 50 תווים לכל היותר
תגים אופציונלי

כל תג יכול להיות טקסט חופשי (עד 15 תווים) או תמונה קטנה.

טיפול מיוחד בחוויית המשתמש מעל התמונה או הסרטון, למשל, כסיכה בשכבת-על בתמונה

  • 'עדכון בזמן אמת'
  • משך הקריאה של המאמר
תג – טקסט אופציונלי

שם התג

הערה: חובה להוסיף טקסט או תמונה לתג.

טקסט חופשי

גודל טקסט מומלץ: עד 15 תווים
תג – תמונה אופציונלי

תמונה קטנה

טיפול מיוחד בחוויית המשתמש, למשל כשכבת-על של תג על התמונה הממוזערת או הסרטון.

הערה: חובה להוסיף טקסט או תמונה לתג.

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

חותמת הזמן של עידן (epoch) באלפיות השנייה, מהרגע שבו המשתמש קיים אינטראקציה עם הישות הזו בפעם האחרונה.

הערה: השדה הזה נדרש אם הישות הזו היא חלק מהאשכול של ההזמנה.

 חותמת זמן של מערכת Unix באלפיות השנייה
אחוז ההתקדמות נדרש באופן מותנה

אחוז התוכן המלא שהמשתמש צפה בו עד היום.

הערה: השדה הזה נדרש אם הישות הזו היא חלק מהאשכול של ההזמנה.

 ערך int בין 0 ל-100, כולל.
קטגוריות תוכן אופציונלי מתארים את הקטגוריה של התוכן הישות.

רשימה של Enums

אפשר לעיין בהנחיות בקטע קטגוריית תוכן.

EventEntity

מאפיין דרישה תיאור פורמט
URI של פעולה חובה

קישור עומק לישות באפליקציית הספק.

הערה: אפשר להשתמש בקישורי עומק לצורך שיוך. אפשר לעיין בשאלות הנפוצות האלה

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 תווים
תג – תמונה אופציונלי

תמונה קטנה

טיפול מיוחד בחוויית המשתמש, למשל כשכבת-על של תג על התמונה הממוזערת או הסרטון.

הערה: חובה להוסיף טקסט או תמונה לתג.

לקבלת הנחיות, אפשר לעיין במפרט לתמונות.
Price - CurrentPrice נדרש באופן מותנה

המחיר הנוכחי של הכרטיס/הכרטיס החוזר לאירוע.

חובה לציין אם צוין מחיר קודם מחוק.

טקסט חופשי
Price - StrikethroughPrice אופציונלי המחיר המקורי של הכרטיס/הכרטיס לתצוגה של האירוע. טקסט חופשי
נכס יתרונות מרכזיים של מחיר אופציונלי קריאה לרכישה עם מחיר מוזל, אם יש מבצע, אירוע או הנחה לחברי מועדון.

טקסט חופשי

גודל טקסט מומלץ: פחות מ-45 תווים (טקסט ארוך מדי עשוי לכלול שלוש נקודות)
קטגוריות תוכן אופציונלי מתארים את הקטגוריה של התוכן הישות.

רשימת הטיפוסים הבני מנייה שעומדים בדרישות

  • TYPE_MOVIES_AND_TV_SHOWS (דוגמה – קולנוע)
  • TYPE_DIGITAL_GAMES (דוגמה – eSports)
  • TYPE_MUSIC (לדוגמה – הופעה)
  • TYPE_TRAVEL_AND_LOCAL (לדוגמה: סיור, פסטיבל)
  • TYPE_HEALTH_AND_FITENESS (דוגמה – שיעור יוגה)
  • TYPE_EDUCATION (דוגמה – כיתה)
  • TYPE_SPORTS (דוגמה – משחק כדורגל)
  • TYPE_DATING (דוגמה – פגישה)

אפשר לעיין בהנחיות בקטע קטגוריית תוכן.

LodgingEntity

מאפיין דרישה תיאור פורמט
URI של פעולה חובה

קישור עומק לישות באפליקציית הספק.

הערה: אפשר להשתמש בקישורי עומק לצורך שיוך. אפשר לעיין בשאלות הנפוצות האלה

URI
כותרת חובה שם הישות.

מחרוזת

גודל טקסט מומלץ: 50 תווים לכל היותר
תמונות של פוסטרים חובה

אם תספקו כמה תמונות, נציג רק תמונה אחת. יחס הגובה-רוחב המומלץ הוא 16:9

הערה: אם אתם מספקים תג, חשוב לוודא שיש מרווח בטוח של 24 דפים לדקה בחלק העליון ובחלק התחתון של התמונה.

לקבלת הנחיות, אפשר לעיין במפרט לתמונות.
מיקום – מדינה חובה המדינה שבה מתבצעת הלינה.

טקסט חופשי

גודל טקסט מומלץ: עד כ-20 תווים
מיקום – עיר חובה העיר שבה מתבצעת הלינה.

טקסט חופשי

גודל טקסט מומלץ: עד כ-20 תווים
מיקום – כתובת להצגה חובה הכתובת של המקום לינה שתוצג למשתמש.

טקסט חופשי

גודל טקסט מומלץ: עד כ-20 תווים
מיקום – רחוב אופציונלי הרחוב (אם רלוונטי) של המקום לינה.

טקסט חופשי

גודל טקסט מומלץ: עד כ-20 תווים
מיקום – מדינה אופציונלי המדינה או המחוז (אם רלוונטי) שבהם נמצא המקום לינה.

טקסט חופשי

גודל טקסט מומלץ: עד כ-20 תווים
מיקום – מיקוד אופציונלי המיקוד (אם רלוונטי) של המקום לינה.

טקסט חופשי

גודל טקסט מומלץ: עד כ-20 תווים
מיקום – שכונה אופציונלי השכונה (אם רלוונטי) של המקום לינה.

טקסט חופשי

גודל טקסט מומלץ: עד כ-20 תווים
תגים אופציונלי

כל תג יכול להיות טקסט חופשי (עד 15 תווים) או תמונה קטנה.
תג – טקסט אופציונלי

שם התג

הערה: חובה להוסיף טקסט או תמונה לתג.

טקסט חופשי

גודל טקסט מומלץ: עד 15 תווים
תג – תמונה אופציונלי

תמונה קטנה

טיפול מיוחד בחוויית המשתמש, למשל כשכבת-על של תג על התמונה הממוזערת או הסרטון.

הערה: חובה להוסיף טקסט או תמונה לתג.

לקבלת הנחיות, אפשר לעיין במפרט לתמונות.
תיאור אופציונלי

פסקה אחת של טקסט לתיאור הישות.

הערה: המשתמש יראה רק את התיאור או את רשימת הכתוביות, ולא את שניהם.

טקסט חופשי

גודל טקסט מומלץ: 180 תווים
רשימת כתוביות אופציונלי

עד 3 כתוביות, כאשר כל כתוביות היא שורה אחת של טקסט.

הערה: המשתמש יראה רק את התיאור או את רשימת הכתוביות, ולא את שניהם.

טקסט חופשי

גודל הטקסט המומלץ לכל כתוביות: 50 תווים לכל היותר
AvailabilityTimeWindow - Localized Start Time - Timestamp אופציונלי חותמת הזמן של תחילת המילניום (epoch) שבה המקום צפוי להיות פתוח או זמין. Joda-Time Instant
AvailabilityTimeWindow - Localized Start Time - Timezone אופציונלי אזור הזמן שבו המקום צפוי להיות פתוח או זמין. Joda-Time DateTimeZone
AvailabilityTimeWindow - Localized End Time - Timestamp אופציונלי חותמת הזמן של התקופה שבה המקום צפוי להיות פתוח או זמין. Joda-Time Instant
AvailabilityTimeWindow - Localized End Time - Timezone אופציונלי אזור הזמן שבו המקום צפוי להיות פתוח או זמין. Joda-Time DateTimeZone
דירוג – ערך מקסימלי אופציונלי

הערך המקסימלי בסולם הדירוג.

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

 מספר >= 0.0
דירוג – ערך נוכחי אופציונלי

הערך הנוכחי של סולם הדירוג.

חובה לציין את הערך הזה אם צוין גם הערך המקסימלי של הדירוג.

 מספר >= 0.0
דירוג – ספירה אופציונלי

מספר הדירוגים של המקום לינה.

הערה: יש לציין את השדה הזה אם רוצים לקבוע באפליקציה איך המידע הזה יוצג למשתמשים. יש לציין את המחרוזת המקוצרת שאפשר להציג למשתמש. לדוגמה, אם המספר הוא 1,000,000, מומלץ להשתמש בקיצור כמו 1M כדי שהוא לא ייחתך במסכים קטנים יותר.

 מחרוזת
דירוג – ערך ספירה אופציונלי

מספר הדירוגים של המקום לינה.

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

 ארוך
Price - CurrentPrice נדרש באופן מותנה

המחיר הנוכחי של האירוח.

חובה לציין אם צוין מחיר קודם מחוק.

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

טקסט חופשי

גודל טקסט מומלץ: פחות מ-45 תווים (טקסט ארוך מדי עשוי לכלול שלוש נקודות)

StoreEntity

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

מאפיין דרישה תיאור פורמט
תמונות של פוסטרים חובה צריך לספק לפחות תמונה אחת. לקבלת הנחיות, אפשר לעיין במפרט לתמונות.
URI של פעולה חובה

קישור עומק לישות באפליקציית הספק.

הערה: אפשר להשתמש בקישורי עומק לצורך שיוך. אפשר לעיין בשאלות הנפוצות האלה

URI
כותרת אופציונלי שם החנות.

טקסט חופשי

גודל טקסט מומלץ: פחות מ-45 תווים (טקסט ארוך מדי עשוי לכלול שלוש נקודות)
מיקום אופציונלי המיקום של החנות.

טקסט חופשי

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

טקסט חופשי

גודל טקסט מומלץ: פחות מ-45 תווים (טקסט ארוך מדי עשוי לכלול שלוש נקודות)
האותיות הקטנות של יתרונות מרכזיים אופציונלי טקסט של האותיות הקטנות בנכס היתרונות המרכזיים.

טקסט חופשי

גודל טקסט מומלץ: פחות מ-45 תווים (טקסט ארוך מדי עשוי לכלול שלוש נקודות)
תיאור אופציונלי תיאור של החנות.

טקסט חופשי

גודל טקסט מומלץ: פחות מ-90 תווים (טקסט ארוך מדי עשוי לכלול שלוש נקודות)
קטגוריה אופציונלי

קטגוריה של חנות. בהקשר של מקומות לסעודה, יכולה להיות זו קטגוריית מטבח כמו 'צרפתי', 'אמריקאי חדש', 'ראמן', 'מסעדת שף'.

טקסט חופשי

גודל טקסט מומלץ: פחות מ-45 תווים (טקסט ארוך מדי עשוי לכלול שלוש נקודות)
דירוג – ערך מקסימלי אופציונלי

הערך המקסימלי בסולם הדירוג.

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

 מספר >= 0.0
דירוג – ערך נוכחי אופציונלי

הערך הנוכחי של סולם הדירוג.

חובה לציין את הערך הזה אם צוין גם הערך המקסימלי של הדירוג.

 מספר >= 0.0
דירוג – ספירה אופציונלי

מספר הדירוגים של המקום לינה.

הערה: יש לציין את השדה הזה אם רוצים לקבוע באפליקציה איך המידע הזה יוצג למשתמשים. יש לציין את המחרוזת המקוצרת שאפשר להציג למשתמש. לדוגמה, אם המספר הוא 1,000,000, מומלץ להשתמש בקיצור כמו 1M כדי שהוא לא ייחתך במסכים קטנים יותר.

 מחרוזת
דירוג – ערך ספירה אופציונלי

מספר הדירוגים של המקום לינה.

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

 ארוך

PointOfInterestEntity

מאפיין דרישה תיאור פורמט
URI של פעולה חובה

קישור עומק לישות באפליקציית הספק.

הערה: אפשר להשתמש בקישורי עומק לצורך שיוך. אפשר לעיין בשאלות הנפוצות האלה

URI
כותרת חובה שם הישות.

מחרוזת

גודל טקסט מומלץ: 50 תווים לכל היותר
תמונות של פוסטרים חובה

אם תספקו כמה תמונות, נציג רק תמונה אחת. יחס הגובה-רוחב המומלץ הוא 16:9

הערה: מומלץ מאוד להוסיף תמונה. אם מצורפת תג, צריך לוודא שיש מרווח בטוח של 24 דפים לשנייה בחלק העליון ובחלק התחתון של התמונה.

 לקבלת הנחיות, אפשר לעיין במפרט לתמונות.
מיקום – מדינה חובה המדינה שבה מתרחשת נקודת העניין.

טקסט חופשי

גודל טקסט מומלץ: עד כ-20 תווים
מיקום – עיר חובה העיר שבה מתרחשת נקודת העניין.

טקסט חופשי

גודל טקסט מומלץ: עד כ-20 תווים
מיקום – כתובת להצגה חובה הכתובת של נקודת העניין שתוצג למשתמש.

טקסט חופשי

גודל טקסט מומלץ: עד כ-20 תווים
מיקום – רחוב אופציונלי הרחוב (אם רלוונטי) של נקודת העניין.

טקסט חופשי

גודל טקסט מומלץ: עד כ-20 תווים
מיקום – מדינה אופציונלי המדינה או המחוז (אם רלוונטי) שבהם נמצא נקודת העניין.

טקסט חופשי

גודל טקסט מומלץ: עד כ-20 תווים
מיקום – מיקוד אופציונלי המיקוד (אם רלוונטי) של נקודת העניין.

טקסט חופשי

גודל טקסט מומלץ: עד כ-20 תווים
מיקום – שכונה אופציונלי השכונה (אם רלוונטי) של נקודת העניין.

טקסט חופשי

גודל טקסט מומלץ: עד כ-20 תווים
AvailabilityTimeWindow - Localized Start Time - Timestamp אופציונלי חותמת הזמן של תחילת המילניום (epoch) שבה נקודת העניין צפויה להיות פתוחה או זמינה. Joda-Time Instant
AvailabilityTimeWindow - Localized Start Time - Timezone אופציונלי אזור הזמן שבו נקודת העניין צפויה להיות פתוחה או זמינה. Joda-Time DateTimeZone
AvailabilityTimeWindow - Localized End Time - Timestamp אופציונלי חותמת הזמן של תחילת המאה (epoch) עד שתוקף נקודת העניין צפוי לפוג. Joda-Time Instant
AvailabilityTimeWindow - Localized End Time - Timezone אופציונלי אזור הזמן שבו נקודת העניין צפויה להיות פתוחה או זמינה. Joda-Time DateTimeZone
תגים אופציונלי

כל תג יכול להיות טקסט חופשי (עד 15 תווים) או תמונה קטנה.
תג – טקסט אופציונלי

שם התג

הערה: חובה להוסיף טקסט או תמונה לתג.

טקסט חופשי

גודל טקסט מומלץ: עד 15 תווים
תג – תמונה אופציונלי

תמונה קטנה

טיפול מיוחד בחוויית המשתמש, למשל כשכבת-על של תג על התמונה הממוזערת או הסרטון.

הערה: חובה להוסיף טקסט או תמונה לתג.

לקבלת הנחיות, אפשר לעיין במפרט לתמונות.
תיאור אופציונלי

פסקה אחת של טקסט לתיאור הישות.

הערה: המשתמש יראה רק את התיאור או את רשימת הכתוביות, ולא את שניהם.

טקסט חופשי

גודל טקסט מומלץ: 180 תווים
רשימת כתוביות אופציונלי

עד 3 כתוביות, כאשר כל כתוביות היא שורה אחת של טקסט.

הערה: המשתמש יראה רק את התיאור או את רשימת הכתוביות, ולא את שניהם.

טקסט חופשי

גודל הטקסט המומלץ לכל כתוביות: 50 תווים לכל היותר
דירוג – ערך מקסימלי אופציונלי

הערך המקסימלי בסולם הדירוג.

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

 מספר >= 0.0
דירוג – ערך נוכחי אופציונלי

הערך הנוכחי של סולם הדירוג.

חובה לציין את הערך הזה אם צוין גם הערך המקסימלי של הדירוג.

 מספר >= 0.0
דירוג – ספירה אופציונלי

מספר הדירוגים של נקודת העניין.

הערה: יש לציין את השדה הזה אם רוצים לקבוע באפליקציה איך המידע הזה יוצג למשתמשים. יש לציין את המחרוזת המקוצרת שאפשר להציג למשתמש. לדוגמה, אם המספר הוא 1,000,000, מומלץ להשתמש בקיצור כמו 1M כדי שהוא לא ייחתך במסכים קטנים יותר.

 מחרוזת
דירוג – ערך ספירה אופציונלי

מספר הדירוגים של נקודת העניין.

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

 ארוך
Price - CurrentPrice נדרש באופן מותנה

המחיר הנוכחי של הכרטיסים או הכרטיס לכניסה לנקודת העניין.

חובה לציין אם צוין מחיר קודם מחוק.

טקסט חופשי
Price - StrikethroughPrice אופציונלי המחיר המקורי של הכרטיסים או הכרטיס לכניסה לנקודת העניין. טקסט חופשי
נכס יתרונות מרכזיים של מחיר אופציונלי קריאה לרכישה עם מחיר מוזל, אם יש מבצע, אירוע או הנחה לחברי מועדון.

טקסט חופשי

גודל טקסט מומלץ: פחות מ-45 תווים (טקסט ארוך מדי עשוי לכלול שלוש נקודות)

קטגוריות תוכן אופציונלי מתארים את הקטגוריה של התוכן הישות.

רשימת הטיפוסים הבני מנייה שעומדים בדרישות

  • TYPE_TRAVEL_AND_LOCAL
  • TYPE_MOVIES_AND_TV_SHOWS (דוגמה – תיאטרון)
  • TYPE_MEDICAL (דוגמה – בית חולים)
  • TYPE_EDUCATION (דוגמה – בית ספר)
  • TYPE_SPORTS (לדוגמה – אצטדיון)

אפשר לעיין בהנחיות בקטע קטגוריית תוכן.

RestaurantReservationEntity

מאפיין דרישה תיאור פורמט
URI של פעולה חובה

קישור עומק לישות באפליקציית הספק.

הערה: אפשר להשתמש בקישורי עומק לצורך שיוך. אפשר לעיין בשאלות הנפוצות האלה

URI
כותרת חובה שם הישות.

מחרוזת

גודל טקסט מומלץ: 50 תווים לכל היותר
שעת ההתחלה של ההזמנה (לפי שעון מקומי) – חותמת זמן חובה חותמת הזמן של שעת ההתחלה הצפויה של ההזמנה. Joda-Time Instant
שעת ההתחלה של ההזמנה (לפי אזור הזמן המקומי) חובה אזור הזמן שבו ההזמנה צפויה להתחיל. Joda-Time DateTimeZone
מיקום – מדינה חובה המדינה שבה מתקיימת המסעדה.

טקסט חופשי

גודל טקסט מומלץ: עד כ-20 תווים
מיקום – עיר חובה העיר שבה נמצאת המסעדה.

טקסט חופשי

גודל טקסט מומלץ: עד כ-20 תווים
מיקום – כתובת להצגה חובה הכתובת של המסעדה שתוצג למשתמש.

טקסט חופשי

גודל טקסט מומלץ: עד כ-20 תווים
מיקום – רחוב אופציונלי הרחוב (אם רלוונטי) של המסעדה.

טקסט חופשי

גודל טקסט מומלץ: עד כ-20 תווים
מיקום – מדינה אופציונלי המדינה או המחוז (אם רלוונטי) שבהם נמצא המסעדה.

טקסט חופשי

גודל טקסט מומלץ: עד כ-20 תווים
מיקום – מיקוד אופציונלי המיקוד (אם רלוונטי) של המסעדה.

טקסט חופשי

גודל טקסט מומלץ: עד כ-20 תווים
מיקום – שכונה אופציונלי השכונה (אם רלוונטי) של המסעדה.

טקסט חופשי

גודל טקסט מומלץ: עד כ-20 תווים
תמונות של פוסטרים אופציונלי אם תספקו כמה תמונות, נציג רק תמונה אחת. יחס הגובה-רוחב המומלץ הוא 16:9 לקבלת הנחיות, אפשר לעיין במפרט לתמונות.
תיאור אופציונלי

פסקה אחת של טקסט לתיאור הישות.

הערה: המשתמש יראה רק את התיאור או את רשימת הכתוביות, ולא את שניהם.

טקסט חופשי

גודל טקסט מומלץ: 180 תווים
רשימת כתוביות אופציונלי

עד 3 כתוביות, כאשר כל כתוביות היא שורה אחת של טקסט.

הערה: המשתמש יראה רק את התיאור או את רשימת הכתוביות, ולא את שניהם.

טקסט חופשי

גודל הטקסט המומלץ לכל כתוביות: 50 תווים לכל היותר
גודל הטבלה אופציונלי מספר האנשים בקבוצת ההזמנה מספר שלם > 0

EventReservationEntity

מאפיין דרישה תיאור פורמט
URI של פעולה חובה

קישור עומק לישות באפליקציית הספק.

הערה: אפשר להשתמש בקישורי עומק לצורך שיוך. אפשר לעיין בשאלות הנפוצות האלה

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 תווים
תג – תמונה אופציונלי

תמונה קטנה

טיפול מיוחד בחוויית המשתמש, למשל כשכבת-על של תג על התמונה הממוזערת או הסרטון.

הערה: חובה להוסיף טקסט או תמונה לתג.

לקבלת הנחיות, אפשר לעיין במפרט לתמונות.
מזהה ההזמנה אופציונלי מזהה ההזמנה של האירוע. טקסט חופשי
Price - CurrentPrice נדרש באופן מותנה

המחיר הנוכחי של הכרטיס/הכרטיס החוזר לאירוע.

חובה לציין אם צוין מחיר קודם מחוק.

טקסט חופשי
Price - StrikethroughPrice אופציונלי המחיר המקורי של הכרטיס/הכרטיס לתצוגה של האירוע. טקסט חופשי
נכס יתרונות מרכזיים של מחיר אופציונלי קריאה לרכישה עם מחיר מוזל, אם יש מבצע, אירוע או הנחה לחברי מועדון.

טקסט חופשי

גודל טקסט מומלץ: פחות מ-45 תווים (טקסט ארוך מדי עשוי לכלול שלוש נקודות)
דירוג – ערך מקסימלי אופציונלי

הערך המקסימלי בסולם הדירוג.

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

 מספר >= 0.0
דירוג – ערך נוכחי אופציונלי

הערך הנוכחי של סולם הדירוג.

חובה לציין את הערך הזה אם צוין גם הערך המקסימלי של הדירוג.

 מספר >= 0.0
דירוג – ספירה אופציונלי

מספר הדירוגים של האירוע.

הערה: יש לציין את השדה הזה אם רוצים לקבוע באפליקציה איך המידע הזה יוצג למשתמשים. יש לציין את המחרוזת המקוצרת שאפשר להציג למשתמש. לדוגמה, אם המספר הוא 1,000,000, מומלץ להשתמש בקיצור כמו 1M כדי שהוא לא ייחתך במסכים קטנים יותר.

 מחרוזת
דירוג – ערך ספירה אופציונלי

מספר הדירוגים של האירוע.

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

 ארוך
קטגוריות תוכן אופציונלי מתארים את הקטגוריה של התוכן הישות.

רשימת הטיפוסים הבני מנייה שעומדים בדרישות

  • TYPE_MOVIES_AND_TV_SHOWS (דוגמה – קולנוע)
  • TYPE_DIGITAL_GAMES (דוגמה – eSports)
  • TYPE_MUSIC (לדוגמה – הופעה)
  • TYPE_TRAVEL_AND_LOCAL (לדוגמה: סיור, פסטיבל)
  • TYPE_HEALTH_AND_FITENESS (דוגמה – שיעור יוגה)
  • TYPE_EDUCATION (דוגמה – כיתה)
  • TYPE_SPORTS (דוגמה – משחק כדורגל)
  • TYPE_DATING (דוגמה – פגישה)

אפשר לעיין בהנחיות בקטע קטגוריית תוכן.

LodgingReservationEntity

מאפיין דרישה תיאור פורמט
URI של פעולה חובה

קישור עומק לישות באפליקציית הספק.

הערה: אפשר להשתמש בקישורי עומק לצורך שיוך. אפשר לעיין בשאלות הנפוצות האלה

URI
כותרת חובה שם הישות.

טקסט חופשי. לדוגמה, 'השהייה שלך מ-12 בדצמבר'

גודל טקסט מומלץ: 50 תווים לכל היותר
שעת הצ'ק-אין המקומית – חותמת זמן חובה חותמת הזמן של תחילת המילניום שמייצגת את שעת הצ'ק-אין של ההזמנה. Joda-Time Instant
שעת צ'ק-אין מותאמת לשעון המקומי – אזור זמן חובה אזור הזמן שבו קיימת שעת הצ'ק אין של ההזמנה. Joda-Time Instant
שעת צ'ק-אאוט מותאמת לשעון המקומי – חותמת זמן חובה חותמת הזמן של עידן (epoch) שמייצגת את שעת היציאה מהמלון. Joda-Time Instant
שעת צ'ק-אאוט מותאמת לשעון המקומי – אזור זמן חובה אזור הזמן שבו מצוין מועד היציאה מהמלון בהזמנה. Joda-Time DateTimeZone
מיקום – מדינה חובה המדינה שבה נמצא המקום לינה.

טקסט חופשי

גודל טקסט מומלץ: עד כ-20 תווים
מיקום – עיר חובה העיר שבה נמצא המקום לינה.

טקסט חופשי

גודל טקסט מומלץ: עד כ-20 תווים
מיקום – כתובת להצגה חובה הכתובת של המקום לינה שתוצג למשתמש.

טקסט חופשי

גודל טקסט מומלץ: עד כ-20 תווים
מיקום – רחוב אופציונלי הרחוב (אם רלוונטי) של המקום לינה.

טקסט חופשי

גודל טקסט מומלץ: עד כ-20 תווים
מיקום – מדינה אופציונלי המדינה או המחוז (אם רלוונטי) שבהם נמצא המקום לינה.

טקסט חופשי

גודל טקסט מומלץ: עד כ-20 תווים
מיקום – מיקוד אופציונלי המיקוד (אם רלוונטי) של המקום לינה.

טקסט חופשי

גודל טקסט מומלץ: עד כ-20 תווים
מיקום – שכונה אופציונלי השכונה (אם רלוונטי) של המקום לינה.

טקסט חופשי

גודל טקסט מומלץ: עד כ-20 תווים
תמונות של פוסטרים אופציונלי

אם תספקו כמה תמונות, נציג רק תמונה אחת. יחס הגובה-רוחב המומלץ הוא 16:9

הערה: אם אתם מספקים תג, חשוב לוודא שיש מרווח בטוח של 24 דפים לשנייה בחלק העליון ובחלק התחתון של התמונה.

לקבלת הנחיות, אפשר לעיין במפרט לתמונות.
תיאור אופציונלי

פסקה אחת של טקסט לתיאור הישות.

הערה: המשתמש יראה רק את התיאור או את רשימת הכתוביות, ולא את שניהם.

טקסט חופשי

גודל טקסט מומלץ: 180 תווים
רשימת כתוביות אופציונלי

עד 3 כתוביות, כאשר כל כתוביות היא שורה אחת של טקסט.

הערה: המשתמש יראה רק את התיאור או את רשימת הכתוביות, ולא את שניהם.

טקסט חופשי

גודל הטקסט המומלץ לכל כתוביות: 50 תווים לכל היותר
מזהה ההזמנה אופציונלי מזהה ההזמנה של הלינה. טקסט חופשי
דירוג – ערך מקסימלי אופציונלי

הערך המקסימלי בסולם הדירוג.

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

 מספר >= 0.0
דירוג – ערך נוכחי אופציונלי

הערך הנוכחי של סולם הדירוג.

חובה לציין את הערך הזה אם צוין גם הערך המקסימלי של הדירוג.

 מספר >= 0.0
דירוג – ספירה אופציונלי

מספר הדירוגים של המקום לינה.

הערה: יש לציין את השדה הזה אם רוצים לקבוע באפליקציה איך המידע הזה יוצג למשתמשים. יש לציין את המחרוזת המקוצרת שאפשר להציג למשתמש. לדוגמה, אם המספר הוא 1,000,000, מומלץ להשתמש בקיצור כמו 1M כדי שהוא לא ייחתך במסכים קטנים יותר.

 מחרוזת
דירוג – ערך ספירה אופציונלי

מספר הדירוגים של המקום לינה.

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

 ארוך
Price - CurrentPrice נדרש באופן מותנה

המחיר הנוכחי של האירוח.

חובה לציין אם צוין מחיר קודם מחוק.

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

טקסט חופשי

גודל טקסט מומלץ: פחות מ-45 תווים (טקסט ארוך מדי עשוי לכלול שלוש נקודות)

TransportationReservationEntity

מאפיין דרישה תיאור פורמט
URI של פעולה חובה

קישור עומק לישות באפליקציית הספק.

הערה: אפשר להשתמש בקישורי עומק לצורך שיוך. אפשר לעיין בשאלות הנפוצות האלה

URI
כותרת חובה שם הישות.

טקסט חופשי. לדוגמה, 'SFO אל SAN'

גודל טקסט מומלץ: 50 תווים לכל היותר
סוג התחבורה חובה אמצעי התחבורה או סוג התחבורה של ההזמנה. Enum: FLIGHT,‏ TRAIN,‏ BUS או FERRY
שעת ההמראה המתורגמת – חותמת זמן חובה חותמת הזמן של תחילת המרוץ שמייצגת את שעת היציאה. Joda-Time Instant
שעת המראה המתורגמת – אזור זמן חובה אזור הזמן של שעת היציאה. Joda-Time DateTimeZone
שעת הגעה מותאמת לשעון המקומי – חותמת זמן חובה חותמת הזמן של תחילת המילניום שמייצגת את שעת ההגעה. 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 תווים
ספק שירות – שם אופציונלי

השם של ספק השירות.

הערה: צריך להוסיף טקסט או תמונה לספק השירות.

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

הלוגו או התמונה של ספק השירות.

הערה: צריך להוסיף טקסט או תמונה לספק השירות.

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

אם תספקו כמה תמונות, נציג רק תמונה אחת. יחס הגובה-רוחב המומלץ הוא 16:9

לקבלת הנחיות, אפשר לעיין במפרט לתמונות.
תיאור אופציונלי

פסקה אחת של טקסט לתיאור הישות.

הערה: המשתמש יראה רק את התיאור או את רשימת הכתוביות, ולא את שניהם.

טקסט חופשי

גודל טקסט מומלץ: 180 תווים
רשימת כתוביות אופציונלי

עד 3 כתוביות, כאשר כל כתוביות היא שורה אחת של טקסט.

הערה: המשתמש יראה רק את התיאור או את רשימת הכתוביות, ולא את שניהם.

טקסט חופשי

גודל הטקסט המומלץ לכל כתוביות: 50 תווים לכל היותר
מזהה ההזמנה אופציונלי מזהה ההזמנה של הנסיעה. טקסט חופשי
Price - CurrentPrice נדרש באופן מותנה

המחיר הנוכחי של ההזמנה.

חובה לציין אם צוין מחיר קודם מחוק.

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

טקסט חופשי

גודל טקסט מומלץ: פחות מ-45 תווים (טקסט ארוך מדי עשוי לכלול שלוש נקודות)

VehicleRentalReservationEntity

מאפיין דרישה תיאור פורמט
URI של פעולה חובה

קישור עומק לישות באפליקציית הספק.

הערה: אפשר להשתמש בקישורי עומק לצורך שיוך. אפשר לעיין בשאלות הנפוצות האלה

URI
כותרת חובה שם הישות.

טקסט חופשי. לדוגמה, "Avis Union Square SF"

גודל טקסט מומלץ: 50 תווים לכל היותר
שעת האיסוף המקומית – חותמת זמן חובה חותמת הזמן מתחילת הזמן (epoch) שמייצגת את מועד האיסוף של ההזמנה. Joda-Time Instant
שעת האיסוף המתוזמנת (לפי אזור הזמן המקומי) חובה אזור הזמן של שעת האיסוף של ההזמנה. Joda-Time DateTimeZone
Localized Return Time - Timestamp אופציונלי חותמת הזמן של תחילת המילניום שמייצגת את מועד היציאה מהמלון. 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 תווים לכל היותר
מזהה אישור אופציונלי מזהה האישור של הזמנת הרכב השכור. טקסט חופשי
Price - CurrentPrice נדרש באופן מותנה

המחיר הנוכחי של ההזמנה.

חובה לציין אם צוין מחיר קודם מחוק.

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

טקסט חופשי

גודל טקסט מומלץ: פחות מ-45 תווים (טקסט ארוך מדי עשוי לכלול שלוש נקודות)

מפרט לתמונות

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

יחס גובה-רוחב מספר פיקסלים מינימלי מספר פיקסלים מומלץ

ריבוע (1x1)

מועדף

 300x300 1,200x1,200
לרוחב (1.91x1) 600x314 1,200x628
לאורך (4x5) 480x600 960x1200

התמונות צריכות להתארח ב-CDN ציבורי כדי ש-Google תהיה לה גישה אליהן.

פורמטים של קבצים

PNG, ‏ JPG, ‏ GIF סטטי, ‏ WebP

גודל קובץ מקסימלי

‎5,120 KB

המלצות נוספות

  • האזור הבטוח לתמונות: התוכן החשוב צריך להופיע במרכז התמונה, על פני 80% ממנה.
  • כדאי להשתמש ברקע שקוף כדי שהתמונה תוצג בצורה תקינה בהגדרות של העיצוב הכהה והבהיר.

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

קטגוריית התוכן מאפשרת לאפליקציות לפרסם תוכן ששייך לכמה קטגוריות. כך תוכלו למפות את התוכן לחלק מהקטגוריות המוגדרות מראש, כלומר:

  • TYPE_EDUCATION
  • TYPE_SPORTS
  • TYPE_MOVIES_AND_TV_SHOWS
  • TYPE_BOOKS
  • TYPE_AUDIOBOOKS
  • TYPE_MUSIC
  • TYPE_DIGITAL_GAMES
  • TYPE_TRAVEL_AND_LOCAL
  • TYPE_HOME_AND_AUTO
  • TYPE_BUSINESS
  • TYPE_NEWS
  • TYPE_FOOD_AND_DRINK
  • TYPE_SHOPPING
  • TYPE_HEALTH_AND_FITENESS
  • TYPE_MEDICAL
  • TYPE_PARENTING
  • TYPE_DATING

התמונות צריכות להתארח ב-CDN ציבורי כדי ש-Google תהיה מסוגלת לגשת אליהן.

הנחיות לשימוש בקטגוריות התוכן

  1. יש ישויות כמו ArticleEntity ו-GenericFeaturedEntity שיכולות להשתמש בכל אחת מקטגוריות התוכן. ישויות אחרות, כמו EventEntity, ‏ EventReservationEntity ו-PointOfInterestEntity, יכולות לקבל את התכונה רק אם הן שייכות לקבוצת משנה של הקטגוריות האלה. לפני שאתם מאכלסים את הרשימה, כדאי לבדוק את רשימת הקטגוריות שזמינות לסוג הישות.

  2. כדאי להשתמש בסוג הישות הספציפי לקטגוריות תוכן מסוימות במקום בשילוב של הישות הגנרית ושל ContentCategory:

    • TYPE_MOVIES_AND_TV_SHOWS – לפני שמשתמשים בישויות הכלליות, כדאי לעיין בישויות שמפורטות במדריך לשילוב עם Watch.
    • TYPE_BOOKS – לפני שמשתמשים בישויות הכלליות, כדאי לעיין ב-EbookEntity.
    • TYPE_AUDIOBOOKS – לפני שמשתמשים בישויות הכלליות, כדאי לעיין ב-AudiobookEntity.
    • TYPE_SHOPPING – לפני שמשתמשים בישויות הכלליות, כדאי לעיין ב-ShoppingEntity.
    • TYPE_FOOD_AND_DRINK – לפני שמשתמשים בישויות הכלליות, כדאי לעיין בישויות שמפורטות במדריך לשילוב נתוני מזון.

  3. השדה ContentCategory הוא אופציונלי, וצריך להשאיר אותו ריק אם התוכן לא שייך לאף אחת מהקטגוריות שצוינו למעלה.

  4. אם מציינים כמה קטגוריות תוכן, צריך לציין אותן לפי רמת הרלוונטיות לתוכן, כאשר קטגוריית התוכן הרלוונטית ביותר מופיעה בראש הרשימה.

שלב 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 מהשותף המפתח יוסרו.
  • הנתונים מהבקשה מנותחים ונשמרים באשכול ההמלצות המעודכן.

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

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 מהשותף המפתח יוסרו.
  • הנתונים מהבקשה מנותחים ונשמרים באשכול הזמנות המעודכן.

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

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

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();

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

deleteUserManagementCluster

ממשק ה-API הזה משמש למחיקת התוכן של UserAccountManagement Cluster.

Kotlin

client.deleteUserManagementCluster()

Java

client.deleteUserManagementCluster();

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

deleteContinueSearchCluster

ממשק ה-API הזה משמש למחיקת התוכן של אשכול 'המשך החיפוש'.

Kotlin

client.deleteContinueSearchCluster()

Java

client.deleteContinueSearchCluster();

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

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: טיפול בכוונות שידור

בנוסף לקריאות ל-Content API לפרסום תוכן דרך משימה, צריך גם להגדיר BroadcastReceiver כדי לקבל את הבקשה לפרסום התוכן.

המטרה של כוונות השידור היא בעיקר להפעיל מחדש את האפליקציה ולאלץ סנכרון נתונים. כווננו של מודעות ה-Broadcast לא נשלחות בתדירות גבוהה. הוא מופעל רק כשמערכת 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
}

fun registerBroadcastReceivers(context: Context){
  var  context = context
  context = context.applicationContext

// Register Recommendation Cluster Publish Intent
  context.registerReceiver(AppEngageBroadcastReceiver(),
                           IntentFilter(Intents.ACTION_PUBLISH_RECOMMENDATION))

// Register Featured Cluster Publish Intent
  context.registerReceiver(AppEngageBroadcastReceiver(),
                           IntentFilter(Intents.ACTION_PUBLISH_FEATURED))
}

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
}

public static void registerBroadcastReceivers(Context context) {

context = context.getApplicationContext();

// Register Recommendation Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
new IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_RECOMMENDATION));

// Register Featured Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
new IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_FEATURED));

}
  • מגדירים באופן סטטי הטמעה באמצעות התג <receiver> בקובץ AndroidManifest.xml. כך האפליקציה יכולה לקבל כוונות שידור כשהיא לא פועלת, וגם לפרסם את התוכן.
<application>
   <receiver
      android:name=".AppEngageBroadcastReceiver"
      android:exported="true"
      android:enabled="true">
      <intent-filter>
         <action android:name="com.google.android.engage.action.PUBLISH_RECOMMENDATION" />
      </intent-filter>
      <intent-filter>
         <action android:name="com.google.android.engage.action.PUBLISH_FEATURED" />
      </intent-filter>
   </receiver>
</application>

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

  • com.google.android.engage.action.PUBLISH_RECOMMENDATION מומלץ להתחיל שיחת publishRecommendationClusters כשמקבלים את הכוונה הזו.
  • com.google.android.engage.action.PUBLISH_FEATURED מומלץ להתחיל שיחת publishFeaturedCluster כשמקבלים את הכוונה הזו.

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

במדריך המפורט תהליך השילוב של Engage למפתחים מוסבר איך לאמת את השילוב אחרי שהוא הושלם.

שאלות נפוצות

שאלות נפוצות על Engage SDK

איש/אשת הקשר

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

השלבים הבאים

אחרי השלמת השילוב, עליכם לבצע את השלבים הבאים:

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