Method: accounts.propertyPerformanceReportViews.query

特定のアカウントの無料リスティング レポートをクエリ(取得、フィルタ、セグメント化)する機能を提供します。この新しいバージョンでは、インプレッション数とクリック数に加えて、フィルタ/集計のより大きなスーパーセットが返されます。

HTTP リクエスト

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

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

パスパラメータ

パラメータ
name

string

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

クエリ パラメータ

パラメータ
filter

string

クエリ対象のアカウントのプロパティ パフォーマンス指標をフィルタするために使用される条件(フィールドと式)。構文では、in 演算子の前後にスペースが必要です。それ以外の場合は、スペースを省略できます。条件は AND 演算子を使用して結合できます。

重要: 複数の条件を追加する正しい構文は "?filter=<condition>=<value>%20AND%20<condition>=<value>..." です。

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

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

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 に含まれます。

重要: partnerHotelId 個以上の値で aggregateBy パラメータを使用すると、エラーが発生する可能性があります。partnerHotelId と date でフィルタリングして行数を減らすと、エラーの発生を防ぐことができます。

pageSize

integer

返される参加結果の最大数。サービスが返す値はこれよりも少ないことがあります。指定されていない場合、最大で 10,000 件の結果が返されます。最大値は 10,000 です。10,000 を超える値は 10,000 に強制変換されます。

pageToken

string

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

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

リクエストの本文

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

レスポンスの本文

PropertyPerformanceReportService.QueryPropertyPerformanceReport に対するレスポンス メッセージです。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

JSON 表現
{
  "results": [
    {
      object (PropertyPerformanceResult)
    }
  ],
  "nextPageToken": string
}
フィールド
results[]

object (PropertyPerformanceResult)

クエリに一致する結果のリスト。

nextPageToken

string

結果の次のページを取得するために使用されるページ設定トークン。このフィールドを省略すると、後続のページはなくなります。

認可スコープ

次の OAuth スコープが必要です。

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

詳細については、OAuth 2.0 Overview をご覧ください。

PropertyPerformanceResult

アカウントのプロパティ パフォーマンス レポートのクエリ結果を表します。

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,
  "adsClickCount": string,
  "adsImpressionCount": string,
  "adsClickthroughRate": number,
  "vrWebsiteButtonClicks": string
}
フィールド
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 で割った値に等しい。

adsClickCount

string (int64 format)

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

adsImpressionCount

string (int64 format)

この結果で記録された広告インプレッションの合計数。

adsClickthroughRate

number

adsClickCount を adsImpressionCount で割った値に等しい。

vrWebsiteButtonClicks

string (int64 format)

Google で民泊の [ウェブサイト] ボタンがクリックされた回数の合計。

AdvanceBookingWindow

サポートされている予約可能期間(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 日以上経過している。

LengthOfStay

サポートされている滞在日数(LOS)を列挙します。

列挙型
LENGTH_OF_STAY_UNSPECIFIED 指定されていません。
LENGTH_OF_STAY_NIGHTS_1 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 1 人。
OCCUPANCY_2 2 人。
OCCUPANCY_3 3 人。
OCCUPANCY_4 4 人。
OCCUPANCY_OVER_4 4 人以上。