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 将提供按用户区域汇总的指标。

字符串值是以英文逗号分隔的字段列表。有效字段包括:dateuserRegionCodedeviceTypepartnerHotelIdpartnerHotelDisplayName。只有此处指定的字段才会包含在 FreeBookingLinksResult 中。

pageSize

integer

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

pageToken

string

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

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

请求正文

请求正文必须为空。

响应正文

已弃用:请改用 QueryPropertyPerformanceReportResponsePropertyPerformanceReportService。针对 FreeBookingLinksReportService.QueryFreeBookingLinksReport 的响应消息。

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

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

object (FreeBookingLinksResult)

与查询匹配的结果列表。

nextPageToken

string

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

授权范围

需要以下 OAuth 范围:

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

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

FreeBookingLinksResult

已弃用:请改用 PropertyPerformanceResultPropertyPerformanceReportService。表示查询账号的免费预订链接统计信息的结果。

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)

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