Method: accounts.freeBookingLinksReportViews.query

DEPRECATO: utilizza PropertyPerformanceReportService.QueryPropertyPerformanceReport, che include anche i report sulle impressioni. Consente di eseguire query (recuperare, filtrare e segmentare) un report sui link di prenotazione gratuiti per un account specifico.

Richiesta HTTP

GET https://travelpartner.googleapis.com/v3/{name=accounts/*}/freeBookingLinksReportViews: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 dei link di prenotazione gratuiti 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.

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 per partnerHotelDisplayName vengono confrontati senza distinzione tra maiuscole e minuscole.

Di seguito sono riportati alcuni esempi di condizioni valide:

  • date = '2021-12-03'
  • date between '2021-12-03' and '2021-12-08'
  • deviceType = 'TABLET'
  • deviceType in ('MOBILE', 'TABLET')
  • partnerHotelId = 'AAA'
  • partnerHotelId in ('AAA', 'BBB')
  • partnerHotelDisplayName = 'hotel A'
  • partnerHotelDisplayName 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, freeBookingLinksResult fornirà metriche aggregate per regione utente.

Il valore della stringa è un elenco di campi separati da virgole. I campi validi sono: date, userRegionCode, deviceType, partnerHotelId e partnerHotelDisplayName. Nel FreeBookingLinksResult sono inclusi solo i campi specificati qui.
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

DEPRECATO: utilizza QueryPropertyPerformanceReportResponse con PropertyPerformanceReportService. Messaggio di risposta per FreeBookingLinksReportService.QueryFreeBookingLinksReport.

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

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

object (FreeBookingLinksResult)

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.

FreeBookingLinksResult

DEPRECATO: utilizza PropertyPerformanceResult con PropertyPerformanceReportService. Rappresenta un risultato della query per le statistiche sui link di prenotazione gratuiti per un account.

Rappresentazione JSON 
{
  "date": {
    object (Date)
  },
  "userRegionCode": string,
  "deviceType": enum (Device),
  "partnerHotelId": string,
  "partnerHotelDisplayName": string,
  "clickCount": string
}
Campi
date

object (Date)

Una data compresa nell'intervallo di date richiesto.

Presente solo se date è 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
deviceType

enum (Device)

Il tipo di dispositivo dell'utente.

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

string

ID hotel del partner.

Presente solo se partnerHotelId è specificato in aggregateBy nella richiesta.
partnerHotelDisplayName

string

Il nome dell'hotel del partner.

Presente solo se partnerHotelDisplayName è specificato in aggregateBy nella richiesta.
clickCount

string (int64 format)

Il numero totale di clic registrati per questo risultato.