Method: accounts.freeBookingLinksReportViews.query

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

בקשת HTTP

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

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

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

פרמטרים
name

string

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

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

פרמטרים
filter

string

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

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

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

הערכים של 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 ייאכפו ל-10,000.
pageToken

string

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

בעת העימוד, כל הפרמטרים האחרים המסופקים ל-השתתפותReportViews.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.

תוצאת FreeBookingLinks

הוצא משימוש: במקומה יש להשתמש במדיניות 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)

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