Method: accounts.participationReportViews.query

提供查询（获取、过滤和细分）特定账号的参与度报告的功能。

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
name

string

所查询账号的资源名称。格式为 accounts/{account_id}。

查询参数

参数
filter

string

用于过滤所查询账号的参与度指标的条件（字段和表达式）。该语法要求在 in 运算符前后添加空格。否则，可以省略空格。可以使用 AND 运算符联接条件。

重要提示：添加多个条件的正确语法是："?filter=<condition>=<value>%20AND%20<condition>=<value>..."

date 是必填字段。所有其他字段都是选填字段。

以下是有效条件的示例：

  • advanceBookingWindow = 2
  • advanceBookingWindow >= 0
  • advanceBookingWindow <= 5
  • checkinDate = '2020-10-01'
  • checkinDate >= '2020-10-01'
  • checkinDate <= '2020-10-01'
  • checkinDate between '2020-10-01' and '2020-10-05'
  • date = '2020-02-04'
  • date between '2020-02-04' and '2020-02-09'
  • deviceType = 'TABLET'
  • deviceType in ('MOBILE', 'TABLET')
  • hotelRegionCode = 'US'
  • hotelRegionCode in ('US', 'CA')
  • lengthOfStayDays = 2
  • lengthOfStayDays >= 0
  • lengthOfStayDays <= 5
  • occupancy = 2
  • occupancy >= 0
  • occupancy <= 5
  • occupancy between 1 and 5
  • partnerHotelId = 'AAA'
  • partnerHotelId in ('AAA', 'BBB')
  • userRegionCode = 'US'
  • userRegionCode in ('US', 'CA')
aggregateBy

string

指定如何细分查询返回的指标。例如，如果将 userRegionCode 指定为 aggregateBy 值，则 participationResult 将提供按用户区域汇总的指标。

字符串值是以英文逗号分隔的字段列表。有效字段包括：date、userRegionCode、deviceType、partnerHotelId、hotelRegionCode、advanceBookingWindow、lengthOfStayDays、checkinDate 和 occupancy。未指定的字段不会包含在 ParticipationResult 中。

重要提示：将 aggregateBy 参数与 partnerHotelId 或两个以上的值搭配使用可能会导致错误。使用 partnerHotelId 和 date 进行过滤以减少行数，可以防止出现错误。
pageSize

integer

要返回的参与结果数上限。服务返回的值可能小于此值。如果未指定，则最多返回 10,000 个结果。最大值为 10,000；大于 10,000 的值将被强制转换为 10,000。
pageToken

string

从之前的 participationReportViews.query 请求接收的页面令牌。提供此令牌可接收后续页面。

进行分页时，提供给 participationReportViews.query 的所有其他参数必须与提供页面令牌的调用相一致。

请求正文

请求正文必须为空。

响应正文

ParticipationReportService.QueryParticipationReport 的响应消息。

如果成功，响应正文将包含结构如下的数据：

JSON 表示法 
{
  "results": [
    {
      object (ParticipationResult)
    }
  ],
  "nextPageToken": string
}
字段
results[]

object (ParticipationResult)

与查询匹配的结果列表。
nextPageToken

string

用于检索下一页结果的分页令牌。

授权范围

需要以下 OAuth 范围：

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

如需了解详情，请参阅 OAuth 2.0 Overview。

ParticipationResult

表示查询账号参与统计信息的结果。

JSON 表示法 
{
  "key": {
    object (Key)
  },
  "opportunityCount": string,
  "participationCount": string,
  "participationPercent": number,
  "missedParticipationCount": string,
  "missedParticipationCountDetails": {
    object (MissedParticipationCountDetails)
  },
  "partnerHotelDisplayName": string
}
字段
key

object (Key)

结果的键。
opportunityCount

string (int64 format)

某家具体酒店可以获得的机会总数。“机会”是指酒店广告在理想情况下本可以向用户展示的总次数。
participationCount

string (int64 format)

您符合参与 Google Ads 竞价流程条件的机会总数。
participationPercent

number

成功参与竞价的机会数除以机会总数所得出的竞价机会百分比率。例如，如果某个房源在 100 次参与 Google Ads 竞价的机会中有 90 次符合条件，则竞价率为 90%。
missedParticipationCount

string (int64 format)

不符合参与 Google Ads 竞价流程条件的机会总数。包括以下情形：

  • 缺少着陆页
  • 缺少价格信息
  • 存在价格问题
  • 无法获取价格信息
  • 其他
missedParticipationCountDetails

object (MissedParticipationCountDetails)

导致错失参与机会的原因（例如，没有空房）以及每种原因的总数。
partnerHotelDisplayName

string

合作伙伴的酒店显示名称。仅当结果按 partnerHotelId 进行汇总时，系统才会填充此字段。

键

结果的键。

JSON 表示法 
{
  "date": {
    object (Date)
  },
  "userRegionCode": string,
  "deviceType": enum (Device),
  "partnerHotelId": string,
  "hotelRegionCode": string,
  "advanceBookingWindow": integer,
  "lengthOfStayDays": integer,
  "checkinDate": {
    object (Date)
  },
  "occupancy": integer
}
字段
date

object (Date)

您请求的指标所对应的日期。

如果 date 不是请求调用中 aggregateBy 参数的值，则 Key 中不会返回 date 字段。
userRegionCode

string

用户的国家/地区的 ISO 3116 地区代码。

如果 userRegionCode 不是请求调用中 aggregateBy 参数的值，则 Key 中不会返回 userRegionCode 字段。
deviceType

enum (Device)

用户的设备类型。

如果 deviceType 不是请求调用中 aggregateBy 参数的值，则 Key 中不会返回 deviceType 字段。
partnerHotelId

string

合作伙伴的酒店 ID。

如果 partnerHotelId 不是请求调用中 aggregateBy 参数的值，则 Key 中不会返回 partnerHotelId 字段。
hotelRegionCode

string

酒店所在国家/地区的 CLDR 地区代码。

如果 hotelRegionCode 不是请求调用中 aggregateBy 参数的值，则 Key 中不会返回 hotelRegionCode 字段。
advanceBookingWindow

integer

用户想要提前多少天预订行程。

如果 advanceBookingWindow 不是请求调用中 aggregateBy 参数的值，则 Key 中不会返回 advanceBookingWindow 字段。
lengthOfStayDays

integer

行程的晚数。

如果 lengthOfStayDays 不是请求调用中 aggregateBy 参数的值，则 Key 中不会返回 lengthOfStayDays 字段。
checkinDate

object (Date)

行程的入住日期。

如果 checkinDate 不是请求调用中 aggregateBy 参数的值，则 Key 中不会返回 checkinDate 字段。
occupancy

integer

行程的总入住人数。

如果 occupancy 不是请求调用中 aggregateBy 参数的值，则 Key 中不会返回 occupancy 字段。

MissedParticipationCountDetails

按原因细分的错失竞价次数。

JSON 表示法 
{
  "noAvailabilityCount": string,
  "hotelSuspendedCount": string,
  "noTaxBreakdownCount": string,
  "noLandingPageCount": string,
  "noPriceCount": string,
  "noPriceCountDetails": {
    object (NoPriceCountDetails)
  },
  "otherReasonCount": string,
  "priceMissingCount": string,
  "priceMissingCountDetails": {
    object (PriceMissingCountDetails)
  },
  "priceProblemCount": string,
  "priceProblemCountDetails": {
    object (PriceProblemCountDetails)
  },
  "priceUnavailableCount": string,
  "priceUnavailableCountDetails": {
    object (PriceUnavailableCountDetails)
  }
}
字段
noAvailabilityCount
(deprecated)

string (int64 format)

因酒店/行程组合不可用或因旅客不符合享受特定房价的条件而错过的竞价总数。若要参与这些竞价，您可能需要提供更多价格信息。
hotelSuspendedCount
(deprecated)

string (int64 format)

因您的一家或多家酒店因价格准确性违规而被暂停展示而错过的竞价总数。
noTaxBreakdownCount
(deprecated)

string (int64 format)

由于您的一家或多家酒店未单独指定税费和其他费用而错过的竞价总数。
noLandingPageCount

string (int64 format)

没有与用户匹配的着陆页。
noPriceCount
(deprecated)

string (int64 format)

因用户请求的行程没有可提供的价格而错过的竞价总数。
noPriceCountDetails
(deprecated)

object (NoPriceCountDetails)

导致“无价格”数量的原因（例如，实时价格不可用）以及每种原因的总数。
otherReasonCount

string (int64 format)

酒店未参与竞价，原因不明。
priceMissingCount

string (int64 format)

因价格未包含在 Google 缓存中或未能成功响应实时价格而错过的竞价总数。包括以下情形：

  • 带宽已用尽
  • 缺少缓存的价格
  • 行程已被屏蔽
  • 未设置实时价格
  • 实时价格超时
  • 实时价格错误
priceMissingCountDetails

object (PriceMissingCountDetails)

导致价格缺失数量的原因。
priceProblemCount

string (int64 format)

因行程价格不准确的问题而导致错过的竞价总数。包括以下情形：

  • 酒店已暂停展示
  • 价格异常高
  • 价格异常低
  • 缺少税费和 Feed
priceProblemCountDetails

object (PriceProblemCountDetails)

导致价格问题数量的原因。
priceUnavailableCount

string (int64 format)

因用户请求的行程所对应的价格被列为不可用 (-1) 而错过的竞价总数。包括以下情形：

  • 无法获取价格信息
  • 不太可能竞价
  • 其他
priceUnavailableCountDetails

object (PriceUnavailableCountDetails)

导致价格不可用数量的原因。

NoPriceCountDetails

导致“无价格”的各种原因以及每种原因的总数。

JSON 表示法 
{
  "livePricingTechnicalIssueCount": string,
  "livePricingNotTriggeredCount": string,
  "livePricingConfigIssueCount": string,
  "livePricingNotAvailableCount": string,
  "livePricingOtherReasonCount": string
}
字段
livePricingTechnicalIssueCount

string (int64 format)

由于以下任何原因导致实时价格发生技术问题而错过的参与总数：

  • 响应速度不够快，超过了响应截止时间（大约 4,000 毫秒）。
  • 您返回了一个错误。
  • 您的回答格式不正确。
livePricingNotTriggeredCount

string (int64 format)

由于以下任何原因未触发实时价格而错过的参与总数：

  • 您未设置出价。
  • 您的着陆页无效。
  • 缓存中的价格不够多。
livePricingConfigIssueCount

string (int64 format)

由于以下任何原因未触发实时价格而错过的参与总数：

  • 您没有为这些搜索配置实时价格。
  • 您已限制 Google 访问相关酒店行程。
livePricingNotAvailableCount

string (int64 format)

因无法获取实时价格而错过的竞价总数。某些默认行程或界面不会触发实时价格。在这种情况下，合作伙伴需要缓存价格才能参与竞价。
livePricingOtherReasonCount

string (int64 format)

因实时价格出现其他问题而错过的竞价次数。

PriceMissingCountDetails

导致价格缺失的各种原因以及每种原因的总数。

JSON 表示法 
{
  "cacheRateMissingCount": string,
  "itineraryBlockedCount": string,
  "livePricingNotSetupCount": string,
  "bandwidthDepletedCount": string,
  "livePricingTimeoutCount": string,
  "livePricingErrorCount": string
}
字段
cacheRateMissingCount

string (int64 format)

缓存中没有此行程对应的价格。由于网页限制，未能完成实时查询。
itineraryBlockedCount

string (int64 format)

此行程不在您的基本参数所设定的范围内，因此无论从实时查询还是缓存填充中，都未提取到行程对应的价格。
livePricingNotSetupCount

string (int64 format)

缓存中没有此行程对应的价格，并且此账号并未配置实时查询。
bandwidthDepletedCount

string (int64 format)

缓存中没有此行程对应的价格，并且没有剩余的实时查询配额。
livePricingTimeoutCount

string (int64 format)

缓存中没有此行程对应的价格，并且发送到您系统的实时查询已超时。
livePricingErrorCount

string (int64 format)

缓存中没有此行程对应的价格。虽然实时查询未超时，但系统返回了错误。

PriceProblemCountDetails

导致价格问题数量的原因以及每种原因的总数量。

JSON 表示法 
{
  "hotelSuspendedCount": string,
  "priceUnusuallyHighCount": string,
  "priceUnusuallyLowCount": string,
  "taxesAndFeesMissingCount": string,
  "basePriceViolationsCount": string,
  "priceAccuracyIssueCount": string
}
字段
hotelSuspendedCount

string (int64 format)

酒店已暂停展示。这可能是因为某些方面一直存在问题（例如税费和其他费用不正确）。
priceUnusuallyHighCount

string (int64 format)

与该地区的价格趋势相比，此行程的价格似乎异常高。
priceUnusuallyLowCount

string (int64 format)

与该地区的价格趋势相比，此行程的价格似乎异常低。
taxesAndFeesMissingCount

string (int64 format)

价格中缺少税费和其他费用。
basePriceViolationsCount

string (int64 format)

基本价格相对于总价格过低。
priceAccuracyIssueCount

string (int64 format)

价格准确性问题。

PriceUnavailableCountDetails

导致价格不可用的原因以及每种原因的总数。

JSON 表示法 
{
  "priceUnavailableCount": string,
  "participationNotLikelyCount": string
}
字段
priceUnavailableCount

string (int64 format)

由于酒店在行程日期无法提供住宿，因此该酒店未参与竞价。
participationNotLikelyCount

string (int64 format)

由于您的服务器经常指示酒店无法提供住宿或客房已售罄，因此缓存中没有此行程对应的价格，并且系统未执行任何实时查询。