Method: accounts.propertyPerformanceReportViews.query

可查詢 (取得、篩選及區隔) 特定帳戶的免費預訂連結報表。這個新版本會傳回曝光次數和點擊次數，以及更多篩選器/匯總。

HTTP 要求

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

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
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)

要求日期範圍內的日期。

只有在要求中的 aggregateBy 指定 date 時才會顯示。
advanceBookingWindow

enum (AdvanceBookingWindow)

查詢日期與入住日期之間的差異 (以天為單位)，以資源的當地時區為準。

只有在要求中的 aggregateBy 指定 advanceBookingWindow 時才會顯示。
brand

string

合作夥伴為房源指定的品牌。

只有在要求中的 aggregateBy 指定 brand 時才會顯示。
deviceType

enum (Device)

使用者的裝置類型。

只有在要求中的 aggregateBy 指定 deviceType 時才會顯示。
highIntentUsers

boolean

使用者的查詢是否顯示出高度預訂意願。

只有在要求中的 aggregateBy 指定 highIntentUsers 時才會顯示。
lengthOfStay

enum (LengthOfStay)

使用者指定的入住和退房日期之間的天數。

只有在要求中的 aggregateBy 指定 lengthOfStay 時才會顯示。
propertyRegionCode

string

資源所在國家/地區的 ISO 3116 區域代碼。

只有在要求中的 aggregateBy 指定 propertyRegionCode 時才會顯示
occupancy

enum (Occupancy)

入住住宿的預計人數。

只有在要求中的 aggregateBy 指定 partnerPropertyId 時才會顯示。
partnerPropertyId

string

合作夥伴的房源 ID。

只有在要求中的 aggregateBy 指定 partnerPropertyId 時才會顯示。
partnerPropertyDisplayName

string

合作夥伴的房源名稱。

只有在要求中的 aggregateBy 指定 partnerPropertyDisplayName 時才會顯示。
userRegionCode

string

使用者的國家/地區 ISO 3116 區域代碼。

只有在要求中的 aggregateBy 指定 userRegionCode 時才會顯示
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)。所有日期比較都是以資源時區為準。

列舉
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)。

列舉
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 晚。

可住人數

列舉支援的會議室總人數。

列舉
OCCUPANCY_UNSPECIFIED 不指定。
OCCUPANCY_1 單人。
OCCUPANCY_2 兩個人。
OCCUPANCY_3 三個人。
OCCUPANCY_4 四個人。
OCCUPANCY_OVER_4 超過 4 人。