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

前回の participationReportViews.query リクエストから受け取ったページトークン。後続のページを受け取るには、これを指定します。

ページ分割を行う場合、participationReportViews.query に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。

リクエストの本文

リクエストの本文は空にする必要があります。

レスポンスの本文

非推奨: 代わりに PropertyPerformanceReportService で QueryPropertyPerformanceReportResponse を使用してください。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

非推奨: 代わりに PropertyPerformanceReportService で PropertyPerformanceResult を使用してください。アカウントの無料予約リンクの統計情報をクエリした結果を表します。

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)

この結果に対して記録されたクリック数の合計。