Method: accounts.propertyPerformanceReportViews.query

Consente di eseguire query (get, filtri e segmenti) di un report sui link del rendimento delle proprietà per un account specifico.

Richiesta HTTP

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

L'URL utilizza la sintassi gRPC Transcoding.

Parametri del percorso

Parametri
name

string

Il nome della risorsa dell'account su cui viene eseguita la query. Formato: accounts/{account_id}

Parametri di ricerca

Parametri
filter

string

Le condizioni (campi ed espressioni) utilizzate per filtrare le metriche sul rendimento della proprietà per l'account oggetto della query. La sintassi richiede spazi che circondano l'operatore in. In caso contrario, gli spazi possono essere omessi. È possibile unire le condizioni utilizzando l'operatore and.

Il campo date è obbligatorio. Tutti gli altri campi sono facoltativi.

I valori del campo date sono inclusi e devono essere in formato AAAA-MM-GG. La prima data accettabile è il 09/03/2021; i valori della data precedente verranno forzati fino al 09/03/2021.

I valori di partnerPropertyDisplayName e brand non fanno distinzione tra maiuscole e minuscole.

Ecco alcuni esempi di condizioni valide:

  • 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

Specifica come segmentare le metriche restituite dalla query. Ad esempio, se userRegionCode viene specificato, PropertyPerformanceResult fornirà le metriche aggregate per area geografica utente.

Il valore stringa è un elenco di campi separato da virgole. I campi validi sono: advanceBookingWindow, brand, date, deviceType, highIntentUsers, lengthOfStay, propertyRegionCode, occupancy, partnerPropertyId, partnerPropertyDisplayName e userRegionCode. Solo i campi specificati qui sono inclusi in PropertyPerformanceResult.
pageSize

integer

Il numero massimo di risultati di partecipazione da restituire. Il servizio potrebbe restituire un valore inferiore a questo valore. Se non viene specificato un valore, verranno restituiti al massimo 10.000 risultati. Il valore massimo è 10.000; i valori superiori a 10.000 verranno forzati a 10.000.
pageToken

string

Un token di pagina, ricevuto da una precedente richiestareportReportViews.query Forniscilo per ricevere la pagina successiva.

Durante l'impaginazione, tutti gli altri parametri forniti a PartecipaReportViews.query devono corrispondere alla chiamata che ha fornito il token della pagina.

Corpo della richiesta

Il corpo della richiesta deve essere vuoto.

Corpo della risposta

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Messaggio di risposta per PropertyPerformanceReportService.QueryPropertyPerformanceReport.

Rappresentazione JSON 
{
  "results": [
    {
      object (PropertyPerformanceResult)
    }
  ],
  "nextPageToken": string
}
Campi
results[]

object (PropertyPerformanceResult)

L'elenco dei risultati che corrispondono alla query.
nextPageToken

string

Token di impaginazione utilizzato per recuperare la pagina successiva dei risultati. Se questo campo viene omesso, non verranno visualizzate altre pagine.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per scoprire di più, consulta la Panoramica di OAuth 2.0.

Rendimento delle proprietà

Rappresenta un risultato dell'esecuzione di query per il report sul rendimento delle proprietà per un account.

Rappresentazione JSON 
{
  "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
}
Campi
date

object (Date)

Una data compresa nell'intervallo di date richiesto.

Presente solo se date è specificato in aggregateBy nella richiesta.
advanceBookingWindow

enum (AdvanceBookingWindow)

Differenza di giorni tra la data della query e la data del check-in nel fuso orario locale della proprietà.

Presente solo se advanceBookingWindow è specificato in aggregateBy nella richiesta.
brand

string

Brand specificato dal partner per la proprietà.

Presente solo se brand è specificato in aggregateBy nella richiesta.
deviceType

enum (Device)

Il tipo di dispositivo dell'utente.

Presente solo se deviceType è specificato in aggregateBy nella richiesta.
highIntentUsers

boolean

Indica se la query dell'utente ha indicato un forte interesse per la prenotazione.

Presente solo se highIntentUsers è specificato in aggregateBy nella richiesta.
lengthOfStay

enum (LengthOfStay)

Numero di notti tra le date di check-in e check-out specificate dall'utente.

Presente solo se lengthOfStay è specificato in aggregateBy nella richiesta.
propertyRegionCode

string

Codice regione ISO 3116 del paese/area geografica della proprietà.

Presente solo se propertyRegionCode è specificato in aggregateBy nella richiesta
occupancy

enum (Occupancy)

Numero richiesto di persone che soggiornano nella proprietà.

Presente solo se partnerPropertyId è specificato in aggregateBy nella richiesta.
partnerPropertyId

string

ID proprietà del partner.

Presente solo se partnerPropertyId è specificato in aggregateBy nella richiesta.
partnerPropertyDisplayName

string

Nome proprietà del partner.

Presente solo se partnerPropertyDisplayName è specificato in aggregateBy nella richiesta.
userRegionCode

string

Codice regione ISO 3116 del paese/area geografica dell'utente.

Presente solo se userRegionCode è specificato in aggregateBy nella richiesta
clickCount

string (int64 format)

Il numero totale di clic registrati per questo risultato.
impressionCount

string (int64 format)

Il numero totale di impressioni registrate per questo risultato. Questo valore è arrotondato per tutelare la privacy dell'utente.
clickthroughRate

number

Uguale a clickCount diviso per impressionCount.

FinestraPrenotazione Avanzata

Enumera le finestre di prenotazione anticipata supportate (ABW). Tutti i confronti tra date sono nel fuso orario della proprietà.

Enum
ADVANCE_BOOKING_WINDOW_UNSPECIFIED Non specificato.
ADVANCE_BOOKING_WINDOW_SAME_DAY La data del check-in era la stessa della data della query.
ADVANCE_BOOKING_WINDOW_NEXT_DAY La data del check-in è stata il giorno successivo alla data della query.
ADVANCE_BOOKING_WINDOW_DAYS_2_TO_7 La data del check-in è stata di 2-7 giorni dopo la data della query.
ADVANCE_BOOKING_WINDOW_DAYS_8_TO_14 La data del check-in è stata di 8-14 giorni dopo la data della query.
ADVANCE_BOOKING_WINDOW_DAYS_15_TO_30 La data del check-in è stata di 15-30 giorni dopo la data della query.
ADVANCE_BOOKING_WINDOW_DAYS_31_TO_60 La data del check-in è stata di 31-60 giorni dopo la data della query.
ADVANCE_BOOKING_WINDOW_DAYS_61_TO_90 La data del check-in è stata di 61-90 giorni dopo la data della query.
ADVANCE_BOOKING_WINDOW_DAYS_91_TO_120 La data del check-in è stata di 91-120 giorni dopo la data della query.
ADVANCE_BOOKING_WINDOW_DAYS_121_TO_150 La data del check-in è stata di 121-150 giorni dopo la data della query.
ADVANCE_BOOKING_WINDOW_DAYS_151_TO_180 La data del check-in era 151-180 giorni dopo la data della query.
ADVANCE_BOOKING_WINDOW_DAYS_OVER_180 La data del check-in è stata effettuata oltre 180 giorni dopo la data della query.

Durata del soggiorno

Enumera la durata del soggiorno (LOS) supportata.

Enum
LENGTH_OF_STAY_UNSPECIFIED Non specificato.
LENGTH_OF_STAY_NIGHTS_1 Soggiorno di una sola notte.
LENGTH_OF_STAY_NIGHTS_2 Soggiorno di 2 notti.
LENGTH_OF_STAY_NIGHTS_3 Soggiorno di 3 notti.
LENGTH_OF_STAY_NIGHTS_4_TO_7 Soggiorno di 4-7 notti.
LENGTH_OF_STAY_NIGHTS_8_TO_14 Soggiorno di 8-14 notti.
LENGTH_OF_STAY_NIGHTS_15_TO_21 Soggiorno di 15-21 notti.
LENGTH_OF_STAY_NIGHTS_22_TO_30 Soggiorno di 22-30 notti.
LENGTH_OF_STAY_NIGHTS_OVER_30 Soggiorno superiore a 30 notti.

Presenza

Enumera l'occupazione totale delle stanze supportata.

Enum
OCCUPANCY_UNSPECIFIED Non specificato.
OCCUPANCY_1 Una persona.
OCCUPANCY_2 Due persone.
OCCUPANCY_3 Tre persone.
OCCUPANCY_4 Quattro persone.
OCCUPANCY_OVER_4 Oltre 4 persone.