Method: accounts.propertyPerformanceReportViews.query

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

בקשת HTTP

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

כתובת ה-URL כתובה בתחביר של gRPC Transcoding.

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

פרמטרים
name

string

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

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

פרמטרים
filter

string

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

חשוב: התחביר הנכון להוספת כמה תנאים הוא: "?filter=<condition>=<value>%20AND%20<condition>=<value>..."

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

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

ההתאמה בין הערכים של 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.

חשוב: שימוש בפרמטר aggregateBy עם partnerHotelId או יותר משני ערכים עלול לגרום לשגיאה. סינון באמצעות partnerHotelId ו-date כדי לצמצם את מספר השורות יכול למנוע את השגיאות.
pageSize

integer

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

string

טוקן של דף שהתקבל מבקשת participationReportViews.query קודמת. צריך להזין את הטוקן כדי לקבל את הדף הבא.

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

גוף הבקשה

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

גוף התשובה

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

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

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

object (PropertyPerformanceResult)

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

string

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

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

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

ניתן למצוא מידע נוסף כאן: OAuth 2.0 Overview.

PropertyPerformanceResult

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

ייצוג ב-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,
  "adsClickCount": string,
  "adsImpressionCount": string,
  "adsClickthroughRate": number,
  "vrWebsiteButtonClicks": string
}
שדות
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.
adsClickCount

string (int64 format)

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

string (int64 format)

המספר הכולל של חשיפות למודעות שנרשמו לתוצאה הזו.
adsClickthroughRate

number

שווה ל-adsClickCount חלקי adsImpressionCount.
vrWebsiteButtonClicks

string (int64 format)

מספר הקליקים הכולל על הלחצן 'אתר' ב-Google עבור יחידות אירוח.

AdvanceBookingWindow

מפרט את החלונות להזמנה מראש (ABW) שנתמכים. כל ההשוואות בין תאריכים מתבצעות לפי אזור הזמן של הנכס.

טיפוסים בני מנייה (enum)
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 ימים אחרי תאריך השאילתה.

LengthOfStay

מפרט את משך השהייה הנתמך (LOS).

טיפוסים בני מנייה (enum)
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 לילות.

תפוסה

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

טיפוסים בני מנייה (enum)
OCCUPANCY_UNSPECIFIED לא צוין.
OCCUPANCY_1 אדם יחיד.
OCCUPANCY_2 שני אנשים.
OCCUPANCY_3 שלושה אנשים.
OCCUPANCY_4 ארבעה אנשים.
OCCUPANCY_OVER_4 מעל 4 אנשים.