Method: accounts.freeBookingLinksReportViews.query

已弃用：请改用 PropertyPerformanceReportService.QueryPropertyPerformanceReport，它也具有展示次数报告。针对特定帐号免费查询预订链接报告的功能（获取、过滤和细分）。

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
name

string

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

查询参数

参数
filter

string

用于过滤要查询的帐号的免费预订链接指标的条件（字段和表达式）。该语法需要围绕 in 运算符的空格。否则，可以省略空格。可以使用 and 运算符联接条件。

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

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

partnerHotelDisplayName 的值不区分大小写。

有效条件的示例如下：

  • date = '2021-12-03'
  • date between '2021-12-03' and '2021-12-08'
  • deviceType = 'TABLET'
  • deviceType in ('MOBILE', 'TABLET')
  • partnerHotelId = 'AAA'
  • partnerHotelId in ('AAA', 'BBB')
  • partnerHotelDisplayName = 'hotel A'
  • partnerHotelDisplayName in ('Hotel A', 'HOTEL b')
  • userRegionCode = 'US'
  • userRegionCode in ('US', 'CA')
aggregateBy

string

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

字符串值是以英文逗号分隔的字段列表。有效字段包括：date、userRegionCode、deviceType、partnerHotelId 和 partnerHotelDisplayName。只有在这里指定的字段包含在 FreeBookingLinksResult 中。
pageSize

integer

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

string

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

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

请求正文

请求正文必须为空。

响应正文

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

已弃用：改用 QueryPropertyPerformanceReportResponse 和 PropertyPerformanceReportService。FreeBookingLinksReportService.QueryFreeBookingLinksReport 的响应消息。

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

object (FreeBookingLinksResult)

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

string

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

授权范围

需要以下 OAuth 作用域：

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

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

FreeBookingLinksResult

已弃用：改用 PropertyPerformanceResult 和 PropertyPerformanceReportService。表示通过查询帐号的免费预订链接统计信息得到的结果。

JSON 表示法 
{
  "date": {
    object (Date)
  },
  "userRegionCode": string,
  "deviceType": enum (Device),
  "partnerHotelId": string,
  "partnerHotelDisplayName": string,
  "clickCount": string
}
字段
date

object (Date)

请求的日期范围中的一个日期。

仅当请求中的 aggregateBy 中指定了 date 时才存在。
userRegionCode

string

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

仅当请求中的 aggregateBy 中指定了 userRegionCode 时才存在
deviceType

enum (Device)

用户的设备类型。

仅当请求中的 aggregateBy 中指定了 deviceType 时才存在。
partnerHotelId

string

合作伙伴的酒店 ID。

仅当请求中的 aggregateBy 中指定了 partnerHotelId 时才存在。
partnerHotelDisplayName

string

合作伙伴的酒店名称。

仅当请求中的 aggregateBy 中指定了 partnerHotelDisplayName 时才存在。
clickCount

string (int64 format)

针对此结果记录的总点击次数。