- בקשת HTTP
- פרמטרים של נתיב
- פרמטרים של שאילתה
- גוף הבקשה
- גוף התגובה
- היקפי הרשאה
- תוצאת ביצועי הנכס
- מודעת הזמנה מראש
- משך השהייה
- תפוסה
מאפשרת לשלוח שאילתות (לקבל, לסנן ולפלח) דוח קישורים של ביצועי נכסים עבור חשבון ספציפי.
בקשת HTTP
GET https://travelpartner.googleapis.com/v3/{name=accounts/*}/propertyPerformanceReportViews:query
כתובת ה-URL כוללת תחביר gRPC קידוד מחדש.
פרמטרים של נתיב
פרמטרים | |
---|---|
name |
שם המשאב של החשבון שלגביו נשלחת שאילתה. פורמט: חשבונות/{account_id} |
פרמטרי שאילתה
פרמטרים | |
---|---|
filter |
התנאים (שדות וביטויים) שמשמשים לסינון מדדי הביצועים של הנכס בחשבון שאליו נשלחת שאילתה. התחביר דורש רווחים מסביב לאופרטור השדה ערכי השדה הערכים של דוגמאות לתנאים חוקיים:
|
aggregateBy |
מציינת איך לפלח את המדדים שהוחזרו על ידי השאילתה. לדוגמה, אם בשדה ערך המחרוזת הוא רשימה של שדות המופרדים בפסיקים. השדות החוקיים הם: |
pageSize |
המספר המקסימלי של תוצאות השתתפות שניתן להחזיר. השירות עשוי להחזיר פחות מהערך הזה. אם לא מצוין, יוחזרו עד 10,000 תוצאות. הערך המקסימלי הוא 10,000. הערכים מעל 10,000 ייאכפו ל-10,000. |
pageToken |
אסימון דף, שהתקבל מבקשת השתתפות קודמת של ReportViews.query. יש לספק אותו כדי לקבל את הדף הבא. בעת העימוד, כל הפרמטרים האחרים המסופקים ל-השתתפותReportViews.query חייבים להתאים לשיחה שסיפקה את אסימון הדף. |
גוף הבקשה
גוף הבקשה חייב להיות ריק.
גוף התגובה
אם התגובה מוצלחת, גוף התגובה מכיל נתונים במבנה הבא:
הודעת תגובה להודעה של PropertyPerformanceReportService.QueryPropertyPerformanceReport
.
ייצוג JSON |
---|
{
"results": [
{
object ( |
שדות | |
---|---|
results[] |
רשימת התוצאות שתואמות לשאילתה. |
nextPageToken |
אסימון עימוד שמשמש לאחזור של דף התוצאות הבא. אם שדה זה יושמט, לא יהיו דפים נוספים. |
היקפי הרשאה
יש צורך בהיקף OAuth הבא:
https://www.googleapis.com/auth/travelpartner
למידע נוסף, אפשר לעיין בסקירה הכללית על OAuth 2.0.
תוצאת ביצועי הנכס
הנתון הזה מייצג תוצאה של יצירת שאילתה בדוח הביצועים של הנכס בחשבון.
ייצוג JSON |
---|
{ "date": { object ( |
שדות | |
---|---|
date |
תאריך בטווח התאריכים המבוקש. יש להציג את ההרשאה רק אם |
advanceBookingWindow |
הבדל הימים בין תאריך השאילתה לבין תאריך הצ'ק-אין באזור הזמן המקומי של הנכס. יש להציג את ההרשאה רק אם |
brand |
המותג שצוין על ידי השותף לנכס. יש להציג את ההרשאה רק אם |
deviceType |
סוג המכשיר של המשתמש. יש להציג את ההרשאה רק אם |
highIntentUsers |
אם שאילתת המשתמש הביעה עניין רב בהזמנות. יש להציג את ההרשאה רק אם |
lengthOfStay |
מספר הלילות בין תאריך הצ'ק-אין לתאריך הצ'ק-אאוט שצוין על ידי המשתמש. יש להציג את ההרשאה רק אם |
propertyRegionCode |
קוד האזור בתקן ISO 3116 של המדינה/האזור של הנכס. יש להציג את הבקשה רק אם |
occupancy |
נשלחה בקשה לקבלת מספר אנשים במלון. יש להציג את ההרשאה רק אם |
partnerPropertyId |
מזהה הנכס של השותף. יש להציג את ההרשאה רק אם |
partnerPropertyDisplayName |
שם הנכס של השותף. יש להציג את ההרשאה רק אם |
userRegionCode |
קוד האזור ISO 3116 של המדינה/האזור של המשתמש. יש להציג את הבקשה רק אם |
clickCount |
המספר הכולל של הקליקים שתועדו לתוצאה הזו. |
impressionCount |
המספר הכולל של חשיפות שתועדו עבור התוצאה הזו. הערך הזה מעוגל כדי לשמור על פרטיות המשתמשים. |
clickthroughRate |
שווה ל- |
חלון הזמנה מראש
מספרי חלונות נתמכים של הזמנות מראש (ABW). כל השוואות התאריכים הן באזור הזמן של הנכס.
Enums | |
---|---|
ADVANCE_BOOKING_WINDOW_UNSPECIFIED |
לא צוין. |
ADVANCE_BOOKING_WINDOW_SAME_DAY |
תאריך הצ'ק-אין היה זהה לתאריך השאילתה. |
ADVANCE_BOOKING_WINDOW_NEXT_DAY |
תאריך הצ'ק אין היה ביום המחרת. |
ADVANCE_BOOKING_WINDOW_DAYS_2_TO_7 |
תאריך הצ'ק אין היה 2-7 ימים אחרי תאריך השאילתה. |
ADVANCE_BOOKING_WINDOW_DAYS_8_TO_14 |
תאריך הצ'ק אין היה 8-14 ימים אחרי תאריך השאילתה. |
ADVANCE_BOOKING_WINDOW_DAYS_15_TO_30 |
תאריך הצ'ק אין היה 15-30 יום אחרי תאריך השאילתה. |
ADVANCE_BOOKING_WINDOW_DAYS_31_TO_60 |
תאריך הצ'ק אין היה 31 עד 60 יום אחרי תאריך השאילתה. |
ADVANCE_BOOKING_WINDOW_DAYS_61_TO_90 |
תאריך הצ'ק אין היה 61-90 יום אחרי תאריך השאילתה. |
ADVANCE_BOOKING_WINDOW_DAYS_91_TO_120 |
תאריך הצ'ק אין היה 91-120 יום אחרי תאריך השאילתה. |
ADVANCE_BOOKING_WINDOW_DAYS_121_TO_150 |
תאריך הצ'ק אין היה 121-150 יום אחרי תאריך השאילתה. |
ADVANCE_BOOKING_WINDOW_DAYS_151_TO_180 |
תאריך הצ'ק אין היה 151-180 יום אחרי תאריך השאילתה. |
ADVANCE_BOOKING_WINDOW_DAYS_OVER_180 |
תאריך הצ'ק אין היה יותר מ-180 יום אחרי תאריך השאילתה. |
משך השהייה
ציון של משך השהייה (LOS) הנתמך.
Enums | |
---|---|
LENGTH_OF_STAY_UNSPECIFIED |
לא צוין. |
LENGTH_OF_STAY_NIGHTS_1 |
שהייה של לילה אחד. |
LENGTH_OF_STAY_NIGHTS_2 |
שהייה של 2 לילות. |
LENGTH_OF_STAY_NIGHTS_3 |
שהייה של 3 לילות. |
LENGTH_OF_STAY_NIGHTS_4_TO_7 |
4-7 לילות. |
LENGTH_OF_STAY_NIGHTS_8_TO_14 |
8-14 לילות. |
LENGTH_OF_STAY_NIGHTS_15_TO_21 |
15-21 לילות. |
LENGTH_OF_STAY_NIGHTS_22_TO_30 |
22-30 לילות. |
LENGTH_OF_STAY_NIGHTS_OVER_30 |
שהייה של יותר מ-30 לילות. |
חדרים
כולל מספר כולל של תפוסת חדרים.
Enums | |
---|---|
OCCUPANCY_UNSPECIFIED |
לא צוין. |
OCCUPANCY_1 |
אדם אחד. |
OCCUPANCY_2 |
שני אנשים. |
OCCUPANCY_3 |
שלושה אנשים. |
OCCUPANCY_4 |
ארבעה אנשים. |
OCCUPANCY_OVER_4 |
יותר מ-4 אנשים. |