本頁面由 Cloud Translation API 翻譯而成。

Method: accounts.propertyPerformanceReportViews.query

HTTP 要求
路徑參數
查詢參數
要求主體
回應主體
- JSON 表示法
授權範圍
PropertyPerformanceResult
- JSON 表示法
提前預訂回溯期
入住天數
活動情形

可查詢或取得特定帳戶的資源成效連結報表 (取得、篩選及區隔)。

HTTP 要求

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

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

路徑參數

參數

參數
`name`	`string` 所查詢帳戶的資源名稱。格式：accounts/{account_id}

name

string

所查詢帳戶的資源名稱。格式：accounts/{account_id}

查詢參數

參數
`filter`	`string` 用於篩選所查詢帳戶資源成效指標的條件 (欄位和運算式)。語法必須有 `in` 運算子周圍的空格。否則，您可以省略空格。您可以使用 `and` 運算子彙整條件。 `date` 為必填欄位。其他欄位則為選填欄位。 `date` 欄位值皆為包含，且必須採用 YYYY-MM-DD 格式。最早的接受日期為 2021 年 3 月 9 日；較早的日期值將強制轉換成 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 只會包含此處指定的欄位。
`pageSize`	`integer` 要傳回的參與結果上限。服務傳回的值可能會低於這個值。如果未指定，則最多傳回 10,000 筆結果。最大值為 10,000；高於 10,000 的值將強制轉換成 10,000。
`pageToken`	`string` 您先前從 engagementReportViews.query 要求收到的頁面權杖，請提供這項資訊，以便接收後續頁面。進行分頁時，提供給 engagementReportViews.query 的所有其他參數都必須與提供網頁權杖的呼叫相符。

要求主體

要求主體必須為空白。

回應主體

如果成功，回應主體即會包含具有以下結構的資料：

「PropertyPerformanceReportService.QueryPropertyPerformanceReport」的回應訊息。

JSON 表示法
{ "results": [ { object (`PropertyPerformanceResult`) } ], "nextPageToken": string }

欄位

欄位
`results[]`	`object (PropertyPerformanceResult)` 符合查詢的結果清單。
`nextPageToken`	`string` 用於擷取下一頁結果的分頁符記。如果省略這個欄位，就不會有後續頁面。

results[]

object (PropertyPerformanceResult)

符合查詢的結果清單。

nextPageToken

string

用於擷取下一頁結果的分頁符記。如果省略這個欄位，就不會有後續頁面。

授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱 OAuth 2.0 總覽。

屬性效能結果

代表查詢帳戶的資源成效報表所產生的結果。

JSON 表示法

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 }

{
  "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
}

欄位
`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`。

提前預訂回溯期

採用支援的提前預訂回溯期 (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 天。

入住天數

列舉支援的入住天數 (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 人。