Method: accounts.freeBookingLinksReportViews.query

サポート終了: 代わりにインプレッション レポートのある PropertyPerformanceReportService.QueryPropertyPerformanceReport を使用してください。特定のアカウントに対し、無料の予約リンクレポートをクエリ（取得、フィルタリング、セグメント化）する機能を提供します。

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
name

string

クエリ対象のアカウントのリソース名。形式: accounts/{account_id}

クエリ パラメータ

パラメータ
filter

string

クエリ対象のアカウントの無料の予約リンクの指標をフィルタするために使用する条件（フィールドと式）。この構文では、in 演算子を囲むスペースが必要です。それ以外の場合は、スペースを省略できます。条件は and 演算子で結合できます。

date フィールドは必須です。その他のフィールドはすべて省略可能です。

date フィールドの値は包括的で、YYYY-MM-DD 形式にする必要があります。最も早い日付は 2021 年 3 月 9 日です。それより前の日付の値は 2021 年 3 月 9 日に強制変換されます。

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

前回の使用量レポートビュー リクエストから受け取ったページトークン。次のページを取得するためにこれを指定してください。

ページ分けする際は、participantReportViews.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)

この検索結果について記録されたクリックの合計数。