Method: accounts.propertyPerformanceReportViews.query

Предоставляет возможность запрашивать (получать, фильтровать и сегментировать) отчет о связях эффективности ресурса для определенной учетной записи.

HTTP-запрос

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

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

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

Параметры
name

string

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

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

Параметры
filter

string

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

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

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

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

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

pageToken

string

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

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

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

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

advanceBookingWindow

enum ( AdvanceBookingWindow )

Разница в днях между датой запроса и датой заезда в местном часовом поясе объекта размещения.

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

brand

string

Марка объекта, указанная партнером.

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

deviceType

enum ( Device )

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

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

highIntentUsers

boolean

Указал ли запрос пользователя на большой интерес к бронированию.

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

lengthOfStay

enum ( LengthOfStay )

Количество ночей между датами заезда и выезда, указанными пользователем.

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

propertyRegionCode

string

Код региона ISO 3116 страны/региона собственности.

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

occupancy

enum ( Occupancy )

Запрашиваемое количество людей, проживающих в отеле.

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

partnerPropertyId

string

Идентификатор собственности партнера.

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

partnerPropertyDisplayName

string

Имя свойства партнера.

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

userRegionCode

string

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

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

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 человек.