Method: accounts.freeBookingLinksReportViews.query

УСТАРЕЛО: вместо этого используйте PropertyPerformanceReportService.QueryPropertyPerformanceReport , который также содержит отчеты о показах. Предоставляет возможность запрашивать (получать, фильтровать и сегментировать) отчет о ссылках на бесплатное бронирование для определенной учетной записи.

HTTP-запрос

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

URL-адрес использует синтаксис транскодирования gRPC .

Параметры пути

Параметры
name

string

Имя ресурса запрашиваемой учетной записи. Формат: аккаунты/{account_id}

Параметры запроса

Параметры
filter

string

Условия (поля и выражения), используемые для фильтрации показателей ссылки на бесплатное бронирование для запрашиваемой учетной записи. Синтаксис требует пробелов вокруг оператора in . В противном случае пробелы могут быть опущены. Условия можно соединить с помощью оператора and .

Поле date обязательно. Все остальные поля являются необязательными.

Значения поля date являются инклюзивными и должны быть в формате ГГГГ-ММ-ДД. Самая ранняя приемлемая дата — 09.03.2021; более ранние значения даты будут приведены к 09.03.2021.

Значения для 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

Максимальное количество возвращаемых результатов участия. Служба может вернуть меньшее значение, чем это значение. Если не указано, будет возвращено не более 10 000 результатов. Максимальное значение — 10 000; значения выше 10 000 будут приведены к 10 000.

pageToken

string

Маркер страницы, полученный из предыдущего запроса memberReportViews.query. Укажите это, чтобы получить следующую страницу.

При разбиении на страницы все остальные параметры, предоставленные для участияReportViews.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 .

БесплатноБронированиеСсылкиРезультат

УСТАРЕЛО: вместо этого используйте PropertyPerformanceResult с PropertyPerformanceReportService . Представляет результат запроса статистики ссылки на бесплатное бронирование для учетной записи.

Представление JSON
{
  "date": {
    object (Date)
  },
  "userRegionCode": string,
  "deviceType": enum (Device),
  "partnerHotelId": string,
  "partnerHotelDisplayName": string,
  "clickCount": string
}
Поля
date

object ( Date )

Дата в пределах запрошенного диапазона дат.

Присутствует только в том случае, если date указана в aggregateBy в запросе.

userRegionCode

string

Код региона ISO 3116 страны/региона пользователя.

Присутствует, только если userRegionCode указан в aggregateBy в запросе

deviceType

enum ( Device )

Тип устройства пользователя.

Присутствует только в том случае, если deviceType указан в aggregateBy в запросе.

partnerHotelId

string

Идентификатор отеля партнера.

Присутствует только в том случае, если partnerHotelId указан в aggregateBy в запросе.

partnerHotelDisplayName

string

Название отеля партнера.

Присутствует только в том случае, если в aggregateBy в параметреaggregateBy partnerHotelDisplayName .

clickCount

string ( int64 format)

Общее количество кликов, зарегистрированных для этого результата.