Method: accounts.propertyPerformanceReportViews.query

Umożliwiają pobieranie (pobieranie, filtrowanie i segmentowanie) raportu o skuteczności usług dotyczących określonego konta.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
name

string

Nazwa zasobu konta, którego dotyczy zapytanie. Format: konta/{identyfikator_konta}

Parametry zapytania

Parametry
filter

string

Warunki (pola i wyrażenia) używane do filtrowania danych o skuteczności konta, którego dotyczy zapytanie. Składnia wymaga spacji wokół operatora in. W przeciwnym razie spacje mogą zostać pominięte. Warunki można łączyć przy użyciu operatora and.

Pole date jest wymagane. Wszystkie pozostałe pola są opcjonalne.

Wartości w polu date muszą być włączające i muszą być w formacie RRRR-MM-DD. Najwcześniejsza dopuszczalna data to 09.03.2021 r. Wcześniejsze wartości daty zostaną zmienione na 09.03.2021 r.

W wartościach partnerPropertyDisplayName i brand wielkość liter nie jest rozróżniana.

Przykłady prawidłowych warunków:

  • 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

Określa sposób podziału danych zwracanych przez zapytanie. Jeśli na przykład wartość userRegionCode jest podana, PropertyPerformanceResult udostępnia dane pogrupowane według regionu użytkownika.

Wartość ciągu znaków to rozdzielona przecinkami lista pól. Prawidłowe pola to: advanceBookingWindow, brand, date, deviceType, highIntentUsers, lengthOfStay, propertyRegionCode, occupancy, partnerPropertyId, partnerPropertyDisplayName i userRegionCode. W tym polu właściwości uwzględniane są tylko pola określone w tym miejscu.
pageSize

integer

Maksymalna liczba wyników uczestnictwa, które zostaną zwrócone. Usługa może zwracać mniejszą wartość. Jeśli nie określono inaczej, zostanie zwróconych maksymalnie 10 000 wyników. Maksymalna wartość wynosi 10 000, a wartości powyżej 10 000 zostaną zmodyfikowane do 10 000.
pageToken

string

Token strony otrzymany z poprzedniego żądania uczestnictwa ReportReports.query. Podaj go, żeby wyświetlić następną stronę.

W podziale na strony wszystkie inne parametry podane w polu engagementReportViews.query muszą być zgodne z wywołaniem dostarczonym przez token strony.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Odpowiedź na: PropertyPerformanceReportService.QueryPropertyPerformanceReport.

Zapis JSON 
{
  "results": [
    {
      object (PropertyPerformanceResult)
    }
  ],
  "nextPageToken": string
}
Pola
results[]

object (PropertyPerformanceResult)

Lista wyników pasujących do zapytania.
nextPageToken

string

Token podziału na strony służący do pobierania następnej strony wyników. Jeśli pominiesz to pole, nie będzie kolejnych stron.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w artykule Omówienie OAuth 2.0.

Wynik wydajności

Reprezentuje wynik zapytania o raport skuteczności konta.

Zapis 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
}
Pola
date

object (Date)

Data w wybranym zakresie dat.

Jest obecny tylko wtedy, gdy w żądaniu określono właściwość date.
advanceBookingWindow

enum (AdvanceBookingWindow)

Różnica w dniach między datą zapytania a datą zameldowania w lokalnej strefie czasowej usługi.

Jest obecny tylko wtedy, gdy w żądaniu określono właściwość advanceBookingWindow.
brand

string

Marka określona przez partnera dla właściwości.

Jest obecny tylko wtedy, gdy w żądaniu określono właściwość brand.
deviceType

enum (Device)

Typ urządzenia użytkownika.

Jest obecny tylko wtedy, gdy w żądaniu określono właściwość deviceType.
highIntentUsers

boolean

Czy zapytanie użytkownika wykazało duże zainteresowanie rezerwacją.

Jest obecny tylko wtedy, gdy w żądaniu określono właściwość highIntentUsers.
lengthOfStay

enum (LengthOfStay)

Liczba nocy między datami zameldowania i wymeldowania określonymi przez użytkownika.

Jest obecny tylko wtedy, gdy w żądaniu określono właściwość lengthOfStay.
propertyRegionCode

string

Kod regionu kraju/regionu podany w normie ISO 3116.

Występuje tylko w przypadku, gdy w żądaniu określono właściwość propertyRegionCode.
occupancy

enum (Occupancy)

Wymagana liczba osób przebywających w hotelu.

Jest obecny tylko wtedy, gdy w żądaniu określono właściwość partnerPropertyId.
partnerPropertyId

string

Identyfikator usługi partnera.

Jest obecny tylko wtedy, gdy w żądaniu określono właściwość partnerPropertyId.
partnerPropertyDisplayName

string

Nazwa właściwości partnera.

Jest obecny tylko wtedy, gdy w żądaniu określono właściwość partnerPropertyDisplayName.
userRegionCode

string

Kod regionu zgodny ze standardem ISO 3116 kraju.

Występuje tylko w przypadku, gdy w żądaniu określono właściwość userRegionCode.
clickCount

string (int64 format)

Łączna liczba kliknięć zarejestrowanych dla tego wyniku.
impressionCount

string (int64 format)

Łączna liczba wyświetleń zarejestrowanych dla tego wyniku. Ta wartość jest zaokrąglana w celu zachowania prywatności użytkownika.
clickthroughRate

number

Kwota clickCount jest dzielona przez impressionCount.

Rezerwacja z wyprzedzeniem

Określa obsługiwane okresy rezerwacji z wyprzedzeniem (ABW). Wszystkie porównania dat znajdują się w strefie czasowej usługi.

Wartości w polu enum
ADVANCE_BOOKING_WINDOW_UNSPECIFIED Nie określono.
ADVANCE_BOOKING_WINDOW_SAME_DAY Data zameldowania była taka sama jak data zapytania.
ADVANCE_BOOKING_WINDOW_NEXT_DAY Data zameldowania przypadała następnego dnia po dacie zapytania.
ADVANCE_BOOKING_WINDOW_DAYS_2_TO_7 Data zameldowania minęła 2–7 dni od daty zapytania.
ADVANCE_BOOKING_WINDOW_DAYS_8_TO_14 Data zameldowania to 8–14 dni od daty zapytania.
ADVANCE_BOOKING_WINDOW_DAYS_15_TO_30 Data zameldowania minęła 15–30 dni od daty zapytania.
ADVANCE_BOOKING_WINDOW_DAYS_31_TO_60 Data zameldowania to 31–60 dni od daty zapytania.
ADVANCE_BOOKING_WINDOW_DAYS_61_TO_90 Data zameldowania to 61–90 dni po dacie zapytania.
ADVANCE_BOOKING_WINDOW_DAYS_91_TO_120 Data zameldowania to 91–120 dni od daty zapytania.
ADVANCE_BOOKING_WINDOW_DAYS_121_TO_150 Data zameldowania minęła 121–150 dni od daty zapytania.
ADVANCE_BOOKING_WINDOW_DAYS_151_TO_180 Data zameldowania minęła 151-180 dni od daty zapytania.
ADVANCE_BOOKING_WINDOW_DAYS_OVER_180 Data zameldowania minęła ponad 180 dni od daty zapytania.

Długość pobytu

Określa obsługiwaną długość pobytu (LOS).

Wartości w polu enum
LENGTH_OF_STAY_UNSPECIFIED Nie określono.
LENGTH_OF_STAY_NIGHTS_1 Pobyt na 1 noc.
LENGTH_OF_STAY_NIGHTS_2 Pobyt na 2 noce.
LENGTH_OF_STAY_NIGHTS_3 Pobyt na 3 noce.
LENGTH_OF_STAY_NIGHTS_4_TO_7 Pobyt 4–7 nocy.
LENGTH_OF_STAY_NIGHTS_8_TO_14 Pobyt na 8–14 nocy.
LENGTH_OF_STAY_NIGHTS_15_TO_21 15–21 nocy.
LENGTH_OF_STAY_NIGHTS_22_TO_30 Pobyt 22–30 nocy.
LENGTH_OF_STAY_NIGHTS_OVER_30 Pobyt powyżej 30 nocy.

Liczba osób

Określa obsługiwane obłożenie sal.

Wartości w polu enum
OCCUPANCY_UNSPECIFIED Nie określono.
OCCUPANCY_1 Jedna osoba.
OCCUPANCY_2 Dwie osoby.
OCCUPANCY_3 Trzy osoby.
OCCUPANCY_4 Cztery osoby.
OCCUPANCY_OVER_4 Ponad 4 osoby.