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 演算子で結合できます。

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

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

partnerPropertyDisplayNamebrand の値は、大文字と小文字が区別されません。

有効な条件の例を以下に示します。

  • 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 ではユーザー リージョンごとに集計された指標が提供されます。

文字列値はフィールドのカンマ区切りのリストです。有効なフィールドは、advanceBookingWindowbranddatedeviceTypehighIntentUserslengthOfStaypropertyRegionCodeoccupancypartnerPropertyIdpartnerPropertyDisplayNameuserRegionCode です。PropertyPerformanceResult には、ここで指定したフィールドのみが含まれます。

pageSize

integer

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

pageToken

string

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

ページ分けする際は、participantReportViews.query に与えられた他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。

リクエスト本文

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

レスポンスの本文

成功すると、レスポンスの本文に次の構造のデータが含まれます。

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

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

object (PropertyPerformanceResult)

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

nextPageToken

string

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

認証スコープ

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

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

詳しくは、OAuth 2.0 の概要をご覧ください。

プロパティのパフォーマンス結果

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

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
}
フィールド
date

object (Date)

リクエストされた期間内の日付。

リクエストの aggregateBydate が指定されている場合にのみ存在します。

advanceBookingWindow

enum (AdvanceBookingWindow)

宿泊施設のタイムゾーンでのクエリの日付とチェックインの日付の差です。

リクエストの aggregateByadvanceBookingWindow が指定されている場合にのみ存在します。

brand

string

パートナーが設定した、パートナーのブランド。

リクエストの aggregateBybrand が指定されている場合にのみ存在します。

deviceType

enum (Device)

ユーザーのデバイスの種類。

リクエストの aggregateBydeviceType が指定されている場合にのみ存在します。

highIntentUsers

boolean

ユーザーのクエリが予約に強い関心を示しているかどうか。

リクエストの aggregateByhighIntentUsers が指定されている場合にのみ存在します。

lengthOfStay

enum (LengthOfStay)

ユーザーが指定したチェックイン日からチェックアウト日までの日数。

リクエストの aggregateBylengthOfStay が指定されている場合にのみ存在します。

propertyRegionCode

string

宿泊施設の国または地域を表す ISO 3116 地域コード。

リクエストの aggregateBypropertyRegionCode が指定されている場合にのみ存在します。

occupancy

enum (Occupancy)

宿泊施設に宿泊希望人数です。

リクエストの aggregateBypartnerPropertyId が指定されている場合にのみ存在します。

partnerPropertyId

string

パートナーのプロパティ ID。

リクエストの aggregateBypartnerPropertyId が指定されている場合にのみ存在します。

partnerPropertyDisplayName

string

パートナーのプロパティ名。

リクエストの aggregateBypartnerPropertyDisplayName が指定されている場合にのみ存在します。

userRegionCode

string

ユーザーの国/地域の ISO 3116 地域コード。

リクエストの aggregateByuserRegionCode が指定されている場合にのみ存在します。

clickCount

string (int64 format)

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

impressionCount

string (int64 format)

この結果に対して記録されたインプレッションの総数。この値は、ユーザーのプライバシーを保護するために四捨五入されます。

clickthroughRate

number

clickCountimpressionCount で割った値と等しい。

予約可能期間

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

滞在日数

サポートされている滞在日数(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 一人向け
OCCUPANCY_2 2 人。
OCCUPANCY_3 3 人。
OCCUPANCY_4 4 人。
OCCUPANCY_OVER_4 4 人以上。