Method: accounts.propertyPerformanceReportViews.query

Consente di eseguire query (recuperare, filtrare e segmentare) un report sui link di prenotazione gratuiti per un account specifico. Questa nuova versione restituisce impressioni e clic, nonché un superset molto più ampio di filtri/aggregazioni.

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
name

string

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

Parametri di query

Parametri
filter

string

Le condizioni (campi ed espressioni) utilizzate per filtrare le metriche di rendimento della proprietà per l'account per cui viene eseguita la query. La sintassi richiede spazi intorno all'operatore in. In caso contrario, gli spazi possono essere omessi. Le condizioni possono essere unite utilizzando l'operatore AND.

Importante:la sintassi corretta per aggiungere più condizioni è: "?filter=<condition>=<value>%20AND%20<condition>=<value>..."

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

I valori del campo date sono inclusivi e devono essere nel formato AAAA-MM-GG. La prima data accettabile è 2021-03-09; i valori di data precedenti verranno forzati a 2021-03-09.

I valori di partnerPropertyDisplayName e brand vengono confrontati senza distinzione tra maiuscole e minuscole.

Di seguito sono riportati 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 viene specificato userRegionCode, PropertyPerformanceResult fornirà metriche aggregate per regione utente.

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

Importante: l'utilizzo del parametro aggregateBy con partnerHotelId o più di due valori può generare un errore. Il filtraggio con partnerHotelId e date per ridurre il numero di righe può impedire il verificarsi di errori.

pageSize

integer

Il numero massimo di risultati di partecipazione da restituire. Il servizio potrebbe restituire un numero inferiore a questo valore. Se non specificato, 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 richiesta participationReportViews.query. Fornisci questo valore per ricevere la pagina successiva.

Durante la paginazione, tutti gli altri parametri forniti a participationReportViews.query devono corrispondere alla chiamata che ha fornito il token di pagina.

Corpo della richiesta

Il corpo della richiesta deve essere vuoto.

Corpo della risposta

Messaggio di risposta per PropertyPerformanceReportService.QueryPropertyPerformanceReport.

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

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

object (PropertyPerformanceResult)

L'elenco dei risultati che corrispondono alla query.

nextPageToken

string

Token di paginazione 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 saperne di più, consulta la OAuth 2.0 Overview.

PropertyPerformanceResult

Rappresenta un risultato della query per il report sul rendimento della 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,
  "adsClickCount": string,
  "adsImpressionCount": string,
  "adsClickthroughRate": number,
  "vrWebsiteButtonClicks": string
}
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 in giorni tra la data della query e la data di 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

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/regione della proprietà.

Presente solo se propertyRegionCode è specificato in aggregateBy nella richiesta

occupancy

enum (Occupancy)

Numero di persone che soggiorneranno 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 della proprietà del partner.

Presente solo se partnerPropertyDisplayName è specificato in aggregateBy nella richiesta.

userRegionCode

string

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

Presente solo se userRegionCode è specificato in aggregateBy nella richiesta

clickCount

string (int64 format)

Il numero totale di clic sui link di prenotazione gratuiti registrati per questo risultato.

impressionCount

string (int64 format)

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

clickthroughRate

number

Uguale a clickCount diviso per impressionCount.

adsClickCount

string (int64 format)

Il numero totale di clic sugli annunci registrati per questo risultato.

adsImpressionCount

string (int64 format)

Il numero totale di impressioni annuncio registrate per questo risultato.

adsClickthroughRate

number

Uguale a adsClickCount diviso per adsImpressionCount.

vrWebsiteButtonClicks

string (int64 format)

Il numero totale di clic sul pulsante "Sito web" su Google per le case vacanze.

AdvanceBookingWindow

Elenca le finestre per prenotazione anticipata (ABW) supportate. Tutti i confronti tra date vengono eseguiti nel fuso orario della proprietà.

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

LengthOfStay

Elenca le durate del soggiorno (LOS) supportate.

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 di oltre 30 notti.

Numero di persone

Elenca l'occupazione totale della stanza supportata.

Enum
OCCUPANCY_UNSPECIFIED Non specificato.
OCCUPANCY_1 Una sola persona.
OCCUPANCY_2 Due persone.
OCCUPANCY_3 Tre persone.
OCCUPANCY_4 Quattro persone.
OCCUPANCY_OVER_4 Più di 4 persone.