Method: accounts.freeBookingLinksReportViews.query

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

בקשת HTTP

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

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

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

פרמטרים
name

string

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

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

פרמטרים
filter

string

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

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

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

ההתאמה בין הערכים של partnerHotelDisplayName לא תלויה באותיות רישיות.

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

  • date = '2021-12-03'
  • date between '2021-12-03' and '2021-12-08'
  • deviceType = 'TABLET'
  • deviceType in ('MOBILE', 'TABLET')
  • partnerHotelId = 'AAA'
  • partnerHotelId in ('AAA', 'BBB')
  • partnerHotelDisplayName = 'hotel A'
  • partnerHotelDisplayName in ('Hotel A', 'HOTEL b')
  • userRegionCode = 'US'
  • userRegionCode in ('US', 'CA')
aggregateBy

string

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

ערך המחרוזת הוא רשימה של שדות שמופרדים בפסיקים. השדות התקפים הם: date,‏ userRegionCode,‏ deviceType,‏ partnerHotelId ו-partnerHotelDisplayName. רק השדות שמצוינים כאן נכללים ב-FreeBookingLinksResult.
pageSize

integer

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

string

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

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

גוף הבקשה

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

גוף התשובה

הוצאה משימוש: במקום זאת, צריך להשתמש ב-QueryPropertyPerformanceReportResponse עם PropertyPerformanceReportService. הודעת תגובה לFreeBookingLinksReportService.QueryFreeBookingLinksReport.

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

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

object (FreeBookingLinksResult)

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

string

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

היקפי הרשאות

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

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

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

FreeBookingLinksResult

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

ייצוג ב-JSON 
{
  "date": {
    object (Date)
  },
  "userRegionCode": string,
  "deviceType": enum (Device),
  "partnerHotelId": string,
  "partnerHotelDisplayName": string,
  "clickCount": string
}
שדות
date

object (Date)

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

הפרמטר הזה מופיע רק אם date מצוין ב-aggregateBy בבקשה.
userRegionCode

string

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

השדה הזה מופיע רק אם userRegionCode מצוין ב-aggregateBy בבקשה
deviceType

enum (Device)

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

הפרמטר הזה מופיע רק אם deviceType מצוין ב-aggregateBy בבקשה.
partnerHotelId

string

מזהה המלון של השותף.

הפרמטר הזה מופיע רק אם partnerHotelId מצוין ב-aggregateBy בבקשה.
partnerHotelDisplayName

string

שם המלון של השותף.

הפרמטר הזה מופיע רק אם partnerHotelDisplayName מצוין ב-aggregateBy בבקשה.
clickCount

string (int64 format)

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