Method: accounts.propertyPerformanceReportViews.query

Umożliwia wysyłanie zapytań (pobieranie, filtrowanie i segmentowanie) do raportu o bezpłatnych linkach do rezerwacji na konkretnym koncie. Ta nowa wersja zwraca wyświetlenia i kliknięcia, a także znacznie większy nadzbiór filtrów i agregacji.

Żą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: accounts/{account_id}

Parametry zapytania

Parametry
filter

string

Warunki (pola i wyrażenia) używane do filtrowania danych o skuteczności usługi na koncie, z którego wysyłane jest zapytanie. Składnia wymaga spacji wokół operatora in. W przeciwnym razie spacje można pominąć. Warunki można łączyć za pomocą operatora AND.

Ważne: prawidłowa składnia dodawania wielu warunków to: "?filter=<condition>=<value>%20AND%20<condition>=<value>..."

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

Wartości pól date są włączone i muszą być podane w formacie RRRR-MM-DD. Najwcześniejsza akceptowana data to 2021-03-09. Wcześniejsze daty zostaną zmienione na 2021-03-09.

Wartości atrybutów partnerPropertyDisplayName i brand są dopasowywane bez rozróżniania wielkości liter.

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 segmentowania danych zwracanych przez zapytanie. Jeśli na przykład podasz wartość userRegionCode, interfejs PropertyPerformanceResult będzie zawierać dane zbiorcze według regionu użytkownika.

Wartość ciągu tekstowego to lista pól rozdzielonych przecinkami. Prawidłowe pola to: advanceBookingWindow, brand, date, deviceType, highIntentUsers, lengthOfStay, propertyRegionCode, occupancy, partnerPropertyId, partnerPropertyDisplayNameuserRegionCode. W obiekcie PropertyPerformanceResult uwzględniane są tylko pola określone w tym miejscu.

Ważne: użycie parametru aggregateBy z parametrem partnerHotelId lub więcej niż 2 wartościami może spowodować błąd. Filtrowanie za pomocą znaków partnerHotelIddate w celu zmniejszenia liczby wierszy może zapobiec wystąpieniu błędów.

pageSize

integer

Maksymalna liczba wyników uczestnictwa do zwrócenia. Usługa może zwrócić mniej niż ta wartość. Jeśli nie podano tego argumentu, zwracanych jest maksymalnie 10 tys. wyników. Maksymalna wartość to 10 000. Wartości powyżej 10 000 zostaną ograniczone do 10 000.

pageToken

string

Token strony otrzymany z poprzedniego żądania participationReportViews.query. Podaj ten token, aby otrzymać kolejną stronę.

Podczas paginacji wszystkie inne parametry przekazane do participationReportViews.query muszą być zgodne z wywołaniem, które dostarczyło token strony.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Wiadomość z odpowiedzią dla PropertyPerformanceReportService.QueryPropertyPerformanceReport.

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

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

object (PropertyPerformanceResult)

Lista wyników pasujących do zapytania.

nextPageToken

string

Token stronicowania używany 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 sekcji OAuth 2.0 Overview.

PropertyPerformanceResult

Reprezentuje wynik zapytania o raport skuteczności usługi na koncie.

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,
  "adsClickCount": string,
  "adsImpressionCount": string,
  "adsClickthroughRate": number,
  "vrWebsiteButtonClicks": string
}
Pola
date

object (Date)

datę mieszczącą się w zakresie dat podanym w żądaniu.

Występuje tylko wtedy, gdy w parametrze aggregateBy w żądaniu określono wartość date.

advanceBookingWindow

enum (AdvanceBookingWindow)

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

Występuje tylko wtedy, gdy w parametrze aggregateBy w żądaniu określono wartość advanceBookingWindow.

brand

string

Marka usługi określona przez partnera.

Występuje tylko wtedy, gdy w parametrze aggregateBy w żądaniu określono wartość brand.

deviceType

enum (Device)

Typ urządzenia użytkownika.

Występuje tylko wtedy, gdy w parametrze aggregateBy w żądaniu określono wartość deviceType.

highIntentUsers

boolean

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

Występuje tylko wtedy, gdy w parametrze aggregateBy w żądaniu określono wartość highIntentUsers.

lengthOfStay

enum (LengthOfStay)

Liczba nocy między datą zameldowania a datą wymeldowania podaną przez użytkownika.

Występuje tylko wtedy, gdy w parametrze aggregateBy w żądaniu określono wartość lengthOfStay.

propertyRegionCode

string

Kod regionu w standardzie ISO 3116 kraju lub regionu, w którym znajduje się nieruchomość.

Występuje tylko wtedy, gdy w żądaniu w parametrze aggregateBy określono wartość propertyRegionCode.

occupancy

enum (Occupancy)

Liczba osób, które mają się zatrzymać w obiekcie.

Występuje tylko wtedy, gdy w parametrze aggregateBy w żądaniu określono wartość partnerPropertyId.

partnerPropertyId

string

Identyfikator usługi partnera.

Występuje tylko wtedy, gdy w parametrze aggregateBy w żądaniu określono wartość partnerPropertyId.

partnerPropertyDisplayName

string

Nazwa usługi partnera.

Występuje tylko wtedy, gdy w parametrze aggregateBy w żądaniu określono wartość partnerPropertyDisplayName.

userRegionCode

string

Kod regionu w formacie ISO 3116 kraju lub regionu użytkownika.

Występuje tylko wtedy, gdy w żądaniu w parametrze aggregateBy określono wartość userRegionCode.

clickCount

string (int64 format)

Łączna liczba kliknięć bezpłatnego linku do rezerwacji, które zostały zarejestrowane w przypadku tego wyniku.

impressionCount

string (int64 format)

Łączna liczba wyświetleń bezpłatnych linków do rezerwacji, które zostały zarejestrowane w przypadku tego wyniku. Ta wartość jest zaokrąglana, aby chronić prywatność użytkowników.

clickthroughRate

number

Równa się clickCount podzielone przez impressionCount.

adsClickCount

string (int64 format)

Łączna liczba kliknięć reklam zarejestrowanych w przypadku tego wyniku.

adsImpressionCount

string (int64 format)

Łączna liczba wyświetleń reklamy, które zostały zarejestrowane w przypadku tego wyniku.

adsClickthroughRate

number

Równa się adsClickCount podzielone przez adsImpressionCount.

vrWebsiteButtonClicks

string (int64 format)

Łączna liczba kliknięć przycisku „Witryna” w Google w przypadku kwater wakacyjnych.

AdvanceBookingWindow

Zawiera listę obsługiwanych okresów rezerwacji z wyprzedzeniem. Wszystkie porównania dat są podawane 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 na dzień po dacie zapytania.
ADVANCE_BOOKING_WINDOW_DAYS_2_TO_7 Data zameldowania przypadała 2–7 dni po dacie zapytania.
ADVANCE_BOOKING_WINDOW_DAYS_8_TO_14 Data zameldowania przypadała 8–14 dni po dacie zapytania.
ADVANCE_BOOKING_WINDOW_DAYS_15_TO_30 Data zameldowania przypadała 15–30 dni po dacie zapytania.
ADVANCE_BOOKING_WINDOW_DAYS_31_TO_60 Data zameldowania przypadała 31–60 dni po dacie zapytania.
ADVANCE_BOOKING_WINDOW_DAYS_61_TO_90 Data zameldowania przypadała 61–90 dni po dacie zapytania.
ADVANCE_BOOKING_WINDOW_DAYS_91_TO_120 Data zameldowania przypadała 91–120 dni po dacie zapytania.
ADVANCE_BOOKING_WINDOW_DAYS_121_TO_150 Data zameldowania przypadała 121–150 dni po dacie zapytania.
ADVANCE_BOOKING_WINDOW_DAYS_151_TO_180 Data zameldowania przypadała 151–180 dni po dacie zapytania.
ADVANCE_BOOKING_WINDOW_DAYS_OVER_180 Data zameldowania przypadała ponad 180 dni po dacie zapytania.

LengthOfStay

Wylicza obsługiwane długości pobytu (LOS).

Wartości w polu enum
LENGTH_OF_STAY_UNSPECIFIED Nie określono.
LENGTH_OF_STAY_NIGHTS_1 Pobyt na jedną 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 na 4–7 nocy.
LENGTH_OF_STAY_NIGHTS_8_TO_14 Pobyt trwający od 8 do 14 nocy.
LENGTH_OF_STAY_NIGHTS_15_TO_21 Pobyt na 15–21 nocy.
LENGTH_OF_STAY_NIGHTS_22_TO_30 Pobyt trwający od 22 do 30 nocy.
LENGTH_OF_STAY_NIGHTS_OVER_30 pobyt trwający ponad 30 nocy;

Liczba osób

Wylicza obsługiwane całkowite obłożenie sali.

Wartości w polu enum
OCCUPANCY_UNSPECIFIED Nie określono.
OCCUPANCY_1 Jedna osoba.
OCCUPANCY_2 2 osoby.
OCCUPANCY_3 3 osoby.
OCCUPANCY_4 4 osoby.
OCCUPANCY_OVER_4 Więcej niż 4 osoby.