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 年 3 月 9 日；較早的日期值將強制轉換成 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 的值將強制轉換成 10,000。
pageToken

string

您先前從 engagementReportViews.query 要求收到的頁面權杖，請提供這項資訊，以便接收後續頁面。

進行分頁時，提供給 engagementReportViews.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)

在指定日期範圍內的日期範圍。

只有在要求的 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)

針對這個結果記錄的點擊總數。