Method: accounts.freeBookingLinksReportViews.query

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

HTTP-запрос

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

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

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

Параметры
name

string

Имя ресурса запрашиваемой учетной записи. Формат: accounts/{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

Токен страницы, полученный из предыдущего запроса participationReportViews.query. Предоставьте его, чтобы получить следующую страницу.

При использовании постраничной навигации все остальные параметры, передаваемые в participationReportViews.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 Overview .

FreeBookingLinksResult

УСТАРЕВШЕЕ: Используйте 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 страны/региона пользователя.

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

deviceType

enum ( Device )

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

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

partnerHotelId

string

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

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

partnerHotelDisplayName

string

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

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

clickCount

string ( int64 format)

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