Method: accounts.freeBookingLinksReportViews.query

VERALTET:Verwenden Sie stattdessen PropertyPerformanceReportService.QueryPropertyPerformanceReport. Dort sind auch Berichte zu Impressionen verfügbar. Ermöglicht das Abfragen (Abrufen, Filtern und Segmentieren) eines Berichts zu Links für die kostenlose Buchung für ein bestimmtes Konto.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
name

string

Der Ressourcenname des Kontos, für das die Abfrage erfolgt. Format: accounts/{account_id}

Suchparameter

Parameter
filter

string

Die Bedingungen (Felder und Ausdrücke), die zum Filtern der Messwerte für kostenlose Buchungslinks für das abgefragte Konto verwendet werden. Die Syntax erfordert Leerzeichen um den Operator in. Andernfalls können Leerzeichen weggelassen werden. Bedingungen können mit dem Operator and verknüpft werden.

date ist ein Pflichtfeld. Alle anderen sind optional.

Die Feldwerte für date sind inklusive und müssen im Format JJJJ-MM-TT angegeben werden. Das früheste zulässige Datum ist der 9. März 2021. Frühere Datumswerte werden auf den 9. März 2021 umgewandelt.

Bei Werten für partnerHotelDisplayName wird die Groß-/Kleinschreibung nicht beachtet.

Beispiele für gültige Bedingungen:

  • 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

Gibt an, wie die von der Abfrage zurückgegebenen Messwerte segmentiert werden sollen. Wenn beispielsweise userRegionCode angegeben ist, enthält freeBookingLinksResult Messwerte, die nach Nutzerregion zusammengefasst sind.

Der Stringwert ist eine durch Kommas getrennte Liste von Feldern. Gültige Felder sind: date, userRegionCode, deviceType, partnerHotelId und partnerHotelDisplayName. Nur die hier angegebenen Felder sind im FreeBookingLinksResult enthalten.

pageSize

integer

Die maximale Anzahl der zurückzugebenden Teilnahmeergebnisse. Der Dienst gibt möglicherweise weniger als diesen Wert zurück. Wenn nicht angegeben, werden maximal 10.000 Ergebnisse zurückgegeben. Der Höchstwert beträgt 10.000. Werte über 10.000 werden implizit auf 10.000 umgewandelt.

pageToken

string

Ein Seitentoken, das von einer vorherigen participationReportViews.query-Anfrage empfangen wurde. Geben Sie diese an, um die nachfolgende Seite zu empfangen.

Beim Paginieren müssen alle anderen für participationReportViews.query bereitgestellten Parameter mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

VERALTET:Verwenden Sie stattdessen QueryPropertyPerformanceReportResponse mit PropertyPerformanceReportService. Antwortnachricht für FreeBookingLinksReportService.QueryFreeBookingLinksReport.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung
{
  "results": [
    {
      object (FreeBookingLinksResult)
    }
  ],
  "nextPageToken": string
}
Felder
results[]

object (FreeBookingLinksResult)

Die Liste der Ergebnisse, die der Abfrage entsprechen.

nextPageToken

string

Paginierungstoken zum Abrufen der nächsten Ergebnisseite. Wenn dieses Feld weggelassen wird, gibt es keine nachfolgenden Seiten.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

Weitere Informationen finden Sie unter OAuth 2.0 Overview.

FreeBookingLinksResult

VERALTET:Verwenden Sie stattdessen PropertyPerformanceResult mit PropertyPerformanceReportService. Stellt ein Ergebnis der Abfrage von Statistiken zu kostenlosen Buchungslinks für ein Konto dar.

JSON-Darstellung
{
  "date": {
    object (Date)
  },
  "userRegionCode": string,
  "deviceType": enum (Device),
  "partnerHotelId": string,
  "partnerHotelDisplayName": string,
  "clickCount": string
}
Felder
date

object (Date)

Ein Datum innerhalb des angeforderten Zeitraums.

Nur vorhanden, wenn date in aggregateBy in der Anfrage angegeben ist.

userRegionCode

string

Der ISO 3116-Regionscode des Landes/der Region des Nutzers.

Nur vorhanden, wenn userRegionCode in aggregateBy in der Anfrage angegeben ist.

deviceType

enum (Device)

Der Gerätetyp des Nutzers.

Nur vorhanden, wenn deviceType in aggregateBy in der Anfrage angegeben ist.

partnerHotelId

string

Hotel-ID des Partners.

Nur vorhanden, wenn partnerHotelId in aggregateBy in der Anfrage angegeben ist.

partnerHotelDisplayName

string

Der Name des Hotels des Partners.

Nur vorhanden, wenn partnerHotelDisplayName in aggregateBy in der Anfrage angegeben ist.

clickCount

string (int64 format)

Die Gesamtzahl der Klicks, die für dieses Ergebnis erfasst wurden.