- Richiesta HTTP
- Parametri del percorso
- Parametri di ricerca
- Corpo della richiesta
- Corpo della risposta
- Ambiti di autorizzazione
- PropertyPerformanceResult
- FinestraFinestraPrenotazione
- Durata del soggiorno
- Numero di persone
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 |
Il nome della risorsa dell'account su cui viene eseguita la query. Formato: accounts/{account_id} |
Parametri di ricerca
Parametri | |
---|---|
filter |
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 Il campo I valori del campo I valori di Ecco alcuni esempi di condizioni valide:
|
aggregateBy |
Specifica come segmentare le metriche restituite dalla query. Ad esempio, se Il valore stringa è un elenco di campi separato da virgole. I campi validi sono: |
pageSize |
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 |
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 ( |
Campi | |
---|---|
results[] |
L'elenco dei risultati che corrispondono alla query. |
nextPageToken |
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 ( |
Campi | |
---|---|
date |
Una data compresa nell'intervallo di date richiesto. Presente solo se |
advanceBookingWindow |
Differenza di giorni tra la data della query e la data del check-in nel fuso orario locale della proprietà. Presente solo se |
brand |
Brand specificato dal partner per la proprietà. Presente solo se |
deviceType |
Il tipo di dispositivo dell'utente. Presente solo se |
highIntentUsers |
Indica se la query dell'utente ha indicato un forte interesse per la prenotazione. Presente solo se |
lengthOfStay |
Numero di notti tra le date di check-in e check-out specificate dall'utente. Presente solo se |
propertyRegionCode |
Codice regione ISO 3116 del paese/area geografica della proprietà. Presente solo se |
occupancy |
Numero richiesto di persone che soggiornano nella proprietà. Presente solo se |
partnerPropertyId |
ID proprietà del partner. Presente solo se |
partnerPropertyDisplayName |
Nome proprietà del partner. Presente solo se |
userRegionCode |
Codice regione ISO 3116 del paese/area geografica dell'utente. Presente solo se |
clickCount |
Il numero totale di clic registrati per questo risultato. |
impressionCount |
Il numero totale di impressioni registrate per questo risultato. Questo valore è arrotondato per tutelare la privacy dell'utente. |
clickthroughRate |
Uguale a |
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. |