Method: accounts.freeBookingLinksReportViews.query

OBSOLÈTE : utilisez PropertyPerformanceReportService.QueryPropertyPerformanceReport, qui propose également des rapports sur les impressions. Permet d'interroger (obtenir, filtrer et segmenter) un rapport sur les liens de réservation gratuits 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 interrogé. Format: accounts/{account_id}

Paramètres de requête

Paramètres
filter

string

Conditions (champs et expressions) utilisées pour filtrer les métriques sur les liens de réservation gratuits pour le compte concerné par la requête. La syntaxe nécessite des espaces autour de l'opérateur in. Sinon, vous pouvez omettre les espaces. Les conditions peuvent être jointes à 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 de début la plus proche est le 2021-03-09 ; les valeurs de date antérieures seront appliquées au 2021-03-09.

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 fournit 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 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-la 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

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

OBSOLÈTE : utilisez QueryPropertyPerformanceReportResponse avec PropertyPerformanceReportService à la place. Message de réponse pour FreeBookingLinksReportService.QueryFreeBookingLinksReport.

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 en savoir plus, consultez Présentation d'OAuth 2.0.

FreeBookingLinksResult

OBSOLÈTE : utilisez PropertyPerformanceResult avec PropertyPerformanceReportService à la place. Représente le résultat d'une requête portant sur des statistiques de liens de réservation gratuits pour 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 plage de dates 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.