- HTTP リクエスト
- パスパラメータ
- クエリ パラメータ
- リクエストの本文
- レスポンスの本文
- 承認スコープ
- PropertyPerformanceResult
- AdvanceBookingWindow(予約予約期間)
- 滞在日数
- 定員
特定のアカウントのプロパティ パフォーマンス リンク レポートをクエリ(取得、フィルタ、セグメント化)する機能を提供します。
HTTP リクエスト
GET https://travelpartner.googleapis.com/v3/{name=accounts/*}/propertyPerformanceReportViews:query
この URL は gRPC Transcoding 構文を使用します。
パスパラメータ
パラメータ | |
---|---|
name |
クエリ対象のアカウントのリソース名。形式: accounts/{account_id} |
クエリ パラメータ
パラメータ | |
---|---|
filter |
クエリ対象のアカウントにおけるプロパティのパフォーマンス指標のフィルタに使用する条件(フィールドと式)。この構文では、
有効な条件の例を以下に示します。
|
aggregateBy |
クエリによって返される指標を分割する方法を指定します。たとえば 文字列値はフィールドのカンマ区切りのリストです。有効なフィールドは、 |
pageSize |
返される参加結果の最大数。サービスはこの値より少ない値を返すことがあります。指定しない場合は、最大 10,000 件の結果が返されます。最大値は 10,000 です。10,000 を超える値は 10,000 に強制変換されます。 |
pageToken |
前回の使用量レポートビュー リクエストから受け取ったページトークン。次のページを取得するためにこれを指定してください。 ページ分けする際は、participantReportViews.query に与えられた他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。 |
リクエスト本文
リクエストの本文は空にする必要があります。
レスポンスの本文
成功すると、レスポンスの本文に次の構造のデータが含まれます。
PropertyPerformanceReportService.QueryPropertyPerformanceReport
に対するレスポンス メッセージです。
JSON 表現 |
---|
{
"results": [
{
object ( |
フィールド | |
---|---|
results[] |
クエリに一致する結果のリスト。 |
nextPageToken |
結果の次のページを取得するために使用されるページ設定トークン。このフィールドを省略すると、後続のページはなくなります。 |
認証スコープ
次の OAuth スコープが必要です。
https://www.googleapis.com/auth/travelpartner
詳しくは、OAuth 2.0 の概要をご覧ください。
プロパティのパフォーマンス結果
アカウントのプロパティ パフォーマンス レポートのクエリの結果を表します。
JSON 表現 |
---|
{ "date": { object ( |
フィールド | |
---|---|
date |
リクエストされた期間内の日付。 リクエストの |
advanceBookingWindow |
宿泊施設のタイムゾーンでのクエリの日付とチェックインの日付の差です。 リクエストの |
brand |
パートナーが設定した、パートナーのブランド。 リクエストの |
deviceType |
ユーザーのデバイスの種類。 リクエストの |
highIntentUsers |
ユーザーのクエリが予約に強い関心を示しているかどうか。 リクエストの |
lengthOfStay |
ユーザーが指定したチェックイン日からチェックアウト日までの日数。 リクエストの |
propertyRegionCode |
宿泊施設の国または地域を表す ISO 3116 地域コード。 リクエストの |
occupancy |
宿泊施設に宿泊希望人数です。 リクエストの |
partnerPropertyId |
パートナーのプロパティ ID。 リクエストの |
partnerPropertyDisplayName |
パートナーのプロパティ名。 リクエストの |
userRegionCode |
ユーザーの国/地域の ISO 3116 地域コード。 リクエストの |
clickCount |
この検索結果について記録されたクリックの合計数。 |
impressionCount |
この結果に対して記録されたインプレッションの総数。この値は、ユーザーのプライバシーを保護するために四捨五入されます。 |
clickthroughRate |
|
予約可能期間
サポートされている予約可能期間(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 人以上。 |