- HTTP-запрос
- Параметры пути
- Параметры запроса
- Тело запроса
- Тело ответа
- Области авторизации
- PropertyPerformanceResult
- Предварительное бронированиеОкно
- Продолжительность пребывания
- Вместимость
Предоставляет возможность запрашивать (получать, фильтровать и сегментировать) отчет о связях эффективности ресурса для определенной учетной записи.
HTTP-запрос
GET https://travelpartner.googleapis.com/v3/{name=accounts/*}/propertyPerformanceReportViews:query
URL-адрес использует синтаксис транскодирования gRPC .
Параметры пути
Параметры | |
---|---|
name | Имя ресурса запрашиваемой учетной записи. Формат: аккаунты/{account_id} |
Параметры запроса
Параметры | |
---|---|
filter | Условия (поля и выражения), используемые для фильтрации показателей эффективности ресурса для запрашиваемой учетной записи. Синтаксис требует пробелов вокруг оператора Поле Значения поля Значения для Ниже приведены примеры допустимых условий:
|
aggregateBy | Указывает, как сегментировать метрики, возвращаемые запросом. Например, если Строковое значение представляет собой список полей, разделенных запятыми. Допустимые поля: |
pageSize | Максимальное количество возвращаемых результатов участия. Служба может вернуть меньшее значение, чем это значение. Если не указано, будет возвращено не более 10 000 результатов. Максимальное значение — 10 000; значения выше 10 000 будут приведены к 10 000. |
pageToken | Маркер страницы, полученный из предыдущего запроса memberReportViews.query. Укажите это, чтобы получить следующую страницу. При разбиении на страницы все остальные параметры, предоставленные для участияReportViews.query, должны соответствовать вызову, предоставившему токен страницы. |
Тело запроса
Тело запроса должно быть пустым.
Тело ответа
В случае успеха тело ответа содержит данные со следующей структурой:
Ответное сообщение для PropertyPerformanceReportService.QueryPropertyPerformanceReport
.
Представление JSON |
---|
{
"results": [
{
object ( |
Поля | |
---|---|
results[] | Список результатов, соответствующих запросу. |
nextPageToken | Токен разбивки на страницы, используемый для получения следующей страницы результатов. Если это поле опущено, последующие страницы отсутствуют. |
Области авторизации
Требуется следующая область действия OAuth:
-
https://www.googleapis.com/auth/travelpartner
Дополнительные сведения см. в обзоре OAuth 2.0 .
PropertyPerformanceResult
Представляет результат запроса отчета об эффективности ресурса для учетной записи.
Представление JSON |
---|
{ "date": { object ( |
Поля | |
---|---|
date | Дата в пределах запрошенного диапазона дат. Присутствует только в том случае, если |
advanceBookingWindow | Разница в днях между датой запроса и датой заезда в местном часовом поясе объекта размещения. Присутствует только в том случае, если в |
brand | Марка объекта, указанная партнером. Присутствует только в том случае, если в |
deviceType | Тип устройства пользователя. Присутствует только в том случае, если |
highIntentUsers | Указал ли запрос пользователя на большой интерес к бронированию. Присутствует только в том случае, если |
lengthOfStay | Количество ночей между датами заезда и выезда, указанными пользователем. Присутствует только в том случае, если |
propertyRegionCode | Код региона ISO 3116 страны/региона собственности. Присутствует только в том случае, если |
occupancy | Запрашиваемое количество людей, проживающих в отеле. Присутствует только в том случае, если |
partnerPropertyId | Идентификатор собственности партнера. Присутствует только в том случае, если |
partnerPropertyDisplayName | Имя свойства партнера. Присутствует только в том случае, если в |
userRegionCode | Код региона ISO 3116 страны/региона пользователя. Присутствует, только если |
clickCount | Общее количество кликов, зарегистрированных для этого результата. |
impressionCount | Общее количество показов, зарегистрированных для этого результата. Это значение округлено для сохранения конфиденциальности пользователя. |
clickthroughRate | Равен |
Предварительное бронированиеОкно
Перечисляет поддерживаемые окна предварительного бронирования (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 человек. |