Method: accounts.propertyPerformanceReportViews.query

מאפשרת לשלוח שאילתות (לקבל, לסנן ולפלח) דוח קישורים של ביצועי נכסים עבור חשבון ספציפי.

בקשת HTTP

GET https://travelpartner.googleapis.com/v3/{name=accounts/*}/propertyPerformanceReportViews:query

כתובת ה-URL כוללת תחביר gRPC קידוד מחדש.

פרמטרים של נתיב

פרמטרים
name

string

שם המשאב של החשבון שלגביו נשלחת שאילתה. פורמט: חשבונות/{account_id}

פרמטרי שאילתה

פרמטרים
filter

string

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

השדה date הוא שדה חובה. כל שאר השדות הם אופציונליים.

ערכי השדה date כלולים במחיר והם חייבים להיות בפורמט YYYY-MM-DD. התאריך הקביל המוקדם ביותר הוא 03.03.2021. הערכים הקודמים של התאריך ייאכפו ל-09.03.2021.

הערכים של partnerPropertyDisplayName ושל brand לא תלויי-רישיות.

דוגמאות לתנאים חוקיים:

  • advanceBookingWindow = 'ADVANCE_BOOKING_WINDOW_SAME_DAY'
  • advanceBookingWindow in ('ADVANCE_BOOKING_WINDOW_SAME_DAY', 'ADVANCE_BOOKING_WINDOW_DAYS_61_TO_90')
  • brand = 'Brand A'
  • brand in ('Brand A', 'brand B')
  • date = '2021-12-03'
  • date between '2021-12-03' and '2021-12-08'
  • deviceType = 'TABLET'
  • deviceType in ('MOBILE', 'TABLET')
  • highIntentUsers = 'TRUE'
  • highIntentUsers = 'FALSE'
  • lengthOfStay = 'LENGTH_OF_STAY_NIGHTS_2'
  • lengthOfStay in ('LENGTH_OF_STAY_NIGHTS_2', 'LENGTH_OF_STAY_NIGHTS_4_TO_7')
  • propertyRegionCode = 'US'
  • propertyRegionCode in ('US', 'CA')
  • occupancy = 'OCCUPANCY_2'
  • occupancy in ('OCCUPANCY_2', 'OCCUPANCY_OVER_4')
  • partnerPropertyId = 'AAA'
  • partnerPropertyId in ('AAA', 'BBB')
  • partnerPropertyDisplayName = 'hotel A'
  • partnerPropertyDisplayName in ('Hotel A', 'HOTEL b')
  • userRegionCode = 'US'
  • userRegionCode in ('US', 'CA')
aggregateBy

string

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

ערך המחרוזת הוא רשימה של שדות המופרדים בפסיקים. השדות החוקיים הם: advanceBookingWindow, brand, date, deviceType, highIntentUsers, lengthOfStay, propertyRegionCode, occupancy, partnerPropertyId, partnerPropertyDisplayName ו-userRegionCode. רק שדות שצוינו כאן נכללים ב-PropertyPerformanceResult.
pageSize

integer

המספר המקסימלי של תוצאות השתתפות שניתן להחזיר. השירות עשוי להחזיר פחות מהערך הזה. אם לא מצוין, יוחזרו עד 10,000 תוצאות. הערך המקסימלי הוא 10,000. הערכים מעל 10,000 ייאכפו ל-10,000.
pageToken

string

אסימון דף, שהתקבל מבקשת השתתפות קודמת של ReportViews.query. יש לספק אותו כדי לקבל את הדף הבא.

בעת העימוד, כל הפרמטרים האחרים המסופקים ל-השתתפותReportViews.query חייבים להתאים לשיחה שסיפקה את אסימון הדף.

גוף הבקשה

גוף הבקשה חייב להיות ריק.

גוף התגובה

אם התגובה מוצלחת, גוף התגובה מכיל נתונים במבנה הבא:

הודעת תגובה להודעה של PropertyPerformanceReportService.QueryPropertyPerformanceReport.

ייצוג JSON 
{
  "results": [
    {
      object (PropertyPerformanceResult)
    }
  ],
  "nextPageToken": string
}
שדות
results[]

object (PropertyPerformanceResult)

רשימת התוצאות שתואמות לשאילתה.
nextPageToken

string

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

היקפי הרשאה

יש צורך בהיקף OAuth הבא:

  • https://www.googleapis.com/auth/travelpartner

למידע נוסף, אפשר לעיין בסקירה הכללית על OAuth 2.0.

תוצאת ביצועי הנכס

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

ייצוג JSON 
{
  "date": {
    object (Date)
  },
  "advanceBookingWindow": enum (AdvanceBookingWindow),
  "brand": string,
  "deviceType": enum (Device),
  "highIntentUsers": boolean,
  "lengthOfStay": enum (LengthOfStay),
  "propertyRegionCode": string,
  "occupancy": enum (Occupancy),
  "partnerPropertyId": string,
  "partnerPropertyDisplayName": string,
  "userRegionCode": string,
  "clickCount": string,
  "impressionCount": string,
  "clickthroughRate": number
}
שדות
date

object (Date)

תאריך בטווח התאריכים המבוקש.

יש להציג את ההרשאה רק אם date צוין ב-aggregateBy בבקשה.
advanceBookingWindow

enum (AdvanceBookingWindow)

הבדל הימים בין תאריך השאילתה לבין תאריך הצ'ק-אין באזור הזמן המקומי של הנכס.

יש להציג את ההרשאה רק אם advanceBookingWindow צוין ב-aggregateBy בבקשה.
brand

string

המותג שצוין על ידי השותף לנכס.

יש להציג את ההרשאה רק אם brand צוין ב-aggregateBy בבקשה.
deviceType

enum (Device)

סוג המכשיר של המשתמש.

יש להציג את ההרשאה רק אם deviceType צוין ב-aggregateBy בבקשה.
highIntentUsers

boolean

אם שאילתת המשתמש הביעה עניין רב בהזמנות.

יש להציג את ההרשאה רק אם highIntentUsers צוין ב-aggregateBy בבקשה.
lengthOfStay

enum (LengthOfStay)

מספר הלילות בין תאריך הצ'ק-אין לתאריך הצ'ק-אאוט שצוין על ידי המשתמש.

יש להציג את ההרשאה רק אם lengthOfStay צוין ב-aggregateBy בבקשה.
propertyRegionCode

string

קוד האזור בתקן ISO 3116 של המדינה/האזור של הנכס.

יש להציג את הבקשה רק אם propertyRegionCode צוין בaggregateBy בבקשה
occupancy

enum (Occupancy)

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

יש להציג את ההרשאה רק אם partnerPropertyId צוין ב-aggregateBy בבקשה.
partnerPropertyId

string

מזהה הנכס של השותף.

יש להציג את ההרשאה רק אם partnerPropertyId צוין ב-aggregateBy בבקשה.
partnerPropertyDisplayName

string

שם הנכס של השותף.

יש להציג את ההרשאה רק אם partnerPropertyDisplayName צוין ב-aggregateBy בבקשה.
userRegionCode

string

קוד האזור ISO 3116 של המדינה/האזור של המשתמש.

יש להציג את הבקשה רק אם userRegionCode צוין בaggregateBy בבקשה
clickCount

string (int64 format)

המספר הכולל של הקליקים שתועדו לתוצאה הזו.
impressionCount

string (int64 format)

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

number

שווה ל-clickCount חלקי impressionCount.

חלון הזמנה מראש

מספרי חלונות נתמכים של הזמנות מראש (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 אנשים.