Method: accounts.propertyPerformanceReportViews.query

Ermöglicht das Abfragen, Filtern und Segmentieren von Leistungsberichten zu Hoteleigenschaften für ein bestimmtes Konto.

HTTP-Request

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 abgefragten Kontos. Format: accounts/{Konto_ID}

Abfrageparameter

Parameter
filter

string

Die Bedingungen (Felder und Ausdrücke), mit denen die Leistungsmesswerte der Property für das abgefragte Konto gefiltert werden. Die Syntax erfordert Leerzeichen um den Operator in. Andernfalls können Leerzeichen weggelassen werden. Bedingungen können mit dem Operator and zusammengeführt werden.

date ist ein Pflichtfeld. Alle anderen sind optional.

Die Feldwerte für date sind einschließlich und müssen im Format JJJJ-MM-TT angegeben werden. Das früheste gültige Datum ist der 09.03.2021. Vorherige Datumswerte werden auf den 09.03.2021 umgewandelt.

Bei den Werten partnerPropertyDisplayName und brand wird die Groß- und 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. Wenn beispielsweise userRegionCode angegeben ist, liefert 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 in der PropertyPerformanceResult enthalten.
pageSize

integer

Die maximale Anzahl der Ergebnisse, die zurückgegeben werden sollen. Der Dienst gibt möglicherweise weniger als diesen Wert zurück. Wenn nicht angegeben, werden maximal 10.000 Ergebnisse zurückgegeben. Der Höchstwert ist 10.000. Werte über 10.000 werden zu 10.000 gezwungen.
pageToken

string

Ein Seiten-Token, das von einer früheren Teilnahmeberichtsanforderung empfangen wurde. Geben Sie diese an, um die nachfolgende Seite zu erhalten.

Bei der Paginierung müssen alle anderen für „biladeReportViews.query“ angegebenen Parameter mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

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

Antwortnachricht für PropertyPerformanceReportService.QueryPropertyPerformanceReport.

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

object (PropertyPerformanceResult)

Die Liste der Ergebnisse, die der Abfrage entsprechen.
nextPageToken

string

Das Paginierungstoken, das zum Abrufen der nächsten Ergebnisseite verwendet wird. 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.

PropertyLeistungsergebnis

Stellt ein Ergebnis aus Abfragen des Leistungsberichts für Properties 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
}
Felder
date

object (Date)

Ein Datum innerhalb des angeforderten Zeitraums.

Ist nur vorhanden, wenn in der Anfrage date in aggregateBy angegeben ist.
advanceBookingWindow

enum (AdvanceBookingWindow)

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

Ist nur vorhanden, wenn in der Anfrage advanceBookingWindow in aggregateBy angegeben ist.
brand

string

Die vom Partner angegebene Marke für die Unterkunft.

Ist nur vorhanden, wenn in der Anfrage brand in aggregateBy angegeben ist.
deviceType

enum (Device)

Der Gerätetyp des Nutzers.

Ist nur vorhanden, wenn in der Anfrage deviceType in aggregateBy angegeben ist.
highIntentUsers

boolean

Gibt an, ob die Suchanfrage des Nutzers ein starkes Interesse an der Buchung zeigt.

Ist nur vorhanden, wenn in der Anfrage highIntentUsers in aggregateBy angegeben ist.
lengthOfStay

enum (LengthOfStay)

Anzahl der Übernachtungen zwischen den Check-in- und Check-out-Daten durch den Nutzer.

Ist nur vorhanden, wenn in der Anfrage lengthOfStay in aggregateBy angegeben ist.
propertyRegionCode

string

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

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

enum (Occupancy)

Angeforderte Anzahl von Personen, die in der Unterkunft übernachten.

Ist nur vorhanden, wenn in der Anfrage partnerPropertyId in aggregateBy angegeben ist.
partnerPropertyId

string

Property-ID des Partners

Ist nur vorhanden, wenn in der Anfrage partnerPropertyId in aggregateBy angegeben ist.
partnerPropertyDisplayName

string

Property-Name des Partners

Ist nur vorhanden, wenn in der Anfrage partnerPropertyDisplayName in aggregateBy angegeben ist.
userRegionCode

string

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

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

string (int64 format)

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

string (int64 format)

Die Gesamtzahl der Impressionen, die für dieses Ergebnis erfasst wurden. Der Wert wird gerundet, um den Datenschutz der Nutzer zu wahren.
clickthroughRate

number

Ist gleich clickCount geteilt durch impressionCount.

Vorausbuchungszeitraum

Aufzählung der unterstützten Vorausbuchungsfenster Alle Datumsvergleiche werden in der Zeitzone der Unterkunft angezeigt.

Enums
ADVANCE_BOOKING_WINDOW_UNSPECIFIED Nicht angegeben.
ADVANCE_BOOKING_WINDOW_SAME_DAY Das Check-in-Datum entspricht dem Abfragedatum.
ADVANCE_BOOKING_WINDOW_NEXT_DAY Das Check-in-Datum war der nächste 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 war 8–14 Tage nach dem Abfragedatum.
ADVANCE_BOOKING_WINDOW_DAYS_15_TO_30 Das Check-in-Datum lag 15–30 Tage nach dem Abfragedatum.
ADVANCE_BOOKING_WINDOW_DAYS_31_TO_60 Das Check-in-Datum lag 31–60 Tage nach dem Abfragedatum.
ADVANCE_BOOKING_WINDOW_DAYS_61_TO_90 Das Check-in-Datum lag 61–90 Tage nach dem Abfragedatum.
ADVANCE_BOOKING_WINDOW_DAYS_91_TO_120 Das Check-in-Datum lag 91–120 Tage nach dem Abfragedatum.
ADVANCE_BOOKING_WINDOW_DAYS_121_TO_150 Das Check-in-Datum lag 121–150 Tage nach dem Abfragedatum.
ADVANCE_BOOKING_WINDOW_DAYS_151_TO_180 Das Check-in-Datum lag 151–180 Tage nach dem Abfragedatum.
ADVANCE_BOOKING_WINDOW_DAYS_OVER_180 Das Check-in-Datum lag mehr als 180 Tage nach dem Abfragedatum.

Aufenthaltsdauer

Listet die unterstützte Aufenthaltsdauer auf.

Enums
LENGTH_OF_STAY_UNSPECIFIED Nicht angegeben.
LENGTH_OF_STAY_NIGHTS_1 1 Übernachtung.
LENGTH_OF_STAY_NIGHTS_2 Aufenthalt mit 2 Übernachtungen.
LENGTH_OF_STAY_NIGHTS_3 Aufenthalt von 3 Nächten.
LENGTH_OF_STAY_NIGHTS_4_TO_7 Aufenthalt von 4 bis 7 Nächten.
LENGTH_OF_STAY_NIGHTS_8_TO_14 Aufenthalt von 8 bis 14 Übernachtungen.
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 Aufenthalt von mehr als 30 Nächten.

Anwesenheit

Aufzählung der unterstützten Belegungen insgesamt

Enums
OCCUPANCY_UNSPECIFIED Nicht angegeben.
OCCUPANCY_1 Eine Person.
OCCUPANCY_2 Zwei Personen.
OCCUPANCY_3 Drei Personen.
OCCUPANCY_4 Vier Personen.
OCCUPANCY_OVER_4 Über 4 Personen.