Method: accounts.propertyPerformanceReportViews.query

提供针对特定账号查询（获取、过滤和细分）免费预订链接报告的功能。新版本会返回展示次数和点击次数，以及更广泛的过滤条件/汇总。

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
name

string

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

查询参数

参数
filter

string

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

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

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

date 字段值包含在内，且必须采用 YYYY-MM-DD 格式。最早可接受的日期是 2021-03-09；更早的日期值将被强制转换为 2021-03-09。

partnerPropertyDisplayName 和 brand 的值不区分大小写。

以下是有效条件的示例：

  • advanceBookingWindow = 'ADVANCE_BOOKING_WINDOW_SAME_DAY'
  • advanceBookingWindow in ('ADVANCE_BOOKING_WINDOW_SAME_DAY', 'ADVANCE_BOOKING_WINDOW_DAYS_61_TO_90')
  • brand = 'Brand A'
  • brand in ('Brand A', 'brand B')
  • date = '2021-12-03'
  • date between '2021-12-03' and '2021-12-08'
  • deviceType = 'TABLET'
  • deviceType in ('MOBILE', 'TABLET')
  • highIntentUsers = 'TRUE'
  • highIntentUsers = 'FALSE'
  • lengthOfStay = 'LENGTH_OF_STAY_NIGHTS_2'
  • lengthOfStay in ('LENGTH_OF_STAY_NIGHTS_2', 'LENGTH_OF_STAY_NIGHTS_4_TO_7')
  • propertyRegionCode = 'US'
  • propertyRegionCode in ('US', 'CA')
  • occupancy = 'OCCUPANCY_2'
  • occupancy in ('OCCUPANCY_2', 'OCCUPANCY_OVER_4')
  • partnerPropertyId = 'AAA'
  • partnerPropertyId in ('AAA', 'BBB')
  • partnerPropertyDisplayName = 'hotel A'
  • partnerPropertyDisplayName in ('Hotel A', 'HOTEL b')
  • userRegionCode = 'US'
  • userRegionCode in ('US', 'CA')
aggregateBy

string

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

字符串值是以英文逗号分隔的字段列表。有效字段包括：advanceBookingWindow、brand、date、deviceType、highIntentUsers、lengthOfStay、propertyRegionCode、occupancy、partnerPropertyId、partnerPropertyDisplayName 和 userRegionCode。只有此处指定的字段才会包含在 PropertyPerformanceResult 中。

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

integer

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

string

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

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

请求正文

请求正文必须为空。

响应正文

PropertyPerformanceReportService.QueryPropertyPerformanceReport 的响应消息。

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

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

object (PropertyPerformanceResult)

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

string

用于检索下一页结果的分页令牌。如果省略此字段，则不存在后续页面。

授权范围

需要以下 OAuth 范围：

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

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

PropertyPerformanceResult

表示查询账号的媒体资源效果报告的结果。

JSON 表示法 
{
  "date": {
    object (Date)
  },
  "advanceBookingWindow": enum (AdvanceBookingWindow),
  "brand": string,
  "deviceType": enum (Device),
  "highIntentUsers": boolean,
  "lengthOfStay": enum (LengthOfStay),
  "propertyRegionCode": string,
  "occupancy": enum (Occupancy),
  "partnerPropertyId": string,
  "partnerPropertyDisplayName": string,
  "userRegionCode": string,
  "clickCount": string,
  "impressionCount": string,
  "clickthroughRate": number,
  "adsClickCount": string,
  "adsImpressionCount": string,
  "adsClickthroughRate": number,
  "vrWebsiteButtonClicks": string
}
字段
date

object (Date)

所请求日期范围内的日期。

仅当在请求的 aggregateBy 中指定了 date 时，此字段才会显示。
advanceBookingWindow

enum (AdvanceBookingWindow)

查询日期与入住日期之间的天数差（以媒体资源的本地时区为准）。

仅当在请求的 aggregateBy 中指定了 advanceBookingWindow 时，此字段才会显示。
brand

string

合作伙伴为媒体资源指定的品牌。

仅当在请求的 aggregateBy 中指定了 brand 时，此字段才会显示。
deviceType

enum (Device)

用户的设备类型。

仅当在请求的 aggregateBy 中指定了 deviceType 时，此字段才会显示。
highIntentUsers

boolean

用户的搜索查询是否表明了强烈的预订意向。

仅当在请求的 aggregateBy 中指定了 highIntentUsers 时，此字段才会显示。
lengthOfStay

enum (LengthOfStay)

用户指定的入住日期和退房日期之间的晚数。

仅当在请求的 aggregateBy 中指定了 lengthOfStay 时，此字段才会显示。
propertyRegionCode

string

房源所在国家/地区的 ISO 3116 地区代码。

仅当在请求的 aggregateBy 中指定了 propertyRegionCode 时，此字段才会显示
occupancy

enum (Occupancy)

入住相应房源的请求人数。

仅当在请求的 aggregateBy 中指定了 partnerPropertyId 时，此字段才会显示。
partnerPropertyId

string

合作伙伴的媒体资源 ID。

仅当在请求的 aggregateBy 中指定了 partnerPropertyId 时，此字段才会显示。
partnerPropertyDisplayName

string

合作伙伴的媒体资源名称。

仅当在请求的 aggregateBy 中指定了 partnerPropertyDisplayName 时，此字段才会显示。
userRegionCode

string

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

仅当在请求的 aggregateBy 中指定了 userRegionCode 时，此字段才会显示
clickCount

string (int64 format)

相应结果记录到的免费预订链接点击总次数。
impressionCount

string (int64 format)

相应结果记录到的免费预订链接展示总次数。为了保护用户隐私，该值为取整值。
clickthroughRate

number

等于 clickCount 除以 impressionCount。
adsClickCount

string (int64 format)

相应结果记录到的广告点击总次数。
adsImpressionCount

string (int64 format)

相应结果记录到的广告展示总次数。
adsClickthroughRate

number

等于 adsClickCount 除以 adsImpressionCount。
vrWebsiteButtonClicks

string (int64 format)

用户在 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 单晚住宿。
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 三人。
OCCUPANCY_4 四人。
OCCUPANCY_OVER_4 4 人以上。