- HTTP リクエスト
- パスパラメータ
- クエリ パラメータ
- リクエストの本文
- レスポンスの本文
- 認可スコープ
- PropertyPerformanceResult
- AdvanceBookingWindow
- LengthOfStay
- Occupancy
特定のアカウントの無料リスティング レポートをクエリ(取得、フィルタ、セグメント化)する機能を提供します。この新しいバージョンでは、インプレッション数とクリック数に加えて、フィルタ/集計のより大きなスーパーセットが返されます。
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 |
前回の participationReportViews.query リクエストから受け取ったページトークン。後続のページを受け取るには、これを指定します。 ページ分割を行う場合、participationReportViews.query に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。 |
リクエストの本文
リクエストの本文は空にする必要があります。
レスポンスの本文
PropertyPerformanceReportService.QueryPropertyPerformanceReport に対するレスポンス メッセージです。
成功した場合、レスポンスの本文には次の構造のデータが含まれます。
| JSON 表現 |
|---|
{
"results": [
{
object ( |
| フィールド | |
|---|---|
results[] |
クエリに一致する結果のリスト。 |
nextPageToken |
結果の次のページを取得するために使用されるページ設定トークン。このフィールドを省略すると、後続のページはなくなります。 |
認可スコープ
次の OAuth スコープが必要です。
https://www.googleapis.com/auth/travelpartner
詳細については、OAuth 2.0 Overview をご覧ください。
PropertyPerformanceResult
アカウントのプロパティ パフォーマンス レポートのクエリ結果を表します。
| JSON 表現 |
|---|
{ "date": { object ( |
| フィールド | |
|---|---|
date |
リクエストされた期間内の日付。 リクエストの |
advanceBookingWindow |
宿泊施設の現地タイムゾーンでのクエリ日とチェックイン日の差(日数)。 リクエストの |
brand |
宿泊施設にパートナーが指定したブランド。 リクエストの |
deviceType |
ユーザーのデバイスの種類。 リクエストの |
highIntentUsers |
検索語句から、予約への購買意向が強いと推測されるかどうか。 リクエストの |
lengthOfStay |
ユーザーが指定したチェックイン日とチェックアウト日の間の宿泊数。 リクエストの |
propertyRegionCode |
プロパティの国/地域の ISO 3116 地域コード。 リクエストの |
occupancy |
宿泊施設に宿泊する人数。 リクエストの |
partnerPropertyId |
パートナーのプロパティ ID。 リクエストの |
partnerPropertyDisplayName |
パートナーのプロパティ名。 リクエストの |
userRegionCode |
ユーザーの国/地域の ISO 3116 地域コード。 リクエストの |
clickCount |
この結果で記録された無料の予約リンクのクリック数の合計。 |
impressionCount |
この結果に対して記録された無料の予約リンクのインプレッション数の合計。この数値は、ユーザーのプライバシー保護のため丸められています。 |
clickthroughRate |
|
adsClickCount |
この結果に対して記録された広告のクリック数の合計。 |
adsImpressionCount |
この結果で記録された広告インプレッションの合計数。 |
adsClickthroughRate |
|
vrWebsiteButtonClicks |
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 人以上。 |