- HTTP リクエスト
- パスパラメータ
- クエリ パラメータ
- リクエストの本文
- レスポンスの本文
- 承認スコープ
- ParticipationResult
- キー
- MissedParticipationCountDetails
- NoPriceCountDetails
- PriceMissingCountDetails
- PriceProblemCountDetails
- PriceUnavailableCountDetails
特定のアカウントの参加レポートに対して、クエリ(取得、フィルタ、セグメント化)を行うことができます。
HTTP リクエスト
GET https://travelpartner.googleapis.com/v3/{name=accounts/*}/participationReportViews:query
この URL は gRPC Transcoding 構文を使用します。
パスパラメータ
| パラメータ | |
|---|---|
| name | 
 クエリ対象のアカウントのリソース名。形式は  | 
クエリ パラメータ
| パラメータ | |
|---|---|
| filter | 
 クエリ対象のアカウントの参加指標のフィルタに使用する条件(フィールドと式)。この構文では、 
 有効な条件の例を以下に示します。 
 | 
| aggregateBy | 
 クエリによって返される指標を分割する方法を指定します。たとえば、 文字列値はフィールドのカンマ区切りのリストです。有効なフィールドは、 多数の行を生成する  | 
| pageSize | 
 返される参加結果の最大数。サービスはこの値より少ない値を返すことがあります。指定しない場合は、最大 10,000 件の結果が返されます。最大値は 10,000 です。10,000 を超える値は 10,000 に強制変換されます。 | 
| pageToken | 
 前回の使用量レポートビュー リクエストから受け取ったページトークン。次のページを取得するためにこれを指定してください。 ページ分けする際は、participantReportViews.query に与えられた他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。 | 
リクエスト本文
リクエストの本文は空にする必要があります。
レスポンスの本文
成功すると、レスポンスの本文に次の構造のデータが含まれます。
ParticipationReportService.QueryParticipationReport に対するレスポンス メッセージです。
| JSON 表現 | 
|---|
| {
  "results": [
    {
      object ( | 
| フィールド | |
|---|---|
| results[] | 
 クエリに一致する結果のリスト。 | 
| nextPageToken | 
 結果の次のページを取得するために使用されるページ設定トークン。 | 
認証スコープ
次の OAuth スコープが必要です。
- https://www.googleapis.com/auth/travelpartner
詳しくは、OAuth 2.0 の概要をご覧ください。
参加結果
アカウントの参加統計のクエリの結果を表します。
| JSON 表現 | 
|---|
| { "key": { object ( | 
| フィールド | |
|---|---|
| key | 
 結果のキー。 | 
| opportunityCount | 
 特定のホテルで利用することができた機会の合計数。機会とは、ホテルの広告をユーザーに表示することができたはずの合計回数のことです。 | 
| participationCount | 
 Google 広告オークションに参加できた機会の総数。 | 
| participationPercent | 
 参加できた機会の回数を機会の総数で割った、参加割合のパーセンテージ。たとえば、100 回の機会に対して宿泊施設が Google 広告オークションに 90 回参加できた場合、参加率は 90% になります。 | 
| missedParticipationCount | 
 Google 広告オークションの対象とならなかった機会の総数。以下の項目で構成されます。 
 | 
| missedParticipationCountDetails | 
 参加失敗数の要因となった理由(空き状況など)、およびそれぞれの理由の合計数。 | 
| partnerHotelDisplayName | 
 パートナーのホテル表示名。このフィールドは、結果が  | 
鍵
結果のキー。
| JSON 表現 | 
|---|
| { "date": { object ( | 
| フィールド | |
|---|---|
| date | 
 指標をリクエストする日付。 リクエスト呼び出しの  | 
| userRegionCode | 
 ユーザーの国/地域の ISO 3116 地域コード。 リクエスト呼び出しの  | 
| deviceType | 
 ユーザーのデバイスの種類。 リクエスト呼び出しの  | 
| partnerHotelId | 
 パートナーのホテル ID。 リクエスト呼び出しの  | 
| hotelRegionCode | 
 ホテルの国または地域の CLDR 地域コード。 リクエスト呼び出しの  | 
| advanceBookingWindow | 
 宿泊プランを予約しようとしている日数。 リクエスト呼び出しの  | 
| lengthOfStayDays | 
 宿泊プランの宿泊日数。 リクエスト呼び出しの  | 
| checkinDate | 
 旅行プランのチェックイン日。 リクエスト呼び出しの  | 
| occupancy | 
 旅行プランの総定員。 リクエスト呼び出しの  | 
MissedParticipationCountDetails
不参加の回数は理由別に分類されています。
| JSON 表現 | 
|---|
| { "noAvailabilityCount": string, "hotelSuspendedCount": string, "noTaxBreakdownCount": string, "noLandingPageCount": string, "noPriceCount": string, "noPriceCountDetails": { object ( | 
| フィールド | |
|---|---|
| noAvailabilityCount | 
 ホテルと宿泊プランの組み合わせを使用できなかったために、または旅行者が料金の対象でなかったために入札不可になった合計回数。オークションに入札するには、より詳細な料金情報を指定する必要があります。 | 
| hotelSuspendedCount | 
 料金精度違反により 1 つ以上のホテルが停止されたために入札不可になった合計回数。 | 
| noTaxBreakdownCount | 
 税金と諸費用を個別に指定していないホテルが 1 つ以上あったために入札不可になった合計回数。 | 
| noLandingPageCount | 
 ユーザーと一致するランディング ページがありませんでした。 | 
| noPriceCount | 
 リクエストされた宿泊プランの料金が提供されなかったために入札不可になった合計回数。 | 
| noPriceCountDetails | 
 料金が発生しない原因(ライブ料金を利用できないなど)と理由ごとの合計数。 | 
| otherReasonCount | 
 不明な理由により参加しませんでした。 | 
| priceMissingCount | 
 料金が Google のキャッシュに存在しない、またはライブ料金へのレスポンスが成功しなかったために入札不可になった合計回数。以下の項目で構成されます。 
 | 
| priceMissingCountDetails | 
 料金が見つからない原因として考えられるカウント。 | 
| priceProblemCount | 
 宿泊プランに対して提示された料金の精度に問題があるために、入札不可になった合計回数。以下の項目で構成されます。 
 | 
| priceProblemCountDetails | 
 料金の問題の原因となった理由。 | 
| priceUnavailableCount | 
 リクエストされた宿泊プランの料金が利用不可(-1)だったために参加を逃したオークションの合計回数。以下の項目で構成されます。 
 | 
| priceUnavailableCountDetails | 
 料金が利用できなかった理由もカウントされます。 | 
NoPriceCountDetails
料金が発生しない理由と、それぞれの理由の合計回数。
| JSON 表現 | 
|---|
| { "livePricingTechnicalIssueCount": string, "livePricingNotTriggeredCount": string, "livePricingConfigIssueCount": string, "livePricingNotAvailableCount": string, "livePricingOtherReasonCount": string } | 
| フィールド | |
|---|---|
| livePricingTechnicalIssueCount | 
 次のいずれかの理由によってライブ料金の技術的な問題が発生したために入札不可になった合計回数。 
 | 
| livePricingNotTriggeredCount | 
 次のいずれかの理由でライブ料金がトリガーされなかったために入札不可になった合計回数: 
 | 
| livePricingConfigIssueCount | 
 次のいずれかの理由でライブ料金がトリガーされなかったために入札不可になった合計回数: 
 | 
| livePricingNotAvailableCount | 
 ライブ料金が利用できなかったために入札不可になった合計回数。デフォルトの宿泊プランや UI によっては、ライブ料金が発生しないことがあります。このシナリオでは、パートナーが入札するには、キャッシュされた料金が必要になります。 | 
| livePricingOtherReasonCount | 
 ライブ料金に関するその他の問題により入札不可になった回数。 | 
PriceMissingCountDetails
価格が見つからない原因となった理由と、各理由の合計数。
| JSON 表現 | 
|---|
| { "cacheRateMissingCount": string, "itineraryBlockedCount": string, "livePricingNotSetupCount": string, "bandwidthDepletedCount": string, "livePricingTimeoutCount": string, "livePricingErrorCount": string } | 
| フィールド | |
|---|---|
| cacheRateMissingCount | 
 この宿泊プランの料金がキャッシュ内にありません。ページの制約により、ライブ クエリが実行されませんでした。 | 
| itineraryBlockedCount | 
 この宿泊プランは基本的なパラメータから外れていたため、対応する料金はライブクエリからもキャッシュ フィルからも取得されませんでした。 | 
| livePricingNotSetupCount | 
 この宿泊プランの料金はキャッシュされておらず、このアカウントにライブクエリが設定されていませんでした。 | 
| bandwidthDepletedCount | 
 この宿泊プランの料金はキャッシュされておらず、ライブ クエリの割り当ても残っていませんでした。 | 
| livePricingTimeoutCount | 
 この宿泊プランの料金はキャッシュされておらず、システムに送信されたライブクエリはタイムアウトしました。 | 
| livePricingErrorCount | 
 この宿泊プランの料金はキャッシュされていませんでした。ライブクエリはタイムアウトしませんでしたが、システムからエラーが返されました。 | 
PriceProblemCountDetails
価格の問題の原因となった理由と、それぞれの理由の合計回数。
| JSON 表現 | 
|---|
| { "hotelSuspendedCount": string, "priceUnusuallyHighCount": string, "priceUnusuallyLowCount": string, "taxesAndFeesMissingCount": string } | 
| フィールド | |
|---|---|
| hotelSuspendedCount | 
 ホテルの掲載が停止されました。その理由として、税金や諸費用が不正確であるなどの問題が続いている可能性が考えられます。 | 
| priceUnusuallyHighCount | 
 この宿泊プランの料金が、地域のトレンドと比べて不自然に高くなっていました。 | 
| priceUnusuallyLowCount | 
 この宿泊プランの料金が、地域のトレンドと比べて不自然に低くなっていました。 | 
| taxesAndFeesMissingCount | 
 税金と諸費用が料金に入力されていませんでした。 |