Method: accounts.freeBookingLinksReportViews.query

WYCOFANO: zamiast tego użyj raportu PropertyPerformanceReportService.QueryPropertyPerformanceReport, który udostępnia też raporty o wyświetleniach. Umożliwia przeszukiwanie (pobieranie, filtrowanie i segmentowanie) bezpłatnego raportu o linkach do rezerwacji związanych z konkretnym kontem.

Żą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: konta/{identyfikator_konta}

Parametry zapytania

Parametry
filter

string

Warunki (pola i wyrażenia) służące do filtrowania danych o bezpłatnych linkach do rezerwacji dotyczących 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 partnerHotelDisplayName nie jest rozróżniana wielkość 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 podziału danych zwracanych przez zapytanie. Jeśli na przykład wartość userRegionCode jest podana, freeBookingLinksResult udostępnia dane pogrupowane według regionu użytkownika.

Wartość ciągu znaków to rozdzielona przecinkami lista pól. Prawidłowe pola to: date, userRegionCode, deviceType, partnerHotelId i partnerHotelDisplayName. W FreeFreeingingLinksResult znajdują się tylko pola wymienione 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:

WYCOFANO: zamiast tego użyj właściwości QueryPropertyPerformanceReportResponse z PropertyPerformanceReportService. Odpowiedź na: FreeBookingLinksReportService.QueryFreeBookingLinksReport.

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

object (FreeBookingLinksResult)

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.

WynikFreeBookingLinks

WYCOFANO: zamiast tego użyj właściwości PropertyPerformanceResult z PropertyPerformanceReportService. Reprezentuje wynik zapytania o bezpłatne statystyki linku do konta.

Zapis JSON 
{
  "date": {
    object (Date)
  },
  "userRegionCode": string,
  "deviceType": enum (Device),
  "partnerHotelId": string,
  "partnerHotelDisplayName": string,
  "clickCount": string
}
Pola
date

object (Date)

Data w wybranym zakresie dat.

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

string

Kod regionu zgodny ze standardem ISO 3116 kraju.

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

enum (Device)

Typ urządzenia użytkownika.

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

string

Identyfikator hotelu partnera.

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

string

Nazwa hotelu partnera.

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

string (int64 format)

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