כדי להגביר את ההתעניינות באפליקציה, כדאי להגיע למשתמשים במקומות שבהם הם נמצאים. אפשר לשלב את Engage SDK כדי להציג המלצות מותאמות אישית ותוכן המשך ישירות למשתמשים בכמה פלטפורמות במכשיר, כמו אוספים, חבילת הבידור וחנות Play. השילוב מוסיף פחות מ-50KB (לאחר דחיסה) לקובץ ה-APK הממוצע, וברוב האפליקציות הוא דורש כשבוע של זמן פיתוח. מידע נוסף זמין באתר העסקי שלנו.
המדריך הזה מכיל הוראות לשותפים מפתחים להעברת תוכן של נסיעות ואירועים לממשקי תוכן של Engage.
תמיכה בקטגוריות ובפלטפורמות
הזמינות של פלטפורמות Engage SDK מבוססת על קטגוריית התוכן של האפליקציה. בטבלה הבאה אפשר לראות את הקריטריונים לזכאות להצגת מוצרים בפלטפורמות ספציפיות:
| סטטוס | קטגוריית תוכן או תרחיש שימוש | משטחים נתמכים |
|---|---|---|
|
נתמך (אפשר להשתמש בכל הפלטפורמות) |
|
|
| לא נתמך |
|
כישורים ב-Android
הצגה ב-GitHubשילוב של Engage SDK
android skills add engage-sdk-integrationפרטי השילוב
הסברים על המונחים
השילוב הזה כולל את סוגי האשכולות הבאים: המלצה, מומלץ, הזמנה והמשך החיפוש.
באשכולות המלצות מוצגות הצעות מותאמות אישית לנסיעות ולאירועים ממפתחים שותפים. ההמלצות האלה יכולות להיות מותאמות אישית למשתמש או כלליות (למשל, פריטים פופולריים). הם מאפשרים להציג המלצות למאמרים, לאירועים, למקומות לינה או למקומות מעניינים.
- אוסף המלצות יכול לכלול
ArticleEntity,EventEntity,LodgingEntity,PointOfInterestEntityאוStoreEntityכרטיסי מוצר, אבל לא שילוב של סוגי ישויות שונים.
ההמלצות שלכם בנויות באופן הבא:
אוסף המלצות: תצוגה בממשק המשתמש שמכילה קבוצה של המלצות מאותו שותף פיתוח.
ישות: אובייקט שמייצג פריט יחיד באשכול. השילוב הזה מציע כמה ישויות שיוצגו באמצעות אשכול ההמלצות:
ArticleEntity: ArticleEntity מייצג המלצה לתוכן מבוסס-טקסט שקשור לנסיעות ולאירועים. אפשר להשתמש בו כדי ליצור מאמרים, פוסטים בבלוג, תוכן שיווקי, קטעי חדשות ועוד.
איור 1: ממשק משתמש שבו מוצג ArticleEntity יחיד באוסף ההמלצות. EventEntity: מייצג אירוע שיתרחש בעתיד. שעת ההתחלה של האירוע היא נתון חשוב שצריך להעביר למשתמשים.
איור 2: ממשק משתמש שבו מוצג EventEntity יחיד באשכול Recommendations. LodgingEntity: LodgingEntity מייצג מקום אירוח, כמו מלון, דירה או בית נופש להשכרה לטווח קצר או ארוך.
איור 3: ממשק משתמש שבו מוצג LodgingEntity יחיד בתוך אשכול ההמלצות. StoreEntity: StoreEntity מייצג חנות, מסעדה, בית קפה וכו'. הוא מדגיש תוכן שבו מקום לאכילה או חנות הם פריט המידע החשוב שצריך להעביר למשתמשים.
איור 4: ממשק משתמש שבו מוצג StoreEntity יחיד באשכול Recommendations. PointOfInterestEntity: PointOfInterestEntity מייצג מקום מעניין כמו תחנת דלק, מקום לאירועים, פארק שעשועים, מוזיאון, אטרקציה תיירותית, מסלול טיולים וכו'. הוא מדגיש תוכן שבו המיקום הוא חלק חיוני מהמידע שצריך להעביר למשתמשים. אסור להשתמש בו כדי לציין מקומות לינה, חנויות או מסעדות.
איור 5: ממשק משתמש שבו רואים PointOfInterestEntity יחיד באשכול Recommendations.
- אוסף המלצות יכול לכלול
באוסף הזמנה מוצג תוכן שמשתמשים הביעו בו עניין לאחרונה, מכמה שותפי פיתוח, בקבוצה אחת בממשק המשתמש. כל שותף מפתח יוכל לשדר עד 10 ישויות באשכול Reservation.
תוכן ההזמנה יכול להיות במבנה הבא:
RestaurantReservationEntity: RestaurantReservationEntity מייצג הזמנה במסעדה או בבית קפה, ועוזר למשתמשים לעקוב אחרי הזמנות קרובות או פעילות במסעדות.
איור 6. ממשק משתמש שבו רואים RestaurantReservationEntity אחד באשכול Reservation. EventReservationEntity: מייצג הזמנה לאירוע ועוזר למשתמשים לעקוב אחרי הזמנות לאירועים קרובים או לאירועים שמתרחשים כרגע. האירועים יכולים לכלול, בין היתר, את הדברים הבאים:
- אירועי ספורט, כמו הזמנה למשחק כדורגל
- אירועים שקשורים לגיימינג, כמו הזמנה של כרטיס לאירוע ספורט אלקטרוני
- אירועי בידור כמו הזמנה של כרטיסים לסרט בקולנוע, להופעה, לתיאטרון או לחתימה על ספר
- הזמנות לנסיעות או לנקודות עניין, כמו סיורים מודרכים, כרטיסים למוזיאון
- הזמנות לאירועים חברתיים / סמינרים / כנסים
- הזמנות להדרכות או לשיעורים
איור 7. ממשק משתמש שמוצג בו EventReservationEntity יחיד באשכול Reservation. LodgingReservationEntity: LodgingEntityReservation מייצג הזמנה של מקום לינה לנסיעות ועוזר למשתמשים לעקוב אחרי הזמנות קרובות או פעילות של בתי מלון או יחידות אירוח.
איור 8. ממשק משתמש שבו רואים LodgingReservationEntity אחד באשכול Reservation. TransportationReservationEntity: TransportationReservationEntity מייצג הזמנה של אמצעי תחבורה מכל סוג, ועוזר למשתמשים לעקוב אחרי הזמנות של טיסות, מעבורות, רכבות, אוטובוסים, נסיעות במוניות או הפלגות קרובות או כאלה שמתבצעות כרגע.
איור 9. ממשק משתמש שבו מוצג TransportationReservationEntity יחיד באשכול Reservation. VehicleRentalReservationEntity: VehicleRentalReservationEntity מייצג הזמנה של השכרת רכב ועוזר למשתמשים לעקוב אחרי הזמנות קרובות או פעילות של השכרת רכב.
איור 10. ממשק משתמש שבו רואים VehicleRentalReservationEntity אחד בתוך קבוצת הזמנות.
באוסף המומלצים מוצגת קבוצה של ישויות מכמה שותפי פיתוח בממשק משתמש אחד. יהיה אשכול אחד של המלצות מובילות, שיוצג בחלק העליון של ממשק המשתמש עם מיקום מועדף מעל כל אשכולות ההמלצות. כל שותף מפתח יוכל לשדר עד 10 ישויות באוסף המומלצים.
GenericFeaturedEntity: GenericFeaturedEntity שונה מ-Recommendation item בכך ש-Featured item צריך לשמש לתוכן מוביל יחיד ממפתחים, ולייצג את התוכן החשוב ביותר שיהיה מעניין ורלוונטי למשתמשים.
איור 11: ממשק משתמש שבו מוצג FeaturedCluster עם רשימה של GenericFeaturedEntity
הבלוק המשך החיפוש עוזר למשתמשים להמשיך את תהליך החיפוש הקודם שלהם לגבי נסיעות. הוא מציג רשימה של שאילתות חיפוש שהמשתמש חיפש לאחרונה בכל האפליקציות שלו לנסיעות. הצביר יוצמד למקום השני, אחרי צבירי ההזמנות ולפני צבירי המלצות והצבירים המומלצים. כל שותף מפתח יוכל לשדר עד 3 ישויות באשכול 'המשך החיפוש'.
- PointOfInterestEntity: PointOfInterestEntity מייצג מקום עניין כמו תחנת דלק, מקום לאירועים, פארק שעשועים, מוזיאון, אטרקציה תיירותית, מסלול טיולים וכו'. הוא מדגיש תוכן שהמשתמש חיפש בעבר.
עבודה מקדימה
רמת ה-API המינימלית: 19
להוסיף את ספריית com.google.android.engage:engage-core לאפליקציה:
dependencies {
// Make sure you also include that repository in your project's build.gradle file.
implementation 'com.google.android.engage:engage-core:1.6.0'
}
סיכום
העיצוב מבוסס על הטמעה של שירות מאוגד.
הנתונים שלקוח יכול לפרסם כפופים למגבלות הבאות עבור סוגים שונים של אשכולות:
| סוג האשכול | מגבלות על אשכולות | מגבלות מינימליות על ישויות באשכול | מגבלות מקסימליות של ישויות באשכול |
|---|---|---|---|
| אשכולות של המלצות | לכל היותר 7 | לפחות 1 | עד 50 (ArticleEntity, EventEntity,
LodgingEntity, StoreEntity או
PointOfInterestEntity) |
| אשכול הזמנות | עד 1 | לפחות 1 | עד 20 (RestaurantReservationEntity,
EventReservationEntity,
LodgingReservationEntity,
TransportationReservationEntity או
VehicleRentalReservationEntity) |
| אשכול מוצג | עד 1 | לפחות 1 | עד 20 (GenericFeaturedEntity) |
| המשך חיפוש באשכול | עד 1 | לפחות 1 | עד 3 (PointOfInterestEntity) |
שלב 1: הזנת נתוני הישות
ב-SDK מוגדרות ישויות שונות שמייצגות כל סוג פריט. אנחנו תומכים בישויות הבאות בקטגוריה 'נסיעות ואירועים':
GenericFeaturedEntityArticleEntityEventEntityLodgingEntityStoreEntityPointOfInterestEntityRestaurantReservationEntityEventReservationEntityLodgingReservationEntityTransportationReservationEntityVehicleRentalReservationEntity
בטבלאות הבאות מפורטים המאפיינים והדרישות שזמינים לכל סוג.
GenericFeaturedEntity
| מאפיין | דרישה | תיאור | פורמט |
|---|---|---|---|
| URI של הפעולה | חובה |
קישור עומק לישות באפליקציה לבעלי מקצוע. הערה: אפשר להשתמש בקישורי עומק לשיוך (Attribution). אפשר לעיין בשאלות הנפוצות |
URI |
| תמונות של פוסטרים | חובה | אם תספקו כמה תמונות, אנחנו נציג רק תמונה אחת. יחס הגובה-רוחב המומלץ הוא 16:9 הערה: אם מספקים תג, צריך לוודא שיש שטח בטוח של 24 נקודות dps בחלק העליון והתחתון של התמונה. |
הנחיות זמינות במאמר בנושא מפרט לתמונות. |
| כותרת | אופציונלי | שם הישות. | טקסט חופשי גודל טקסט מומלץ: 50 תווים |
| תיאור | אופציונלי | פסקה אחת של טקסט שמתארת את הישות. הערה: המשתמש יראה את רשימת התיאורים או את רשימת הכתוביות, אבל לא את שתיהן. |
טקסט חופשי גודל טקסט מומלץ: 180 תווים |
| רשימת כתוביות | אופציונלי | עד 3 כתוביות, כאשר כל כתובית היא שורה אחת של טקסט. הערה: המשתמש יראה את רשימת התיאורים או את רשימת הכתוביות, אבל לא את שתיהן. |
טקסט חופשי גודל הטקסט המומלץ לכל כתובית: 50 תווים לכל היותר |
| תגים | אופציונלי | כל תג יכול להיות טקסט חופשי (עד 15 תווים) או תמונה קטנה. טיפול מיוחד בחוויית המשתמש מעל תמונה או סרטון, לדוגמה, שכבת-על של תג על התמונה
|
|
| תג – טקסט | אופציונלי | שם התג הערה: חובה להוסיף טקסט או תמונה לתג |
טקסט חופשי גודל טקסט מומלץ: עד 15 תווים |
| תג – תמונה | אופציונלי | תמונה קטנה טיפול מיוחד בחוויית המשתמש, למשל שכבת-על של תג על התמונה הממוזערת של התמונה או הסרטון. הערה: חובה להוסיף טקסט או תמונה לתג |
הנחיות זמינות במאמר בנושא מפרט לתמונות. |
| קטגוריות תוכן | אופציונלי | מתארים את קטגוריית התוכן בישות. | רשימת טיפוסים בני מנייה אפשר לקבל הנחיות נוספות בקטע בנושא קטגוריות תוכן. |
| DisplayTimeWindow (אופציונלי) – הגדרת חלון זמן להצגת תוכן בממשק | |||
| חותמת זמן של התחלה | אופציונלי |
חותמת הזמן של התקופה שאחריה התוכן צריך להיות מוצג במשטח. אם לא מוגדרת הגבלה, התוכן יכול להופיע בפלטפורמה. |
חותמת זמן של תקופת זמן המערכת באלפיות השנייה |
| חותמת זמן של סיום | אופציונלי |
חותמת הזמן של העידן שאחריה התוכן לא מוצג יותר בפלטפורמה. אם לא מוגדרת הגבלה, התוכן יכול להופיע בפלטפורמה. |
חותמת זמן של תקופת זמן המערכת באלפיות השנייה |
ArticleEntity
| מאפיין | דרישה | תיאור | פורמט |
|---|---|---|---|
| URI של הפעולה | חובה |
קישור עומק לישות באפליקציה לבעלי מקצוע. הערה: אפשר להשתמש בקישורי עומק לשיוך (Attribution). אפשר לעיין בשאלות הנפוצות |
URI |
| כותרת | חובה | שם הישות. | טקסט חופשי גודל טקסט מומלץ: עד 50 תווים |
| תמונות של פוסטרים | אופציונלי | אם תספקו כמה תמונות, אנחנו נציג רק תמונה אחת. יחס הגובה-רוחב המומלץ הוא 16:9 הערה: מומלץ מאוד להוסיף תמונה. אם מספקים תג, צריך לוודא שיש מרווח בטוח של 24 נקודות לשני הצדדים, העליון והתחתון, של התמונה |
הנחיות זמינות במאמר בנושא מפרט לתמונות. |
| מקור – שם | אופציונלי | השם של המחבר, הארגון או הכתב | טקסט חופשי גודל טקסט מומלץ: פחות מ-25 תווים |
| מקור – תמונה | אופציונלי | תמונה של המקור, כמו המחבר, הארגון או הכתב | הנחיות זמינות במאמר בנושא מפרט לתמונות. |
| תיאור | אופציונלי | פסקה אחת של טקסט שמתארת את הישות. הערה: המשתמש יראה את רשימת התיאורים או את רשימת הכתוביות, אבל לא את שתיהן. |
טקסט חופשי גודל טקסט מומלץ: 180 תווים |
| רשימת כתוביות | אופציונלי | עד 3 כתוביות, כאשר כל כתובית היא שורה אחת של טקסט. הערה: המשתמש יראה את רשימת התיאורים או את רשימת הכתוביות, אבל לא את שתיהן. |
טקסט חופשי גודל הטקסט המומלץ לכל כתובית: 50 תווים לכל היותר |
| תגים | אופציונלי | כל תג יכול להיות טקסט חופשי (עד 15 תווים) או תמונה קטנה. טיפול מיוחד בחוויית המשתמש מעל תמונה או סרטון, למשל, כשכבת-על של תג על התמונה
|
|
| תג – טקסט | אופציונלי | שם התג הערה: חובה להוסיף טקסט או תמונה לתג |
טקסט חופשי גודל טקסט מומלץ: עד 15 תווים |
| תג – תמונה | אופציונלי | תמונה קטנה טיפול מיוחד בחוויית המשתמש, למשל שכבת-על של תג על התמונה הממוזערת של התמונה או הסרטון. הערה: חובה להוסיף טקסט או תמונה לתג |
הנחיות זמינות במאמר בנושא מפרט לתמונות. |
| מועד פרסום התוכן | אופציונלי | חותמת הזמן של התקופה (epoch) באלפיות השנייה שבה התוכן פורסם או עודכן באפליקציה. | חותמת זמן של תקופת זמן המערכת באלפיות השנייה |
| שעת ההתעניינות האחרונה | אופציונלי | חותמת הזמן של התקופה (epoch) באלפיות השנייה שבה המשתמש קיים אינטראקציה עם הישות הזו בפעם האחרונה. |
חותמת זמן של תקופת זמן המערכת באלפיות השנייה |
| אחוז ההתקדמות | אופציונלי | אחוז התוכן המלא שהמשתמש צרך עד היום. |
ערך int בין 0 ל-100 כולל. |
| קטגוריות תוכן | אופציונלי | מתארים את קטגוריית התוכן בישות. | רשימת טיפוסים בני מנייה אפשר לקבל הנחיות נוספות בקטע בנושא קטגוריות תוכן. |
| DisplayTimeWindow (אופציונלי) – הגדרת חלון זמן להצגת תוכן בממשק | |||
| חותמת זמן של התחלה | אופציונלי |
חותמת הזמן של התקופה שאחריה התוכן צריך להיות מוצג במשטח. אם לא מוגדרת הגבלה, התוכן יכול להופיע בפלטפורמה. |
חותמת זמן של תקופת זמן המערכת באלפיות השנייה |
| חותמת זמן של סיום | אופציונלי |
חותמת הזמן של העידן שאחריה התוכן לא מוצג יותר בפלטפורמה. אם לא מוגדרת הגבלה, התוכן יכול להופיע בפלטפורמה. |
חותמת זמן של תקופת זמן המערכת באלפיות השנייה |
EventEntity
| מאפיין | דרישה | תיאור | פורמט |
|---|---|---|---|
| URI של הפעולה | חובה |
קישור עומק לישות באפליקציה לבעלי מקצוע. הערה: אפשר להשתמש בקישורי עומק לשיוך (Attribution). אפשר לעיין בשאלות הנפוצות |
URI |
| כותרת | חובה | שם הישות. | מחרוזת גודל טקסט מומלץ: עד 50 תווים |
| חותמת זמן של שעת ההתחלה המקומית | חובה |
חותמת הזמן של התקופה שבה האירוע צפוי להתחיל. |
Joda-Time Instant |
| שעת התחלה מקומית – אזור זמן | חובה |
אזור הזמן שבו האירוע צפוי להתחיל. |
Joda-Time DateTimeZone הנחיות מפורטות זמינות במאמר מפרטים של אזורי זמן. |
| מצב אירוע | חובה | שדה שבו מציינים אם האירוע יהיה וירטואלי, פרונטלי או שניהם. |
דוגמאות: VIRTUAL, IN_PERSON או HYBRID |
| תמונות של פוסטרים | חובה | אם תספקו כמה תמונות, אנחנו נציג רק תמונה אחת. יחס הגובה-רוחב המומלץ הוא 16:9 הערה: מומלץ מאוד להוסיף תמונה. אם מספקים תג, צריך לוודא שיש מרווח בטוח של 24 נקודות לשני הצדדים, העליון והתחתון, של התמונה |
הנחיות זמינות במאמר בנושא מפרט לתמונות. |
| מיקום – מדינה | חובה (מותנה) | המדינה שבה מתקיים האירוע. הערה: חובה להשתמש בפרמטר הזה באירועים מסוג IN_PERSON או HYBRID. |
טקסט חופשי גודל טקסט מומלץ: עד 20 תווים |
| מיקום – עיר | חובה (מותנה) | העיר שבה מתקיים האירוע. הערה: חובה להשתמש בפרמטר הזה באירועים מסוג IN_PERSON או HYBRID. |
טקסט חופשי גודל טקסט מומלץ: עד 20 תווים |
| מיקום – כתובת לתצוגה | חובה (מותנה) | הכתובת או שם המקום שבו האירוע יתקיים, שיוצגו למשתמש. הערה: חובה להשתמש בפרמטר הזה באירועים מסוג IN_PERSON או HYBRID. |
טקסט חופשי גודל טקסט מומלץ: עד 20 תווים |
| מיקום – רחוב | אופציונלי | כתובת הרחוב (אם רלוונטי) של המיקום שבו מתקיים האירוע. | טקסט חופשי גודל טקסט מומלץ: עד 20 תווים |
| מיקום – מדינה | אופציונלי | המדינה (State) או המחוז (אם רלוונטי) שבהם האירוע מתקיים. | טקסט חופשי גודל טקסט מומלץ: עד 20 תווים |
| מיקום – מיקוד | אופציונלי | המיקוד (אם רלוונטי) של המיקום שבו מתקיים האירוע. | טקסט חופשי גודל טקסט מומלץ: עד 20 תווים |
| מיקום – שכונה | אופציונלי | השכונה (אם רלוונטי) שבה מתקיים האירוע. | טקסט חופשי גודל טקסט מומלץ: עד 20 תווים |
| שעת סיום | אופציונלי |
חותמת הזמן של מערכת Unix שבה האירוע צפוי להסתיים. הערה: הערך הזה יוצג באלפיות השנייה. |
חותמת זמן של תקופת זמן המערכת באלפיות השנייה |
| תיאור | אופציונלי | פסקה אחת של טקסט שמתארת את הישות. הערה: המשתמש יראה את רשימת התיאורים או את רשימת הכתוביות, אבל לא את שתיהן. |
טקסט חופשי גודל טקסט מומלץ: 180 תווים |
| רשימת כתוביות | אופציונלי | עד 3 כתוביות, כאשר כל כתובית היא שורה אחת של טקסט. הערה: המשתמש יראה את רשימת התיאורים או את רשימת הכתוביות, אבל לא את שתיהן. |
טקסט חופשי גודל הטקסט המומלץ לכל כתובית: 50 תווים לכל היותר |
| תגים | אופציונלי |
כל תג יכול להיות טקסט חופשי (עד 15 תווים) או תמונה קטנה. |
|
| תג – טקסט | אופציונלי | שם התג הערה: חובה להוסיף טקסט או תמונה לתג |
טקסט חופשי גודל טקסט מומלץ: עד 15 תווים |
| תג – תמונה | אופציונלי | תמונה קטנה טיפול מיוחד בחוויית המשתמש, למשל שכבת-על של תג על התמונה הממוזערת של התמונה או הסרטון. הערה: חובה להוסיף טקסט או תמונה לתג |
הנחיות זמינות במאמר בנושא מפרט לתמונות. |
| מחיר – מחיר נוכחי | חובה (מותנה) |
המחיר הנוכחי של הכרטיס לאירוע. חובה לציין את המחיר המקורי אם מציינים מחיר קודם מחוק. |
טקסט חופשי |
| מחיר – מחיר קודם מחוק | אופציונלי | המחיר המקורי של הכרטיס לאירוע. | טקסט חופשי |
| נכס יתרונות מרכזיים עם מחיר | אופציונלי | המחיר מוצג בהדגשה כדי להציג מבצע, אירוע או הנחה לחברי מועדון, אם יש כאלה. | טקסט חופשי גודל הטקסט המומלץ: פחות מ-45 תווים (אם הטקסט ארוך מדי, יכול להיות שיוצגו שלוש נקודות) |
| קטגוריות תוכן | אופציונלי | מתארים את קטגוריית התוכן בישות. | רשימה של טיפוסים בני מנייה שעומדים בדרישות
אפשר לקבל הנחיות נוספות בקטע בנושא קטגוריות תוכן. |
| DisplayTimeWindow (אופציונלי) – הגדרת חלון זמן להצגת תוכן בממשק | |||
| חותמת זמן של התחלה | אופציונלי |
חותמת הזמן של התקופה שאחריה התוכן צריך להיות מוצג במשטח. אם לא מוגדרת הגבלה, התוכן יכול להופיע בפלטפורמה. |
חותמת זמן של תקופת זמן המערכת באלפיות השנייה |
| חותמת זמן של סיום | אופציונלי |
חותמת הזמן של העידן שאחריה התוכן לא מוצג יותר בפלטפורמה. אם לא מוגדרת הגבלה, התוכן יכול להופיע בפלטפורמה. |
חותמת זמן של תקופת זמן המערכת באלפיות השנייה |
LodgingEntity
| מאפיין | דרישה | תיאור | פורמט |
|---|---|---|---|
| URI של הפעולה | חובה |
קישור עומק לישות באפליקציה לבעלי מקצוע. הערה: אפשר להשתמש בקישורי עומק לשיוך (Attribution). אפשר לעיין בשאלות הנפוצות |
URI |
| כותרת | חובה | שם הישות. | מחרוזת גודל טקסט מומלץ: עד 50 תווים |
| תמונות של פוסטרים | חובה |
אם תספקו כמה תמונות, אנחנו נציג רק תמונה אחת. יחס הגובה-רוחב המומלץ הוא 16:9 הערה: אם מספקים תג, צריך לוודא שיש שטח בטוח של 24 נקודות dps בחלק העליון והתחתון של התמונה. |
הנחיות זמינות במאמר בנושא מפרט לתמונות. |
| מיקום – מדינה | חובה | המדינה שבה מתבצעת השהייה. | טקסט חופשי גודל טקסט מומלץ: עד 20 תווים |
| מיקום – עיר | חובה | העיר שבה מתבצעת הלינה. | טקסט חופשי גודל טקסט מומלץ: עד 20 תווים |
| מיקום – כתובת לתצוגה | חובה | הכתובת שתוצג למשתמש. ברוב תרחישי השימוש, מומלץ לכלול את שם העיר ואולי גם את שם המדינה. אפשר לכלול רק את הכתובת או את השכונה אם המשתמש נמצא בקרבת המיקום, אם המשתמש מכיר את המיקום או אם העיר כלולה בכותרת של קבוצת המיקומים. אם אתם כוללים את כתובת הרחוב, צריך לספק כתובת תמציתית, ולהשתמש בקיצורים איפה שאפשר (לדוגמה, 'רח' במקום 'רחוב', 'שד' במקום 'שדרה'). | טקסט חופשי גודל טקסט מומלץ: עד 20 תווים |
| מיקום – רחוב | אופציונלי | כתובת הרחוב (אם רלוונטי) של מקום האירוח. | טקסט חופשי גודל טקסט מומלץ: עד 20 תווים |
| מיקום – מדינה | אופציונלי | המדינה (State) או המחוז (אם רלוונטי) שבהם נמצא מקום האירוח. | טקסט חופשי גודל טקסט מומלץ: עד 20 תווים |
| מיקום – מיקוד | אופציונלי | המיקוד (אם רלוונטי) של מקום האירוח. | טקסט חופשי גודל טקסט מומלץ: עד 20 תווים |
| מיקום – שכונה | אופציונלי | השכונה (אם רלוונטי) של מקום האירוח. | טקסט חופשי גודל טקסט מומלץ: עד 20 תווים |
| תגים | אופציונלי |
כל תג יכול להיות טקסט חופשי (עד 15 תווים) או תמונה קטנה. |
|
| תג – טקסט | אופציונלי | שם התג הערה: חובה להוסיף טקסט או תמונה לתג |
טקסט חופשי גודל טקסט מומלץ: עד 15 תווים |
| תג – תמונה | אופציונלי | תמונה קטנה טיפול מיוחד בחוויית המשתמש, למשל שכבת-על של תג על התמונה הממוזערת של התמונה או הסרטון. הערה: חובה להוסיף טקסט או תמונה לתג |
הנחיות זמינות במאמר בנושא מפרט לתמונות. |
| תיאור | אופציונלי | פסקה אחת של טקסט שמתארת את הישות. הערה: המשתמש יראה את רשימת התיאורים או את רשימת הכתוביות, אבל לא את שתיהן. |
טקסט חופשי גודל טקסט מומלץ: 180 תווים |
| רשימת כתוביות | אופציונלי | עד 3 כתוביות, כאשר כל כתובית היא שורה אחת של טקסט. הערה: המשתמש יראה את רשימת התיאורים או את רשימת הכתוביות, אבל לא את שתיהן. |
טקסט חופשי גודל הטקסט המומלץ לכל כתובית: 50 תווים לכל היותר |
| AvailabilityTimeWindow – שעת התחלה מקומית – חותמת זמן | אופציונלי | חותמת הזמן של תקופת ה-epoch שבה מקום האירוח צפוי להיות פתוח או זמין. | Joda-Time Instant |
| AvailabilityTimeWindow – שעת התחלה מקומית – אזור זמן | אופציונלי | אזור הזמן שבו מקום האירוח צפוי להיות פתוח או זמין. |
Joda-Time DateTimeZone הנחיות מפורטות זמינות במאמר מפרטים של אזורי זמן. |
| AvailabilityTimeWindow - Localized End Time - Timestamp | אופציונלי | חותמת הזמן של תקופת ה-Epoch שעד אליה מקום האירוח צפוי להיות פתוח או זמין. | Joda-Time Instant |
| AvailabilityTimeWindow – שעת סיום מקומית – אזור זמן | אופציונלי | אזור הזמן שבו מקום האירוח צפוי להיות פתוח או זמין. |
Joda-Time DateTimeZone הנחיות מפורטות זמינות במאמר מפרטים של אזורי זמן. |
| דירוג – ערך מקסימלי | אופציונלי | הערך המקסימלי בסולם הדירוג. חובה לציין את המאפיין הזה אם מציינים גם את הערך הנוכחי של הדירוג. |
מספר >= 0.0 |
| דירוג – ערך נוכחי | אופציונלי | הערך הנוכחי של סולם הדירוג. חובה לציין את המאפיין הזה אם מציינים גם את הערך המקסימלי של הדירוג. |
מספר >= 0.0 |
| דירוג – מספר | אופציונלי | ספירת הדירוגים של מקום האירוח. הערה: צריך לספק את השדה הזה אם האפליקציה רוצה לשלוט באופן שבו הוא מוצג למשתמשים. צריך לספק את המחרוזת התמציתית שאפשר להציג למשתמש. לדוגמה, אם המספר הוא 1,000,000, כדאי להשתמש בקיצורים כמו 1M, כדי שהמספר לא ייחתך בגדלים קטנים יותר של מסכים. |
מחרוזת |
| דירוג – ערך הספירה | אופציונלי | ספירת הדירוגים של מקום האירוח. הערה: צריך לציין את השדה הזה אם לא רוצים לטפל בעצמכם בלוגיקה של קיצור התצוגה. אם מופיעים גם הערך Count וגם הערך Count Value, נשתמש בערך Count כדי להציג את הנתונים למשתמשים |
ארוך |
| מחיר – מחיר נוכחי | חובה (מותנה) | המחיר הנוכחי של מקום האירוח. חובה לציין את המאפיין הזה אם מציינים מחיר קודם מחוק. |
טקסט חופשי |
| מחיר – מחיר קודם מחוק | אופציונלי | המחיר המקורי של מקום האירוח, שיוצג עם קו חוצה בממשק המשתמש. | טקסט חופשי |
| נכס יתרונות מרכזיים עם מחיר | אופציונלי | המחיר מוצג בהדגשה כדי להציג מבצע, אירוע או הנחה לחברי מועדון, אם יש כאלה. | טקסט חופשי גודל הטקסט המומלץ: פחות מ-45 תווים (אם הטקסט ארוך מדי, יכול להיות שיוצגו שלוש נקודות) |
| DisplayTimeWindow (אופציונלי) – הגדרת חלון זמן להצגת תוכן בממשק | |||
| חותמת זמן של התחלה | אופציונלי |
חותמת הזמן של התקופה שאחריה התוכן צריך להיות מוצג במשטח. אם לא מוגדרת הגבלה, התוכן יכול להופיע בפלטפורמה. |
חותמת זמן של תקופת זמן המערכת באלפיות השנייה |
| חותמת זמן של סיום | אופציונלי |
חותמת הזמן של העידן שאחריה התוכן לא מוצג יותר בפלטפורמה. אם לא מוגדרת הגבלה, התוכן יכול להופיע בפלטפורמה. |
חותמת זמן של תקופת זמן המערכת באלפיות השנייה |
StoreEntity
אובייקט StoreEntity מייצג חנות ספציפית שמפתחים שותפים רוצים לפרסם, כמו מסעדה פופולרית או מקום לאכול שרלוונטיים לחוויית הנסיעה של המשתמש.
| מאפיין | דרישה | תיאור | פורמט |
|---|---|---|---|
| תמונות של פוסטרים | חובה | צריך לספק לפחות תמונה אחת. | הנחיות זמינות במאמר בנושא מפרט לתמונות. |
| URI של הפעולה | חובה |
קישור עומק לישות באפליקציה לבעלי מקצוע. הערה: אפשר להשתמש בקישורי עומק לשיוך (Attribution). אפשר לעיין בשאלות הנפוצות |
URI |
| כותרת | אופציונלי | שם החנות. | טקסט חופשי גודל הטקסט המומלץ: פחות מ-45 תווים (אם הטקסט ארוך מדי, יכול להיות שיוצגו שלוש נקודות) |
| מיקום | אופציונלי | המיקום של החנות. | טקסט חופשי גודל הטקסט המומלץ: פחות מ-45 תווים (אם הטקסט ארוך מדי, יכול להיות שיוצגו שלוש נקודות) |
| יתרונות מרכזיים | אופציונלי | הפניה למידע על מבצע, אירוע או עדכון בחנות, אם יש כאלה. | טקסט חופשי גודל הטקסט המומלץ: פחות מ-45 תווים (אם הטקסט ארוך מדי, יכול להיות שיוצגו שלוש נקודות) |
| האותיות הקטנות של היתרונות המרכזיים | אופציונלי | הטקסט של האותיות הקטנות בנכס היתרונות המרכזיים. | טקסט חופשי גודל הטקסט המומלץ: פחות מ-45 תווים (אם הטקסט ארוך מדי, יכול להיות שיוצגו שלוש נקודות) |
| תיאור | אופציונלי | תיאור של החנות. | טקסט חופשי גודל הטקסט המומלץ: פחות מ-90 תווים (אם הטקסט ארוך מדי, יכול להיות שיוצגו שלוש נקודות) |
| קטגוריה | אופציונלי | קטגוריה של חנות. בהקשר של מקומות לאכול, יכולה להיות קטגוריה של מטבח כמו french, new american, ramen, fine dining. |
טקסט חופשי גודל הטקסט המומלץ: פחות מ-45 תווים (אם הטקסט ארוך מדי, יכול להיות שיוצגו שלוש נקודות) |
| דירוג – ערך מקסימלי | אופציונלי | הערך המקסימלי בסולם הדירוג. חובה לציין את המאפיין הזה אם מציינים גם את הערך הנוכחי של הדירוג. |
מספר >= 0.0 |
| דירוג – ערך נוכחי | אופציונלי | הערך הנוכחי של סולם הדירוג. חובה לציין את המאפיין הזה אם מציינים גם את הערך המקסימלי של הדירוג. |
מספר >= 0.0 |
| דירוג – מספר | אופציונלי | ספירת הדירוגים של מקום האירוח. הערה: צריך לספק את השדה הזה אם האפליקציה רוצה לשלוט באופן שבו הוא מוצג למשתמשים. צריך לספק את המחרוזת התמציתית שאפשר להציג למשתמש. לדוגמה, אם המספר הוא 1,000,000, כדאי להשתמש בקיצורים כמו 1M, כדי שהמספר לא ייחתך בגדלים קטנים יותר של מסכים. |
מחרוזת |
| דירוג – ערך הספירה | אופציונלי | ספירת הדירוגים של מקום האירוח. הערה: צריך לציין את השדה הזה אם לא רוצים לטפל בעצמכם בלוגיקה של קיצור התצוגה. אם מופיעים גם הערך Count וגם הערך Count Value, נשתמש בערך Count כדי להציג את הנתונים למשתמשים |
ארוך |
| DisplayTimeWindow (אופציונלי) – הגדרת חלון זמן להצגת תוכן בממשק | |||
| חותמת זמן של התחלה | אופציונלי |
חותמת הזמן של התקופה שאחריה התוכן צריך להיות מוצג במשטח. אם לא מוגדרת הגבלה, התוכן יכול להופיע בפלטפורמה. |
חותמת זמן של תקופת זמן המערכת באלפיות השנייה |
| חותמת זמן של סיום | אופציונלי |
חותמת הזמן של העידן שאחריה התוכן לא מוצג יותר בפלטפורמה. אם לא מוגדרת הגבלה, התוכן יכול להופיע בפלטפורמה. |
חותמת זמן של תקופת זמן המערכת באלפיות השנייה |
PointOfInterestEntity
| מאפיין | דרישה | תיאור | פורמט |
|---|---|---|---|
| URI של הפעולה | חובה |
קישור עומק לישות באפליקציה לבעלי מקצוע. הערה: אפשר להשתמש בקישורי עומק לשיוך (Attribution). אפשר לעיין בשאלות הנפוצות |
URI |
| כותרת | חובה | שם הישות. | מחרוזת גודל טקסט מומלץ: עד 50 תווים |
| תמונות של פוסטרים | חובה (מותנה) |
אם תספקו כמה תמונות, אנחנו נציג רק תמונה אחת. יחס הגובה-רוחב המומלץ הוא 16:9 הערה: חובה להוסיף תמונה אם הישות היא חלק מקבוצת המלצות. אם מספקים תג, צריך לוודא שיש מרווח בטוח של 24 נקודות dps בחלק העליון ובחלק התחתון של התמונה |
הנחיות זמינות במאמר בנושא מפרט לתמונות. |
| שעת ההתעניינות האחרונה | חובה (מותנה) |
חותמת הזמן של התקופה שחלפה מאז שהמשתמש קיים אינטראקציה עם הישות הזו. הערה: השדה הזה הוא חובה אם הישות היא חלק מאשכול של המשך חיפוש. |
Joda-Time Instant |
| מיקום – מדינה | חובה (מותנה) |
המדינה שבה מתרחשת נקודת העניין. הערה: השדה הזה הוא חובה אם הישות היא חלק מאשכול המלצות. |
טקסט חופשי גודל טקסט מומלץ: עד 20 תווים |
| מיקום – עיר | חובה (מותנה) |
העיר שבה מתרחשת נקודת העניין. הערה: השדה הזה הוא חובה אם הישות היא חלק מאשכול המלצות. |
טקסט חופשי גודל טקסט מומלץ: עד 20 תווים |
| מיקום – כתובת לתצוגה | חובה (מותנה) |
הכתובת שתוצג למשתמש. צריך לציין כתובת תמציתית, ולהשתמש בקיצורים איפה שאפשר (למשל, 'St' במקום 'Street', 'Ave' במקום 'Avenue'). יכול להיות שהמחרוזת הזו תיחתך, בהתאם למכשיר ולהגדרות של המשתמש. כדי לזהות את המיקום בצורה ברורה, צריך לכלול את שם העיר. הערה: השדה הזה הוא חובה אם הישות היא חלק מאשכול המלצות. |
טקסט חופשי גודל טקסט מומלץ: עד 35 תווים |
| מיקום – רחוב | אופציונלי | כתובת הרחוב (אם רלוונטי) של נקודת העניין. | טקסט חופשי גודל טקסט מומלץ: עד 20 תווים |
| מיקום – מדינה | אופציונלי | המדינה (State) או המחוז (אם רלוונטי) שבהם נמצאת נקודת העניין. | טקסט חופשי גודל טקסט מומלץ: עד 20 תווים |
| מיקום – מיקוד | אופציונלי | המיקוד (אם רלוונטי) של נקודת העניין. | טקסט חופשי גודל טקסט מומלץ: עד 20 תווים |
| מיקום – שכונה | אופציונלי | השכונה (אם רלוונטי) של נקודת העניין. | טקסט חופשי גודל טקסט מומלץ: עד 20 תווים |
| AvailabilityTimeWindow – שעת התחלה מקומית – חותמת זמן | אופציונלי | חותמת הזמן של התקופה שבה המקום המעניין צפוי להיות פתוח או זמין. | Joda-Time Instant |
| AvailabilityTimeWindow – שעת התחלה מקומית – אזור זמן | אופציונלי | אזור הזמן שבו נקודת העניין צפויה להיות פתוחה או זמינה. |
Joda-Time DateTimeZone הנחיות מפורטות זמינות במאמר מפרטים של אזורי זמן. |
| AvailabilityTimeWindow - Localized End Time - Timestamp | אופציונלי | חותמת הזמן של תקופת ה-Epoch שעד אליה המקום המעניין צפוי להיות פתוח או זמין. | Joda-Time Instant |
| AvailabilityTimeWindow – שעת סיום מקומית – אזור זמן | אופציונלי | אזור הזמן שבו נקודת העניין צפויה להיות פתוחה או זמינה. |
Joda-Time DateTimeZone הנחיות מפורטות זמינות במאמר מפרטים של אזורי זמן. |
| תגים | אופציונלי |
כל תג יכול להיות טקסט חופשי (עד 15 תווים) או תמונה קטנה. |
|
| תג – טקסט | אופציונלי | שם התג הערה: חובה להוסיף טקסט או תמונה לתג |
טקסט חופשי גודל טקסט מומלץ: עד 15 תווים |
| תג – תמונה | אופציונלי | תמונה קטנה טיפול מיוחד בחוויית המשתמש, למשל שכבת-על של תג על התמונה הממוזערת של התמונה או הסרטון. הערה: חובה להוסיף טקסט או תמונה לתג |
הנחיות זמינות במאמר בנושא מפרט לתמונות. |
| תיאור | אופציונלי | פסקה אחת של טקסט שמתארת את הישות. הערה: המשתמש יראה את רשימת התיאורים או את רשימת הכתוביות, אבל לא את שתיהן. |
טקסט חופשי גודל טקסט מומלץ: 180 תווים |
| רשימת כתוביות | אופציונלי | עד 3 כתוביות, כאשר כל כתובית היא שורה אחת של טקסט. הערה: המשתמש יראה את רשימת התיאורים או את רשימת הכתוביות, אבל לא את שתיהן. |
טקסט חופשי גודל הטקסט המומלץ לכל כתובית: 50 תווים לכל היותר |
| דירוג – ערך מקסימלי | אופציונלי | הערך המקסימלי בסולם הדירוג. חובה לציין את המאפיין הזה אם מציינים גם את הערך הנוכחי של הדירוג. |
מספר >= 0.0 |
| דירוג – ערך נוכחי | אופציונלי | הערך הנוכחי של סולם הדירוג. חובה לציין את המאפיין הזה אם מציינים גם את הערך המקסימלי של הדירוג. |
מספר >= 0.0 |
| דירוג – מספר | אופציונלי | מספר הדירוגים של נקודת העניין. הערה: צריך לספק את השדה הזה אם האפליקציה רוצה לשלוט באופן שבו הוא מוצג למשתמשים. צריך לספק את המחרוזת התמציתית שאפשר להציג למשתמש. לדוגמה, אם המספר הוא 1,000,000, כדאי להשתמש בקיצורים כמו 1M, כדי שהמספר לא ייחתך בגדלים קטנים יותר של מסכים. |
מחרוזת |
| דירוג – ערך הספירה | אופציונלי | מספר הדירוגים של נקודת העניין. הערה: צריך לציין את השדה הזה אם לא רוצים לטפל בעצמכם בלוגיקה של קיצור התצוגה. אם מופיעים גם Count וגם Count Value נשתמש ב-Count כדי להציג למשתמשים |
ארוך |
| מחיר – מחיר נוכחי | חובה (מותנה) |
המחיר הנוכחי של הכרטיסים או כרטיס הכניסה לנקודת העניין. חובה לציין את המחיר המקורי אם מציינים מחיר קודם מחוק. |
טקסט חופשי |
| מחיר – מחיר קודם מחוק | אופציונלי | המחיר המקורי של הכרטיסים או של כרטיס הכניסה לנקודת העניין. | טקסט חופשי |
| נכס יתרונות מרכזיים עם מחיר | אופציונלי | המחיר מוצג בהדגשה כדי להציג מבצע, אירוע או הנחה לחברי מועדון, אם יש כאלה. |
טקסט חופשי גודל הטקסט המומלץ: פחות מ-45 תווים (אם הטקסט ארוך מדי, יכול להיות שיוצגו שלוש נקודות) |
| קטגוריות תוכן | אופציונלי | מתארים את קטגוריית התוכן בישות. | רשימה של טיפוסים בני מנייה שעומדים בדרישות
אפשר לקבל הנחיות נוספות בקטע בנושא קטגוריות תוכן. |
| DisplayTimeWindow (אופציונלי) – הגדרת חלון זמן להצגת תוכן בממשק | |||
| חותמת זמן של התחלה | אופציונלי |
חותמת הזמן של התקופה שאחריה התוכן צריך להיות מוצג במשטח. אם לא מוגדרת הגבלה, התוכן יכול להופיע בפלטפורמה. |
חותמת זמן של תקופת זמן המערכת באלפיות השנייה |
| חותמת זמן של סיום | אופציונלי |
חותמת הזמן של העידן שאחריה התוכן לא מוצג יותר בפלטפורמה. אם לא מוגדרת הגבלה, התוכן יכול להופיע בפלטפורמה. |
חותמת זמן של תקופת זמן המערכת באלפיות השנייה |
RestaurantReservationEntity
| מאפיין | דרישה | תיאור | פורמט |
|---|---|---|---|
| URI של הפעולה | חובה |
קישור עומק לישות באפליקציה לבעלי מקצוע. הערה: אפשר להשתמש בקישורי עומק לשיוך (Attribution). אפשר לעיין בשאלות הנפוצות |
URI |
| כותרת | חובה | שם הישות. | מחרוזת גודל טקסט מומלץ: עד 50 תווים |
| שעת ההתחלה של ההזמנה – חותמת זמן | חובה | חותמת הזמן של תקופת ה-Epoch שבה ההזמנה צפויה להתחיל. | 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 נקודות לשני הצדדים, העליון והתחתון, של התמונה |
הנחיות זמינות במאמר בנושא מפרט לתמונות. |
| שעת סיום מקומית – חותמת זמן | אופציונלי |
חותמת הזמן של מערכת Unix שבה האירוע צפוי להסתיים. |
Joda-Time Instant |
| שעת סיום מקומית – אזור זמן | אופציונלי |
אזור הזמן שבו האירוע צפוי להסתיים. |
Joda-Time DateTimeZone הנחיות מפורטות זמינות במאמר מפרטים של אזורי זמן. |
| ספק השירות – שם | אופציונלי |
השם של ספק השירות. הערה: חובה להוסיף טקסט או תמונה לספק השירות. |
טקסט חופשי. לדוגמה, שם מארגן האירוע או הסיור |
| ספק שירות – תמונה | אופציונלי |
הלוגו או התמונה של ספק השירות. הערה: חובה להוסיף טקסט או תמונה לספק השירות. |
הנחיות זמינות במאמר בנושא מפרט לתמונות. |
| תיאור | אופציונלי | פסקה אחת של טקסט שמתארת את הישות. הערה: המשתמש יראה את רשימת התיאורים או את רשימת הכתוביות, אבל לא את שתיהן. |
טקסט חופשי גודל טקסט מומלץ: 180 תווים |
| רשימת כתוביות | אופציונלי | עד 3 כתוביות, כאשר כל כתובית היא שורה אחת של טקסט. הערה: המשתמש יראה את רשימת התיאורים או את רשימת הכתוביות, אבל לא את שתיהן. |
טקסט חופשי גודל הטקסט המומלץ לכל כתובית: 50 תווים לכל היותר |
| תגים | אופציונלי |
כל תג יכול להיות טקסט חופשי (עד 15 תווים) או תמונה קטנה. |
|
| תג – טקסט | אופציונלי | שם התג הערה: חובה להוסיף טקסט או תמונה לתג |
טקסט חופשי גודל טקסט מומלץ: עד 15 תווים |
| תג – תמונה | אופציונלי | תמונה קטנה טיפול מיוחד בחוויית המשתמש, למשל שכבת-על של תג על התמונה הממוזערת של התמונה או הסרטון. הערה: חובה להוסיף טקסט או תמונה לתג |
הנחיות זמינות במאמר בנושא מפרט לתמונות. |
| מזהה ההזמנה | אופציונלי | מזהה ההזמנה של האירוע. | טקסט חופשי |
| מחיר – מחיר נוכחי | חובה (מותנה) |
המחיר הנוכחי של הכרטיס לאירוע. חובה לציין את המחיר המקורי אם מציינים מחיר קודם מחוק. |
טקסט חופשי |
| מחיר – מחיר קודם מחוק | אופציונלי | המחיר המקורי של הכרטיס לאירוע. | טקסט חופשי |
| נכס יתרונות מרכזיים עם מחיר | אופציונלי | המחיר מוצג בהדגשה כדי להציג מבצע, אירוע או הנחה לחברי מועדון, אם יש כאלה. | טקסט חופשי גודל הטקסט המומלץ: פחות מ-45 תווים (אם הטקסט ארוך מדי, יכול להיות שיוצגו שלוש נקודות) |
| דירוג – ערך מקסימלי | אופציונלי | הערך המקסימלי בסולם הדירוג. חובה לציין את המאפיין הזה אם מציינים גם את הערך הנוכחי של הדירוג. |
מספר >= 0.0 |
| דירוג – ערך נוכחי | אופציונלי | הערך הנוכחי של סולם הדירוג. חובה לציין את המאפיין הזה אם מציינים גם את הערך המקסימלי של הדירוג. |
מספר >= 0.0 |
| דירוג – מספר | אופציונלי | מספר הדירוגים של האירוע. הערה: צריך לספק את השדה הזה אם האפליקציה רוצה לשלוט באופן שבו הוא מוצג למשתמשים. צריך לספק את המחרוזת התמציתית שאפשר להציג למשתמש. לדוגמה, אם המספר הוא 1,000,000, כדאי להשתמש בקיצורים כמו 1M, כדי שהמספר לא ייחתך בגדלים קטנים יותר של מסכים. |
מחרוזת |
| דירוג – ערך הספירה | אופציונלי | מספר הדירוגים של האירוע. הערה: צריך לציין את השדה הזה אם לא רוצים לטפל בעצמכם בלוגיקה של קיצור התצוגה. אם מופיעים גם Count וגם Count Value נשתמש ב-Count כדי להציג למשתמשים |
ארוך |
| קטגוריות תוכן | אופציונלי | מתארים את קטגוריית התוכן בישות. | רשימה של טיפוסים בני מנייה שעומדים בדרישות
אפשר לקבל הנחיות נוספות בקטע בנושא קטגוריות תוכן. |
| DisplayTimeWindow (אופציונלי) – הגדרת חלון זמן להצגת תוכן בממשק | |||
| חותמת זמן של התחלה | אופציונלי |
חותמת הזמן של התקופה שאחריה התוכן צריך להיות מוצג במשטח. אם לא מוגדרת הגבלה, התוכן יכול להופיע בפלטפורמה. |
חותמת זמן של תקופת זמן המערכת באלפיות השנייה |
| חותמת זמן של סיום | אופציונלי |
חותמת הזמן של העידן שאחריה התוכן לא מוצג יותר בפלטפורמה. אם לא מוגדרת הגבלה, התוכן יכול להופיע בפלטפורמה. |
חותמת זמן של תקופת זמן המערכת באלפיות השנייה |
LodgingReservationEntity
| מאפיין | דרישה | תיאור | פורמט |
|---|---|---|---|
| URI של הפעולה | חובה |
קישור עומק לישות באפליקציה לבעלי מקצוע. הערה: אפשר להשתמש בקישורי עומק לשיוך (Attribution). אפשר לעיין בשאלות הנפוצות |
URI |
| כותרת | חובה | שם הישות. | טקסט חופשי. לדוגמה, 'השהייה שלך החל מ-12 בדצמבר' גודל טקסט מומלץ: עד 50 תווים |
| שעת הצ'ק-אין המקומית – חותמת זמן | חובה | חותמת הזמן של התקופה שמייצגת את שעת הצ'ק-אין להזמנה. | Joda-Time Instant |
| שעת הצ'ק-אין המקומית – אזור זמן | חובה | אזור הזמן שבו מוגדרת שעת הצ'ק אין בהזמנה. |
Joda-Time DateTimeZone הנחיות מפורטות זמינות במאמר מפרטים של אזורי זמן. |
| שעת הצ'ק אאוט המקומית – חותמת זמן | חובה | חותמת הזמן של התקופה שמייצגת את שעת הצ'ק-אאוט של ההזמנה. | Joda-Time Instant |
| שעת הצ'ק אאוט המקומית – אזור זמן | חובה | אזור הזמן שבו מוגדרת שעת הצ'ק אאוט בהזמנה. |
Joda-Time DateTimeZone הנחיות מפורטות זמינות במאמר מפרטים של אזורי זמן. |
| מיקום – מדינה | חובה | המדינה שבה נמצא מקום האירוח. | טקסט חופשי גודל טקסט מומלץ: עד 20 תווים |
| מיקום – עיר | חובה | העיר שבה נמצא מקום האירוח. | טקסט חופשי גודל טקסט מומלץ: עד 20 תווים |
| מיקום – כתובת לתצוגה | חובה | הכתובת שתוצג למשתמש. צריך לציין כתובת תמציתית, ולהשתמש בקיצורים איפה שאפשר (למשל, 'St' במקום 'Street', 'Ave' במקום 'Avenue'). יכול להיות שהמחרוזת הזו תיחתך, בהתאם למכשיר ולהגדרות של המשתמש. כדי לזהות את המיקום בצורה ברורה, צריך לכלול את שם העיר. | טקסט חופשי גודל טקסט מומלץ: עד 35 תווים |
| מיקום – רחוב | אופציונלי | כתובת הרחוב (אם רלוונטי) של מקום האירוח. | טקסט חופשי גודל טקסט מומלץ: עד 20 תווים |
| מיקום – מדינה | אופציונלי | המדינה (State) או המחוז (אם רלוונטי) שבהם נמצא מקום האירוח. | טקסט חופשי גודל טקסט מומלץ: עד 20 תווים |
| מיקום – מיקוד | אופציונלי | המיקוד (אם רלוונטי) של מקום האירוח. | טקסט חופשי גודל טקסט מומלץ: עד 20 תווים |
| מיקום – שכונה | אופציונלי | השכונה (אם רלוונטי) של מקום האירוח. | טקסט חופשי גודל טקסט מומלץ: עד 20 תווים |
| תמונות של פוסטרים | אופציונלי |
אם תספקו כמה תמונות, אנחנו נציג רק תמונה אחת. יחס הגובה-רוחב המומלץ הוא 16:9 הערה: אם מספקים תג, צריך לוודא שיש שטח בטוח של 24 נקודות לכל אינץ' (dps) בחלק העליון והתחתון של התמונה. |
הנחיות זמינות במאמר בנושא מפרט לתמונות. |
| תיאור | אופציונלי | פסקה אחת של טקסט שמתארת את הישות. הערה: המשתמש יראה את רשימת התיאורים או את רשימת הכתוביות, אבל לא את שתיהן. |
טקסט חופשי גודל טקסט מומלץ: 180 תווים |
| רשימת כתוביות | אופציונלי | עד 3 כתוביות, כאשר כל כתובית היא שורה אחת של טקסט. הערה: המשתמש יראה את רשימת התיאורים או את רשימת הכתוביות, אבל לא את שתיהן. |
טקסט חופשי גודל הטקסט המומלץ לכל כתובית: 50 תווים לכל היותר |
| מזהה ההזמנה | אופציונלי | מזהה ההזמנה של הזמנת מקום הלינה. | טקסט חופשי |
| דירוג – ערך מקסימלי | אופציונלי | הערך המקסימלי בסולם הדירוג. חובה לציין את המאפיין הזה אם מציינים גם את הערך הנוכחי של הדירוג. |
מספר >= 0.0 |
| דירוג – ערך נוכחי | אופציונלי | הערך הנוכחי של סולם הדירוג. חובה לציין את המאפיין הזה אם מציינים גם את הערך המקסימלי של הדירוג. |
מספר >= 0.0 |
| דירוג – מספר | אופציונלי | ספירת הדירוגים של מקום האירוח. הערה: צריך לספק את השדה הזה אם האפליקציה רוצה לשלוט באופן שבו הוא מוצג למשתמשים. צריך לספק את המחרוזת התמציתית שאפשר להציג למשתמש. לדוגמה, אם המספר הוא 1,000,000, כדאי להשתמש בקיצורים כמו 1M, כדי שהמספר לא ייחתך בגדלים קטנים יותר של מסכים. |
מחרוזת |
| דירוג – ערך הספירה | אופציונלי | ספירת הדירוגים של מקום האירוח. הערה: צריך לציין את השדה הזה אם לא רוצים לטפל בעצמכם בלוגיקה של קיצור התצוגה. אם מופיעים גם הערך Count וגם הערך Count Value, נשתמש בערך Count כדי להציג את הנתונים למשתמשים |
ארוך |
| מחיר – מחיר נוכחי | חובה (מותנה) | המחיר הנוכחי של מקום האירוח. חובה לציין את המאפיין הזה אם מציינים מחיר קודם מחוק. |
טקסט חופשי |
| מחיר – מחיר קודם מחוק | אופציונלי | המחיר המקורי של מקום האירוח, שיוצג עם קו חוצה בממשק המשתמש. | טקסט חופשי |
| נכס יתרונות מרכזיים עם מחיר | אופציונלי | המחיר מוצג בהדגשה כדי להציג מבצע, אירוע או הנחה לחברי מועדון, אם יש כאלה. | טקסט חופשי גודל הטקסט המומלץ: פחות מ-45 תווים (אם הטקסט ארוך מדי, יכול להיות שיוצגו שלוש נקודות) |
| DisplayTimeWindow (אופציונלי) – הגדרת חלון זמן להצגת תוכן בממשק | |||
| חותמת זמן של התחלה | אופציונלי |
חותמת הזמן של התקופה שאחריה התוכן צריך להיות מוצג במשטח. אם לא מוגדרת הגבלה, התוכן יכול להופיע בפלטפורמה. |
חותמת זמן של תקופת זמן המערכת באלפיות השנייה |
| חותמת זמן של סיום | אופציונלי |
חותמת הזמן של העידן שאחריה התוכן לא מוצג יותר בפלטפורמה. אם לא מוגדרת הגבלה, התוכן יכול להופיע בפלטפורמה. |
חותמת זמן של תקופת זמן המערכת באלפיות השנייה |
TransportationReservationEntity
| מאפיין | דרישה | תיאור | פורמט |
|---|---|---|---|
| URI של הפעולה | חובה |
קישור עומק לישות באפליקציה לבעלי מקצוע. הערה: אפשר להשתמש בקישורי עומק לשיוך (Attribution). אפשר לעיין בשאלות הנפוצות |
URI |
| כותרת | חובה | שם הישות. | טקסט חופשי. לדוגמה, 'SFO to SAN' גודל טקסט מומלץ: עד 50 תווים |
| סוג התחבורה | חובה | אמצעי התחבורה או סוג התחבורה בהזמנה. | ערכים לדוגמה: FLIGHT, TRAIN, BUS או FERRY |
| שעת יציאה מקומית – חותמת זמן | חובה | חותמת הזמן של העידן שמייצגת את שעת ההמראה. | Joda-Time Instant |
| שעת יציאה מקומית – אזור זמן | חובה | אזור הזמן של שעת היציאה. |
Joda-Time DateTimeZone הנחיות מפורטות זמינות במאמר מפרטים של אזורי זמן. |
| שעת הגעה מקומית – חותמת זמן | חובה | חותמת הזמן של העידן שמייצגת את זמן ההגעה. | Joda-Time Instant |
| שעת הגעה מקומית – אזור זמן | חובה | אזור הזמן של זמן ההגעה. |
Joda-Time DateTimeZone הנחיות מפורטות זמינות במאמר מפרטים של אזורי זמן. |
| מספר כרטיס הנסיעה | חובה | מספר הטיסה, מספר האוטובוס, מספר הרכבת או מספר המעבורת/השייט. | טקסט חופשי |
| זמן העלייה למטוס המקומי – חותמת זמן | חובה | חותמת הזמן של התקופה שמייצגת את זמן העלייה למטוס בהזמנה (אם רלוונטי) | Joda-Time Instant |
| זמן העלייה למטוס לפי השעון המקומי – אזור זמן | חובה | אזור הזמן של שעת העלייה למטוס בהזמנה (אם רלוונטי) |
Joda-Time DateTimeZone הנחיות מפורטות זמינות במאמר מפרטים של אזורי זמן. |
| מיקום ההמראה – מדינה | אופציונלי | מדינת המוצא. | טקסט חופשי גודל טקסט מומלץ: עד 20 תווים |
| מיקום המוצא – עיר | אופציונלי | עיר המוצא. | טקסט חופשי גודל טקסט מומלץ: עד 20 תווים |
| מיקום ההמראה – כתובת מוצגת | אופציונלי | מיקום היציאה שיוצג למשתמש. | טקסט חופשי גודל טקסט מומלץ: עד 20 תווים |
| מיקום ההמראה – רחוב | אופציונלי | כתובת הרחוב (אם רלוונטי) של מיקום ההמראה. | טקסט חופשי גודל טקסט מומלץ: עד 20 תווים |
| מיקום היציאה – מדינה | אופציונלי | המדינה או המחוז (אם רלוונטי) של מיקום היציאה. | טקסט חופשי גודל טקסט מומלץ: עד 20 תווים |
| מיקום ההמראה – מיקוד | אופציונלי | המיקוד (אם רלוונטי) של נקודת המוצא. | טקסט חופשי גודל טקסט מומלץ: עד 20 תווים |
| מיקום היציאה – שכונה | אופציונלי | השכונה (אם רלוונטי) של מיקום ההמראה. | טקסט חופשי גודל טקסט מומלץ: עד 20 תווים |
| מיקום ההגעה – מדינה | אופציונלי | מדינת ההגעה. | טקסט חופשי גודל טקסט מומלץ: עד 20 תווים |
| מיקום ההגעה – עיר | אופציונלי | העיר שבה נוחתים. | טקסט חופשי גודל טקסט מומלץ: עד 20 תווים |
| מיקום ההגעה – כתובת לתצוגה | אופציונלי | מיקום ההגעה שיוצג למשתמש. | טקסט חופשי גודל טקסט מומלץ: עד 20 תווים |
| מיקום ההגעה – כתובת | אופציונלי | הכתובת (אם רלוונטי) של מיקום ההגעה. | טקסט חופשי גודל טקסט מומלץ: עד 20 תווים |
| מיקום ההגעה – מדינה | אופציונלי | המדינה (state) או המחוז (אם רלוונטי) של מיקום ההגעה. | טקסט חופשי גודל טקסט מומלץ: עד 20 תווים |
| מיקום ההגעה – מיקוד | אופציונלי | המיקוד (אם רלוונטי) של מיקום ההגעה. | טקסט חופשי גודל טקסט מומלץ: עד 20 תווים |
| מיקום ההגעה – שכונה | אופציונלי | השכונה (אם רלוונטי) של מיקום ההגעה. | טקסט חופשי גודל טקסט מומלץ: עד 20 תווים |
| ספק השירות – שם | אופציונלי |
השם של ספק השירות. הערה: חובה להוסיף טקסט או תמונה לספק השירות. |
טקסט חופשי. לדוגמה, שם חברת התעופה |
| ספק שירות – תמונה | אופציונלי |
הלוגו או התמונה של ספק השירות. הערה: חובה להוסיף טקסט או תמונה לספק השירות. |
הנחיות זמינות במאמר בנושא מפרט לתמונות. |
| תמונות של פוסטרים | אופציונלי |
אם תספקו כמה תמונות, אנחנו נציג רק תמונה אחת. יחס הגובה-רוחב המומלץ הוא 16:9 |
הנחיות זמינות במאמר בנושא מפרט לתמונות. |
| תיאור | אופציונלי | פסקה אחת של טקסט שמתארת את הישות. הערה: המשתמש יראה את רשימת התיאורים או את רשימת הכתוביות, אבל לא את שתיהן. |
טקסט חופשי גודל טקסט מומלץ: 180 תווים |
| רשימת כתוביות | אופציונלי | עד 3 כתוביות, כאשר כל כתובית היא שורה אחת של טקסט. הערה: המשתמש יראה את רשימת התיאורים או את רשימת הכתוביות, אבל לא את שתיהן. |
טקסט חופשי גודל הטקסט המומלץ לכל כתובית: 50 תווים לכל היותר |
| מזהה ההזמנה | אופציונלי | מזהה ההזמנה של הזמנת התחבורה. | טקסט חופשי |
| מחיר – מחיר נוכחי | חובה (מותנה) | המחיר הנוכחי של ההזמנה. חובה לציין את המאפיין הזה אם מציינים מחיר קודם מחוק. |
טקסט חופשי |
| מחיר – מחיר קודם מחוק | אופציונלי | המחיר המקורי של ההזמנה, שיוצג עם קו חוצה בממשק המשתמש. | טקסט חופשי |
| נכס יתרונות מרכזיים עם מחיר | אופציונלי | המחיר מוצג בהדגשה כדי להציג מבצע, אירוע או הנחה לחברי מועדון, אם יש כאלה. | טקסט חופשי גודל הטקסט המומלץ: פחות מ-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 תווים |
| כתובת להחזרה – מדינה | אופציונלי | המדינה או המחוז (אם רלוונטי) של מיקום ההחזרה. | טקסט חופשי גודל טקסט מומלץ: עד 20 תווים |
| כתובת להחזרה – מיקוד | אופציונלי | המיקוד (אם רלוונטי) של מיקום ההחזרה. | טקסט חופשי גודל טקסט מומלץ: עד 20 תווים |
| כתובת להחזרת מוצרים – שכונה | אופציונלי | השכונה (אם רלוונטי) של מיקום ההחזרה. | טקסט חופשי גודל טקסט מומלץ: עד 20 תווים |
| ספק השירות – שם | אופציונלי |
השם של ספק השירות. הערה: חובה להוסיף טקסט או תמונה לספק השירות. |
טקסט חופשי. לדוגמה, "Avis Car Rental" |
| ספק שירות – תמונה | אופציונלי |
הלוגו או התמונה של ספק השירות. הערה: חובה להוסיף טקסט או תמונה לספק השירות. |
הנחיות זמינות במאמר בנושא מפרט לתמונות. |
| תמונות של פוסטרים | אופציונלי |
אם תספקו כמה תמונות, אנחנו נציג רק תמונה אחת. יחס הגובה-רוחב המומלץ הוא 16:9 |
הנחיות זמינות במאמר בנושא מפרט לתמונות. |
| תיאור | אופציונלי | פסקה אחת של טקסט שמתארת את הישות. הערה: המשתמש יראה את רשימת התיאורים או את רשימת הכתוביות, אבל לא את שתיהן. |
טקסט חופשי גודל טקסט מומלץ: 180 תווים |
| רשימת כתוביות | אופציונלי | עד 3 כתוביות, כאשר כל כתובית היא שורה אחת של טקסט. הערה: המשתמש יראה את רשימת התיאורים או את רשימת הכתוביות, אבל לא את שתיהן. |
טקסט חופשי גודל הטקסט המומלץ לכל כתובית: 50 תווים לכל היותר |
| מזהה האישור | אופציונלי | מזהה האישור של הזמנת השכרת הרכב. | טקסט חופשי |
| מחיר – מחיר נוכחי | חובה (מותנה) | המחיר הנוכחי של ההזמנה. חובה לציין את המאפיין הזה אם מציינים מחיר קודם מחוק. |
טקסט חופשי |
| מחיר – מחיר קודם מחוק | אופציונלי | המחיר המקורי של ההזמנה, שיוצג עם קו חוצה בממשק המשתמש. | טקסט חופשי |
| נכס יתרונות מרכזיים עם מחיר | אופציונלי | המחיר מוצג בהדגשה כדי להציג מבצע, אירוע או הנחה לחברי מועדון, אם יש כאלה. | טקסט חופשי גודל הטקסט המומלץ: פחות מ-45 תווים (אם הטקסט ארוך מדי, יכול להיות שיוצגו שלוש נקודות) |
| DisplayTimeWindow (אופציונלי) – הגדרת חלון זמן להצגת תוכן בממשק | |||
| חותמת זמן של התחלה | אופציונלי |
חותמת הזמן של התקופה שאחריה התוכן צריך להיות מוצג במשטח. אם לא מוגדרת הגבלה, התוכן יכול להופיע בפלטפורמה. |
חותמת זמן של תקופת זמן המערכת באלפיות השנייה |
| חותמת זמן של סיום | אופציונלי |
חותמת הזמן של העידן שאחריה התוכן לא מוצג יותר בפלטפורמה. אם לא מוגדרת הגבלה, התוכן יכול להופיע בפלטפורמה. |
חותמת זמן של תקופת זמן המערכת באלפיות השנייה |
מפרט לתמונות
בטבלה הזו מפורטות הדרישות לגבי נכסי תמונות:
| יחס גובה-רוחב | מספר פיקסלים מינימלי | מספר פיקסלים מומלץ |
|---|---|---|
ריבוע (1x1) מועדף |
300x300 | 1,200x1,200 |
| תמונה לרוחב (1.91x1) | 600x314 | 1,200x628 |
| לאורך (4x5) | 480x600 | 960x1200 |
התמונות צריכות להיות מאוחסנות ברשתות 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, שמכיל את סוגי האשכולות שצריך לבדוק את זמינות השירות שלהם. בטבלה הבאה מפורטים ClusterTypeערכי ה-enum
הנדרשים עבור ServiceAvailabilityRequest.
| סוג האשכול | קבוע מסוג אשכול | ערך של מספר שלם |
|---|---|---|
| לא ידוע | TYPE_UNKNOWN |
0 |
| אשכול המלצות | TYPE_RECOMMENDATION |
1 |
| אשכול מוצג | TYPE_FEATURED |
2 |
| אוסף המשכים | TYPE_CONTINUATION |
3 |
| אשכול לניהול משתמשים | TYPE_ENGAGEMENT |
8 |
| Subscription Cluster | 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 לא צריך להיות מופעל 'באופן רציף' בכל המכשירים הנתמכים מסיבה כלשהי, והוא מוגדר להעברה לסירוגין של נתונים עבור קבוצת מכשירים כלשהי, כל הפרסומים של אשכול ההמשכיות (למשל, הזמנה והמשך חיפוש) עדיין יופעלו בהגדרת ברירת המחדל, ושאר סוגי האשכולות יופעלו ויכובו לסירוגין. אם ההטמעה לסירוגין רלוונטית לכם אבל הגדרת ברירת המחדל הזו לא מתאימה לצרכים שלכם, אתם יכולים לפנות לכתובת engage-developers@google.com.
לגרסאות SDK שקודמות לגרסה 1.6.0 (הוצאה משימוש)
Kotlin
client.isServiceAvailable.addOnCompleteListener { task ->
if (task.isSuccessful) {
// Handle IPC call success
if(task.result) {
// Service is available on the device, proceed with content publish
// calls.
} else {
// Service is not available, no further action is needed.
}
} else {
// The IPC call itself fails, proceed with error handling logic here,
// such as retry.
}
}
Java
client.isServiceAvailable().addOnCompleteListener(task - > {
if (task.isSuccessful()) {
// Handle success
if(task.getResult()) {
// Service is available on the device, proceed with content publish
// calls.
} else {
// Service is not available, no further action is needed.
}
} else {
// The IPC call itself fails, proceed with error handling logic here,
// such as retry.
}
});
publishRecommendationClusters
ה-API הזה משמש לפרסום רשימה של אובייקטים מסוג RecommendationCluster.
Kotlin
client.publishRecommendationClusters(
PublishRecommendationClustersRequest.Builder()
.addRecommendationCluster(
RecommendationCluster.Builder()
.addEntity(entity1)
.addEntity(entity2)
.setTitle("Top Picks For You")
.build()
)
.build()
)
Java
client.publishRecommendationClusters(
new PublishRecommendationClustersRequest.Builder()
.addRecommendationCluster(
new RecommendationCluster.Builder()
.addEntity(entity1)
.addEntity(entity2)
.setTitle("Top Picks For You")
.build())
.build());
כשהשירות מקבל את הבקשה, הפעולות הבאות מתבצעות במסגרת עסקה אחת:
- הנתונים הקיימים של
RecommendationClusterמשותף המפתחים יוסרו. - הנתונים מהבקשה מנותחים ומאוחסנים ב-RecommendationCluster המעודכן.
במקרה של שגיאה, הבקשה כולה נדחית והמצב הקיים נשמר.
publishFeaturedCluster
ה-API הזה משמש לפרסום רשימה של אובייקטים מסוג FeaturedCluster.
Kotlin
client.publishFeaturedCluster(
PublishFeaturedClusterRequest.Builder()
.setFeaturedCluster(
FeaturedCluster.Builder()
.addEntity(entity1)
.addEntity(entity2)
.build())
.build())
Java
client.publishFeaturedCluster(
new PublishFeaturedClustersRequest.Builder()
.addFeaturedCluster(
new FeaturedCluster.Builder()
.addEntity(entity1)
.addEntity(entity2)
.build())
.build());
כשהשירות מקבל את הבקשה, הפעולות הבאות מתבצעות במסגרת עסקה אחת:
- הנתונים הקיימים של
FeaturedClusterמשותף המפתחים יוסרו. - הנתונים מהבקשה מנותחים ומאוחסנים באוסף המאמרים המומלצים המעודכן.
במקרה של שגיאה, הבקשה כולה נדחית והמצב הקיים נשמר.
publishReservationCluster
ה-API הזה משמש לפרסום אובייקט ReservationCluster.
Kotlin
client.publishReservationCluster(
PublishReservationClusterRequest.Builder()
.setReservationCluster(
ReservationCluster.Builder()
.addLodgingReservationEntity(lodgingReservationEntity)
.addVehicleRentalReservationEntity(vehicleRentalReservationEntity)
.addTransportationReservationEntity(transportationReservationEntity)
.addEventReservationEntity(eventReservationEntity)
.addRestaurantReservationEntity(restaurantReservationEntity)
.build())
.build())
Java
client.publishReservationCluster(
new PublishReservationClusterRequest.Builder()
.setReservationCluster(
new ReservationCluster.Builder()
.addLodgingReservationEntity(lodgingReservationEntity)
.addVehicleRentalReservationEntity(vehicleRentalReservationEntity)
.addTransportationReservationEntity(transportationReservationEntity)
.addEventReservationEntity(eventReservationEntity)
.addRestaurantReservationEntity(restaurantReservationEntity)
.build())
.build());
כשהשירות מקבל את הבקשה, הפעולות הבאות מתבצעות במסגרת עסקה אחת:
- הנתונים הקיימים של
ReservationClusterמשותף המפתחים יוסרו. - הנתונים מהבקשה מנותחים ונשמרים ב-Reservation Cluster המעודכן.
במקרה של שגיאה, הבקשה כולה נדחית והמצב הקיים נשמר.
publishContinueSearchCluster
ה-API הזה משמש לפרסום רשימה של אובייקטים מסוג ContinueSearchCluster.
Kotlin
client.publishContinueSearchCluster(
PublishContinueSearchClusterRequest.Builder()
.setContinueSearchCluster(
ContinueSearchCluster.Builder()
.addPointOfInterestEntity(entity1)
.addPointOfInterestEntity(entity2)
.build())
.build())
Java
client.publishContinueSearchCluster(
new PublishContinueSearchClusterRequest.Builder()
.setContinueSearchCluster(
new ContinueSearchCluster.Builder()
.addPointOfInterestEntity(entity1)
.addPointOfInterestEntity(entity2)
.build())
.build());
כשהשירות מקבל את הבקשה, הפעולות הבאות מתבצעות במסגרת עסקה אחת:
- הנתונים הקיימים של
ContinueSearchClusterמשותף המפתחים יוסרו. - הנתונים מהבקשה מנותחים ומאוחסנים באשכול המעודכן של המשך החיפוש.
במקרה של שגיאה, הבקשה כולה נדחית והמצב הקיים נשמר.
publishUserAccountManagementRequest
ה-API הזה משמש לפרסום כרטיס כניסה . פעולת הכניסה מפנה את המשתמשים לדף הכניסה של האפליקציה כדי שהאפליקציה תוכל לפרסם תוכן (או לספק תוכן מותאם אישית יותר)
המטא-נתונים הבאים הם חלק מכרטיס הכניסה –
| מאפיין | דרישה | תיאור |
|---|---|---|
| URI של הפעולה | חובה | קישור עומק לפעולה (כלומר, מעבר לדף הכניסה לאפליקציה) |
| תמונה | אופציונלי – אם לא מספקים את הערך הזה, צריך לספק את הערך Title |
התמונה שמוצגת בכרטיס תמונות עם יחס גובה-רוחב של 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());
deleteRecommendationClusters
ממשק ה-API הזה משמש למחיקת התוכן של קבוצות המלצות.
Kotlin
client.deleteRecommendationClusters()
Java
client.deleteRecommendationClusters();
כשהשירות מקבל את הבקשה, הוא מסיר את הנתונים הקיימים מאשכולות ההמלצות. במקרה של שגיאה, הבקשה כולה נדחית והמצב הקיים נשמר.
deleteFeaturedCluster
ממשק ה-API הזה משמש למחיקת התוכן של קבוצת תכונות מרכזית.
Kotlin
client.deleteFeaturedCluster()
Java
client.deleteFeaturedCluster();
כשהשירות מקבל את הבקשה, הוא מסיר את הנתונים הקיימים מהאשכול המומלץ. במקרה של שגיאה, הבקשה כולה נדחית והמצב הקיים נשמר.
deleteReservationCluster
ממשק ה-API הזה משמש למחיקת התוכן של Reservation Cluster.
Kotlin
client.deleteReservationCluster()
Java
client.deleteReservationCluster();
כשהשירות מקבל את הבקשה, הוא מסיר את הנתונים הקיימים מ-Reservation Cluster. במקרה של שגיאה, הבקשה כולה נדחית והמצב הקיים נשמר.
deleteUserManagementCluster
ה-API הזה משמש למחיקת התוכן של UserAccountManagement Cluster.
Kotlin
client.deleteUserManagementCluster()
Java
client.deleteUserManagementCluster();
כשהשירות מקבל את הבקשה, הוא מסיר את הנתונים הקיימים מהאשכול UserAccountManagement. במקרה של שגיאה, הבקשה כולה נדחית והמצב הקיים נשמר.
deleteContinueSearchCluster
ממשק ה-API הזה משמש למחיקת התוכן של אשכול המשך החיפוש.
Kotlin
client.deleteContinueSearchCluster()
Java
client.deleteContinueSearchCluster();
כשהשירות מקבל את הבקשה, הוא מסיר את הנתונים הקיימים מ-Continue Search Cluster. במקרה של שגיאה, הבקשה כולה נדחית והמצב הקיים נשמר.
deleteClusters
ממשק ה-API הזה משמש למחיקת התוכן של סוג מסוים של אשכול.
Kotlin
client.deleteClusters(
DeleteClustersRequest.Builder()
.addClusterType(ClusterType.TYPE_RESERVATION)
.addClusterType(ClusterType.TYPE_FEATURED)
.addClusterType(ClusterType.TYPE_RECOMMENDATION)
.addClusterType(ClusterType.TYPE_CONTINUE_SEARCH)
.build())
Java
client.deleteClusters(
new DeleteClustersRequest.Builder()
.addClusterType(ClusterType.TYPE_RESERVATION)
.addClusterType(ClusterType.TYPE_FEATURED)
.addClusterType(ClusterType.TYPE_RECOMMENDATION)
.addClusterType(ClusterType.TYPE_CONTINUE_SEARCH)
.build());
כשהשירות מקבל את הבקשה, הוא מסיר את הנתונים הקיימים מכל האשכולות שתואמים לסוגי האשכולות שצוינו. הלקוחות יכולים לבחור להעביר סוג אחד או כמה סוגים של אשכולות. במקרה של שגיאה, הבקשה כולה נדחית והמצב הקיים נשמר.
טיפול בשגיאות
מומלץ מאוד להאזין לתוצאת המשימה מממשקי ה-API של הפרסום, כדי שאפשר יהיה לבצע פעולת המשך לשחזור ולשליחה מחדש של משימה שהושלמה בהצלחה.
Kotlin
client.publishRecommendationClusters(
PublishRecommendationClustersRequest.Builder()
.addRecommendationCluster(..)
.build())
.addOnCompleteListener { task ->
if (task.isSuccessful) {
// do something
} else {
val exception = task.exception
if (exception is AppEngageException) {
@AppEngageErrorCode val errorCode = exception.errorCode
if (errorCode == AppEngageErrorCode.SERVICE_NOT_FOUND) {
// do something
}
}
}
}
Java
client.publishRecommendationClusters(
new PublishRecommendationClustersRequest.Builder()
.addRecommendationCluster(...)
.build())
.addOnCompleteListener(
task -> {
if (task.isSuccessful()) {
// do something
} else {
Exception exception = task.getException();
if (exception instanceof AppEngageException) {
@AppEngageErrorCode
int errorCode = ((AppEngageException) exception).getErrorCode();
if (errorCode == AppEngageErrorCode.SERVICE_NOT_FOUND) {
// do something
}
}
}
});
השגיאה מוחזרת כ-AppEngageException עם הסיבה שכלולה כקוד שגיאה.
| קוד שגיאה | שם השגיאה | הערה |
|---|---|---|
1 |
SERVICE_NOT_FOUND |
השירות לא זמין במכשיר הזה. |
2 |
SERVICE_NOT_AVAILABLE |
השירות זמין במכשיר הנתון, אבל הוא לא זמין בזמן השיחה (לדוגמה, הוא מושבת באופן מפורש). |
3 |
SERVICE_CALL_EXECUTION_FAILURE |
ההרצה של המשימה נכשלה בגלל בעיות בשרשור. במקרה כזה, אפשר לנסות שוב. |
4 |
SERVICE_CALL_PERMISSION_DENIED |
לפונה אין הרשאה להתקשר לשירות. |
5 |
SERVICE_CALL_INVALID_ARGUMENT |
הבקשה מכילה נתונים לא תקינים (לדוגמה, מספר האשכולות חורג מהמספר המותר). |
6 |
SERVICE_CALL_INTERNAL |
יש שגיאה בצד השירות. |
7 |
SERVICE_CALL_RESOURCE_EXHAUSTED |
הקריאה לשירות מתבצעת בתדירות גבוהה מדי. |
שלב 3: טיפול ב-Intents של שידור
בנוסף לקריאות ל-API לפרסום תוכן דרך משימה, צריך גם להגדיר BroadcastReceiver כדי לקבל את הבקשה לפרסום תוכן.
המטרה של שידורי Intent היא בעיקר להפעיל מחדש אפליקציות ולאלץ סנכרון נתונים. לא מומלץ לשלוח שידורי כוונות בתדירות גבוהה מאוד. ההתראה מופעלת רק כשהשירות של Engage קובע שהתוכן לא עדכני (לדוגמה, אם הוא נוצר לפני שבוע). כך המשתמשים יכולים להיות בטוחים שהם יקבלו חוויית תוכן חדשה, גם אם האפליקציה לא הופעלה במשך תקופה ארוכה.
צריך להגדיר את BroadcastReceiver בשתי הדרכים הבאות:
רישום דינמי של מופע של המחלקה
BroadcastReceiverבאמצעותContext.registerReceiver(). ההרשאה הזו מאפשרת תקשורת מאפליקציות שעדיין פועלות בזיכרון.
Kotlin
class AppEngageBroadcastReceiver : BroadcastReceiver(){
// Trigger recommendation cluster publish when PUBLISH_RECOMMENDATION broadcast
// is received
// Trigger featured cluster publish when PUBLISH_FEATURED broadcast is received
// Trigger continue search cluster publish when PUBLISH_CONTINUE_SEARCH
// broadcast is received
// Trigger reservation cluster publish when PUBLISH_RESERVATION broadcast is
// received
}
fun registerBroadcastReceivers(context: Context){
var context = context
context = context.applicationContext
// Register Recommendation Cluster Publish Intent
context.registerReceiver(AppEngageBroadcastReceiver(),
IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_RECOMMENDATION),
com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
/*scheduler=*/null)
// Register Featured Cluster Publish Intent
context.registerReceiver(AppEngageBroadcastReceiver(),
IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_FEATURED),
com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
/*scheduler=*/null)
// Register Continue Search Cluster Publish Intent
context.registerReceiver(AppEngageBroadcastReceiver(),
IntentFilter(com.google.android.engage.travel.service.Intents.ACTION_PUBLISH_CONTINUE_SEARCH),
com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
/*scheduler=*/null)
// Register Reservation Cluster Publish Intent
context.registerReceiver(AppEngageBroadcastReceiver(),
IntentFilter(com.google.android.engage.travel.service.Intents.ACTION_PUBLISH_RESERVATION),
com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
/*scheduler=*/null)
}
Java
class AppEngageBroadcastReceiver extends BroadcastReceiver {
// Trigger recommendation cluster publish when PUBLISH_RECOMMENDATION broadcast
// is received
// Trigger featured cluster publish when PUBLISH_FEATURED broadcast is received
// Trigger continue search cluster publish when PUBLISH_CONTINUE_SEARCH
// broadcast is received
// Trigger reservation cluster publish when PUBLISH_RESERVATION broadcast is
// received
}
public static void registerBroadcastReceivers(Context context) {
context = context.getApplicationContext();
// Register Recommendation Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
new IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_RECOMMENDATION),
com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
/*scheduler=*/null);
// Register Featured Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
new IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_FEATURED),
com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
/*scheduler=*/null);
// Register Continue Search Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
new IntentFilter(com.google.android.engage.travel.service.Intents.ACTION_PUBLISH_CONTINUE_SEARCH),
com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
/*scheduler=*/null);
// Register Reservation Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
new IntentFilter(com.google.android.engage.travel.service.Intents.ACTION_PUBLISH_RESERVATION),
com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
/*scheduler=*/null);
}
מצהירים באופן סטטי על הטמעה באמצעות התג
<receiver>בקובץAndroidManifest.xml. ההרשאה הזו מאפשרת לאפליקציה לקבל שידורי Intent כשהיא לא פועלת, וגם מאפשרת לאפליקציה לפרסם את התוכן.
<application>
<receiver
android:name=".AppEngageBroadcastReceiver"
android:permission="com.google.android.engage.REQUEST_ENGAGE_DATA"
android:exported="true"
android:enabled="true">
<intent-filter>
<action android:name="com.google.android.engage.action.PUBLISH_RECOMMENDATION" />
</intent-filter>
<intent-filter>
<action android:name="com.google.android.engage.action.PUBLISH_FEATURED" />
</intent-filter>
<intent-filter>
<action android:name="com.google.android.engage.action.travel.PUBLISH_CONTINUE_SEARCH" />
</intent-filter>
<intent-filter>
<action android:name="com.google.android.engage.action.travel.PUBLISH_RESERVATION" />
</intent-filter>
</receiver>
</application>
הכוונה הבאה נשלחת על ידי השירות:
com.google.android.engage.action.PUBLISH_RECOMMENDATIONמומלץ להתחיל שיחתpublishRecommendationClustersכשמתקבלת הכוונה הזו.com.google.android.engage.action.PUBLISH_FEATUREDמומלץ להתחיל שיחהpublishFeaturedClusterכשמתקבלת הכוונה הזו.com.google.android.engage.action.travel.PUBLISH_CONTINUE_SEARCHמומלץ להתחיל שיחתpublishContinueSearchClusterכשמקבלים את הכוונה הזו.com.google.android.engage.action.travel.PUBLISH_RESERVATIONמומלץ להתחיל שיחתpublishReservationClusterכשמתקבלת הכוונה הזו.
תהליך העבודה של השילוב
מדריך מפורט לאימות השילוב אחרי שהוא הושלם זמין במאמר תהליך העבודה של שילוב מפתחים ב-Engage.
שאלות נפוצות
יצירת קשר
אם יש לכם שאלות במהלך תהליך האינטגרציה, תוכלו לפנות אל engage-developers@google.com.
השלבים הבאים
אחרי שמסיימים את השילוב, השלבים הבאים הם:
- שולחים אימייל לכתובת
engage-developers@google.comומצרפים את קובץ ה-APK המשולב שמוכן לבדיקה על ידי Google. - Google מבצעת אימות ובדיקה פנימית כדי לוודא שהשילוב פועל כצפוי. אם יהיה צורך בשינויים, Google תיצור איתך קשר ותספק את כל הפרטים הנדרשים.
- כשהבדיקה מסתיימת ולא צריך לבצע שינויים, Google תיצור איתכם קשר כדי להודיע לכם שאתם יכולים להתחיל לפרסם את קובץ ה-APK המעודכן והמשולב בחנות Play.
- אחרי ש-Google תאשר שקובץ ה-APK המעודכן פורסם בחנות Play, יכול להיות שקטעי ההמלצות, התוצאות הנבחרות, ההזמנות והמשך החיפוש יפורסמו ויוצגו למשתמשים.