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 运算符联接条件。

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

有效条件的示例如下:

  • advanceBookingWindow = 2
  • advanceBookingWindow >= 0
  • advanceBookingWindow <= 5
  • advanceBookingWindow between 1 and 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
  • lengthOfStayDays between 1 and 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 将提供按用户区域汇总的指标。

字符串值是以英文逗号分隔的字段列表。有效字段包括:dateuserRegionCodedeviceTypepartnerHotelIdhotelRegionCodeadvanceBookingWindowlengthOfStayDayscheckinDateoccupancy。未指定的字段不会包含在 ParticipationResult 中。

使用生成大量行的 aggregateBy 规范会导致错误。按 partnerHotelId 或两个以上的字段进行聚合时尤其如此。为降低出错的可能性,请按 partnerHotelIddate 进行过滤,以便仅包含特定数量的酒店和日期。包含大量酒店的帐号需要通过更多过滤功能来进一步减少数据。

pageSize

integer

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

pageToken

string

从之前的 engagementReportViews.query 请求收到的页面令牌。请提供此属性以接收后续页面。

进行分页时,提供给 engagementReportViews.query 的所有其他参数必须与提供页面令牌的调用匹配。

请求正文

请求正文必须为空。

响应正文

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

ParticipationReportService.QueryParticipationReport 的响应消息。

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

object (ParticipationResult)

与查询匹配的结果列表。

nextPageToken

string

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

授权范围

需要以下 OAuth 作用域:

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

如需了解详情,请参阅 OAuth 2.0 概览

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 字段。

未接电话详细信息

错失的参与次数(按原因细分)。

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)

由于以下任何原因,实时价格导致技术问题而错失的参与总数:

  • 响应速度不够快,并且超过了回复截止日期(大约 4000 毫秒)。
  • 您返回了错误。
  • 您的回复格式不正确。
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)

此行程未缓存任何价格。实时查询未超时,但系统返回了错误。

价格问题详情

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

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

string (int64 format)

该酒店已被暂停。这可能是因为某些因素(例如税费和费用不正确)持续存在。

priceUnusuallyHighCount

string (int64 format)

与地区趋势相比,此行程的价格似乎有点奇怪。

priceUnusuallyLowCount

string (int64 format)

与地区趋势相比,此行程的价格似乎很奇怪。

taxesAndFeesMissingCount

string (int64 format)

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

PriceUnavailableCountDetails

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

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

string (int64 format)

酒店未参与,因为在行程日期没有可用的酒店。

participationNotLikelyCount

string (int64 format)

此行程未缓存任何价格,系统未执行任何实时查询,因为您的服务器通常告诉我们酒店不可用或已售罄。