Method: accounts.propertyPerformanceReportViews.query

Permet d'interroger (obtenir, filtrer et segmenter) un rapport sur les liens de réservation sans frais pour un compte spécifique. Cette nouvelle version renvoie les impressions et les clics, ainsi qu'un sur-ensemble beaucoup plus important de filtres/agrégations.

Requête HTTP

GET https://travelpartner.googleapis.com/v3/{name=accounts/*}/propertyPerformanceReportViews: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 de performances de la propriété 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.

Important : La syntaxe correcte pour ajouter plusieurs conditions est la suivante : "?filter=<condition>=<value>%20AND%20<condition>=<value>..."

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 partnerPropertyDisplayName et brand ne sont pas sensibles à la casse.

Voici des exemples de conditions valides :

  • 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

Spécifie comment segmenter les métriques renvoyées par la requête. Par exemple, si userRegionCode est spécifié, PropertyPerformanceResult 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 : advanceBookingWindow, brand, date, deviceType, highIntentUsers, lengthOfStay, propertyRegionCode, occupancy, partnerPropertyId, partnerPropertyDisplayName et userRegionCode. Seuls les champs spécifiés ici sont inclus dans PropertyPerformanceResult.

Important : L'utilisation du paramètre aggregateBy avec partnerHotelId ou plus de deux valeurs peut entraîner une erreur. Pour éviter les erreurs, vous pouvez filtrer les données avec partnerHotelId et date afin de réduire le nombre de lignes.

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

Message de réponse pour PropertyPerformanceReportService.QueryPropertyPerformanceReport.

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 (PropertyPerformanceResult)
    }
  ],
  "nextPageToken": string
}
Champs
results[]

object (PropertyPerformanceResult)

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.

PropertyPerformanceResult

Représente un résultat de requête pour le rapport sur les performances de la propriété d'un compte.

Représentation 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
}
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.

advanceBookingWindow

enum (AdvanceBookingWindow)

Différence en jours entre la date de la requête et la date d'arrivée dans le fuseau horaire local de l'établissement.

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

brand

string

Marque spécifiée par le partenaire pour l'établissement.

Présent uniquement si brand 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.

highIntentUsers

boolean

Indique si la requête de l'utilisateur indiquait une forte intention de réserver.

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

lengthOfStay

enum (LengthOfStay)

Nombre de nuits entre les dates d'arrivée et de départ spécifiées par l'utilisateur.

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

propertyRegionCode

string

Code de région ISO 3116 du pays ou de la région de la propriété.

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

occupancy

enum (Occupancy)

Nombre de personnes séjournant dans l'établissement.

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

partnerPropertyId

string

ID de propriété du partenaire.

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

partnerPropertyDisplayName

string

Nom de la propriété du partenaire.

Présent uniquement si partnerPropertyDisplayName 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

clickCount

string (int64 format)

Nombre total de clics sur les liens de réservation gratuits enregistrés pour ce résultat.

impressionCount

string (int64 format)

Nombre total d'impressions de liens de réservation gratuits enregistrées pour ce résultat. Cette valeur est arrondie pour respecter la confidentialité des données des utilisateurs.

clickthroughRate

number

Équivaut à clickCount divisé par impressionCount.

adsClickCount

string (int64 format)

Nombre total de clics sur l'annonce enregistrés pour ce résultat.

adsImpressionCount

string (int64 format)

Nombre total d'impressions d'annonces enregistrées pour ce résultat.

adsClickthroughRate

number

Équivaut à adsClickCount divisé par adsImpressionCount.

vrWebsiteButtonClicks

string (int64 format)

Nombre total de clics sur le bouton "Site Web" sur Google pour les locations de vacances.

AdvanceBookingWindow

Énumère les périodes de réservation à l'avance (PRA) acceptées. Toutes les comparaisons de dates sont effectuées dans le fuseau horaire de la propriété.

Enums
ADVANCE_BOOKING_WINDOW_UNSPECIFIED Non spécifié.
ADVANCE_BOOKING_WINDOW_SAME_DAY La date d'arrivée était identique à la date de la requête.
ADVANCE_BOOKING_WINDOW_NEXT_DAY La date d'arrivée était le lendemain de la date de la requête.
ADVANCE_BOOKING_WINDOW_DAYS_2_TO_7 La date d'arrivée était comprise entre deux et sept jours après la date de la requête.
ADVANCE_BOOKING_WINDOW_DAYS_8_TO_14 La date d'arrivée était comprise entre 8 et 14 jours après la date de la requête.
ADVANCE_BOOKING_WINDOW_DAYS_15_TO_30 La date d'arrivée était comprise entre 15 et 30 jours après la date de la requête.
ADVANCE_BOOKING_WINDOW_DAYS_31_TO_60 La date d'arrivée était comprise entre 31 et 60 jours après la date de la requête.
ADVANCE_BOOKING_WINDOW_DAYS_61_TO_90 La date d'arrivée était comprise entre 61 et 90 jours après la date de la requête.
ADVANCE_BOOKING_WINDOW_DAYS_91_TO_120 La date d'arrivée était comprise entre 91 et 120 jours après la date de la requête.
ADVANCE_BOOKING_WINDOW_DAYS_121_TO_150 La date d'arrivée était comprise entre 121 et 150 jours après la date de la requête.
ADVANCE_BOOKING_WINDOW_DAYS_151_TO_180 La date d'arrivée était comprise entre 151 et 180 jours après la date de la requête.
ADVANCE_BOOKING_WINDOW_DAYS_OVER_180 La date d'arrivée était plus de 180 jours après la date de la requête.

LengthOfStay

Énumère les durées de séjour (DDS) acceptées.

Enums
LENGTH_OF_STAY_UNSPECIFIED Non spécifié.
LENGTH_OF_STAY_NIGHTS_1 Séjour d'une nuit
LENGTH_OF_STAY_NIGHTS_2 Séjour de deux nuits.
LENGTH_OF_STAY_NIGHTS_3 Séjour de trois nuits.
LENGTH_OF_STAY_NIGHTS_4_TO_7 Séjour de 4 à 7 nuits.
LENGTH_OF_STAY_NIGHTS_8_TO_14 Séjour de 8 à 14 nuits.
LENGTH_OF_STAY_NIGHTS_15_TO_21 Séjour de 15 à 21 nuits.
LENGTH_OF_STAY_NIGHTS_22_TO_30 Séjour de 22 à 30 nuits
LENGTH_OF_STAY_NIGHTS_OVER_30 Séjour de plus de 30 nuits

Nombre de personnes

Énumère l'occupation totale de la salle acceptée.

Enums
OCCUPANCY_UNSPECIFIED Non spécifié.
OCCUPANCY_1 Une seule personne.
OCCUPANCY_2 Deux personnes.
OCCUPANCY_3 Trois personnes.
OCCUPANCY_4 Quatre personnes.
OCCUPANCY_OVER_4 Plus de quatre personnes.