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

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 中仅包含此处指定的字段。
pageSize

integer

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

string

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

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

请求正文

请求正文必须为空。

响应正文

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

PropertyPerformanceReportService.QueryPropertyPerformanceReport 的响应消息。

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

object (PropertyPerformanceResult)

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

string

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

授权范围

需要以下 OAuth 作用域：

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

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

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

提前预订期限

枚举支持的提前预订期限 (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 天以上。

住宿时长

枚举支持的住宿时长 (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 两个人，
OCCUPANCY_3 三个人。
OCCUPANCY_4 四人。
OCCUPANCY_OVER_4 超过 4 人。