Method: accounts.freeBookingLinksReportViews.query

WYCOFANO: zamiast niego używaj PropertyPerformanceReportService.QueryPropertyPerformanceReport, który też zawiera raportowanie wyświetleń. Umożliwia wysyłanie zapytań (pobieranie, filtrowanie i segmentowanie) do raportu o bezpłatnych linkach do rezerwacji na konkretnym koncie.

Żądanie HTTP

GET https://travelpartner.googleapis.com/v3/{name=accounts/*}/freeBookingLinksReportViews: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 bezpłatnych linkach do rezerwacji na koncie, którego dotyczy zapytanie. Składnia wymaga spacji wokół operatora in. W przeciwnym razie spacje można pominąć. Warunki można łączyć za pomocą operatora and.

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 w przypadku atrybutu partnerHotelDisplayName są dopasowywane bez rozróżniania wielkości liter.

Przykłady prawidłowych warunków:

  • 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

Określa sposób segmentowania danych zwracanych przez zapytanie. Jeśli na przykład podasz wartość userRegionCode, interfejs freeBookingLinksResult będzie zawierać dane zbiorcze według regionu użytkownika.

Wartość ciągu tekstowego to lista pól rozdzielonych przecinkami. Prawidłowe pola to: date, userRegionCode, deviceType, partnerHotelId i partnerHotelDisplayName. W obiekcie FreeBookingLinksResult uwzględniane są tylko pola określone w tym miejscu.
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

WYCOFANO: zamiast niej używaj QueryPropertyPerformanceReportResponse z PropertyPerformanceReportService. Wiadomość z odpowiedzią dla FreeBookingLinksReportService.QueryFreeBookingLinksReport.

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

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

object (FreeBookingLinksResult)

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.

FreeBookingLinksResult

WYCOFANO: zamiast niej używaj PropertyPerformanceResult z PropertyPerformanceReportService. Reprezentuje wynik zapytania o statystyki bezpłatnych linków do rezerwacji na koncie.

Zapis JSON 
{
  "date": {
    object (Date)
  },
  "userRegionCode": string,
  "deviceType": enum (Device),
  "partnerHotelId": string,
  "partnerHotelDisplayName": string,
  "clickCount": 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.
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.
deviceType

enum (Device)

Typ urządzenia użytkownika.

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

string

Identyfikator hotelu partnera.

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

string

Nazwa hotelu partnera.

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

string (int64 format)

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