- Requête HTTP
- Paramètres de chemin d'accès
- Paramètres de requête
- Corps de la requête
- Corps de la réponse
- Champs d'application des autorisations
- PropertyPerformanceResult
- Période de réservation à l'avance
- LengthOfStay
- Nombre de personnes
Permet d'interroger (obtenir, filtrer et segmenter) un rapport sur les liens de performances d'une propriété pour un compte spécifique.
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 |
Nom de ressource du compte interrogé. Format: accounts/{account_id} |
Paramètres de requête
Paramètres | |
---|---|
filter |
Conditions (champs et expressions) utilisées pour filtrer les métriques de performances de la propriété du compte concerné par la requête. La syntaxe nécessite des espaces autour de l'opérateur Le champ Les valeurs du champ Les valeurs de Voici des exemples de conditions valides:
|
aggregateBy |
Spécifie comment segmenter les métriques renvoyées par la requête. Par exemple, si La valeur de chaîne est une liste de champs séparés par une virgule. Les champs valides sont: |
pageSize |
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 |
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 qui ont la structure suivante :
Message de réponse pour PropertyPerformanceReportService.QueryPropertyPerformanceReport
.
Représentation JSON |
---|
{
"results": [
{
object ( |
Champs | |
---|---|
results[] |
Liste des résultats correspondant à la requête. |
nextPageToken |
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.
PropertyPerformanceResult
Représente le résultat d'une requête sur le rapport sur les performances de la propriété pour un compte.
Représentation JSON |
---|
{ "date": { object ( |
Champs | |
---|---|
date |
Date comprise dans la plage de dates demandée Présent uniquement si |
advanceBookingWindow |
Différence en nombre de 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 |
brand |
Marque de l'établissement spécifiée par le partenaire. Présent uniquement si |
deviceType |
Type d'appareil de l'utilisateur. Présent uniquement si |
highIntentUsers |
Indique si la requête de l'utilisateur indique un fort intérêt pour la réservation. Présent uniquement si |
lengthOfStay |
Nombre de nuits entre les dates d'arrivée et de départ spécifiées par l'utilisateur. Présent uniquement si |
propertyRegionCode |
Code de région ISO 3116 du pays/de la région de la propriété. Présent uniquement si |
occupancy |
Nombre de personnes séjournant dans l'établissement. Présent uniquement si |
partnerPropertyId |
ID de la propriété du partenaire. Présent uniquement si |
partnerPropertyDisplayName |
Nom de la propriété du partenaire. Présent uniquement si |
userRegionCode |
Code de région ISO 3116 du pays/de la région de l'utilisateur. Présent uniquement si |
clickCount |
Nombre total de clics enregistrés pour ce résultat. |
impressionCount |
Nombre total d'impressions enregistrées pour ce résultat. Cette valeur est arrondie pour protéger la vie privée des utilisateurs. |
clickthroughRate |
égal à |
Période de réservation anticipée
Énumère les périodes de réservation à l'avance compatibles. Toutes les comparaisons de dates sont effectuées selon 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 correspond à 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 se situe 2 à 7 jours après la date de la requête. |
ADVANCE_BOOKING_WINDOW_DAYS_8_TO_14 |
La date d'arrivée se situe 8 à 14 jours après la date de la requête. |
ADVANCE_BOOKING_WINDOW_DAYS_15_TO_30 |
La date d'arrivée se situe 15 à 30 jours après la date de la requête. |
ADVANCE_BOOKING_WINDOW_DAYS_31_TO_60 |
La date d'arrivée se situe 31 à 60 jours après la date de la requête. |
ADVANCE_BOOKING_WINDOW_DAYS_61_TO_90 |
La date d'arrivée se situe 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 se situe 91 à 120 jours après la date de la requête. |
ADVANCE_BOOKING_WINDOW_DAYS_121_TO_150 |
La date d'arrivée se situe 121 à 150 jours après la date de la requête. |
ADVANCE_BOOKING_WINDOW_DAYS_151_TO_180 |
La date d'arrivée se situe 151 à 180 jours après la date de la requête. |
ADVANCE_BOOKING_WINDOW_DAYS_OVER_180 |
La date d'arrivée était postérieure de plus de 180 jours à la date de la requête. |
Durée du séjour
Énumère la durée de séjour acceptée.
Enums | |
---|---|
LENGTH_OF_STAY_UNSPECIFIED |
Non spécifié. |
LENGTH_OF_STAY_NIGHTS_1 |
Une seule nuit. |
LENGTH_OF_STAY_NIGHTS_2 |
Séjour de 2 nuits. |
LENGTH_OF_STAY_NIGHTS_3 |
Séjour de 3 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 |
pour les séjours de plus de 30 nuits. |
Occupation
Énumère l'occupation totale des salles.
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 4 personnes. |