כדי להגביר את ההתעניינות באפליקציה, כדאי להגיע למשתמשים במקומות שבהם הם נמצאים. אפשר לשלב את Engage SDK כדי להציג המלצות מותאמות אישית ותוכן להמשך צפייה ישירות למשתמשים בכמה פלטפורמות במכשיר, כמו אוספים, חבילת הבידור וחנות Play. השילוב מוסיף פחות מ-50KB (דחוס) ל-APK הממוצע, ולוקח בערך שבוע של זמן פיתוח ברוב האפליקציות. מידע נוסף זמין באתר העסקי שלנו.
המדריך הזה כולל הוראות לשותפי פיתוח בנושא העברת תוכן של נסיעות ואירועים לפלטפורמות התוכן של Engage.
תמיכה בקטגוריות ופלטפורמות
הזכאות לפלטפורמות של Engage SDK מבוססת על קטגוריית התוכן של האפליקציה. בטבלה הבאה מפורטות דרישות הסף לפלטפורמות ספציפיות:
| סטטוס | קטגוריית תוכן או תרחיש שימוש | פלטפורמות נתמכות |
|---|---|---|
|
נתמך (עומד בדרישות בכל הפלטפורמות) |
|
|
| לא נתמך |
|
מיומנויות ב-Android
הצגה ב-GitHubשילוב של Engage SDK
android skills add engage-sdk-integrationפרטי השילוב
בקטע הזה מפורטים השלבים, מודלי הנתונים והמונחים שנדרשים כדי לשלב את Engage SDK עם תוכן של נסיעות ואירועים.
הסברים על המונחים
השילוב הזה כולל את סוגי האשכולות הבאים: המלצה, נבחרים, הזמנה והמשך החיפוש.
אשכולות של המלצות מציגים הצעות מותאמות אישית לנסיעות ולאירועים ממפתח שותף ספציפי. ההמלצות האלה יכולות להיות מותאמות אישית למשתמש או כלליות (לדוגמה, פריטים פופולריים). אפשר להשתמש בהם כדי להציג מאמרים, אירועים, מקומות לינה או המלצות על מקומות מעניינים.
- אשכול המלצות יכול להיות מורכב מדפים עסקיים של
ArticleEntity,EventEntity,LodgingEntity,PointOfInterestEntityאוStoreEntity, אבל לא משילוב של סוגי ישויות שונים.
ההמלצות מוצגות במבנה הבא:
אוסף המלצות: תצוגה בממשק המשתמש שמכילה קבוצת המלצות מאותו שותף פיתוח.
ישות: אובייקט שמייצג פריט אחד באשכול. השילוב הזה מציע כמה ישויות שיוצגו באמצעות אשכול ההמלצות:
ArticleEntity: מייצג המלצה לתוכן מבוסס-טקסט שקשור לנסיעות ולאירועים. אפשר להשתמש בו למאמרים, לפוסטים בבלוג, לתוכן שיווקי, לתקצירי חדשות וכו'.
איור 1: ממשק משתמש שבו מוצג ArticleEntity יחיד באשכול המלצות. EventEntity: מייצג אירוע שיתרחש בעתיד. שעת ההתחלה של האירוע היא מידע קריטי שצריך להעביר למשתמשים.
איור 2: ממשק משתמש שבו מוצג EventEntity יחיד בתוך אשכול המלצות. LodgingEntity: הישות LodgingEntity מייצגת מקום לינה, כמו מלון, דירה או בית נופש להשכרה לטווח קצר או ארוך.
איור 3: ממשק משתמש שבו מוצג LodgingEntity יחיד באשכול המלצות. StoreEntity: מייצג חנות, מסעדה, בית קפה וכו'. הוא מדגיש תוכן שבו מסעדה או חנות הן המידע החשוב שצריך להעביר למשתמשים.
איור 4: ממשק משתמש שבו מוצגת ישות StoreEntity אחת באשכול Recommendations. PointOfInterestEntity: הישות PointOfInterestEntity מייצגת מקום מעניין, כמו תחנת דלק, מקום לאירועים, פארק שעשועים, מוזיאון, אטרקציה תיירותית, מסלול טיול וכו'. היא מדגישה תוכן שבו המיקום הוא מידע קריטי שצריך להעביר למשתמשים. הוא לא מיועד ללינה, לחנות או למסעדה.
איור 5: ממשק משתמש שבו מוצגת ישות PointOfInterestEntity אחת באשכול Recommendations.
- אשכול המלצות יכול להיות מורכב מדפים עסקיים של
באשכול הזמנה מוצג תוכן שמשתמשים מכמה שותפי פיתוח קיימו איתו אינטראקציה לאחרונה, והוא מקובץ בממשק משתמש אחד. כל שותף פיתוח יוכל לשדר עד 10 ישויות באשכול ההזמנות.
תוכן ההזמנה יכול להיות במבנה הבא:
RestaurantReservationEntity: הישות RestaurantReservationEntity מייצגת הזמנה למסעדה או לבית קפה, ועוזרת למשתמשים לעקוב אחרי הזמנות קרובות או פעילות במסעדות.
איור 6. ממשק משתמש שמוצג בו RestaurantReservationEntity אחד בתוך אשכול Reservation. EventReservationEntity: מייצג הזמנה לאירוע ועוזר למשתמשים לעקוב אחרי הזמנות לאירועים קרובים או מתמשכים. האירועים יכולים לכלול, בין היתר:
- אירועי ספורט, כמו הזמנת כרטיסים למשחק כדורגל
- אירועי גיימינג, כמו הזמנת מקום לספורט אלקטרוני
- אירועי בידור כמו הזמנת כרטיסים לסרט בקולנוע, הופעה, תיאטרון, אירוע חתימה על ספרים
- הזמנות של נסיעות או נקודות עניין, כמו סיורים מודרכים וכרטיסים למוזיאונים
- הזמנות לאירועים חברתיים, סמינרים וכנסים
- הזמנת מקום במפגשי הדרכה או לימודים
איור 7. ממשק משתמש שמוצגת בו ישות EventReservationEntity אחת בתוך אשכול Reservation. LodgingReservationEntity: הישות LodgingEntityReservation מייצגת הזמנה של מקום לינה בנסיעה, ועוזרת למשתמשים לעקוב אחרי הזמנות קרובות או פעילות של מלונות או יחידות אירוח.
איור 8. ממשק משתמש שמוצגת בו ישות LodgingReservationEntity אחת בתוך אשכול Reservation. TransportationReservationEntity: הישות TransportationReservationEntity מייצגת הזמנה של נסיעה בכל אמצעי תחבורה, ועוזרת למשתמשים לעקוב אחרי הזמנות של טיסות, מעבורות, רכבות, אוטובוסים, נסיעות בהזמנה או הפלגות קרובות או פעילות.
איור 9. ממשק משתמש שמוצג בו TransportationReservationEntity אחד באשכול Reservation. VehicleRentalReservationEntity: מייצגת הזמנה של השכרת רכב ועוזרת למשתמשים לעקוב אחרי הזמנות קרובות או פעילות של השכרת רכב.
איור 10. ממשק משתמש שבו מוצגת ישות אחת מסוג VehicleRentalReservationEntity בתוך אשכול של הזמנות.
אוסף ההמלצות מציג מבחר ישויות מכמה שותפי פיתוח בקבוצה אחת בממשק המשתמש. יהיה רק אשכול אחד של תוכן מומלץ, שיופיע בחלק העליון של ממשק המשתמש, במיקום עם עדיפות גבוהה יותר מכל אשכולות ההמלצות. כל שותף פיתוח יוכל לשדר עד 10 ישויות באשכול "מומלצים".
GenericFeaturedEntity: בניגוד לפריט Recommendation, פריט Featured צריך לשמש לתוכן מוביל יחיד של מפתחים, ולייצג את התוכן החשוב ביותר שיהיה מעניין ורלוונטי למשתמשים.
איור 11: ממשק משתמש שמוצג בו FeaturedCluster עם רשימה של GenericFeaturedEntity
אשכול המשך החיפוש עוזר למשתמשים להמשיך את תהליך החיפוש הקודם שלהם בנושא נסיעות, על ידי הצגת רשימה של שאילתות חיפוש שהמשתמש חיפש לאחרונה בכל אפליקציות הנסיעות שלו. האוסף יוצמד למיקום השני, אחרי ההזמנות ולפני האוספים של ההמלצות והפריטים הנבחרים. כל שותף פיתוח יוכל לשדר עד 3 ישויות באשכול "המשך החיפוש".
- 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'
}
סיכום
העיצוב מבוסס על הטמעה של שרת מאגד (bound service).
הנתונים שלקוח יכול לפרסם כפופים למגבלות הבאות, בהתאם לסוגי האשכולות השונים:
| סוג האשכול | מגבלות על אשכולות | מגבלות מינימליות על ישויות באשכול | מגבלות מקסימליות של ישויות באשכול |
|---|---|---|---|
| אשכולות של המלצות | עד 7 | לפחות אחד | עד 50 (ArticleEntity, EventEntity, LodgingEntity, StoreEntity או PointOfInterestEntity) |
| אשכול הזמנות | לכל היותר 1 | לפחות אחד | עד 20 (RestaurantReservationEntity,
EventReservationEntity,
LodgingReservationEntity,
TransportationReservationEntity או
VehicleRentalReservationEntity) |
| קבוצת פנים מומלצת | לכל היותר 1 | לפחות אחד | עד 20 (GenericFeaturedEntity) |
| המשך החיפוש באשכול | לכל היותר 1 | לפחות אחד | עד 3 (PointOfInterestEntity) |
שלב 1: מסירת נתוני הישות
ב-SDK מוגדרות ישויות שונות שמייצגות כל סוג פריט. אנחנו תומכים בישויות הבאות בקטגוריה "נסיעות ואירועים":
GenericFeaturedEntityArticleEntityEventEntityLodgingEntityStoreEntityPointOfInterestEntityRestaurantReservationEntityEventReservationEntityLodgingReservationEntityTransportationReservationEntityVehicleRentalReservationEntity
בטבלאות הבאות מפורטים המאפיינים הזמינים והדרישות לכל סוג.
GenericFeaturedEntity
| מאפיין | דרישה | תיאור | פורמט |
|---|---|---|---|
| URI של הפעולה | חובה |
קישור עומק לישות באפליקציה של הספק. הערה: אפשר להשתמש בקישורי עומק לצורך שיוך (Attribution). כדאי לעיין בשאלות הנפוצות האלה |
URI |
| תמונות של פוסטרים | חובה | אם תספקו כמה תמונות, נציג רק תמונה אחת. יחס הגובה-רוחב המומלץ הוא 16:9 הערה: אם מוסיפים תג, צריך להקפיד על אזור בטוח של 24 dps בחלק העליון והתחתון של התמונה. |
כדי לקבל הנחיות, כדאי לעיין במפרט לתמונות. |
| כותרת | אופציונלי | שם הישות. | טקסט חופשי גודל טקסט מומלץ: 50 תווים |
| תיאור | אופציונלי | פסקה אחת של טקסט שמתארת את הישות. הערה: למשתמש יוצג התיאור או רשימת כותרות המשנה, אבל לא שניהם. |
טקסט חופשי אורך טקסט מומלץ: 180 תווים |
| רשימת כתוביות | אופציונלי | עד 3 כותרות משנה, כשכל כותרת משנה היא שורת טקסט אחת. הערה: למשתמש יוצג התיאור או רשימת כותרות המשנה, אבל לא שניהם. |
טקסט חופשי גודל הטקסט המומלץ לכל כתובית: עד 50 תווים |
| תגים | אופציונלי | כל תג יכול להיות טקסט חופשי (עד 15 תווים) או תמונה קטנה. טיפול מיוחד בחוויית המשתמש מעל התמונה או הסרטון, למשל, שכבת-על של תג על התמונה
|
|
| תג – טקסט | אופציונלי | שם התג הערה: חובה להוסיף טקסט או תמונה לתג. |
טקסט חופשי גודל טקסט מומלץ: עד 15 תווים |
| תג – תמונה | אופציונלי | תמונה קטנה טיפול מיוחד בחוויית המשתמש, למשל שכבת-על של תג על התמונה הממוזערת של התמונה או הסרטון. הערה: חובה להוסיף טקסט או תמונה לתג. |
כדי לקבל הנחיות, כדאי לעיין במפרט לתמונות. |
| קטגוריות תוכן | אופציונלי | תארו את קטגוריית התוכן של הישות. | רשימת טיפוסים בני מנייה (enum) אפשר לעיין בקטע "קטגוריית תוכן" כדי לקבל הנחיות. |
| DisplayTimeWindow (אופציונלי) – הגדרת חלון זמן להצגת תוכן בפלטפורמה | |||
| חותמת הזמן של ההתחלה | אופציונלי |
חותמת הזמן של התקופה שאחריה התוכן אמור להופיע בפלטפורמה. אם המדיניות לא מוגדרת, אפשר להציג תוכן בפלטפורמה. |
חותמת זמן של תקופת זמן המערכת באלפיות השנייה |
| חותמת זמן של סיום | אופציונלי |
חותמת הזמן של התקופה שאחריה התוכן לא מוצג יותר בפלטפורמה. אם המדיניות לא מוגדרת, אפשר להציג תוכן בפלטפורמה. |
חותמת זמן של תקופת זמן המערכת באלפיות השנייה |
ArticleEntity
| מאפיין | דרישה | תיאור | פורמט |
|---|---|---|---|
| URI של הפעולה | חובה |
קישור עומק לישות באפליקציה של הספק. הערה: אפשר להשתמש בקישורי עומק לצורך שיוך (Attribution). כדאי לעיין בשאלות הנפוצות האלה |
URI |
| כותרת | חובה | שם הישות. | טקסט חופשי אורך הטקסט המומלץ: עד 50 תווים |
| תמונות של פוסטרים | אופציונלי | אם תספקו כמה תמונות, נציג רק תמונה אחת. יחס הגובה-רוחב המומלץ הוא 16:9 הערה: מומלץ מאוד להוסיף תמונה. אם מוסיפים תג, צריך לוודא שיש אזור בטוח של 24 dps גם בחלק העליון וגם בחלק התחתון של התמונה. |
כדי לקבל הנחיות, כדאי לעיין במפרט לתמונות. |
| מקור – כותרת | אופציונלי | שם המחבר, הארגון או הכתב | טקסט חופשי גודל טקסט מומלץ: פחות מ-25 תווים |
| מקור – תמונה | אופציונלי | תמונה של המקור, כמו המחבר, הארגון או הכתב | כדי לקבל הנחיות, כדאי לעיין במפרט לתמונות. |
| תיאור | אופציונלי | פסקה אחת של טקסט שמתארת את הישות. הערה: למשתמש יוצג התיאור או רשימת כותרות המשנה, אבל לא שניהם. |
טקסט חופשי אורך טקסט מומלץ: 180 תווים |
| רשימת כתוביות | אופציונלי | עד 3 כותרות משנה, כשכל כותרת משנה היא שורת טקסט אחת. הערה: למשתמש יוצג התיאור או רשימת כותרות המשנה, אבל לא שניהם. |
טקסט חופשי גודל הטקסט המומלץ לכל כתובית: עד 50 תווים |
| תגים | אופציונלי | כל תג יכול להיות טקסט חופשי (עד 15 תווים) או תמונה קטנה. עיצוב מיוחד של חוויית המשתמש מעל התמונה או הסרטון, למשל, שכבת-על של תג על התמונה
|
|
| תג – טקסט | אופציונלי | שם התג הערה: חובה להוסיף טקסט או תמונה לתג. |
טקסט חופשי גודל טקסט מומלץ: עד 15 תווים |
| תג – תמונה | אופציונלי | תמונה קטנה טיפול מיוחד בחוויית המשתמש, למשל שכבת-על של תג על התמונה הממוזערת של התמונה או הסרטון. הערה: חובה להוסיף טקסט או תמונה לתג. |
כדי לקבל הנחיות, כדאי לעיין במפרט לתמונות. |
| מועד פרסום התוכן | אופציונלי | חותמת הזמן של התקופה במילי-שניות שבה התוכן פורסם או עודכן באפליקציה. | חותמת זמן של תקופת זמן המערכת באלפיות השנייה |
| מועד ההתעניינות האחרון | אופציונלי | חותמת הזמן של התקופה באלפיות השנייה שבה המשתמש היה באינטראקציה עם הישות הזו בפעם האחרונה. |
חותמת זמן של תקופת זמן המערכת באלפיות השנייה |
| אחוז ההתקדמות | אופציונלי | אחוז התוכן המלא שהמשתמש צרך עד היום. |
ערך int בין 0 ל-100, כולל. |
| קטגוריות תוכן | אופציונלי | תארו את קטגוריית התוכן של הישות. | רשימת טיפוסים בני מנייה (enum) אפשר לעיין בקטע "קטגוריית תוכן" כדי לקבל הנחיות. |
| DisplayTimeWindow (אופציונלי) – הגדרת חלון זמן להצגת תוכן בפלטפורמה | |||
| חותמת הזמן של ההתחלה | אופציונלי |
חותמת הזמן של התקופה שאחריה התוכן אמור להופיע בפלטפורמה. אם המדיניות לא מוגדרת, אפשר להציג תוכן בפלטפורמה. |
חותמת זמן של תקופת זמן המערכת באלפיות השנייה |
| חותמת זמן של סיום | אופציונלי |
חותמת הזמן של התקופה שאחריה התוכן לא מוצג יותר בפלטפורמה. אם המדיניות לא מוגדרת, אפשר להציג תוכן בפלטפורמה. |
חותמת זמן של תקופת זמן המערכת באלפיות השנייה |
EventEntity
| מאפיין | דרישה | תיאור | פורמט |
|---|---|---|---|
| URI של הפעולה | חובה |
קישור עומק לישות באפליקציה של הספק. הערה: אפשר להשתמש בקישורי עומק לצורך שיוך (Attribution). כדאי לעיין בשאלות הנפוצות האלה |
URI |
| כותרת | חובה | שם הישות. | מחרוזת אורך הטקסט המומלץ: עד 50 תווים |
| שעת התחלה מקומית – חותמת זמן | חובה |
חותמת הזמן של התאריך שבו האירוע צפוי להתחיל. |
Joda-Time Instant |
| שעת התחלה מקומית – אזור זמן | חובה |
אזור הזמן שבו האירוע צפוי להתחיל. |
Joda-Time DateTimeZone אפשר לעיין במפרט של אזורי זמן כדי לקבל הנחיות. |
| מצב אירוע | חובה | שדה שמציין אם האירוע יהיה וירטואלי, פיזי או גם וגם. |
ערכים אפשריים: VIRTUAL, IN_PERSON או HYBRID |
| תמונות של פוסטרים | חובה | אם תספקו כמה תמונות, נציג רק תמונה אחת. יחס הגובה-רוחב המומלץ הוא 16:9 הערה: מומלץ מאוד להוסיף תמונה. אם מוסיפים תג, צריך לוודא שיש אזור בטוח של 24 dps גם בחלק העליון וגם בחלק התחתון של התמונה. |
כדי לקבל הנחיות, כדאי לעיין במפרט לתמונות. |
| מיקום – מדינה | חובה בתנאים מסוימים | המדינה שבה האירוע מתקיים. הערה: השדה הזה נדרש לאירועים מסוג IN_PERSON או HYBRID. |
טקסט חופשי גודל טקסט מומלץ: עד כ-20 תווים |
| מיקום – עיר | חובה בתנאים מסוימים | העיר שבה האירוע מתרחש. הערה: השדה הזה נדרש לאירועים מסוג IN_PERSON או HYBRID. |
טקסט חופשי גודל טקסט מומלץ: עד כ-20 תווים |
| מיקום – כתובת לתצוגה | חובה בתנאים מסוימים | הכתובת או שם המקום שבו האירוע יתקיים, שיוצגו למשתמש. הערה: השדה הזה נדרש לאירועים מסוג IN_PERSON או HYBRID. |
טקסט חופשי גודל טקסט מומלץ: עד כ-20 תווים |
| מיקום – כתובת | אופציונלי | הכתובת (אם רלוונטי) של המיקום שבו מתקיים האירוע. | טקסט חופשי גודל טקסט מומלץ: עד כ-20 תווים |
| מיקום – מדינה | אופציונלי | המדינה (State) או המחוז (אם רלוונטי) שבהם האירוע מתקיים. | טקסט חופשי גודל טקסט מומלץ: עד כ-20 תווים |
| מיקום – מיקוד | אופציונלי | המיקוד (אם רלוונטי) של המיקום שבו מתקיים האירוע. | טקסט חופשי גודל טקסט מומלץ: עד כ-20 תווים |
| מיקום – שכונה | אופציונלי | השכונה (אם רלוונטי) שבה האירוע מתקיים. | טקסט חופשי גודל טקסט מומלץ: עד כ-20 תווים |
| שעת סיום | אופציונלי |
חותמת הזמן של התקופה שבה האירוע צפוי להסתיים. הערה: הערך הזה יוצג באלפיות השנייה. |
חותמת זמן של תקופת זמן המערכת באלפיות השנייה |
| תיאור | אופציונלי | פסקה אחת של טקסט שמתארת את הישות. הערה: למשתמש יוצג התיאור או רשימת כותרות המשנה, אבל לא שניהם. |
טקסט חופשי אורך טקסט מומלץ: 180 תווים |
| רשימת כתוביות | אופציונלי | עד 3 כותרות משנה, כשכל כותרת משנה היא שורת טקסט אחת. הערה: למשתמש יוצג התיאור או רשימת כותרות המשנה, אבל לא שניהם. |
טקסט חופשי גודל הטקסט המומלץ לכל כתובית: עד 50 תווים |
| תגים | אופציונלי |
כל תג יכול להיות טקסט חופשי (עד 15 תווים) או תמונה קטנה. |
|
| תג – טקסט | אופציונלי | שם התג הערה: חובה להוסיף טקסט או תמונה לתג. |
טקסט חופשי גודל טקסט מומלץ: עד 15 תווים |
| תג – תמונה | אופציונלי | תמונה קטנה טיפול מיוחד בחוויית המשתמש, למשל שכבת-על של תג על התמונה הממוזערת של התמונה או הסרטון. הערה: חובה להוסיף טקסט או תמונה לתג. |
כדי לקבל הנחיות, כדאי לעיין במפרט לתמונות. |
| Price - CurrentPrice | חובה בתנאים מסוימים |
המחיר הנוכחי של הכרטיס לאירוע. חובה לציין את המאפיין הזה אם מציינים מחיר קודם מחוק. |
טקסט חופשי |
| Price - StrikethroughPrice | אופציונלי | המחיר המקורי של הכרטיס לאירוע. | טקסט חופשי |
| יתרונות מרכזיים של מחיר | אופציונלי | הצגת מחיר כדי להבליט מבצע, אירוע או הנחה לחברי מועדון, אם יש כאלה. | טקסט חופשי אורך הטקסט המומלץ: פחות מ-45 תווים (טקסט ארוך מדי עלול להופיע עם שלוש נקודות) |
| קטגוריות תוכן | אופציונלי | תארו את קטגוריית התוכן של הישות. | רשימה של טיפוסים בני מנייה (enum) שעומדים בדרישות
אפשר לעיין בקטע "קטגוריית תוכן" כדי לקבל הנחיות. |
| DisplayTimeWindow (אופציונלי) – הגדרת חלון זמן להצגת תוכן בפלטפורמה | |||
| חותמת הזמן של ההתחלה | אופציונלי |
חותמת הזמן של התקופה שאחריה התוכן אמור להופיע בפלטפורמה. אם המדיניות לא מוגדרת, אפשר להציג תוכן בפלטפורמה. |
חותמת זמן של תקופת זמן המערכת באלפיות השנייה |
| חותמת זמן של סיום | אופציונלי |
חותמת הזמן של התקופה שאחריה התוכן לא מוצג יותר בפלטפורמה. אם המדיניות לא מוגדרת, אפשר להציג תוכן בפלטפורמה. |
חותמת זמן של תקופת זמן המערכת באלפיות השנייה |
LodgingEntity
| מאפיין | דרישה | תיאור | פורמט |
|---|---|---|---|
| URI של הפעולה | חובה |
קישור עומק לישות באפליקציה של הספק. הערה: אפשר להשתמש בקישורי עומק לצורך שיוך (Attribution). כדאי לעיין בשאלות הנפוצות האלה |
URI |
| כותרת | חובה | שם הישות. | מחרוזת אורך הטקסט המומלץ: עד 50 תווים |
| תמונות של פוסטרים | חובה |
אם תספקו כמה תמונות, נציג רק תמונה אחת. יחס הגובה-רוחב המומלץ הוא 16:9 הערה: אם מוסיפים תג, צריך להקפיד על אזור בטוח של 24 dps בחלק העליון והתחתון של התמונה. |
כדי לקבל הנחיות, כדאי לעיין במפרט לתמונות. |
| מיקום – מדינה | חובה | המדינה שבה נמצא מקום הלינה. | טקסט חופשי גודל טקסט מומלץ: עד כ-20 תווים |
| מיקום – עיר | חובה | העיר שבה נמצא מקום הלינה. | טקסט חופשי גודל טקסט מומלץ: עד כ-20 תווים |
| מיקום – כתובת לתצוגה | חובה | הכתובת שתוצג למשתמש. ברוב המקרים, מומלץ לכלול את שם העיר, ואולי גם את המדינה או האזור. צריך לכלול את כתובת הרחוב או השכונה רק אם המשתמש נמצא בקרבת המיקום, אם המשתמש מכיר את המיקום או אם העיר כלולה בשם האשכול. אם אתם כוללים את הכתובת, ציינו כתובת תמציתית והשתמשו בקיצורים כשאפשר (לדוגמה, "רח'" במקום "רחוב"). | טקסט חופשי גודל טקסט מומלץ: עד כ-20 תווים |
| מיקום – כתובת | אופציונלי | הרחוב של מקום האירוח (אם רלוונטי). | טקסט חופשי גודל טקסט מומלץ: עד כ-20 תווים |
| מיקום – מדינה | אופציונלי | המדינה (State) או המחוז (אם רלוונטי) שבהם נמצא מקום האירוח. | טקסט חופשי גודל טקסט מומלץ: עד כ-20 תווים |
| מיקום – מיקוד | אופציונלי | המיקוד (אם רלוונטי) של מקום הלינה. | טקסט חופשי גודל טקסט מומלץ: עד כ-20 תווים |
| מיקום – שכונה | אופציונלי | השכונה (אם רלוונטי) שבה נמצא מקום האירוח. | טקסט חופשי גודל טקסט מומלץ: עד כ-20 תווים |
| תגים | אופציונלי |
כל תג יכול להיות טקסט חופשי (עד 15 תווים) או תמונה קטנה. |
|
| תג – טקסט | אופציונלי | שם התג הערה: חובה להוסיף טקסט או תמונה לתג. |
טקסט חופשי גודל טקסט מומלץ: עד 15 תווים |
| תג – תמונה | אופציונלי | תמונה קטנה טיפול מיוחד בחוויית המשתמש, למשל שכבת-על של תג על התמונה הממוזערת של התמונה או הסרטון. הערה: חובה להוסיף טקסט או תמונה לתג. |
כדי לקבל הנחיות, כדאי לעיין במפרט לתמונות. |
| תיאור | אופציונלי | פסקה אחת של טקסט שמתארת את הישות. הערה: למשתמש יוצג התיאור או רשימת כותרות המשנה, אבל לא שניהם. |
טקסט חופשי אורך טקסט מומלץ: 180 תווים |
| רשימת כתוביות | אופציונלי | עד 3 כותרות משנה, כשכל כותרת משנה היא שורת טקסט אחת. הערה: למשתמש יוצג התיאור או רשימת כותרות המשנה, אבל לא שניהם. |
טקסט חופשי גודל הטקסט המומלץ לכל כתובית: עד 50 תווים |
| AvailabilityTimeWindow - Localized Start Time - Timestamp | אופציונלי | חותמת הזמן של התקופה שבה המלון צפוי להיות פתוח או זמין. | Joda-Time Instant |
| AvailabilityTimeWindow – שעת התחלה מקומית – אזור זמן | אופציונלי | אזור הזמן שבו המלון צפוי להיות פתוח או זמין. |
Joda-Time DateTimeZone אפשר לעיין במפרט של אזורי זמן כדי לקבל הנחיות. |
| AvailabilityTimeWindow – שעת סיום מקומית – חותמת זמן | אופציונלי | חותמת הזמן של התקופה שעד אליה המלון צפוי להיות פתוח או זמין. | Joda-Time Instant |
| AvailabilityTimeWindow – שעת סיום מקומית – אזור זמן | אופציונלי | אזור הזמן שבו המלון צפוי להיות פתוח או זמין. |
Joda-Time DateTimeZone אפשר לעיין במפרט של אזורי זמן כדי לקבל הנחיות. |
| דירוג – ערך מקסימלי | אופציונלי | הערך המקסימלי של סולם הדירוג. חובה לציין את הערך הזה אם מציינים גם את הערך הנוכחי של הדירוג. |
מספר >= 0.0 |
| דירוג – ערך נוכחי | אופציונלי | הערך הנוכחי של סולם הדירוג. חובה לציין את הערך הזה אם מציינים גם את ערך הדירוג המקסימלי. |
מספר >= 0.0 |
| דירוג – מספר | אופציונלי | מספר הדירוגים של מקום האירוח. הערה: צריך לספק את השדה הזה אם רוצים שהאפליקציה תשלוט באופן שבו הוא מוצג למשתמשים. צריך לספק מחרוזת תמציתית שאפשר להציג למשתמש. לדוגמה, אם המספר הוא 1,000,000, כדאי להשתמש בקיצורים כמו 1M, כדי שהמספר לא ייחתך במסכים קטנים יותר. |
מחרוזת |
| דירוג – ערך הספירה | אופציונלי | מספר הדירוגים של מקום האירוח. הערה: צריך לספק את השדה הזה אם לא רוצים לטפל בעצמכם בלוגיקה של קיצור התצוגה. אם גם Count וגם Count Value קיימים, נשתמש ב-Count כדי להציג למשתמשים |
ארוך |
| Price - CurrentPrice | חובה בתנאים מסוימים | המחיר הנוכחי של מקום האירוח. חובה לציין את המאפיין הזה אם מציינים מחיר קודם מחוק. |
טקסט חופשי |
| Price - 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 יחידות dp בחלק העליון ובחלק התחתון של התמונה |
כדי לקבל הנחיות, כדאי לעיין במפרט לתמונות. |
| מועד ההתעניינות האחרון | חובה בתנאים מסוימים |
חותמת הזמן של התקופה שבה המשתמש היה באינטראקציה אחרונה עם הישות הזו. הערה: השדה הזה הוא חובה אם הישות היא חלק מאשכול של המשך חיפוש. |
Joda-Time Instant |
| מיקום – מדינה | חובה בתנאים מסוימים |
המדינה שבה נמצאת נקודת העניין. הערה: השדה הזה הוא חובה אם הישות היא חלק מאשכול המלצות. |
טקסט חופשי גודל טקסט מומלץ: עד כ-20 תווים |
| מיקום – עיר | חובה בתנאים מסוימים |
העיר שבה נמצאת נקודת העניין. הערה: השדה הזה הוא חובה אם הישות היא חלק מאשכול המלצות. |
טקסט חופשי גודל טקסט מומלץ: עד כ-20 תווים |
| מיקום – כתובת לתצוגה | חובה בתנאים מסוימים |
הכתובת שתוצג למשתמש. צריך לציין כתובת תמציתית, ולהשתמש בקיצורים כשאפשר (לדוגמה, "רח'" במקום "רחוב"). המחרוזת הזו עשויה להיחתך בהתאם למכשיר ולהגדרות של המשתמש. כדאי לכלול את שם העיר כדי שהזיהוי יהיה ברור. הערה: השדה הזה הוא חובה אם הישות היא חלק מאשכול המלצות. |
טקסט חופשי גודל טקסט מומלץ: עד כ-35 תווים |
| מיקום – כתובת | אופציונלי | הרחוב (אם רלוונטי) של נקודת העניין. | טקסט חופשי גודל טקסט מומלץ: עד כ-20 תווים |
| מיקום – מדינה | אופציונלי | המדינה (State) או המחוז (אם רלוונטי) שבהם נמצאת נקודת העניין. | טקסט חופשי גודל טקסט מומלץ: עד כ-20 תווים |
| מיקום – מיקוד | אופציונלי | המיקוד (אם רלוונטי) של נקודת העניין. | טקסט חופשי גודל טקסט מומלץ: עד כ-20 תווים |
| מיקום – שכונה | אופציונלי | השכונה (אם רלוונטי) של נקודת העניין. | טקסט חופשי גודל טקסט מומלץ: עד כ-20 תווים |
| AvailabilityTimeWindow - Localized Start Time - Timestamp | אופציונלי | חותמת הזמן של התקופה שבה נקודת העניין צפויה להיות פתוחה או זמינה. | Joda-Time Instant |
| AvailabilityTimeWindow – שעת התחלה מקומית – אזור זמן | אופציונלי | אזור הזמן שבו נקודת העניין צפויה להיות פתוחה או זמינה. |
Joda-Time DateTimeZone אפשר לעיין במפרט של אזורי זמן כדי לקבל הנחיות. |
| AvailabilityTimeWindow – שעת סיום מקומית – חותמת זמן | אופציונלי | חותמת הזמן של התקופה שעד אליה הנקודה אמורה להיות פתוחה או זמינה. | Joda-Time Instant |
| AvailabilityTimeWindow – שעת סיום מקומית – אזור זמן | אופציונלי | אזור הזמן שבו נקודת העניין צפויה להיות פתוחה או זמינה. |
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 תווים (אם הטקסט ארוך מדי, יכול להיות שיוצגו שלוש נקודות) |
| קטגוריות תוכן | אופציונלי | תארו את קטגוריית התוכן של הישות. | רשימה של טיפוסים בני מנייה (enum) שעומדים בדרישות
אפשר לעיין בקטע "קטגוריית תוכן" כדי לקבל הנחיות. |
| DisplayTimeWindow (אופציונלי) – הגדרת חלון זמן להצגת תוכן בפלטפורמה | |||
| חותמת הזמן של ההתחלה | אופציונלי |
חותמת הזמן של התקופה שאחריה התוכן אמור להופיע בפלטפורמה. אם המדיניות לא מוגדרת, אפשר להציג תוכן בפלטפורמה. |
חותמת זמן של תקופת זמן המערכת באלפיות השנייה |
| חותמת זמן של סיום | אופציונלי |
חותמת הזמן של התקופה שאחריה התוכן לא מוצג יותר בפלטפורמה. אם המדיניות לא מוגדרת, אפשר להציג תוכן בפלטפורמה. |
חותמת זמן של תקופת זמן המערכת באלפיות השנייה |
RestaurantReservationEntity
| מאפיין | דרישה | תיאור | פורמט |
|---|---|---|---|
| URI של הפעולה | חובה |
קישור עומק לישות באפליקציה של הספק. הערה: אפשר להשתמש בקישורי עומק לצורך שיוך (Attribution). כדאי לעיין בשאלות הנפוצות האלה |
URI |
| כותרת | חובה | שם הישות. | מחרוזת אורך הטקסט המומלץ: עד 50 תווים |
| שעת ההתחלה של ההזמנה לפי השעון המקומי – חותמת זמן | חובה | חותמת הזמן של התאריך והשעה שבהם ההזמנה צפויה להתחיל. | Joda-Time Instant |
| שעת ההתחלה של ההזמנה לפי המיקום – אזור זמן | חובה | אזור הזמן שבו ההזמנה צפויה להתחיל. |
Joda-Time DateTimeZone אפשר לעיין במפרט של אזורי זמן כדי לקבל הנחיות. |
| מיקום – מדינה | חובה | המדינה שבה המסעדה נמצאת. | טקסט חופשי גודל טקסט מומלץ: עד כ-20 תווים |
| מיקום – עיר | חובה | העיר שבה המסעדה נמצאת. | טקסט חופשי גודל טקסט מומלץ: עד כ-20 תווים |
| מיקום – כתובת לתצוגה | חובה | הכתובת של המסעדה שתוצג למשתמש. | טקסט חופשי גודל טקסט מומלץ: עד כ-20 תווים |
| מיקום – כתובת | אופציונלי | הכתובת (אם רלוונטי) של המסעדה. | טקסט חופשי גודל טקסט מומלץ: עד כ-20 תווים |
| מיקום – מדינה | אופציונלי | המדינה (State) או המחוז (אם רלוונטי) שבהם המסעדה נמצאת. | טקסט חופשי גודל טקסט מומלץ: עד כ-20 תווים |
| מיקום – מיקוד | אופציונלי | המיקוד של המסעדה (אם רלוונטי). | טקסט חופשי גודל טקסט מומלץ: עד כ-20 תווים |
| מיקום – שכונה | אופציונלי | השכונה (אם רלוונטי) שבה נמצאת המסעדה. | טקסט חופשי גודל טקסט מומלץ: עד כ-20 תווים |
| תמונות של פוסטרים | אופציונלי | אם תספקו כמה תמונות, נציג רק תמונה אחת. יחס הגובה-רוחב המומלץ הוא 16:9 | כדי לקבל הנחיות, כדאי לעיין במפרט לתמונות. |
| תיאור | אופציונלי | פסקה אחת של טקסט שמתארת את הישות. הערה: למשתמש יוצג התיאור או רשימת כותרות המשנה, אבל לא שניהם. |
טקסט חופשי אורך טקסט מומלץ: 180 תווים |
| רשימת כתוביות | אופציונלי | עד 3 כותרות משנה, כשכל כותרת משנה היא שורת טקסט אחת. הערה: למשתמש יוצג התיאור או רשימת כותרות המשנה, אבל לא שניהם. |
טקסט חופשי גודל הטקסט המומלץ לכל כתובית: עד 50 תווים |
| גודל השולחן | אופציונלי | מספר האנשים בקבוצה שהוזמן לה מקום | מספר שלם > 0 |
| DisplayTimeWindow (אופציונלי) – הגדרת חלון זמן להצגת תוכן בפלטפורמה | |||
| חותמת הזמן של ההתחלה | אופציונלי |
חותמת הזמן של התקופה שאחריה התוכן אמור להופיע בפלטפורמה. אם המדיניות לא מוגדרת, אפשר להציג תוכן בפלטפורמה. |
חותמת זמן של תקופת זמן המערכת באלפיות השנייה |
| חותמת זמן של סיום | אופציונלי |
חותמת הזמן של התקופה שאחריה התוכן לא מוצג יותר בפלטפורמה. אם המדיניות לא מוגדרת, אפשר להציג תוכן בפלטפורמה. |
חותמת זמן של תקופת זמן המערכת באלפיות השנייה |
EventReservationEntity
| מאפיין | דרישה | תיאור | פורמט |
|---|---|---|---|
| URI של הפעולה | חובה |
קישור עומק לישות באפליקציה של הספק. הערה: אפשר להשתמש בקישורי עומק לצורך שיוך (Attribution). כדאי לעיין בשאלות הנפוצות האלה |
URI |
| כותרת | חובה | שם הישות. | מחרוזת אורך הטקסט המומלץ: עד 50 תווים |
| שעת התחלה מקומית – חותמת זמן | חובה |
חותמת הזמן של התאריך שבו האירוע צפוי להתחיל. |
Joda-Time Instant |
| שעת התחלה מקומית – אזור זמן | חובה |
אזור הזמן שבו האירוע צפוי להתחיל. |
Joda-Time DateTimeZone אפשר לעיין במפרט של אזורי זמן כדי לקבל הנחיות. |
| מצב אירוע | חובה | שדה שמציין אם האירוע יהיה וירטואלי, פיזי או גם וגם. |
ערכים אפשריים: VIRTUAL, IN_PERSON או HYBRID |
| מיקום – מדינה | חובה בתנאים מסוימים | המדינה שבה האירוע מתקיים. הערה: השדה הזה נדרש לאירועים מסוג IN_PERSON או HYBRID. |
טקסט חופשי גודל טקסט מומלץ: עד כ-20 תווים |
| מיקום – עיר | חובה בתנאים מסוימים | העיר שבה האירוע מתרחש. הערה: השדה הזה נדרש לאירועים מסוג IN_PERSON או HYBRID. |
טקסט חופשי גודל טקסט מומלץ: עד כ-20 תווים |
| מיקום – כתובת לתצוגה | חובה בתנאים מסוימים | הכתובת או שם המקום שבו האירוע יתקיים, שיוצגו למשתמש. הערה: השדה הזה נדרש לאירועים מסוג IN_PERSON או HYBRID. |
טקסט חופשי גודל טקסט מומלץ: עד כ-20 תווים |
| מיקום – כתובת | אופציונלי | הכתובת (אם רלוונטי) של המיקום שבו מתקיים האירוע. | טקסט חופשי גודל טקסט מומלץ: עד כ-20 תווים |
| מיקום – מדינה | אופציונלי | המדינה (State) או המחוז (אם רלוונטי) שבהם האירוע מתקיים. | טקסט חופשי גודל טקסט מומלץ: עד כ-20 תווים |
| מיקום – מיקוד | אופציונלי | המיקוד (אם רלוונטי) של המיקום שבו מתקיים האירוע. | טקסט חופשי גודל טקסט מומלץ: עד כ-20 תווים |
| מיקום – שכונה | אופציונלי | השכונה (אם רלוונטי) שבה האירוע מתקיים. | טקסט חופשי גודל טקסט מומלץ: עד כ-20 תווים |
| תמונות של פוסטרים | אופציונלי | אם תספקו כמה תמונות, נציג רק תמונה אחת. יחס הגובה-רוחב המומלץ הוא 16:9 הערה: מומלץ מאוד להוסיף תמונה. אם מוסיפים תג, צריך לוודא שיש אזור בטוח של 24 dps גם בחלק העליון וגם בחלק התחתון של התמונה. |
כדי לקבל הנחיות, כדאי לעיין במפרט לתמונות. |
| שעת סיום מקומית – חותמת זמן | אופציונלי |
חותמת הזמן של התקופה שבה האירוע צפוי להסתיים. |
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 כדי להציג למשתמשים |
ארוך |
| קטגוריות תוכן | אופציונלי | תארו את קטגוריית התוכן של הישות. | רשימה של טיפוסים בני מנייה (enum) שעומדים בדרישות
אפשר לעיין בקטע "קטגוריית תוכן" כדי לקבל הנחיות. |
| DisplayTimeWindow (אופציונלי) – הגדרת חלון זמן להצגת תוכן בפלטפורמה | |||
| חותמת הזמן של ההתחלה | אופציונלי |
חותמת הזמן של התקופה שאחריה התוכן אמור להופיע בפלטפורמה. אם המדיניות לא מוגדרת, אפשר להציג תוכן בפלטפורמה. |
חותמת זמן של תקופת זמן המערכת באלפיות השנייה |
| חותמת זמן של סיום | אופציונלי |
חותמת הזמן של התקופה שאחריה התוכן לא מוצג יותר בפלטפורמה. אם המדיניות לא מוגדרת, אפשר להציג תוכן בפלטפורמה. |
חותמת זמן של תקופת זמן המערכת באלפיות השנייה |
LodgingReservationEntity
| מאפיין | דרישה | תיאור | פורמט |
|---|---|---|---|
| URI של הפעולה | חובה |
קישור עומק לישות באפליקציה של הספק. הערה: אפשר להשתמש בקישורי עומק לצורך שיוך (Attribution). כדאי לעיין בשאלות הנפוצות האלה |
URI |
| כותרת | חובה | שם הישות. | טקסט חופשי. לדוגמה, "השהות שלך החל מ-12 בדצמבר" אורך הטקסט המומלץ: עד 50 תווים |
| שעת הצ'ק-אין המקומית – חותמת זמן | חובה | חותמת הזמן של התקופה שמייצגת את שעת הצ'ק-אין של ההזמנה. | Joda-Time Instant |
| שעת הצ'ק-אין המקומית – אזור זמן | חובה | אזור הזמן של שעת הצ'ק-אין בהזמנה. |
Joda-Time DateTimeZone אפשר לעיין במפרט של אזורי זמן כדי לקבל הנחיות. |
| שעת הצ'ק-אאוט המקומית – חותמת זמן | חובה | חותמת הזמן של התקופה שמייצגת את שעת הצ'ק-אאוט של ההזמנה. | Joda-Time Instant |
| שעת הצ'ק אאוט המקומית – אזור זמן | חובה | אזור הזמן של שעת הצ'ק-אאוט של ההזמנה. |
Joda-Time DateTimeZone אפשר לעיין במפרט של אזורי זמן כדי לקבל הנחיות. |
| מיקום – מדינה | חובה | המדינה שבה נמצא מקום האירוח. | טקסט חופשי גודל טקסט מומלץ: עד כ-20 תווים |
| מיקום – עיר | חובה | העיר שבה נמצא מקום האירוח. | טקסט חופשי גודל טקסט מומלץ: עד כ-20 תווים |
| מיקום – כתובת לתצוגה | חובה | הכתובת שתוצג למשתמש. צריך להזין כתובת תמציתית ולהשתמש בקיצורים כשאפשר (לדוגמה, "רח'" במקום "רחוב"). יכול להיות שהמחרוזת הזו תיחתך בהתאם למכשיר ולהגדרות של המשתמש. כדי לזהות את המיקום בבירור, צריך לכלול את שם העיר. | טקסט חופשי גודל טקסט מומלץ: עד כ-35 תווים |
| מיקום – כתובת | אופציונלי | הרחוב של מקום האירוח (אם רלוונטי). | טקסט חופשי גודל טקסט מומלץ: עד כ-20 תווים |
| מיקום – מדינה | אופציונלי | המדינה (State) או המחוז (אם רלוונטי) שבהם נמצא מקום האירוח. | טקסט חופשי גודל טקסט מומלץ: עד כ-20 תווים |
| מיקום – מיקוד | אופציונלי | המיקוד (אם רלוונטי) של מקום הלינה. | טקסט חופשי גודל טקסט מומלץ: עד כ-20 תווים |
| מיקום – שכונה | אופציונלי | השכונה (אם רלוונטי) שבה נמצא מקום האירוח. | טקסט חופשי גודל טקסט מומלץ: עד כ-20 תווים |
| תמונות של פוסטרים | אופציונלי |
אם תספקו כמה תמונות, נציג רק תמונה אחת. יחס הגובה-רוחב המומלץ הוא 16:9 הערה: אם מוסיפים תג, צריך להקפיד על אזור בטוח של 24 dps בחלק העליון והתחתון של התמונה. |
כדי לקבל הנחיות, כדאי לעיין במפרט לתמונות. |
| תיאור | אופציונלי | פסקה אחת של טקסט שמתארת את הישות. הערה: למשתמש יוצג התיאור או רשימת כותרות המשנה, אבל לא שניהם. |
טקסט חופשי אורך טקסט מומלץ: 180 תווים |
| רשימת כתוביות | אופציונלי | עד 3 כותרות משנה, כשכל כותרת משנה היא שורת טקסט אחת. הערה: למשתמש יוצג התיאור או רשימת כותרות המשנה, אבל לא שניהם. |
טקסט חופשי גודל הטקסט המומלץ לכל כתובית: עד 50 תווים |
| מזהה ההזמנה | אופציונלי | מזהה ההזמנה של מקום הלינה. | טקסט חופשי |
| דירוג – ערך מקסימלי | אופציונלי | הערך המקסימלי של סולם הדירוג. חובה לציין את הערך הזה אם מציינים גם את הערך הנוכחי של הדירוג. |
מספר >= 0.0 |
| דירוג – ערך נוכחי | אופציונלי | הערך הנוכחי של סולם הדירוג. חובה לציין את הערך הזה אם מציינים גם את ערך הדירוג המקסימלי. |
מספר >= 0.0 |
| דירוג – מספר | אופציונלי | מספר הדירוגים של מקום האירוח. הערה: צריך לספק את השדה הזה אם רוצים שהאפליקציה תשלוט באופן שבו הוא מוצג למשתמשים. צריך לספק מחרוזת תמציתית שאפשר להציג למשתמש. לדוגמה, אם המספר הוא 1,000,000, כדאי להשתמש בקיצורים כמו 1M, כדי שהמספר לא ייחתך במסכים קטנים יותר. |
מחרוזת |
| דירוג – ערך הספירה | אופציונלי | מספר הדירוגים של מקום האירוח. הערה: צריך לספק את השדה הזה אם לא רוצים לטפל בעצמכם בלוגיקה של קיצור התצוגה. אם גם Count וגם Count Value קיימים, נשתמש ב-Count כדי להציג למשתמשים |
ארוך |
| Price - CurrentPrice | חובה בתנאים מסוימים | המחיר הנוכחי של מקום האירוח. חובה לציין את המאפיין הזה אם מציינים מחיר קודם מחוק. |
טקסט חופשי |
| Price - 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 תווים |
| מיקום היציאה – מדינה (State) | אופציונלי | המדינה או המחוז (אם רלוונטי) של מיקום היציאה. | טקסט חופשי גודל טקסט מומלץ: עד כ-20 תווים |
| מיקום היציאה – מיקוד | אופציונלי | המיקוד (אם רלוונטי) של מיקום היציאה. | טקסט חופשי גודל טקסט מומלץ: עד כ-20 תווים |
| מיקום היציאה – שכונה | אופציונלי | השכונה (אם רלוונטי) של מיקום היציאה. | טקסט חופשי גודל טקסט מומלץ: עד כ-20 תווים |
| מיקום ההגעה – מדינה | אופציונלי | מדינת היעד. | טקסט חופשי גודל טקסט מומלץ: עד כ-20 תווים |
| מיקום ההגעה – עיר | אופציונלי | עיר היעד. | טקסט חופשי גודל טקסט מומלץ: עד כ-20 תווים |
| מיקום ההגעה – כתובת לתצוגה | אופציונלי | מיקום ההגעה שיוצג למשתמש. | טקסט חופשי גודל טקסט מומלץ: עד כ-20 תווים |
| מיקום ההגעה – כתובת | אופציונלי | הכתובת (אם רלוונטי) של מיקום היעד. | טקסט חופשי גודל טקסט מומלץ: עד כ-20 תווים |
| מיקום ההגעה – מדינה | אופציונלי | המדינה (State) או המחוז (אם רלוונטי) של מיקום ההגעה. | טקסט חופשי גודל טקסט מומלץ: עד כ-20 תווים |
| מיקום ההגעה – מיקוד | אופציונלי | המיקוד (אם רלוונטי) של מיקום ההגעה. | טקסט חופשי גודל טקסט מומלץ: עד כ-20 תווים |
| מיקום ההגעה – שכונה | אופציונלי | השכונה (אם רלוונטי) של מיקום היעד. | טקסט חופשי גודל טקסט מומלץ: עד כ-20 תווים |
| ספק שירות – שם | אופציונלי |
שם ספק השירות. הערה: חובה להוסיף טקסט או תמונה לספק השירות. |
טקסט חופשי. לדוגמה, שם חברת התעופה |
| ספק שירות – תמונה | אופציונלי |
הלוגו או התמונה של ספק השירות. הערה: חובה להוסיף טקסט או תמונה לספק השירות. |
כדי לקבל הנחיות, כדאי לעיין במפרט לתמונות. |
| תמונות של פוסטרים | אופציונלי |
אם תספקו כמה תמונות, נציג רק תמונה אחת. יחס הגובה-רוחב המומלץ הוא 16:9 |
כדי לקבל הנחיות, כדאי לעיין במפרט לתמונות. |
| תיאור | אופציונלי | פסקה אחת של טקסט שמתארת את הישות. הערה: למשתמש יוצג התיאור או רשימת כותרות המשנה, אבל לא שניהם. |
טקסט חופשי אורך טקסט מומלץ: 180 תווים |
| רשימת כתוביות | אופציונלי | עד 3 כותרות משנה, כשכל כותרת משנה היא שורת טקסט אחת. הערה: למשתמש יוצג התיאור או רשימת כותרות המשנה, אבל לא שניהם. |
טקסט חופשי גודל הטקסט המומלץ לכל כתובית: עד 50 תווים |
| מזהה ההזמנה | אופציונלי | מזהה ההזמנה של הנסיעה. | טקסט חופשי |
| Price - CurrentPrice | חובה בתנאים מסוימים | המחיר הנוכחי של ההזמנה. חובה לציין את המאפיין הזה אם מציינים מחיר קודם מחוק. |
טקסט חופשי |
| Price - 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 תווים |
| כתובת האיסוף – מדינה | אופציונלי | המדינה (State) או המחוז (אם רלוונטי) של נקודת האיסוף. | טקסט חופשי גודל טקסט מומלץ: עד כ-20 תווים |
| כתובת האיסוף – מיקוד | אופציונלי | המיקוד (אם רלוונטי) של נקודת האיסוף. | טקסט חופשי גודל טקסט מומלץ: עד כ-20 תווים |
| כתובת האיסוף – שכונה | אופציונלי | השכונה (אם רלוונטי) של נקודת האיסוף. | טקסט חופשי גודל טקסט מומלץ: עד כ-20 תווים |
| כתובת להחזרה – מדינה | אופציונלי | המדינה שבה נמצא המיקום להחזרות. | טקסט חופשי גודל טקסט מומלץ: עד כ-20 תווים |
| כתובת להחזרה – עיר | אופציונלי | העיר שבה נמצא המיקום להחזרות. | טקסט חופשי גודל טקסט מומלץ: עד כ-20 תווים |
| כתובת להחזרה – כתובת לתצוגה | אופציונלי | המיקום להחזרות שיוצג למשתמש. | טקסט חופשי גודל טקסט מומלץ: עד כ-20 תווים |
| כתובת להחזרה – רחוב ומספר בית | אופציונלי | כתובת הרחוב (אם רלוונטי) של המיקום להחזרות. | טקסט חופשי גודל טקסט מומלץ: עד כ-20 תווים |
| כתובת להחזרה – מדינה | אופציונלי | המדינה (State) או המחוז (אם רלוונטי) של המיקום להחזרות. | טקסט חופשי גודל טקסט מומלץ: עד כ-20 תווים |
| כתובת להחזרה – מיקוד | אופציונלי | המיקוד (אם רלוונטי) של המיקום להחזרות. | טקסט חופשי גודל טקסט מומלץ: עד כ-20 תווים |
| כתובת להחזרה – שכונה | אופציונלי | השכונה (אם רלוונטי) של המיקום להחזרות. | טקסט חופשי גודל טקסט מומלץ: עד כ-20 תווים |
| ספק שירות – שם | אופציונלי |
שם ספק השירות. הערה: חובה להוסיף טקסט או תמונה לספק השירות. |
טקסט חופשי. לדוגמה, "Avis השכרת רכב" |
| ספק שירות – תמונה | אופציונלי |
הלוגו או התמונה של ספק השירות. הערה: חובה להוסיף טקסט או תמונה לספק השירות. |
כדי לקבל הנחיות, כדאי לעיין במפרט לתמונות. |
| תמונות של פוסטרים | אופציונלי |
אם תספקו כמה תמונות, נציג רק תמונה אחת. יחס הגובה-רוחב המומלץ הוא 16:9 |
כדי לקבל הנחיות, כדאי לעיין במפרט לתמונות. |
| תיאור | אופציונלי | פסקה אחת של טקסט שמתארת את הישות. הערה: למשתמש יוצג התיאור או רשימת כותרות המשנה, אבל לא שניהם. |
טקסט חופשי אורך טקסט מומלץ: 180 תווים |
| רשימת כתוביות | אופציונלי | עד 3 כותרות משנה, כשכל כותרת משנה היא שורת טקסט אחת. הערה: למשתמש יוצג התיאור או רשימת כותרות המשנה, אבל לא שניהם. |
טקסט חופשי גודל הטקסט המומלץ לכל כתובית: עד 50 תווים |
| מזהה האישור | אופציונלי | מזהה האישור של הזמנת הרכב השכור. | טקסט חופשי |
| Price - CurrentPrice | חובה בתנאים מסוימים | המחיר הנוכחי של ההזמנה. חובה לציין את המאפיין הזה אם מציינים מחיר קודם מחוק. |
טקסט חופשי |
| Price - StrikethroughPrice | אופציונלי | המחיר המקורי של ההזמנה, שיוצג עם קו חוצה בממשק המשתמש. | טקסט חופשי |
| יתרונות מרכזיים של מחיר | אופציונלי | הצגת מחיר כדי להבליט מבצע, אירוע או הנחה לחברי מועדון, אם יש כאלה. | טקסט חופשי אורך הטקסט המומלץ: פחות מ-45 תווים (טקסט ארוך מדי עלול להופיע עם שלוש נקודות) |
| DisplayTimeWindow (אופציונלי) – הגדרת חלון זמן להצגת תוכן בפלטפורמה | |||
| חותמת הזמן של ההתחלה | אופציונלי |
חותמת הזמן של התקופה שאחריה התוכן אמור להופיע בפלטפורמה. אם המדיניות לא מוגדרת, אפשר להציג תוכן בפלטפורמה. |
חותמת זמן של תקופת זמן המערכת באלפיות השנייה |
| חותמת זמן של סיום | אופציונלי |
חותמת הזמן של התקופה שאחריה התוכן לא מוצג יותר בפלטפורמה. אם המדיניות לא מוגדרת, אפשר להציג תוכן בפלטפורמה. |
חותמת זמן של תקופת זמן המערכת באלפיות השנייה |
מפרט לתמונות
בטבלה הבאה מפורטות הדרישות לגבי נכסי תמונות:
| יחס גובה-רוחב | אשכולות נתמכים | מספר פיקסלים מינימלי | מספר פיקסלים מומלץ |
|---|---|---|---|
| תמונה לרוחב (16:9, 1.91X1) | מומלץ, הזמנה, המשך חיפוש והמלצה (עדיף 16:9) | 640x360 (16:9) / 600x314 (1.91x1) | 1,264 x 712 (16:9) / 1,200 x 628 (1.91x1) |
| תמונה ריבועית (1x1) | כל האשכולות (מועדף עבור StoreEntity; נדרש עבור תמונות של ספק השירות והתג) |
300x300 | 1,200x1,200 |
| לאורך (4x5) | המלצה | 480x600 | 960x1,200 |
התמונות צריכות להתארח ברשתות CDN ציבוריות כדי ש-Google תוכל לגשת אליהן.
פורמט קובץ
PNG, JPG, GIF סטטי, WebP
גודל קובץ מקסימלי
5,120KB
המלצות נוספות
- האזור הבטוח לתמונות: צריך למקם את התוכן החשוב במרכז התמונה, והוא צריך להשתרע על פני 80% מהשטח שלה.
- כדאי להשתמש ברקע שקוף כדי שהתמונה תוצג כמו שצריך בהגדרות של עיצוב כהה ובהיר.
מפרט אזור הזמן
עדיף להשתמש במזהה (לדוגמה, "America/Los_Angeles") ולא בהיסט (לדוגמה, "-07:00").
דוגמה לשימוש: DateTimeZone.forID("America/Los_Angeles")
קטגוריית התוכן
קטגוריית התוכן מאפשרת לאפליקציות לפרסם תוכן ששייך לכמה קטגוריות. הפעולה הזו ממפה את התוכן עם חלק מהקטגוריות המוגדרות מראש, כלומר:
TYPE_EDUCATIONTYPE_SPORTSTYPE_MOVIES_AND_TV_SHOWSTYPE_BOOKSTYPE_AUDIOBOOKSTYPE_MUSICTYPE_DIGITAL_GAMESTYPE_TRAVEL_AND_LOCALTYPE_HOME_AND_AUTOTYPE_BUSINESSTYPE_NEWSTYPE_FOOD_AND_DRINKTYPE_SHOPPINGTYPE_HEALTH_AND_FITENESSTYPE_MEDICALTYPE_PARENTINGTYPE_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 לפרסום אשכולות בלקוח:
isServiceAvailablepublishRecommendationClusterspublishFeaturedClusterpublishReservationClusterpublishContinueSearchClusterpublishUserAccountManagementRequestupdatePublishStatusdeleteRecommendationsClustersdeleteFeaturedClusterdeleteReservationClusterdeleteContinueSearchClusterdeleteUserManagementClusterdeleteClusters
isServiceAvailable
ה-API הזה משמש כדי לבדוק אם השירות זמין לשילוב ואם אפשר להציג את התוכן במכשיר.
Engage SDK מגרסה 1.6.0 ואילך (מומלץ)
מיומנויות ב-Android
הצגה ב-GitHubשילוב של Engage SDK
android skills add engage-sdk-integrationUse the engage-sdk-integration skill to use Engage SDK 1.6.0 and refactor isServiceAvailable to pass ServiceAvailabilityRequest for publishing all cluster types.אתם יכולים לבדוק את זמינות השירות לכל סוג אשכול שאתם מתכוונים לפרסם. isServiceAvailable API מקבל אובייקט בקשה, ServiceAvailabilityRequest, שמכיל את סוגי האשכולות שצריך לבדוק את זמינות השירות שלהם. בטבלה הבאה מפורטים ערכי ה-enum של ClusterType שנדרשים ל-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 לסירוגין כדי להפחית את עלויות מודעות שהוצגו. עם זאת, אסטרטגיית ניתוח התוכן לסירוגין משפיעה לרעה על חוויית המשתמש: תוכן מיושן לא יוצג, וחלק מהפלטפורמות לא יציגו תוכן.
החל מגרסה 1.6.0, Engage SDK מאפשר לבדוק את הזמינות של סוגי אשכולות ספציפיים. אם האפליקציה שלכם משתמשת בהטמעה לסירוגין:
- אשכולות המשך (כמו "הזמנה" ו"המשך החיפוש") נשארים מופעלים כברירת מחדל בכל המכשירים הנתמכים.
- סוגים אחרים של אשכולות (כמו המלצות) מופעלים ומושבתים לסירוגין.
אם הגדרת ברירת המחדל הזו לא מתאימה לצרכים שלכם, פנו אל 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קיימים של שותף הפיתוח יוסרו. - הנתונים מהבקשה מנותחים ונשמרים באשכול ההמלצות המעודכן.
אם יש שגיאה, כל הבקשה נדחית והמצב הקיים נשמר.
publishFeaturedCluster
ה-API הזה משמש לפרסום רשימה של אובייקטים מסוג FeaturedCluster.
Kotlin
client.publishFeaturedCluster(
PublishFeaturedClusterRequest.Builder()
.setFeaturedCluster(
FeaturedCluster.Builder()
.addEntity(entity1)
.addEntity(entity2)
.build())
.build())
Java
client.publishFeaturedCluster(
new PublishFeaturedClusterRequest.Builder()
.setFeaturedCluster(
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 | הכותרת בכרטיס |
| טקסט פעולה | אופציונלי | הטקסט שמוצג ב-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());
deleteRecommendationsClusters
ה-API הזה משמש למחיקת התוכן של אשכולות ההמלצות.
Kotlin
client.deleteRecommendationsClusters()
Java
client.deleteRecommendationsClusters();
כשהשירות מקבל את הבקשה, הוא מסיר את הנתונים הקיימים מאשכולות ההמלצות. אם יש שגיאה, כל הבקשה נדחית והמצב הקיים נשמר.
deleteFeaturedCluster
ה-API הזה משמש למחיקת התוכן של אשכול מומלץ.
Kotlin
client.deleteFeaturedCluster()
Java
client.deleteFeaturedCluster();
כשהשירות מקבל את הבקשה, הוא מסיר את הנתונים הקיימים מהאשכול הנבחר. אם יש שגיאה, כל הבקשה נדחית והמצב הקיים נשמר.
deleteReservationCluster
ה-API הזה משמש למחיקת התוכן של אשכול ההזמנות.
Kotlin
client.deleteReservationCluster()
Java
client.deleteReservationCluster();
כשהשירות מקבל את הבקשה, הוא מסיר את הנתונים הקיימים מ-Reservation Cluster. אם יש שגיאה, כל הבקשה נדחית והמצב הקיים נשמר.
deleteUserManagementCluster
ה-API הזה משמש למחיקת התוכן של אשכול UserAccountManagement.
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: טיפול ב-broadcast intents
בנוסף לביצוע קריאות ל-API לפרסום תוכן באמצעות משימה, צריך גם להגדיר BroadcastReceiver כדי לקבל את הבקשה לפרסום תוכן.
המטרה של כוונות שידור היא בעיקר להפעיל מחדש את האפליקציה ולאלץ סנכרון נתונים. כוונות שידור לא נועדו להישלח בתדירות גבוהה מאוד. הוא מופעל רק כששירות 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. ההרשאה הזו מאפשרת לאפליקציה לקבל כוונות שידור כשהיא לא פועלת, וגם לפרסם את התוכן.
<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כשמקבלים את ה-intent הזה.com.google.android.engage.action.PUBLISH_FEATUREDמומלץ להתחיל שיחתpublishFeaturedClusterכשמקבלים את ה-Intent הזה.com.google.android.engage.action.travel.PUBLISH_CONTINUE_SEARCHמומלץ להתחיל שיחתpublishContinueSearchClusterכשמקבלים את ה-intent הזה.com.google.android.engage.action.travel.PUBLISH_RESERVATIONמומלץ להתחיל שיחתpublishReservationClusterכשמקבלים את ה-intent הזה.
תהליך עבודה של שילוב
לקבלת מדריך מפורט לאימות השילוב לאחר השלמתו, ראו תהליך העבודה של המפתחים לשילוב עם Engage.
שאלות נפוצות
יצירת קשר
אם יש לכם שאלות במהלך תהליך השילוב, אתם יכולים לפנות אל engage-developers@google.com.
השלבים הבאים
אחרי שתשלימו את השילוב, אלה השלבים הבאים:
- שולחים אימייל לכתובת
engage-developers@google.comומצרפים את קובץ ה-APK המשולב שמוכן לבדיקה של Google. - Google מבצעת אימות ובדיקות פנימיות כדי לוודא שהשילוב פועל כצפוי. אם צריך לבצע שינויים, Google תפנה אליכם עם הפרטים הנדרשים.
- כשהבדיקה מסתיימת ולא נדרשים שינויים, Google יוצרת איתכם קשר כדי להודיע לכם שאתם יכולים להתחיל לפרסם את ה-APK המעודכן והמשולב בחנות Play.
- אחרי ש-Google תאשר שה-APK המעודכן פורסם בחנות Play, יכול להיות שאשכולות ההמלצות, התוכן המוצג, ההזמנות והמשך החיפוש יפורסמו ויוצגו למשתמשים.