Method: accounts.freeBookingLinksReportViews.query

已淘汰：請改用 PropertyPerformanceReportService.QueryPropertyPerformanceReport，該函式也提供曝光報表。可查詢 (取得、篩選及區隔) 特定帳戶的免費預訂連結報表。

HTTP 要求

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

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

路徑參數

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

要求日期範圍內的日期。

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

string

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

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

enum (Device)

使用者的裝置類型。

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

string

合作夥伴的飯店 ID。

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

string

合作夥伴的飯店名稱。

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

string (int64 format)

這項結果記錄到的總點擊次數。