Method: accounts.freeBookingLinksReportViews.query

OBSOLÈTE : utilisez plutôt PropertyPerformanceReportService.QueryPropertyPerformanceReport, qui permet également de générer des rapports sur les impressions. Permet d'interroger (obtenir, filtrer et segmenter) un rapport sur les liens de réservation sans frais pour un compte spécifique.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
name

string

Nom de ressource du compte pour lequel la requête est effectuée. Format : accounts/{account_id}

Paramètres de requête

Paramètres
filter

string

Conditions (champs et expressions) utilisées pour filtrer les métriques des liens de réservation gratuits pour le compte interrogé. La syntaxe nécessite des espaces autour de l'opérateur in. Sinon, les espaces peuvent être omis. Vous pouvez joindre des conditions à l'aide de l'opérateur and.

Le champ date est obligatoire. Tous les autres sont facultatifs.

Les valeurs du champ date sont inclusives et doivent être au format AAAA-MM-JJ. La date la plus ancienne acceptée est le 9 mars 2021. Les valeurs de date antérieures seront forcées à cette date.

Les valeurs de partnerHotelDisplayName ne sont pas sensibles à la casse.

Voici des exemples de conditions valides :

  • 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

Spécifie comment segmenter les métriques renvoyées par la requête. Par exemple, si userRegionCode est spécifié, freeBookingLinksResult fournira des métriques agrégées par région de l'utilisateur.

La valeur de chaîne est une liste de champs séparés par une virgule. Les champs valides sont les suivants : date, userRegionCode, deviceType, partnerHotelId et partnerHotelDisplayName. Seuls les champs spécifiés ici sont inclus dans FreeBookingLinksResult.
pageSize

integer

Nombre maximal de résultats de participation à renvoyer. Le service peut renvoyer un nombre inférieur à cette valeur. Si aucune valeur n'est spécifiée, 10 000 résultats au maximum sont renvoyés. La valeur maximale est 10 000. Les valeurs supérieures sont réduites à 10 000.
pageToken

string

Jeton de page reçu d'une requête participationReportViews.query précédente. Fournissez-le pour recevoir la page suivante.

Lors de la pagination, tous les autres paramètres fournis à participationReportViews.query doivent correspondre à l'appel ayant fourni le jeton de page.

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

OBSOLÈTE : utilisez plutôt QueryPropertyPerformanceReportResponse avec PropertyPerformanceReportService. Message de réponse pour FreeBookingLinksReportService.QueryFreeBookingLinksReport.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON 
{
  "results": [
    {
      object (FreeBookingLinksResult)
    }
  ],
  "nextPageToken": string
}
Champs
results[]

object (FreeBookingLinksResult)

Liste des résultats correspondant à la requête.
nextPageToken

string

Jeton de pagination utilisé pour récupérer la page de résultats suivante. Si ce champ est omis, il n'y a pas d'autres pages.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Pour plus d'informations, consultez la OAuth 2.0 Overview.

FreeBookingLinksResult

OBSOLÈTE : utilisez plutôt PropertyPerformanceResult avec PropertyPerformanceReportService. Représente un résultat de requête pour les statistiques sur les liens de réservation gratuits d'un compte.

Représentation JSON 
{
  "date": {
    object (Date)
  },
  "userRegionCode": string,
  "deviceType": enum (Device),
  "partnerHotelId": string,
  "partnerHotelDisplayName": string,
  "clickCount": string
}
Champs
date

object (Date)

Date comprise dans la période demandée.

Présent uniquement si date est spécifié dans aggregateBy dans la requête.
userRegionCode

string

Code de région ISO 3116 du pays/de la région de l'utilisateur.

Présent uniquement si userRegionCode est spécifié dans aggregateBy dans la requête
deviceType

enum (Device)

Type d'appareil de l'utilisateur.

Présent uniquement si deviceType est spécifié dans aggregateBy dans la requête.
partnerHotelId

string

ID de l'hôtel du partenaire.

Présent uniquement si partnerHotelId est spécifié dans aggregateBy dans la requête.
partnerHotelDisplayName

string

Nom de l'hôtel du partenaire.

Présent uniquement si partnerHotelDisplayName est spécifié dans aggregateBy dans la requête.
clickCount

string (int64 format)

Nombre total de clics enregistrés pour ce résultat.