Method: accounts.participationReportViews.query

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

בקשת HTTP

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

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

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

פרמטרים
name

string

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

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

פרמטרים
filter

string

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

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

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

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

  • advanceBookingWindow = 2
  • advanceBookingWindow >= 0
  • advanceBookingWindow <= 5
  • checkinDate = '2020-10-01'
  • checkinDate >= '2020-10-01'
  • checkinDate <= '2020-10-01'
  • checkinDate between '2020-10-01' and '2020-10-05'
  • date = '2020-02-04'
  • date between '2020-02-04' and '2020-02-09'
  • deviceType = 'TABLET'
  • deviceType in ('MOBILE', 'TABLET')
  • hotelRegionCode = 'US'
  • hotelRegionCode in ('US', 'CA')
  • lengthOfStayDays = 2
  • lengthOfStayDays >= 0
  • lengthOfStayDays <= 5
  • occupancy = 2
  • occupancy >= 0
  • occupancy <= 5
  • occupancy between 1 and 5
  • partnerHotelId = 'AAA'
  • partnerHotelId in ('AAA', 'BBB')
  • userRegionCode = 'US'
  • userRegionCode in ('US', 'CA')
aggregateBy

string

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

ערך המחרוזת הוא רשימה של שדות שמופרדים בפסיקים. השדות התקפים הם: date,‏ userRegionCode,‏ deviceType,‏ partnerHotelId,‏ hotelRegionCode,‏ advanceBookingWindow,‏ lengthOfStayDays,‏ checkinDate ו-occupancy. שדות שלא צוינו לא נכללים ב-ParticipationResult.

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

integer

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

string

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

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

גוף הבקשה

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

גוף התשובה

הודעת תגובה לParticipationReportService.QueryParticipationReport.

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

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

object (ParticipationResult)

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

string

אסימון עימוד שמשמש לאחזור של דף התוצאות הבא.

היקפי הרשאות

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

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

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

ParticipationResult

מייצג תוצאה של שאילתה לגבי נתוני השתתפות בחשבון.

ייצוג ב-JSON 
{
  "key": {
    object (Key)
  },
  "opportunityCount": string,
  "participationCount": string,
  "participationPercent": number,
  "missedParticipationCount": string,
  "missedParticipationCountDetails": {
    object (MissedParticipationCountDetails)
  },
  "partnerHotelDisplayName": string
}
שדות
key

object (Key)

המפתח של התוצאה.
opportunityCount

string (int64 format)

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

string (int64 format)

המספר הכולל של ההזדמנויות שבהן הייתם כשירים להשתתף בתהליך המכרז של Google Ads.
participationPercent

number

שיעור ההשתתפות הוא מדד באחוזים. כדי לחשב אותו מחלקים את מספר ההזדמנויות שההשתתפות בהן התממשה במספר ההזדמנויות הכולל. לדוגמה, אם נכס עמד בדרישות להשתתפות במכרז של Google Ads‏ 90 פעמים מתוך 100 הזדמנויות, שיעור ההשתתפות הוא 90%.
missedParticipationCount

string (int64 format)

המספר הכולל של ההזדמנויות שלא עומדות בדרישות להשתתפות בתהליך המכרז ב-Google Ads. הוא כולל את הרכיבים הבאים:

  • חסר דף נחיתה
  • חסר מחיר
  • בעיה במחיר
  • המחיר לא זמין
  • אחר
missedParticipationCountDetails

object (MissedParticipationCountDetails)

הסיבות לכך שההשתתפות לא נספרה (לדוגמה, אין זמינות) וספירה כוללת לכל סיבה.
partnerHotelDisplayName

string

השם המוצג של המלון של השותף. השדה הזה מאוכלס רק כשהתוצאה מצטברת לפי partnerHotelId.

מפתח

המפתח של תוצאה.

ייצוג ב-JSON 
{
  "date": {
    object (Date)
  },
  "userRegionCode": string,
  "deviceType": enum (Device),
  "partnerHotelId": string,
  "hotelRegionCode": string,
  "advanceBookingWindow": integer,
  "lengthOfStayDays": integer,
  "checkinDate": {
    object (Date)
  },
  "occupancy": integer
}
שדות
date

object (Date)

התאריך שבו רוצים לקבל מדדים.

אם date הוא לא ערך של הפרמטר aggregateBy בקריאת הבקשה, השדה date לא מוחזר ב-Key.
userRegionCode

string

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

אם userRegionCode הוא לא ערך של הפרמטר aggregateBy בקריאת הבקשה, השדה userRegionCode לא מוחזר ב-Key.
deviceType

enum (Device)

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

אם deviceType הוא לא ערך של הפרמטר aggregateBy בקריאת הבקשה, השדה deviceType לא מוחזר ב-Key.
partnerHotelId

string

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

אם partnerHotelId הוא לא ערך של הפרמטר aggregateBy בקריאת הבקשה, השדה partnerHotelId לא מוחזר ב-Key.
hotelRegionCode

string

קוד האזור/המדינה של המלון במאגר CLDR.

אם hotelRegionCode הוא לא ערך של הפרמטר aggregateBy בקריאת הבקשה, השדה hotelRegionCode לא מוחזר ב-Key.
advanceBookingWindow

integer

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

אם advanceBookingWindow הוא לא ערך של הפרמטר aggregateBy בקריאת הבקשה, השדה advanceBookingWindow לא מוחזר ב-Key.
lengthOfStayDays

integer

מספר הלילות במסלול הנסיעה.

אם lengthOfStayDays הוא לא ערך של הפרמטר aggregateBy בקריאת הבקשה, השדה lengthOfStayDays לא מוחזר ב-Key.
checkinDate

object (Date)

תאריך הצ'ק-אין של מסלול הנסיעה.

אם checkinDate הוא לא ערך של הפרמטר aggregateBy בקריאת הבקשה, השדה checkinDate לא מוחזר ב-Key.
occupancy

integer

מספר הנוסעים הכולל במסלול הנסיעה.

אם occupancy הוא לא ערך של הפרמטר aggregateBy בקריאת הבקשה, השדה occupancy לא מוחזר ב-Key.

MissedParticipationCountDetails

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

ייצוג ב-JSON 
{
  "noAvailabilityCount": string,
  "hotelSuspendedCount": string,
  "noTaxBreakdownCount": string,
  "noLandingPageCount": string,
  "noPriceCount": string,
  "noPriceCountDetails": {
    object (NoPriceCountDetails)
  },
  "otherReasonCount": string,
  "priceMissingCount": string,
  "priceMissingCountDetails": {
    object (PriceMissingCountDetails)
  },
  "priceProblemCount": string,
  "priceProblemCountDetails": {
    object (PriceProblemCountDetails)
  },
  "priceUnavailableCount": string,
  "priceUnavailableCountDetails": {
    object (PriceUnavailableCountDetails)
  }
}
שדות
noAvailabilityCount
(deprecated)

string (int64 format)

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

string (int64 format)

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

string (int64 format)

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

string (int64 format)

לא נמצא דף נחיתה שתואם למשתמש.
noPriceCount
(deprecated)

string (int64 format)

המספר הכולל של ההשתתפויות שהוחמצו בגלל שלא הוצע מחיר לתוכנית הנסיעה המבוקשת.
noPriceCountDetails
(deprecated)

object (NoPriceCountDetails)

הסיבות שהובילו לכך שלא הוצג מחיר (לדוגמה, מחיר בזמן אמת לא זמין) והספירה הכוללת של כל סיבה.
otherReasonCount

string (int64 format)

המלון לא השתתף מסיבה לא ידועה.
priceMissingCount

string (int64 format)

המספר הכולל של הפעמים שבהן לא השתתפתם במכרז בגלל שמחיר לא הופיע במטמון של Google או בגלל שהתגובה שלכם למחיר בזמן אמת לא עברה בהצלחה. הוא כולל את הרכיבים הבאים:

  • רוחב הפס מוצה
  • חסר שיעור מטמון
  • המסלול חסום
  • לא הוגדר תמחור בזמן אמת
  • זמן קצוב לתפוגה של מחיר בזמן אמת
  • שגיאה במחיר בזמן אמת
priceMissingCountDetails

object (PriceMissingCountDetails)

הסיבות שהובילו לכך שהמחיר לא מופיע.
priceProblemCount

string (int64 format)

המספר הכולל של מקרים שבהם לא הייתה השתתפות בגלל בעיה בדיוק המחיר שסופק למועד השהייה. הוא כולל את הרכיבים הבאים:

  • מלון מושעה
  • המחיר גבוה באופן חריג
  • המחיר נמוך באופן חריג
  • חסרים מיסים ופידים
priceProblemCountDetails

object (PriceProblemCountDetails)

הסיבות שהובילו לבעיה במחיר.
priceUnavailableCount

string (int64 format)

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

  • המחיר לא זמין
  • לא סביר שתהיה השתתפות
  • אחר
priceUnavailableCountDetails

object (PriceUnavailableCountDetails)

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

NoPriceCountDetails

הסיבות שתרמו לספירה של 'אין מחיר' ולספירה הכוללת של כל סיבה.

ייצוג ב-JSON 
{
  "livePricingTechnicalIssueCount": string,
  "livePricingNotTriggeredCount": string,
  "livePricingConfigIssueCount": string,
  "livePricingNotAvailableCount": string,
  "livePricingOtherReasonCount": string
}
שדות
livePricingTechnicalIssueCount

string (int64 format)

המספר הכולל של השתתפות שהוחמצה בגלל בעיות טכניות במחירים בזמן אמת, מכל אחת מהסיבות הבאות:

  • לא הגבתם מספיק מהר ועברתם את המועד האחרון לתגובה (כ-4,000 אלפיות השנייה).
  • החזרת שגיאה.
  • התגובה שלך הייתה בפורמט לא תקין.
livePricingNotTriggeredCount

string (int64 format)

המספר הכולל של הפעמים שבהן לא הופעל מחיר בזמן אמת, ולכן לא הייתה אפשרות להשתתף במכרז, בגלל אחת מהסיבות הבאות:

  • לא הגדרתם הצעת מחיר.
  • לא היה לכם דף נחיתה תקין.
  • לא היו מספיק מחירים במטמון.
livePricingConfigIssueCount

string (int64 format)

המספר הכולל של הפעמים שבהן לא הופעל מחיר בזמן אמת, ולכן לא הייתה אפשרות להשתתף במכרז, בגלל אחת מהסיבות הבאות:

  • לא הגדרתם תמחור בזמן אמת לחיפושים האלה.
  • הגבלת את הגישה של Google למסלול הנסיעה של המלון הרלוונטי.
livePricingNotAvailableCount

string (int64 format)

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

string (int64 format)

מספר הפעמים שבהן לא השתתפתם בגלל בעיות אחרות במחירים בזמן אמת.

PriceMissingCountDetails

הסיבות שתרמו למספר המוצרים שחסר להם מחיר ולמספר הכולל של כל סיבה.

ייצוג ב-JSON 
{
  "cacheRateMissingCount": string,
  "itineraryBlockedCount": string,
  "livePricingNotSetupCount": string,
  "bandwidthDepletedCount": string,
  "livePricingTimeoutCount": string,
  "livePricingErrorCount": string
}
שדות
cacheRateMissingCount

string (int64 format)

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

string (int64 format)

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

string (int64 format)

לא נשמר במטמון מחיר למסלול הנסיעה הזה, ולא הוגדרה שאילתה בזמן אמת לחשבון הזה.
bandwidthDepletedCount

string (int64 format)

לא נשמר במטמון מחיר למסלול הנסיעה הזה, ולא נותרה מכסה לשאילתות בזמן אמת.
livePricingTimeoutCount

string (int64 format)

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

string (int64 format)

לא נשמר במטמון מחיר למסלול הנסיעה הזה. השאילתה הפעילה לא הגיעה לזמן הקצוב לתפוגה, אבל המערכת החזירה שגיאה.

PriceProblemCountDetails

הסיבות שהובילו לבעיות במחיר, והספירה הכוללת של כל סיבה.

ייצוג ב-JSON 
{
  "hotelSuspendedCount": string,
  "priceUnusuallyHighCount": string,
  "priceUnusuallyLowCount": string,
  "taxesAndFeesMissingCount": string,
  "basePriceViolationsCount": string,
  "priceAccuracyIssueCount": string
}
שדות
hotelSuspendedCount

string (int64 format)

המלון הושעה. הסיבה לכך יכולה להיות בעיות חוזרות בתחומים כמו מיסים ועמלות לא נכונים.
priceUnusuallyHighCount

string (int64 format)

המחיר שצוין למסלול הנסיעה הזה נראה גבוה באופן חריג בהשוואה למגמות באזור.
priceUnusuallyLowCount

string (int64 format)

המחיר שצוין למסלול הנסיעה הזה נראה נמוך באופן חריג בהשוואה למגמות האזוריות.
taxesAndFeesMissingCount

string (int64 format)

המחירים לא כללו מיסים ועמלות.
basePriceViolationsCount

string (int64 format)

המחיר הבסיסי נמוך מדי ביחס למחיר הכולל.
priceAccuracyIssueCount

string (int64 format)

בעיה שקשורה לדיוק במחירים.

PriceUnavailableCountDetails

הסיבות שתרמו למספר המוצרים שהמחיר שלהם לא זמין, ולמספר הכולל של כל סיבה.

ייצוג ב-JSON 
{
  "priceUnavailableCount": string,
  "participationNotLikelyCount": string
}
שדות
priceUnavailableCount

string (int64 format)

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

string (int64 format)

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