Method: accounts.propertyPerformanceReportViews.query

Ermöglicht das Abfragen (Abrufen, Filtern und Segmentieren) eines Berichts zu Links für die kostenlose Buchung für ein bestimmtes Konto. In dieser neuen Version werden Impressionen und Klicks sowie eine viel größere Obermenge von Filtern/Aggregationen zurückgegeben.

HTTP-Anfrage

GET https://travelpartner.googleapis.com/v3/{name=accounts/*}/propertyPerformanceReportViews: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 Property-Leistungsmesswerte 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.

Wichtig:Die richtige Syntax zum Hinzufügen mehrerer Bedingungen lautet: "?filter=<condition>=<value>%20AND%20<condition>=<value>..."

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 den Werten für partnerPropertyDisplayName und brand wird die Groß-/Kleinschreibung nicht berücksichtigt.

Beispiele für gültige Bedingungen:

  • 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

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

Der Stringwert ist eine durch Kommas getrennte Liste von Feldern. Gültige Felder sind: advanceBookingWindow, brand, date, deviceType, highIntentUsers, lengthOfStay, propertyRegionCode, occupancy, partnerPropertyId, partnerPropertyDisplayName und userRegionCode. Nur die hier angegebenen Felder sind im PropertyPerformanceResult enthalten.

Wichtig: Wenn Sie den Parameter aggregateBy mit partnerHotelId oder mehr als zwei Werten verwenden, kann dies zu einem Fehler führen. Wenn Sie mit partnerHotelId und date filtern, um die Anzahl der Zeilen zu reduzieren, können Sie Fehler vermeiden.

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

Antwortnachricht für PropertyPerformanceReportService.QueryPropertyPerformanceReport.

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

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

object (PropertyPerformanceResult)

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.

PropertyPerformanceResult

Stellt ein Ergebnis der Abfrage des Property-Leistungsberichts für ein Konto dar.

JSON-Darstellung
{
  "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
}
Felder
date

object (Date)

Ein Datum innerhalb des angeforderten Zeitraums.

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

advanceBookingWindow

enum (AdvanceBookingWindow)

Die Differenz in Tagen zwischen dem Abfragedatum und dem Check-in-Datum in der lokalen Zeitzone der Unterkunft.

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

brand

string

Vom Partner angegebene Marke für die Unterkunft.

Nur vorhanden, wenn brand 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.

highIntentUsers

boolean

Gibt an, ob die Anfrage des Nutzers auf ein starkes Buchungsinteresse hinweist.

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

lengthOfStay

enum (LengthOfStay)

Anzahl der Nächte zwischen den vom Nutzer angegebenen Check-in- und Check-out-Daten.

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

propertyRegionCode

string

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

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

occupancy

enum (Occupancy)

Die angeforderte Anzahl der Personen, die in der Unterkunft übernachten.

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

partnerPropertyId

string

Die Immobilien-ID des Partners.

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

partnerPropertyDisplayName

string

Name der Unterkunft des Partners

Nur vorhanden, wenn partnerPropertyDisplayName 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.

clickCount

string (int64 format)

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

impressionCount

string (int64 format)

Die Gesamtzahl der Impressionen über kostenlose Buchungslinks, die für dieses Ergebnis erfasst wurden. Der Wert wird aufgerundet, um den Datenschutz der Nutzer zu wahren.

clickthroughRate

number

Gleich clickCount geteilt durch impressionCount.

adsClickCount

string (int64 format)

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

adsImpressionCount

string (int64 format)

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

adsClickthroughRate

number

Gleich adsClickCount geteilt durch adsImpressionCount.

vrWebsiteButtonClicks

string (int64 format)

Die Gesamtzahl der Klicks auf die Schaltfläche „Website“ bei Google für Ferienunterkünfte.

AdvanceBookingWindow

Listet die unterstützten Reservierungszeiträume auf. Alle Datumsvergleiche erfolgen in der Zeitzone der Property.

Enums
ADVANCE_BOOKING_WINDOW_UNSPECIFIED Nicht angegeben.
ADVANCE_BOOKING_WINDOW_SAME_DAY Das Check-in-Datum war dasselbe wie das Abfragedatum.
ADVANCE_BOOKING_WINDOW_NEXT_DAY Das Anreisedatum war der Tag nach dem Abfragedatum.
ADVANCE_BOOKING_WINDOW_DAYS_2_TO_7 Das Check-in-Datum lag 2–7 Tage nach dem Abfragedatum.
ADVANCE_BOOKING_WINDOW_DAYS_8_TO_14 Das Check-in-Datum lag 8 bis 14 Tage nach dem Datum der Anfrage.
ADVANCE_BOOKING_WINDOW_DAYS_15_TO_30 Das Check-in-Datum lag 15 bis 30 Tage nach dem Abfragedatum.
ADVANCE_BOOKING_WINDOW_DAYS_31_TO_60 Das Check-in-Datum lag 31 bis 60 Tage nach dem Abfragedatum.
ADVANCE_BOOKING_WINDOW_DAYS_61_TO_90 Das Check-in-Datum lag 61 bis 90 Tage nach dem Datum der Anfrage.
ADVANCE_BOOKING_WINDOW_DAYS_91_TO_120 Das Check-in-Datum lag 91 bis 120 Tage nach dem Abfragedatum.
ADVANCE_BOOKING_WINDOW_DAYS_121_TO_150 Das Check-in-Datum lag 121 bis 150 Tage nach dem Abfragedatum.
ADVANCE_BOOKING_WINDOW_DAYS_151_TO_180 Das Check-in-Datum lag 151 bis 180 Tage nach dem Abfragedatum.
ADVANCE_BOOKING_WINDOW_DAYS_OVER_180 Das Check-in-Datum lag mehr als 180 Tage nach dem Abfragedatum.

LengthOfStay

Listet die unterstützten Aufenthaltsdauern auf.

Enums
LENGTH_OF_STAY_UNSPECIFIED Nicht angegeben.
LENGTH_OF_STAY_NIGHTS_1 Übernachtung für eine Nacht
LENGTH_OF_STAY_NIGHTS_2 Aufenthalt von 2 Nächten
LENGTH_OF_STAY_NIGHTS_3 Aufenthalt von 3 Nächten
LENGTH_OF_STAY_NIGHTS_4_TO_7 Aufenthalt von 4–7 Übernachtungen
LENGTH_OF_STAY_NIGHTS_8_TO_14 Aufenthalt von 8 bis 14 Nächten.
LENGTH_OF_STAY_NIGHTS_15_TO_21 Aufenthalt von 15 bis 21 Übernachtungen.
LENGTH_OF_STAY_NIGHTS_22_TO_30 Aufenthalt von 22 bis 30 Übernachtungen.
LENGTH_OF_STAY_NIGHTS_OVER_30 Aufenthalte von mehr als 30 Nächten

Anwesenheit

Listet die unterstützte Gesamtzahl der Personen im Raum auf.

Enums
OCCUPANCY_UNSPECIFIED Nicht angegeben.
OCCUPANCY_1 Einzelperson.
OCCUPANCY_2 Zwei Personen.
OCCUPANCY_3 Drei Personen.
OCCUPANCY_4 Vier Personen.
OCCUPANCY_OVER_4 Mehr als 4 Personen.