Engage SDK Travel: instructions d'intégration technique tierce

Google est en train de développer une surface sur appareil, qui organisera les applications des utilisateurs par secteurs et offrira une nouvelle expérience immersive permettant une consommation et une découverte personnalisées du contenu de ces applications. Cette expérience plein écran donne aux développeurs partenaires la possibilité de présenter leurs meilleurs contenus enrichis sur une chaîne dédiée en dehors de leur application. Ce guide explique aux développeurs partenaires comment intégrer leur contenu de voyage et d'événements à l'aide du SDK Engage pour renseigner cette nouvelle surface.

Détails de l'intégration

Terminologie

Cette intégration comprend les types de clusters suivants: Recommendation (Recommandations), Featured (Sélection), Reservation (Réservation) et Continue Search (Continuer la recherche).

  • Les clusters Recommandation affichent des suggestions personnalisées de voyages et d'événements provenant d'un développeur partenaire individuel. Ces recommandations peuvent être personnalisées en fonction de l'utilisateur ou généralisées (par exemple, les articles tendance). Utilisez-les pour afficher des recommandations d'articles, d'événements, d'hébergements ou de lieux d'intérêt.

    • Un cluster "Recommandation" peut être constitué de fiches ArticleEntity, EventEntity, LodgingEntity, PointOfInterestEntity ou StoreEntity, mais pas de types d'entités différents.

    Les recommandations présentent la structure suivante :

    • Cluster "Recommendations" : vue de l'interface utilisateur contenant un groupe de recommandations du même développeur partenaire.

    • Entité : objet représentant un seul élément dans un cluster. Cette intégration propose certaines entités qui s'affichent à l'aide du cluster "Recommendation" (Recommandations) :

      • ArticleEntity: ArticleEntity représente une recommandation pour un contenu textuel lié aux voyages et aux événements. Il peut être utilisé pour les articles, les articles de blog, les contenus marketing, les extraits d'actualités, etc.

        Figure 1:UI affichant un seul ArticleEntity dans le cluster "Recommandations".

      • EventEntity: EventEntity représente un événement qui se produira à l'avenir. L'heure de début de l'événement est une information essentielle qui doit être transmise aux utilisateurs.

        Figure 2:UI affichant une seule EventEntity dans le cluster "Recommandations".

      • LodgingEntity: LodgingEntity représente un hébergement, tel qu'un hôtel, un appartement ou une maison de vacances pour des locations de courte et longue durée.

        Figure 3:UI affichant une seule LodgingEntity dans le cluster "Recommandations".

      • StoreEntity: StoreEntity représente un magasin, un restaurant, un café, etc. Il met en avant le contenu pour lequel un établissement ou un magasin est l'information essentielle à transmettre aux utilisateurs.

        Figure 4:Interface utilisateur affichant une seule StoreEntity dans le cluster "Recommandations".

      • PointOfInterestEntity: PointOfInterestEntity représente un point d'intérêt, comme une station-service, un lieu d'événement, un parc à thème, un musée, une attraction touristique, un sentier de randonnée, etc. Il met en avant les contenus pour lesquels la localisation est une information essentielle à transmettre aux utilisateurs. Il ne doit pas être utilisé pour un hébergement, un magasin ou un restaurant.

        Figure 5:Interface utilisateur affichant une seule entité PointOfInterest dans le cluster "Recommandations".

  • Le cluster Réservation affiche dans un regroupement d'UI le contenu avec lequel les utilisateurs de plusieurs développeurs partenaires ont interagi récemment. Chaque développeur partenaire est autorisé à diffuser au maximum 10 entités dans le cluster "Réservation".

    Le contenu de votre réservation peut avoir la structure suivante:

    • RestaurantReservationEntity: RestaurantReservationEntity représente une réservation dans un restaurant ou un café et aide les utilisateurs à suivre les réservations de restaurant à venir ou en cours.

      Figure 6 : Interface utilisateur affichant une seule RestaurantReservationEntity dans un cluster de réservations.

    • EventReservationEntity: EventReservationEntity représente une réservation pour un événement et aide les utilisateurs à suivre les réservations d'événements à venir ou en cours. Les événements peuvent inclure, sans s'y limiter, les éléments suivants:

      • Événements sportifs, comme la réservation d'un match de football
      • Événements de jeux vidéo, comme les réservations pour les e-sports
      • Événements de divertissement tels que la réservation de séances de cinéma, de concerts, de pièces de théâtre ou de séances de dédicace
      • Réservations de voyages ou de lieux d'intérêt, comme des visites guidées ou des billets de musée
      • Réservations pour des événements privés, des séminaires ou des conférences
      • Réservations de sessions de formation
      Figure 7 Interface utilisateur affichant une seule EventReservationEntity dans un cluster de réservations.

    • LodgingReservationEntity: LodgingEntityReservation représente une réservation d'hébergement de voyage et aide les utilisateurs à suivre les réservations d'hôtel ou de location de vacances à venir ou en cours.

      Figure 8 : Interface utilisateur montrant une seule LodgingReservationEntity dans un cluster de réservations.

    • TransportationReservationEntity: TransportationReservationEntity représente la réservation de transports par n'importe quel mode et aide les utilisateurs à suivre les réservations de vols, de ferries, de trains, de bus, de services de covoiturage ou de croisières à venir ou en cours.

      Figure 9. Interface utilisateur affichant une seule TransportationReservationEntity dans un cluster de réservations.

    • VehicleRentalReservationEntity: VehicleRentalReservationEntity représente la réservation de véhicule de location et aide les utilisateurs à suivre les réservations de véhicules de location à venir ou en cours.

      Figure 10. Interface utilisateur affichant une seule entité VehicleRentalReservationEntity dans un cluster de réservations.

  • Le cluster Featured affiche une sélection d'entités de plusieurs développeurs partenaires dans un même groupe d'UI. Il n'existe qu'un seul cluster "Featured", situé dans la partie supérieure de l'UI avec un emplacement prioritaire au-dessus de tous les clusters "Recommendation". Chaque développeur partenaire est autorisé à diffuser jusqu'à 10 entités dans le cluster "Featured".

    • GenericFeaturedEntity: GenericFeaturedEntity diffère de l'élément de recommandation en ce sens que l'élément sélectionné doit être utilisé pour un seul contenu de premier plan des développeurs et doit représenter le contenu le plus important qui sera intéressant et pertinent pour les utilisateurs.

      Figure 11:UI affichant un FeaturedCluster avec une liste de GenericFeaturedEntity

  • Le cluster Continue Search (Poursuivre la recherche) aide les utilisateurs à reprendre leur parcours de recherche de voyage précédent en affichant une liste des requêtes de recherche que l'utilisateur a récemment effectuées dans toutes ses applications de voyage. Le cluster sera épinglé en deuxième position, après les réservations et avant les clusters "Sélection" et "Recommandations". Chaque développeur partenaire est autorisé à diffuser jusqu'à trois entités dans le cluster "Recherche continuer".

    • PointOfInterestEntity:PointOfInterestEntity représente un point d'intérêt, comme une station-service, un lieu d'événement, un parc à thème, un musée, une attraction touristique, un sentier de randonnée, etc. Il met en avant le contenu que l'utilisateur a déjà recherché.

Travail préalable

Niveau d'API minimal : 19

Ajoutez la bibliothèque com.google.android.engage:engage-core à votre application :

dependencies {
    // Make sure you also include that repository in your project's build.gradle file.
    implementation 'com.google.android.engage:engage-core:1.5.2'
}

Résumé

La conception repose sur l'implémentation d'un service lié.

Les données qu'un client peut publier sont soumises aux limites suivantes pour chaque type de cluster :

Type de cluster Nombre limite de clusters Limites minimales d'entités dans un cluster Limites maximales d'entités dans un cluster
Cluster(s) "Recommendation" 5 maximum Au moins 5 25 maximum (ArticleEntity, EventEntity, LodgingEntity, StoreEntity ou PointOfInterestEntity)
Cluster de réservation 1 maximum Au moins 1 10 maximum (RestaurantReservationEntity, EventReservationEntity, LodgingReservationEntity, TransportationReservationEntity ou VehicleRentalReservationEntity)
Cluster "Featured" 1 maximum Au moins 1 10 maximum (GenericFeaturedEntity)
Cluster "Continue Search" (Continuer la recherche) 1 maximum Au moins 1 3 maximum (PointOfInterestEntity)

Étape 1 : Fournir les données d'entité

Le SDK a défini différentes entités pour représenter chaque type d'élément. Nous prenons en charge les entités suivantes pour la catégorie "Voyages et événements" :

  1. GenericFeaturedEntity
  2. ArticleEntity
  3. EventEntity
  4. LodgingEntity
  5. StoreEntity
  6. PointOfInterestEntity
  7. RestaurantReservationEntity
  8. EventReservationEntity
  9. LodgingReservationEntity
  10. TransportationReservationEntity
  11. VehicleRentalReservationEntity

Les tableaux ci-dessous décrivent les attributs disponibles pour chaque type et indiquent s'ils sont obligatoires.

GenericFeaturedEntity

Attribut Obligatoire ? Description Format
URI d'action Obligatoire

Lien profond vers l'entité dans l'application pour les fournisseurs.

Remarque : Vous pouvez utiliser des liens profonds pour l'attribution. Consultez ces questions fréquentes.

URI
Images poster Obligatoire

Nous n'affichons qu'une seule image lorsque plusieurs images sont fournies. Format recommandé : 16:9

Remarque:Si un badge est fourni, assurez-vous d'inclure une zone de sécurité de 24 dp en haut et en bas de l'image.

 Consultez la section Caractéristiques des images pour en savoir plus.
Titre Facultatif Titre de l'entité.

Texte libre

Taille de texte recommandée: 50 caractères
Description Facultatif

Un seul paragraphe de texte pour décrire l'entité.

Remarque:L'utilisateur ne verra que la description ou la liste des sous-titres, et non les deux.

Texte libre

Taille de texte recommandée: 180 caractères
Liste des sous-titres Facultatif

Jusqu'à trois sous-titres, chacun ne comportant qu'une seule ligne de texte.

Remarque:L'utilisateur ne verra que la description ou la liste des sous-titres, et non les deux.

Texte libre

Taille de texte recommandée pour chaque sous-titre: 50 caractères maximum
Badges Facultatif

Chaque badge est un texte libre (15 caractères maximum) ou une petite image.

Traitement UX spécial au-dessus de l'image/vidéo, par exemple en tant que superposition de badge sur l'image

  • "Mise à jour en direct"
  • Durée de lecture de l'article
Badge - Text Facultatif

Titre du badge

Remarque:Vous devez indiquer du texte ou une image pour le badge.

Texte libre

Taille de texte recommandée: 15 caractères maximum
Badge – Image Facultatif

Petite image

Traitement UX spécial, par exemple sous la forme d'un badge superposé à la vignette de l'image/vidéo.

Remarque:Vous devez indiquer du texte ou une image pour le badge.

Consultez la section Caractéristiques des images pour en savoir plus.
Catégories de contenu Facultatif Décrit la catégorie du contenu de l'entité.

Liste des énumérations

Pour obtenir des conseils, consultez la section Catégorie de contenu.

ArticleEntity

Attribut Obligatoire ? Description Format
URI d'action Obligatoire

Lien profond vers l'entité dans l'application pour les fournisseurs.

Remarque : Vous pouvez utiliser des liens profonds pour l'attribution. Consultez ces questions fréquentes.

URI
Titre Obligatoire Titre de l'entité.

Texte libre

Taille de texte recommandée: 50 caractères maximum
Images poster Facultatif

Nous n'affichons qu'une seule image lorsque plusieurs images sont fournies. Format recommandé : 16:9

Remarque:Nous vous recommandons vivement d'ajouter une image. Si un badge est fourni, assurez-vous d'avoir un espace de sécurité de 24 dps en haut et en bas de l'image.

 Consultez la section Caractéristiques des images pour en savoir plus.
Source – Titre Facultatif Nom de l'auteur, de l'organisation ou du signaleur

Texte libre

Taille de texte recommandée: 25 caractères maximum
Source – Image Facultatif Image de la source (auteur, organisation, journaliste, etc.) Consultez la section Caractéristiques des images pour en savoir plus.
Description Facultatif

Un seul paragraphe de texte pour décrire l'entité.

Remarque:L'utilisateur ne verra que la description ou la liste des sous-titres, et non les deux.

Texte libre

Taille de texte recommandée: 180 caractères
Liste des sous-titres Facultatif

Jusqu'à trois sous-titres, chacun ne comportant qu'une seule ligne de texte.

Remarque:L'utilisateur ne verra que la description ou la liste des sous-titres, et non les deux.

Texte libre

Taille de texte recommandée pour chaque sous-titre: 50 caractères maximum
Badges Facultatif

Chaque badge est composé de texte libre (15 caractères maximum) ou d'une petite image.

Traitement UX spécial au-dessus de l'image/vidéo, par exemple, en tant que superposition de badge sur l'image

  • "Mise à jour en direct"
  • Durée de lecture de l'article
Badge - Text Facultatif

Titre du badge

Remarque:Vous devez indiquer du texte ou une image pour le badge.

Texte libre

Taille de texte recommandée: 15 caractères maximum
Badge – Image Facultatif

Petite image

Traitement UX spécial, par exemple sous la forme d'un badge superposé à la vignette de l'image/vidéo.

Remarque:Vous devez indiquer du texte ou une image pour le badge.

Consultez la section Caractéristiques des images pour en savoir plus.
Heure de publication du contenu Facultatif Il s'agit de l'horodatage de l'epoch en millisecondes au moment où le contenu a été publié / mis à jour dans l'application. Code temporel de l'epoch (en millisecondes)
Durée du dernier engagement Obligatoire sous certaines conditions

Horodatage d'epoch en millisecondes lorsque l'utilisateur a interagi avec cette entité pour la dernière fois.

Remarque:Ce champ est obligatoire si cette entité fait partie du cluster de réservations.

 Code temporel de l'epoch (en millisecondes)
Pourcentage de progression Obligatoire sous certaines conditions

Pourcentage du contenu total consommé par l'utilisateur à ce jour.

Remarque:Ce champ est obligatoire si cette entité fait partie du cluster de réservations.

 Valeur entière comprise entre 0 et 100 inclus.
Catégories de contenu Facultatif Décrit la catégorie du contenu de l'entité.

Liste des énumérations

Pour obtenir des conseils, consultez la section Catégorie de contenu.

EventEntity

Attribut Obligatoire ? Description Format
URI d'action Obligatoire

Lien profond vers l'entité dans l'application pour les fournisseurs.

Remarque : Vous pouvez utiliser des liens profonds pour l'attribution. Consultez ces questions fréquentes.

URI
Titre Obligatoire Titre de l'entité.

Chaîne

Taille de texte recommandée: 50 caractères maximum
Heure de début localisée - Code temporel Obligatoire

Code temporel de l'événement au moment prévu de son début.

 Joda-Time Instant
Heure de début localisée - Fuseau horaire Obligatoire

Fuseau horaire dans lequel l'événement doit commencer.

 Joda-Time DateTimeZone
Mode événement Obligatoire

Champ permettant d'indiquer si l'événement aura lieu en présentiel, à distance ou les deux.

 Enum: VIRTUAL, IN_PERSON ou HYBRID
Images poster Obligatoire

Nous n'affichons qu'une seule image lorsque plusieurs images sont fournies. Format recommandé : 16:9

Remarque:Nous vous recommandons vivement d'ajouter une image. Si un badge est fourni, assurez-vous d'avoir un espace de sécurité de 24 dps en haut et en bas de l'image.

 Consultez la section Caractéristiques des images pour en savoir plus.
Emplacement : pays Obligatoire sous certaines conditions

Pays dans lequel se déroule l'événement.

Remarque:Ce champ est obligatoire pour les événements de type IN_PERSON ou HYBRID.

Texte libre

Taille de texte recommandée: 20 caractères maximum
Lieu (ville) Obligatoire sous certaines conditions

Ville où se déroule l'événement.

Remarque:Ce champ est obligatoire pour les événements de type IN_PERSON ou HYBRID.

Texte libre

Taille de texte recommandée: 20 caractères maximum
Emplacement : adresse à afficher Obligatoire sous certaines conditions

Adresse ou nom du lieu où se déroulera l'événement à afficher pour l'utilisateur.

Remarque:Ce champ est obligatoire pour les événements de type IN_PERSON ou HYBRID.

Texte libre

Taille de texte recommandée: 20 caractères maximum
Lieu : adresse postale Facultatif Adresse (le cas échéant) du lieu où se déroule l'événement.

Texte libre

Taille de texte recommandée: 20 caractères maximum
Emplacement – État Facultatif État ou province (le cas échéant) dans lequel l'événement est organisé.

Texte libre

Taille de texte recommandée: 20 caractères maximum
Lieu : code postal Facultatif Code postal (le cas échéant) du lieu où se déroule l'événement.

Texte libre

Taille de texte recommandée: 20 caractères maximum
Emplacement : quartier Facultatif Quartier (le cas échéant) dans lequel l'événement se déroule.

Texte libre

Taille de texte recommandée: 20 caractères maximum
Heure de fin Facultatif

Code temporel de l'événement à la date initiale de référence du système d'exploitation.

Remarque:Cette valeur est exprimée en millisecondes.

 Code temporel de l'epoch (en millisecondes)
Description Facultatif

Un seul paragraphe de texte pour décrire l'entité.

Remarque:L'utilisateur ne verra que la description ou la liste des sous-titres, et non les deux.

Texte libre

Taille de texte recommandée: 180 caractères
Liste des sous-titres Facultatif

Jusqu'à trois sous-titres, chacun ne comportant qu'une seule ligne de texte.

Remarque:L'utilisateur ne verra que la description ou la liste des sous-titres, et non les deux.

Texte libre

Taille de texte recommandée pour chaque sous-titre: 50 caractères maximum
Badges Facultatif

Chaque badge est composé de texte libre (15 caractères maximum) ou d'une petite image.
Badge - Text Facultatif

Titre du badge

Remarque:Vous devez indiquer du texte ou une image pour le badge.

Texte libre

Taille de texte recommandée: 15 caractères maximum
Badge – Image Facultatif

Petite image

Traitement UX spécial, par exemple sous la forme d'un badge superposé à la vignette de l'image/vidéo.

Remarque:Vous devez indiquer du texte ou une image pour le badge.

Consultez la section Caractéristiques des images pour en savoir plus.
Prix - CurrentPrice Obligatoire sous certaines conditions

Prix actuel du billet/de la carte pour l'événement.

À fournir si le prix barré est indiqué.

Texte libre
Prix - StrikethroughPrice Facultatif Prix d'origine du billet/de la carte pour l'événement. Texte libre
Accroche sur le prix Facultatif Accroche de prix pour mettre en avant une promotion, un événement ou une remise réservée aux membres, le cas échéant.

Texte libre

Taille de texte recommandée: 45 caractères maximum (si le texte est trop long, des points de suspension peuvent s'afficher)
Catégories de contenu Facultatif Décrit la catégorie du contenu de l'entité.

Liste des énumérations éligibles

  • TYPE_MOVIES_AND_TV_SHOWS (Exemple : cinéma)
  • TYPE_DIGITAL_GAMES (exemple : e-sport)
  • TYPE_MUSIC (Exemple : concert)
  • TYPE_TRAVEL_AND_LOCAL (par exemple : visite, festival)
  • TYPE_HEALTH_AND_FITENESS (exemple : cours de yoga)
  • TYPE_EDUCATION (exemple : cours)
  • TYPE_SPORTS (exemple : match de football)
  • TYPE_DATING (Exemple : rencontre)

Pour obtenir des conseils, consultez la section Catégorie de contenu.

LodgingEntity

Attribut Obligatoire ? Description Format
URI d'action Obligatoire

Lien profond vers l'entité dans l'application pour les fournisseurs.

Remarque : Vous pouvez utiliser des liens profonds pour l'attribution. Consultez ces questions fréquentes.

URI
Titre Obligatoire Titre de l'entité.

Chaîne

Taille de texte recommandée: 50 caractères maximum
Images poster Obligatoire

Nous n'affichons qu'une seule image lorsque plusieurs images sont fournies. Format recommandé : 16:9

Remarque:Si un badge est fourni, assurez-vous d'inclure une zone de sécurité de 24 dps en haut et en bas de l'image.

Consultez la section Caractéristiques des images pour en savoir plus.
Emplacement : pays Obligatoire Pays dans lequel l'hébergement est proposé.

Texte libre

Taille de texte recommandée: 20 caractères maximum
Lieu (ville) Obligatoire Ville dans laquelle l'hébergement est proposé.

Texte libre

Taille de texte recommandée: 20 caractères maximum
Emplacement : adresse à afficher Obligatoire Adresse de l'hébergement qui s'affichera pour l'utilisateur.

Texte libre

Taille de texte recommandée: 20 caractères maximum
Lieu : adresse postale Facultatif Adresse postale (le cas échéant) de l'hébergement.

Texte libre

Taille de texte recommandée: 20 caractères maximum
Emplacement – État Facultatif État ou province (le cas échéant) dans lequel se trouve l'hébergement.

Texte libre

Taille de texte recommandée: 20 caractères maximum
Lieu : code postal Facultatif Code postal (le cas échéant) de l'hébergement.

Texte libre

Taille de texte recommandée: 20 caractères maximum
Emplacement : quartier Facultatif Quartier (le cas échéant) de l'hébergement

Texte libre

Taille de texte recommandée: 20 caractères maximum
Badges Facultatif

Chaque badge est composé de texte libre (15 caractères maximum) ou d'une petite image.
Badge - Text Facultatif

Titre du badge

Remarque:Vous devez indiquer du texte ou une image pour le badge.

Texte libre

Taille de texte recommandée: 15 caractères maximum
Badge – Image Facultatif

Petite image

Traitement UX spécial, par exemple sous la forme d'un badge superposé à la vignette de l'image/vidéo.

Remarque:Vous devez indiquer du texte ou une image pour le badge.

Consultez la section Caractéristiques des images pour en savoir plus.
Description Facultatif

Un seul paragraphe de texte pour décrire l'entité.

Remarque:L'utilisateur ne verra que la description ou la liste des sous-titres, et non les deux.

Texte libre

Taille de texte recommandée: 180 caractères
Liste des sous-titres Facultatif

Jusqu'à trois sous-titres, chacun ne comportant qu'une seule ligne de texte.

Remarque:L'utilisateur ne verra que la description ou la liste des sous-titres, et non les deux.

Texte libre

Taille de texte recommandée pour chaque sous-titre: 50 caractères maximum
AvailabilityTimeWindow - Localized Start Time - Timestamp Facultatif Code temporel de l'époque à laquelle l'hébergement devrait être ouvert/disponible. Joda-Time Instant
AvailabilityTimeWindow - Localized Start Time - Timezone Facultatif Fuseau horaire dans lequel l'hébergement devrait être ouvert/disponible. Joda-Time DateTimeZone
AvailabilityTimeWindow - Localized End Time - Timestamp Facultatif Code temporel de l'ère jusqu'auquel l'hébergement devrait être ouvert/disponible. Joda-Time Instant
AvailabilityTimeWindow - Localized End Time - Timezone Facultatif Fuseau horaire dans lequel l'hébergement devrait être ouvert/disponible. Joda-Time DateTimeZone
Note (valeur maximale) Facultatif

Valeur maximale de l'échelle d'évaluation.

À fournir si la valeur de la note actuelle est également indiquée.

 Nombre >= 0.0
Note (valeur actuelle) Facultatif

Valeur actuelle de l'échelle d'évaluation.

À fournir si la valeur maximale de la note est également indiquée.

 Nombre >= 0.0
Nombre de notes Facultatif

Nombre de notes attribuées à l'hébergement.

Remarque:Indiquez ce champ si votre application souhaite contrôler la façon dont elle est affichée aux utilisateurs. Fournissez la chaîne concise qui peut être affichée pour l'utilisateur. Par exemple, si le nombre est de 1 000 000, envisagez d'utiliser des abréviations telles que 1 M afin qu'il ne soit pas tronqué sur les tailles d'écran plus petites.

 Chaîne
Note (valeur de la fréquence) Facultatif

Nombre de notes attribuées à l'hébergement.

Remarque:Fournissez ce champ si vous ne souhaitez pas gérer vous-même la logique d'affichage des abréviations. Si les valeurs "Nombre" et "Valeur du nombre" sont présentes, nous utiliserons le nombre pour l'afficher aux utilisateurs.

 Longue
Prix - CurrentPrice Obligatoire sous certaines conditions

Prix actuel de l'hébergement.

À fournir si le prix barré est indiqué.

Texte libre
Prix - StrikethroughPrice Facultatif Prix d'origine de l'hébergement, qui sera barré dans l'UI. Texte libre
Accroche sur le prix Facultatif Accroche de prix pour mettre en avant une promotion, un événement ou une remise réservée aux membres, le cas échéant.

Texte libre

Taille de texte recommandée: 45 caractères maximum (si le texte est trop long, des points de suspension peuvent s'afficher)

StoreEntity

L'objet StoreEntity représente un magasin individuel que les développeurs partenaires souhaitent publier, comme un restaurant ou un établissement de restauration populaire pertinent pour l'expérience de voyage.

Attribut Obligatoire ? Description Format
Images poster Obligatoire Vous devez fournir au moins une image. Consultez la section Caractéristiques des images pour en savoir plus.
URI d'action Obligatoire

Lien profond vers l'entité dans l'application pour les fournisseurs.

Remarque : Vous pouvez utiliser des liens profonds pour l'attribution. Consultez ces questions fréquentes.

URI
Titre Facultatif Nom du magasin.

Texte libre

Taille de texte recommandée : 45 caractères maximum (si le texte est trop long, des points de suspension peuvent s'afficher)
Position Facultatif Emplacement du magasin.

Texte libre

Taille de texte recommandée : 45 caractères maximum (si le texte est trop long, des points de suspension peuvent s'afficher)
Accroche Facultatif Accroche qui met en avant une promotion, un événement ou une nouveauté pour le magasin, le cas échéant.

Texte libre

Taille de texte recommandée : 45 caractères maximum (si le texte est trop long, des points de suspension peuvent s'afficher)
Texte en petits caractères de l'accroche Facultatif Texte en petits caractères pour l'accroche.

Texte libre

Taille de texte recommandée : 45 caractères maximum (si le texte est trop long, des points de suspension peuvent s'afficher)
Description Facultatif Description du magasin.

Texte libre

Taille de texte recommandée : 90 caractères maximum (si le texte est trop long, des points de suspension peuvent s'afficher)
Catégorie Facultatif

Catégorie d'un magasin. Dans le contexte des établissements de restauration, il peut s'agir de la cuisine, par exemple "française", "nouvelle cuisine américaine", "ramen" ou "gastronomique".

Texte libre

Taille de texte recommandée : 45 caractères maximum (si le texte est trop long, des points de suspension peuvent s'afficher)
Note (valeur maximale) Facultatif

Valeur maximale de l'échelle d'évaluation.

À fournir si la valeur de la note actuelle est également indiquée.

 Nombre >= 0.0
Note (valeur actuelle) Facultatif

Valeur actuelle de l'échelle d'évaluation.

À fournir si la valeur maximale de la note est également indiquée.

 Nombre >= 0.0
Nombre de notes Facultatif

Nombre de notes attribuées à l'hébergement.

Remarque:Indiquez ce champ si votre application souhaite contrôler la façon dont elle est affichée aux utilisateurs. Fournissez la chaîne concise qui peut être affichée pour l'utilisateur. Par exemple, si le nombre est de 1 000 000, envisagez d'utiliser des abréviations telles que 1 M afin qu'il ne soit pas tronqué sur les tailles d'écran plus petites.

 Chaîne
Note (valeur de la fréquence) Facultatif

Nombre de notes attribuées à l'hébergement.

Remarque:Fournissez ce champ si vous ne souhaitez pas gérer vous-même la logique d'affichage des abréviations. Si les valeurs "Nombre" et "Valeur du nombre" sont présentes, nous utiliserons le nombre pour l'afficher aux utilisateurs.

 Longue

PointOfInterestEntity

Attribut Obligatoire ? Description Format
URI d'action Obligatoire

Lien profond vers l'entité dans l'application pour les fournisseurs.

Remarque : Vous pouvez utiliser des liens profonds pour l'attribution. Consultez ces questions fréquentes.

URI
Titre Obligatoire Titre de l'entité.

Chaîne

Taille de texte recommandée: 50 caractères maximum
Images poster Obligatoire

Nous n'affichons qu'une seule image lorsque plusieurs images sont fournies. Format recommandé : 16:9

Remarque:Nous vous recommandons vivement d'ajouter une image. Si un badge est fourni, assurez-vous d'un espace de sécurité de 24 dps en haut et en bas de l'image.

 Consultez la section Caractéristiques des images pour en savoir plus.
Emplacement : pays Obligatoire Pays dans lequel se trouve le point d'intérêt.

Texte libre

Taille de texte recommandée: 20 caractères maximum
Lieu (ville) Obligatoire Ville où se trouve le point d'intérêt.

Texte libre

Taille de texte recommandée: 20 caractères maximum
Emplacement : adresse à afficher Obligatoire Adresse du point d'intérêt qui s'affichera pour l'utilisateur.

Texte libre

Taille de texte recommandée: 20 caractères maximum
Lieu : adresse postale Facultatif Adresse postale (le cas échéant) du point d'intérêt.

Texte libre

Taille de texte recommandée: 20 caractères maximum
Emplacement – État Facultatif État ou province (le cas échéant) dans lequel se trouve le point d'intérêt.

Texte libre

Taille de texte recommandée: 20 caractères maximum
Lieu : code postal Facultatif Code postal (le cas échéant) du point d'intérêt.

Texte libre

Taille de texte recommandée: 20 caractères maximum
Emplacement : quartier Facultatif Quartier (le cas échéant) du point d'intérêt.

Texte libre

Taille de texte recommandée: 20 caractères maximum
AvailabilityTimeWindow - Localized Start Time - Timestamp Facultatif Code temporel de l'époque où le point d'intérêt devrait être ouvert/disponible. Joda-Time Instant
AvailabilityTimeWindow - Localized Start Time - Timezone Facultatif Fuseau horaire dans lequel le point d'intérêt devrait être ouvert/disponible. Joda-Time DateTimeZone
AvailabilityTimeWindow - Localized End Time - Timestamp Facultatif Code temporel d'époque jusqu'auquel le point d'intérêt devrait être ouvert/disponible. Joda-Time Instant
AvailabilityTimeWindow - Localized End Time - Timezone Facultatif Fuseau horaire dans lequel le point d'intérêt devrait être ouvert/disponible. Joda-Time DateTimeZone
Badges Facultatif

Chaque badge est composé de texte libre (15 caractères maximum) ou d'une petite image.
Badge - Text Facultatif

Titre du badge

Remarque:Vous devez indiquer du texte ou une image pour le badge.

Texte libre

Taille de texte recommandée: 15 caractères maximum
Badge – Image Facultatif

Petite image

Traitement UX spécial, par exemple sous la forme d'un badge superposé à la vignette de l'image/vidéo.

Remarque:Vous devez indiquer du texte ou une image pour le badge.

Consultez la section Caractéristiques des images pour en savoir plus.
Description Facultatif

Un seul paragraphe de texte pour décrire l'entité.

Remarque:L'utilisateur ne verra que la description ou la liste des sous-titres, et non les deux.

Texte libre

Taille de texte recommandée: 180 caractères
Liste des sous-titres Facultatif

Jusqu'à trois sous-titres, chacun ne comportant qu'une seule ligne de texte.

Remarque:L'utilisateur ne verra que la description ou la liste des sous-titres, et non les deux.

Texte libre

Taille de texte recommandée pour chaque sous-titre: 50 caractères maximum
Note (valeur maximale) Facultatif

Valeur maximale de l'échelle d'évaluation.

À fournir si la valeur de la note actuelle est également indiquée.

 Nombre >= 0.0
Note (valeur actuelle) Facultatif

Valeur actuelle de l'échelle d'évaluation.

À fournir si la valeur maximale de la note est également indiquée.

 Nombre >= 0.0
Nombre de notes Facultatif

Nombre de notes pour le point d'intérêt.

Remarque:Indiquez ce champ si votre application souhaite contrôler la façon dont elle est affichée aux utilisateurs. Fournissez la chaîne concise qui peut être affichée pour l'utilisateur. Par exemple, si le nombre est de 1 000 000, envisagez d'utiliser des abréviations telles que 1 M afin qu'il ne soit pas tronqué sur les tailles d'écran plus petites.

 Chaîne
Note (valeur de la fréquence) Facultatif

Nombre de notes pour le point d'intérêt.

Remarque:Fournissez ce champ si vous ne souhaitez pas gérer vous-même la logique d'affichage des abréviations. Si les valeurs "Nombre" et "Valeur du nombre" sont présentes, nous utiliserons le nombre pour l'afficher aux utilisateurs.

 Longue
Prix - CurrentPrice Obligatoire sous certaines conditions

Prix actuel des billets/cartes d'accès au point d'intérêt.

À fournir si le prix barré est indiqué.

Texte libre
Prix - StrikethroughPrice Facultatif Prix d'origine des billets/cartes d'accès au point d'intérêt. Texte libre
Accroche sur le prix Facultatif Accroche de prix pour mettre en avant une promotion, un événement ou une remise réservée aux membres, le cas échéant.

Texte libre

Taille de texte recommandée: 45 caractères maximum (si le texte est trop long, des points de suspension peuvent s'afficher)

Catégories de contenu Facultatif Décrit la catégorie du contenu de l'entité.

Liste des énumérations éligibles

  • TYPE_TRAVEL_AND_LOCAL
  • TYPE_MOVIES_AND_TV_SHOWS (par exemple, cinéma)
  • TYPE_MEDICAL (exemple : hôpital)
  • TYPE_EDUCATION (exemple : école)
  • TYPE_SPORTS (exemple : stade)

Pour obtenir des conseils, consultez la section Catégorie de contenu.

RestaurantReservationEntity

Attribut Obligatoire ? Description Format
URI d'action Obligatoire

Lien profond vers l'entité dans l'application pour les fournisseurs.

Remarque : Vous pouvez utiliser des liens profonds pour l'attribution. Consultez ces questions fréquentes.

URI
Titre Obligatoire Titre de l'entité.

Chaîne

Taille de texte recommandée: 50 caractères maximum
Heure de début de la réservation localisée – Code temporel Obligatoire Code temporel d'époque correspondant au début prévu de la réservation. Joda-Time Instant
Heure de début de la réservation localisée - Fuseau horaire Obligatoire Fuseau horaire dans lequel la réservation doit commencer. Joda-Time DateTimeZone
Emplacement : pays Obligatoire Pays dans lequel se trouve le restaurant.

Texte libre

Taille de texte recommandée: 20 caractères maximum
Lieu (ville) Obligatoire Ville dans laquelle se trouve le restaurant.

Texte libre

Taille de texte recommandée: 20 caractères maximum
Emplacement : adresse à afficher Obligatoire Adresse du restaurant qui s'affichera auprès de l'utilisateur.

Texte libre

Taille de texte recommandée: 20 caractères maximum
Lieu : adresse postale Facultatif Adresse postale (le cas échéant) du restaurant.

Texte libre

Taille de texte recommandée: 20 caractères maximum
Emplacement – État Facultatif État ou province (le cas échéant) dans lequel se trouve le restaurant.

Texte libre

Taille de texte recommandée: 20 caractères maximum
Lieu : code postal Facultatif Code postal (le cas échéant) du restaurant.

Texte libre

Taille de texte recommandée: 20 caractères maximum
Emplacement : quartier Facultatif Quartier (le cas échéant) du restaurant.

Texte libre

Taille de texte recommandée: 20 caractères maximum
Images poster Facultatif Nous n'affichons qu'une seule image lorsque plusieurs images sont fournies. Format recommandé : 16:9 Consultez la section Caractéristiques des images pour en savoir plus.
Description Facultatif

Un seul paragraphe de texte pour décrire l'entité.

Remarque:L'utilisateur ne verra que la description ou la liste des sous-titres, et non les deux.

Texte libre

Taille de texte recommandée: 180 caractères
Liste des sous-titres Facultatif

Jusqu'à trois sous-titres, chacun ne comportant qu'une seule ligne de texte.

Remarque:L'utilisateur ne verra que la description ou la liste des sous-titres, et non les deux.

Texte libre

Taille de texte recommandée pour chaque sous-titre: 50 caractères maximum
Taille de la table Facultatif Nombre de personnes dans le groupe de réservation Entier > 0

EventReservationEntity

Attribut Obligatoire ? Description Format
URI d'action Obligatoire

Lien profond vers l'entité dans l'application pour les fournisseurs.

Remarque : Vous pouvez utiliser des liens profonds pour l'attribution. Consultez ces questions fréquentes.

URI
Titre Obligatoire Titre de l'entité.

Chaîne

Taille de texte recommandée: 50 caractères maximum
Heure de début localisée - Code temporel Obligatoire

Code temporel de l'événement au moment prévu de son début.

 Joda-Time Instant
Heure de début localisée - Fuseau horaire Obligatoire

Fuseau horaire dans lequel l'événement doit commencer.

 Joda-Time DateTimeZone
Mode événement Obligatoire

Champ permettant d'indiquer si l'événement aura lieu en présentiel, à distance ou les deux.

 Enum: VIRTUAL, IN_PERSON ou HYBRID
Emplacement : pays Obligatoire sous certaines conditions

Pays dans lequel se déroule l'événement.

Remarque:Ce champ est obligatoire pour les événements de type IN_PERSON ou HYBRID.

Texte libre

Taille de texte recommandée: 20 caractères maximum
Lieu (ville) Obligatoire sous certaines conditions

Ville où se déroule l'événement.

Remarque:Ce champ est obligatoire pour les événements de type IN_PERSON ou HYBRID.

Texte libre

Taille de texte recommandée: 20 caractères maximum
Emplacement : adresse à afficher Obligatoire sous certaines conditions

Adresse ou nom du lieu où se déroulera l'événement à afficher pour l'utilisateur.

Remarque:Ce champ est obligatoire pour les événements de type IN_PERSON ou HYBRID.

Texte libre

Taille de texte recommandée: 20 caractères maximum
Lieu : adresse postale Facultatif Adresse (le cas échéant) du lieu où se déroule l'événement.

Texte libre

Taille de texte recommandée: 20 caractères maximum
Emplacement – État Facultatif État ou province (le cas échéant) dans lequel l'événement est organisé.

Texte libre

Taille de texte recommandée: 20 caractères maximum
Lieu : code postal Facultatif Code postal (le cas échéant) du lieu où se déroule l'événement.

Texte libre

Taille de texte recommandée: 20 caractères maximum
Emplacement : quartier Facultatif Quartier (le cas échéant) dans lequel l'événement se déroule.

Texte libre

Taille de texte recommandée: 20 caractères maximum
Images poster Facultatif

Nous n'affichons qu'une seule image lorsque plusieurs images sont fournies. Format recommandé : 16:9

Remarque:Nous vous recommandons vivement d'ajouter une image. Si un badge est fourni, assurez-vous de laisser un espace de sécurité de 24 dps en haut et en bas de l'image.

 Consultez la section Caractéristiques des images pour en savoir plus.
Heure de fin localisée - Code temporel Facultatif

Code temporel de l'événement à la date initiale de référence du système d'exploitation.

 Joda-Time Instant
Heure de fin localisée - Fuseau horaire Facultatif

Fuseau horaire dans lequel l'événement devrait se terminer.

 Joda-Time DateTimeZone
Fournisseur de services - Nom Facultatif

Nom du fournisseur de services.

Remarque:Vous devez indiquer du texte ou une image pour le fournisseur de services.

Texte libre. (par exemple, le nom de l'organisateur de l'événement/de la visite)
Fournisseur de services : image Facultatif

Logo/Image du fournisseur de services.

Remarque:Vous devez indiquer du texte ou une image pour le fournisseur de services.

Consultez la section Caractéristiques des images pour en savoir plus.
Description Facultatif

Un seul paragraphe de texte pour décrire l'entité.

Remarque:L'utilisateur ne verra que la description ou la liste des sous-titres, et non les deux.

Texte libre

Taille de texte recommandée: 180 caractères
Liste des sous-titres Facultatif

Jusqu'à trois sous-titres, chacun ne comportant qu'une seule ligne de texte.

Remarque:L'utilisateur ne verra que la description ou la liste des sous-titres, et non les deux.

Texte libre

Taille de texte recommandée pour chaque sous-titre: 50 caractères maximum
Badges Facultatif

Chaque badge est composé de texte libre (15 caractères maximum) ou d'une petite image.
Badge - Text Facultatif

Titre du badge

Remarque:Vous devez indiquer du texte ou une image pour le badge.

Texte libre

Taille de texte recommandée: 15 caractères maximum
Badge – Image Facultatif

Petite image

Traitement UX spécial, par exemple sous la forme d'un badge superposé à la vignette de l'image/vidéo.

Remarque:Vous devez indiquer du texte ou une image pour le badge.

Consultez la section Caractéristiques des images pour en savoir plus.
ID de réservation Facultatif ID de la réservation de l'événement. Texte libre
Prix - CurrentPrice Obligatoire sous certaines conditions

Prix actuel du billet/de la carte pour l'événement.

À fournir si le prix barré est indiqué.

Texte libre
Prix - StrikethroughPrice Facultatif Prix d'origine du billet/de la carte pour l'événement. Texte libre
Accroche sur le prix Facultatif Accroche de prix pour mettre en avant une promotion, un événement ou une remise réservée aux membres, le cas échéant.

Texte libre

Taille de texte recommandée: 45 caractères maximum (si le texte est trop long, des points de suspension peuvent s'afficher)
Note (valeur maximale) Facultatif

Valeur maximale de l'échelle d'évaluation.

À fournir si la valeur de la note actuelle est également indiquée.

 Nombre >= 0.0
Note (valeur actuelle) Facultatif

Valeur actuelle de l'échelle d'évaluation.

À fournir si la valeur maximale de la note est également indiquée.

 Nombre >= 0.0
Nombre de notes Facultatif

Nombre de notes pour l'événement.

Remarque:Indiquez ce champ si votre application souhaite contrôler la façon dont elle est affichée aux utilisateurs. Fournissez la chaîne concise qui peut être affichée pour l'utilisateur. Par exemple, si le nombre est de 1 000 000, envisagez d'utiliser des abréviations telles que 1 M afin qu'il ne soit pas tronqué sur les tailles d'écran plus petites.

 Chaîne
Note (valeur de la fréquence) Facultatif

Nombre de notes pour l'événement.

Remarque:Fournissez ce champ si vous ne souhaitez pas gérer vous-même la logique d'affichage des abréviations. Si les valeurs "Nombre" et "Valeur du nombre" sont présentes, nous utiliserons le nombre pour l'afficher aux utilisateurs.

 Longue
Catégories de contenu Facultatif Décrit la catégorie du contenu de l'entité.

Liste des énumérations éligibles

  • TYPE_MOVIES_AND_TV_SHOWS (Exemple : cinéma)
  • TYPE_DIGITAL_GAMES (exemple : e-sport)
  • TYPE_MUSIC (Exemple : concert)
  • TYPE_TRAVEL_AND_LOCAL (par exemple : visite, festival)
  • TYPE_HEALTH_AND_FITENESS (exemple : cours de yoga)
  • TYPE_EDUCATION (exemple : cours)
  • TYPE_SPORTS (exemple : match de football)
  • TYPE_DATING (Exemple : rencontre)

Pour obtenir des conseils, consultez la section Catégorie de contenu.

LodgingReservationEntity

Attribut Obligatoire ? Description Format
URI d'action Obligatoire

Lien profond vers l'entité dans l'application pour les fournisseurs.

Remarque : Vous pouvez utiliser des liens profonds pour l'attribution. Consultez ces questions fréquentes.

URI
Titre Obligatoire Titre de l'entité.

Texte libre. (par exemple, "Votre séjour du 12 décembre")

Taille de texte recommandée: 50 caractères maximum
Heure d'arrivée localisée – Code temporel Obligatoire Code temporel d'epoch représentant l'heure d'arrivée de la réservation. Joda-Time Instant
Heure de check-in localisée – Fuseau horaire Obligatoire Fuseau horaire de l'heure d'arrivée de la réservation. Joda-Time Instant
Heure de départ localisée – Code temporel Obligatoire Code temporel d'époque représentant l'heure de départ de la réservation. Joda-Time Instant
Heure de départ localisée – Fuseau horaire Obligatoire Fuseau horaire dans lequel l'heure de départ de la réservation est définie. Joda-Time DateTimeZone
Emplacement : pays Obligatoire Pays dans lequel se trouve l'hébergement.

Texte libre

Taille de texte recommandée: 20 caractères maximum
Lieu (ville) Obligatoire Ville dans laquelle se trouve l'hébergement.

Texte libre

Taille de texte recommandée: 20 caractères maximum
Emplacement : adresse à afficher Obligatoire Adresse de l'hébergement qui s'affichera pour l'utilisateur.

Texte libre

Taille de texte recommandée: 20 caractères maximum
Lieu : adresse postale Facultatif Adresse postale (le cas échéant) de l'hébergement.

Texte libre

Taille de texte recommandée: 20 caractères maximum
Emplacement – État Facultatif État ou province (le cas échéant) dans lequel se trouve l'hébergement.

Texte libre

Taille de texte recommandée: 20 caractères maximum
Lieu : code postal Facultatif Code postal (le cas échéant) de l'hébergement.

Texte libre

Taille de texte recommandée: 20 caractères maximum
Emplacement : quartier Facultatif Quartier (le cas échéant) de l'hébergement

Texte libre

Taille de texte recommandée: 20 caractères maximum
Images poster Facultatif

Nous n'affichons qu'une seule image lorsque plusieurs images sont fournies. Format recommandé : 16:9

Remarque:Si un badge est fourni, assurez-vous d'inclure une zone de sécurité de 24 dps en haut et en bas de l'image.

Consultez la section Caractéristiques des images pour en savoir plus.
Description Facultatif

Un seul paragraphe de texte pour décrire l'entité.

Remarque:L'utilisateur ne verra que la description ou la liste des sous-titres, et non les deux.

Texte libre

Taille de texte recommandée: 180 caractères
Liste des sous-titres Facultatif

Jusqu'à trois sous-titres, chacun ne comportant qu'une seule ligne de texte.

Remarque:L'utilisateur ne verra que la description ou la liste des sous-titres, et non les deux.

Texte libre

Taille de texte recommandée pour chaque sous-titre: 50 caractères maximum
ID de réservation Facultatif ID de la réservation d'hébergement. Texte libre
Note (valeur maximale) Facultatif

Valeur maximale de l'échelle d'évaluation.

À fournir si la valeur de la note actuelle est également indiquée.

 Nombre >= 0.0
Note (valeur actuelle) Facultatif

Valeur actuelle de l'échelle d'évaluation.

À fournir si la valeur maximale de la note est également indiquée.

 Nombre >= 0.0
Nombre de notes Facultatif

Nombre de notes attribuées à l'hébergement.

Remarque:Indiquez ce champ si votre application souhaite contrôler la façon dont elle est affichée aux utilisateurs. Fournissez la chaîne concise qui peut être affichée pour l'utilisateur. Par exemple, si le nombre est de 1 000 000, envisagez d'utiliser des abréviations telles que 1 M afin qu'il ne soit pas tronqué sur les tailles d'écran plus petites.

 Chaîne
Note (valeur de la fréquence) Facultatif

Nombre de notes attribuées à l'hébergement.

Remarque:Fournissez ce champ si vous ne souhaitez pas gérer vous-même la logique d'affichage des abréviations. Si les valeurs "Nombre" et "Valeur du nombre" sont présentes, nous utiliserons le nombre pour l'afficher aux utilisateurs.

 Longue
Prix - CurrentPrice Obligatoire sous certaines conditions

Prix actuel de l'hébergement.

À fournir si le prix barré est indiqué.

Texte libre
Prix - StrikethroughPrice Facultatif Prix d'origine de l'hébergement, qui sera barré dans l'UI. Texte libre
Accroche sur le prix Facultatif Accroche de prix pour mettre en avant une promotion, un événement ou une remise réservée aux membres, le cas échéant.

Texte libre

Taille de texte recommandée: 45 caractères maximum (si le texte est trop long, des points de suspension peuvent s'afficher)

TransportationReservationEntity

Attribut Obligatoire ? Description Format
URI d'action Obligatoire

Lien profond vers l'entité dans l'application pour les fournisseurs.

Remarque : Vous pouvez utiliser des liens profonds pour l'attribution. Consultez ces questions fréquentes.

URI
Titre Obligatoire Titre de l'entité.

Texte libre. (par exemple, "SFO à SAN")

Taille de texte recommandée: 50 caractères maximum
Type de transport Obligatoire Mode/Type de transport de la réservation. Énumération: FLIGHT, TRAIN, BUS ou FERRY
Heure de départ localisée – Code temporel Obligatoire Code temporel d'époque représentant l'heure de départ. Joda-Time Instant
Heure de départ localisée – Fuseau horaire Obligatoire Fuseau horaire de l'heure de départ. Joda-Time DateTimeZone
Heure d'arrivée localisée – Code temporel Obligatoire Code temporel d'époque représentant l'heure d'arrivée. Joda-Time Instant
Heure d'arrivée localisée – Fuseau horaire Obligatoire Fuseau horaire de l'heure d'arrivée. Joda-Time DateTimeZone
Numéro de transport Obligatoire Numéro du vol, du bus, du train ou du ferry/croisière. Texte libre
Heure d'embarquement localisée – Code temporel Obligatoire Code temporel d'époque représentant l'heure d'embarquement de la réservation (le cas échéant) Joda-Time Instant
Heure d'embarquement localisée – Fuseau horaire Obligatoire Fuseau horaire de l'heure d'embarquement de la réservation (le cas échéant) Joda-Time DateTimeZone
Lieu de départ (pays) Facultatif Pays de départ.

Texte libre

Taille de texte recommandée: 20 caractères maximum
Lieu de départ (ville) Facultatif Ville de départ.

Texte libre

Taille de texte recommandée: 20 caractères maximum
Lieu de départ – Adresse à afficher Facultatif Lieu de départ à afficher pour l'utilisateur.

Texte libre

Taille de texte recommandée: 20 caractères maximum
Lieu de départ : adresse postale Facultatif Adresse postale (le cas échéant) du lieu de départ.

Texte libre

Taille de texte recommandée: 20 caractères maximum
Lieu de départ (État) Facultatif État ou province (le cas échéant) du lieu de départ.

Texte libre

Taille de texte recommandée: 20 caractères maximum
Lieu de départ (code postal) Facultatif Code postal (le cas échéant) du lieu de départ.

Texte libre

Taille de texte recommandée: 20 caractères maximum
Lieu de départ : quartier Facultatif Quartier (le cas échéant) du point de départ

Texte libre

Taille de texte recommandée: 20 caractères maximum
Lieu d'arrivée (pays) Facultatif Pays d'arrivée.

Texte libre

Taille de texte recommandée: 20 caractères maximum
Lieu d'arrivée (ville) Facultatif Ville d'arrivée.

Texte libre

Taille de texte recommandée: 20 caractères maximum
Lieu d'arrivée : adresse à afficher Facultatif Lieu d'arrivée qui s'affichera auprès de l'utilisateur.

Texte libre

Taille de texte recommandée: 20 caractères maximum
Lieu d'arrivée : adresse Facultatif Adresse postale (le cas échéant) du lieu d'arrivée.

Texte libre

Taille de texte recommandée: 20 caractères maximum
Lieu d'arrivée (État) Facultatif État ou province (le cas échéant) de l'emplacement d'arrivée.

Texte libre

Taille de texte recommandée: 20 caractères maximum
Lieu d'arrivée : code postal Facultatif Code postal (le cas échéant) de l'emplacement de livraison.

Texte libre

Taille de texte recommandée: 20 caractères maximum
Lieu d'arrivée – Quartier Facultatif Quartier (le cas échéant) de l'emplacement d'arrivée.

Texte libre

Taille de texte recommandée: 20 caractères maximum
Fournisseur de services - Nom Facultatif

Nom du fournisseur de services.

Remarque:Vous devez indiquer du texte ou une image pour le fournisseur de services.

Texte libre. (par exemple, "Nom de la compagnie aérienne")
Fournisseur de services : image Facultatif

Logo/Image du fournisseur de services.

Remarque:Vous devez indiquer du texte ou une image pour le fournisseur de services.

Consultez la section Caractéristiques des images pour en savoir plus.
Images poster Facultatif

Nous n'affichons qu'une seule image lorsque plusieurs images sont fournies. Format recommandé : 16:9

Consultez la section Caractéristiques des images pour en savoir plus.
Description Facultatif

Un seul paragraphe de texte pour décrire l'entité.

Remarque:L'utilisateur ne verra que la description ou la liste des sous-titres, et non les deux.

Texte libre

Taille de texte recommandée: 180 caractères
Liste des sous-titres Facultatif

Jusqu'à trois sous-titres, chacun ne comportant qu'une seule ligne de texte.

Remarque:L'utilisateur ne verra que la description ou la liste des sous-titres, et non les deux.

Texte libre

Taille de texte recommandée pour chaque sous-titre: 50 caractères maximum
ID de réservation Facultatif ID de la réservation de transport. Texte libre
Prix - CurrentPrice Obligatoire sous certaines conditions

Prix actuel de la réservation.

À fournir si le prix barré est indiqué.

Texte libre
Prix - StrikethroughPrice Facultatif Prix d'origine de la réservation, qui sera barré dans l'UI. Texte libre
Accroche sur le prix Facultatif Accroche de prix pour mettre en avant une promotion, un événement ou une remise réservée aux membres, le cas échéant.

Texte libre

Taille de texte recommandée: 45 caractères maximum (si le texte est trop long, des points de suspension peuvent s'afficher)

VehicleRentalReservationEntity

Attribut Obligatoire ? Description Format
URI d'action Obligatoire

Lien profond vers l'entité dans l'application pour les fournisseurs.

Remarque : Vous pouvez utiliser des liens profonds pour l'attribution. Consultez ces questions fréquentes.

URI
Titre Obligatoire Titre de l'entité.

Texte libre. (par exemple, "Avis Union Square SF")

Taille de texte recommandée: 50 caractères maximum
Heure de retrait localisée – Code temporel Obligatoire Code temporel d'époque représentant l'heure de prise en charge de la réservation. Joda-Time Instant
Heure de retrait localisée – Fuseau horaire Obligatoire Fuseau horaire de l'heure de prise en charge de la réservation. Joda-Time DateTimeZone
Heure de retour localisée – Code temporel Facultatif Code temporel d'époque représentant l'heure de départ de la réservation. Joda-Time Instant
Heure de retour localisée - Fuseau horaire Facultatif Fuseau horaire de l'heure de départ de la réservation. Joda-Time DateTimeZone
Adresse de retrait - Pays Facultatif Pays du lieu de prise en charge.

Texte libre

Taille de texte recommandée: 20 caractères maximum
Adresse de retrait (ville) Facultatif Ville du lieu de prise en charge.

Texte libre

Taille de texte recommandée: 20 caractères maximum
Adresse de retrait – Adresse à afficher Facultatif Lieu de retrait qui s'affichera auprès de l'utilisateur.

Texte libre

Taille de texte recommandée: 20 caractères maximum
Adresse de retrait : adresse postale Facultatif Adresse postale (le cas échéant) du lieu de retrait.

Texte libre

Taille de texte recommandée: 20 caractères maximum
Adresse de retrait (État) Facultatif État ou province (le cas échéant) du lieu de prise en charge.

Texte libre

Taille de texte recommandée: 20 caractères maximum
Adresse de retrait (code postal) Facultatif Code postal (le cas échéant) du lieu de retrait.

Texte libre

Taille de texte recommandée: 20 caractères maximum
Adresse de retrait : quartier Facultatif Quartier (le cas échéant) du lieu de retrait.

Texte libre

Taille de texte recommandée: 20 caractères maximum
Adresse de retour (pays) Facultatif Pays de l'emplacement de retour.

Texte libre

Taille de texte recommandée: 20 caractères maximum
Adresse de retour (ville) Facultatif Ville de l'adresse de retour.

Texte libre

Taille de texte recommandée: 20 caractères maximum
Adresse de retour : adresse à afficher Facultatif Emplacement de retour qui s'affichera auprès de l'utilisateur.

Texte libre

Taille de texte recommandée: 20 caractères maximum
Adresse de retour : adresse postale Facultatif Adresse postale (le cas échéant) du lieu de retour.

Texte libre

Taille de texte recommandée: 20 caractères maximum
Adresse de retour (État) Facultatif État ou province (le cas échéant) du lieu de retour.

Texte libre

Taille de texte recommandée: 20 caractères maximum
Adresse de retour (code postal) Facultatif Code postal (le cas échéant) du lieu de retour.

Texte libre

Taille de texte recommandée: 20 caractères maximum
Adresse de retour : quartier Facultatif Quartier (le cas échéant) de l'emplacement de retour.

Texte libre

Taille de texte recommandée: 20 caractères maximum
Fournisseur de services - Nom Facultatif

Nom du fournisseur de services.

Remarque:Vous devez indiquer du texte ou une image pour le fournisseur de services.

Texte libre. (par exemple, "Avis Car Rental")
Fournisseur de services : image Facultatif

Logo/Image du fournisseur de services.

Remarque:Vous devez indiquer du texte ou une image pour le fournisseur de services.

Consultez la section Caractéristiques des images pour en savoir plus.
Images poster Facultatif

Nous n'affichons qu'une seule image lorsque plusieurs images sont fournies. Format recommandé : 16:9

Consultez la section Caractéristiques des images pour en savoir plus.
Description Facultatif

Un seul paragraphe de texte pour décrire l'entité.

Remarque:L'utilisateur ne verra que la description ou la liste des sous-titres, et non les deux.

Texte libre

Taille de texte recommandée: 180 caractères
Liste des sous-titres Facultatif

Jusqu'à trois sous-titres, chacun ne comportant qu'une seule ligne de texte.

Remarque:L'utilisateur ne verra que la description ou la liste des sous-titres, et non les deux.

Texte libre

Taille de texte recommandée pour chaque sous-titre: 50 caractères maximum
ID de confirmation Facultatif ID de confirmation de la réservation de location de véhicule. Texte libre
Prix - CurrentPrice Obligatoire sous certaines conditions

Prix actuel de la réservation.

À fournir si le prix barré est indiqué.

Texte libre
Prix - StrikethroughPrice Facultatif Prix d'origine de la réservation, qui sera barré dans l'UI. Texte libre
Accroche sur le prix Facultatif Accroche de prix pour mettre en avant une promotion, un événement ou une remise réservée aux membres, le cas échéant.

Texte libre

Taille de texte recommandée: 45 caractères maximum (si le texte est trop long, des points de suspension peuvent s'afficher)

Caractéristiques des images

Vous trouverez ci-dessous les spécifications requises pour les composants Image:

Format Nombre minimal de pixels Nombre de pixels recommandé

Carré (1x1)

Préféré

 300 x 300 1 200 x 1 200
Paysage (1,91 x 1) 600 x 314 1 200 x 628
Format portrait (4 x 5) 480 x 600 960 x 1200

Les images doivent être hébergées sur des CDN publics pour que Google puisse y accéder.

Formats des fichiers

PNG, JPG, GIF statique, WebP

Taille maximale des fichiers

5 120 Ko

Autres recommandations

  • Zone de sécurité de l'image : placez le contenu important dans les 80 % les plus au centre de l'image.
  • Utilisez un arrière-plan transparent pour que l'image s'affiche correctement avec les paramètres du thème sombre et clair.

Catégorie de contenu

La catégorie de contenu permet aux applications de publier du contenu appartenant à plusieurs catégories. Le contenu est alors mis en correspondance avec certaines des catégories prédéfinies, à savoir:

  • TYPE_EDUCATION
  • TYPE_SPORTS
  • TYPE_MOVIES_AND_TV_SHOWS
  • TYPE_BOOKS
  • TYPE_AUDIOBOOKS
  • TYPE_MUSIC
  • TYPE_DIGITAL_GAMES
  • TYPE_TRAVEL_AND_LOCAL
  • TYPE_HOME_AND_AUTO
  • TYPE_BUSINESS
  • TYPE_NEWS
  • TYPE_FOOD_AND_DRINK
  • TYPE_SHOPPING
  • TYPE_HEALTH_AND_FITENESS
  • TYPE_MEDICAL
  • TYPE_PARENTING
  • TYPE_DATING

Les images doivent être hébergées sur des CDN publics pour que Google puisse y accéder.

Consignes concernant l'utilisation des catégories de contenu

  1. Certaines entités, comme ArticleEntity et GenericFeaturedEntity, peuvent utiliser n'importe quelle catégorie de contenu. Pour d'autres entités telles que EventEntity, EventReservationEntity et PointOfInterestEntity, seul un sous-ensemble de ces catégories est éligible. Vérifiez la liste des catégories éligibles à un type d'entité avant de la renseigner.

  2. Utilisez le type d'entité spécifique pour certaines catégories de contenu plutôt qu'une combinaison des entités génériques et de ContentCategory:

    • TYPE_MOVIES_AND_TV_SHOWS : consultez les entités du guide d'intégration de Watch avant d'utiliser les entités génériques.
    • TYPE_BOOKS : consultez EbookEntity avant d'utiliser les entités génériques.
    • TYPE_AUDIOBOOKS : consultez AudiobookEntity avant d'utiliser les entités génériques.
    • TYPE_SHOPPING : consultez ShoppingEntity avant d'utiliser les entités génériques.
    • TYPE_FOOD_AND_DRINK : consultez les entités du guide d'intégration des aliments avant d'utiliser les entités génériques.

  3. Le champ "ContentCategory" est facultatif et doit être laissé vide si le contenu n'appartient à aucune des catégories mentionnées précédemment.

  4. Si vous fournissez plusieurs catégories de contenu, indiquez-les dans l'ordre de pertinence par rapport au contenu, en plaçant la catégorie de contenu la plus pertinente en premier dans la liste.

Étape 2 : Fournir les données de cluster

Il est recommandé d'exécuter la tâche de publication de contenu en arrière-plan (par exemple, à l'aide de WorkManager) et de la programmer régulièrement ou sur la base d'un événement précis (par exemple, chaque fois que l'utilisateur ouvre l'application ou lorsqu'il vient d'ajouter quelque chose à son panier).

AppEngageTravelClient permet la publication des clusters.

Les API suivantes permettent de publier des clusters dans le client :

  • isServiceAvailable
  • publishRecommendationClusters
  • publishFeaturedCluster
  • publishReservationCluster
  • publishContinueSearchCluster
  • publishUserAccountManagementRequest
  • updatePublishStatus
  • deleteRecommendationsClusters
  • deleteFeaturedCluster
  • deleteReservationCluster
  • deleteContinueSearchCluster
  • deleteUserManagementCluster
  • deleteClusters

isServiceAvailable

Cette API permet de vérifier si le service est disponible pour l'intégration et de déterminer si le contenu peut être présenté sur l'appareil.

Kotlin

client.isServiceAvailable.addOnCompleteListener { task ->
    if (task.isSuccessful) {
        // Handle IPC call success
        if(task.result) {
          // Service is available on the device, proceed with content publish
          // calls.
        } else {
          // Service is not available, no further action is needed.
        }
    } else {
      // The IPC call itself fails, proceed with error handling logic here,
      // such as retry.
    }
}

Java

client.isServiceAvailable().addOnCompleteListener(task - > {
    if (task.isSuccessful()) {
        // Handle success
        if(task.getResult()) {
          // Service is available on the device, proceed with content publish
          // calls.
        } else {
          // Service is not available, no further action is needed.
        }
    } else {
      // The IPC call itself fails, proceed with error handling logic here,
      // such as retry.
    }
});

publishRecommendationClusters

Cette API permet de publier une liste d'objets RecommendationCluster.

Kotlin

client.publishRecommendationClusters(
      PublishRecommendationClustersRequest.Builder()
        .addRecommendationCluster(
          RecommendationCluster.Builder()
            .addEntity(entity1)
            .addEntity(entity2)
            .setTitle("Top Picks For You")
            .build()
        )
        .build()
    )

Java

client.publishRecommendationClusters(
            new PublishRecommendationClustersRequest.Builder()
                .addRecommendationCluster(
                    new RecommendationCluster.Builder()
                        .addEntity(entity1)
                        .addEntity(entity2)
                        .setTitle("Top Picks For You")
                        .build())
                .build());

Lorsque le service reçoit la requête, les actions suivantes ont lieu dans une seule transaction :

  • Les données RecommendationCluster existantes du développeur partenaire sont supprimées.
  • Les données de la requête sont analysées et stockées dans le cluster "Recommendation" mis à jour.

En cas d'erreur, la requête entière est rejetée, et l'état existant est maintenu.

publishFeaturedCluster

Cette API permet de publier une liste d'objets FeaturedCluster.

Kotlin

client.publishFeaturedCluster(
    PublishFeaturedClusterRequest.Builder()
      .setFeaturedCluster(
        FeaturedCluster.Builder()
          .addEntity(entity1)
          .addEntity(entity2)
          .build())
      .build())

Java

client.publishFeaturedCluster(
            new PublishFeaturedClustersRequest.Builder()
                .addFeaturedCluster(
                    new FeaturedCluster.Builder()
                        .addEntity(entity1)
                        .addEntity(entity2)
                        .build())
                .build());

Lorsque le service reçoit la requête, les actions suivantes ont lieu dans une seule transaction :

  • Les données FeaturedCluster existantes du développeur partenaire sont supprimées.
  • Les données de la requête sont analysées et stockées dans le cluster "Featured" mis à jour.

En cas d'erreur, la requête entière est rejetée, et l'état existant est maintenu.

publishReservationCluster

Cette API permet de publier un objet ReservationCluster.

Kotlin

client.publishReservationCluster(
    PublishReservationClusterRequest.Builder()
      .setReservationCluster(
        ReservationCluster.Builder()
          .addLodgingReservationEntity(lodgingReservationEntity)
          .addVehicleRentalReservationEntity(vehicleRentalReservationEntity)
          .addTransportationReservationEntity(transportationReservationEntity)
          .addEventReservationEntity(eventReservationEntity)
          .addRestaurantReservationEntity(restaurantReservationEntity)
          .build())
      .build())

Java

client.publishReservationCluster(
            new PublishReservationClusterRequest.Builder()
                .setReservationCluster(
                    new ReservationCluster.Builder()
                        .addLodgingReservationEntity(lodgingReservationEntity)
                        .addVehicleRentalReservationEntity(vehicleRentalReservationEntity)
                        .addTransportationReservationEntity(transportationReservationEntity)
                        .addEventReservationEntity(eventReservationEntity)
                        .addRestaurantReservationEntity(restaurantReservationEntity)
                        .build())
                .build());

Lorsque le service reçoit la requête, les actions suivantes ont lieu dans une seule transaction :

  • Les données ReservationCluster existantes du développeur partenaire sont supprimées.
  • Les données de la requête sont analysées et stockées dans le cluster "Reservation" mis à jour.

En cas d'erreur, la requête entière est rejetée, et l'état existant est maintenu.

publishContinueSearchCluster

Cette API permet de publier une liste d'objets ContinueSearchCluster.

Kotlin

client.publishContinueSearchCluster(
    PublishContinueSearchClusterRequest.Builder()
      .setContinueSearchCluster(
        ContinueSearchCluster.Builder()
          .addPointOfInterestEntity(entity1)
          .addPointOfInterestEntity(entity2)
          .build())
      .build())

Java

client.publishContinueSearchCluster(
            new PublishContinueSearchClusterRequest.Builder()
                .setContinueSearchCluster(
                    new ContinueSearchCluster.Builder()
                        .addPointOfInterestEntity(entity1)
                        .addPointOfInterestEntity(entity2)
                        .build())
                .build());

Lorsque le service reçoit la requête, les actions suivantes ont lieu dans une seule transaction :

  • Les données ContinueSearchCluster existantes du développeur partenaire sont supprimées.
  • Les données de la requête sont analysées et stockées dans le cluster "Continue Search" mis à jour.

En cas d'erreur, la requête entière est rejetée, et l'état existant est maintenu.

publishUserAccountManagementRequest

Cette API permet de publier une fiche de connexion. L'action de connexion redirige les utilisateurs vers la page de connexion de l'application afin que celle-ci puisse publier du contenu (ou fournir un contenu plus personnalisé).

Les métadonnées suivantes font partie de la fiche de connexion :

Attribut Obligatoire ? Description
URI d'action Obligatoire Lien profond vers l'action (par exemple, accès à la page de connexion de l'application)
Image Facultatif : si aucun titre n'est fourni, vous devez en fournir un

Image affichée sur la fiche

Images au format 16:9 avec une résolution de 1 264 x 712
Titre Facultatif : si aucune image n'est fournie, vous devez en fournir une Titre sur la fiche
Texte de l'action Facultatif Texte affiché sur l'incitation à l'action (par exemple, "Se connecter")
Sous-titre Facultatif Sous-titre facultatif sur la fiche

Kotlin

var SIGN_IN_CARD_ENTITY =
      SignInCardEntity.Builder()
          .addPosterImage(
              Image.Builder()
                  .setImageUri(Uri.parse("http://www.x.com/image.png"))
                  .setImageHeightInPixel(500)
                  .setImageWidthInPixel(500)
                  .build())
          .setActionText("Sign In")
          .setActionUri(Uri.parse("http://xx.com/signin"))
          .build()

client.publishUserAccountManagementRequest(
            PublishUserAccountManagementRequest.Builder()
                .setSignInCardEntity(SIGN_IN_CARD_ENTITY)
                .build());

Java

SignInCardEntity SIGN_IN_CARD_ENTITY =
      new SignInCardEntity.Builder()
          .addPosterImage(
              new Image.Builder()
                  .setImageUri(Uri.parse("http://www.x.com/image.png"))
                  .setImageHeightInPixel(500)
                  .setImageWidthInPixel(500)
                  .build())
          .setActionText("Sign In")
          .setActionUri(Uri.parse("http://xx.com/signin"))
          .build();

client.publishUserAccountManagementRequest(
            new PublishUserAccountManagementRequest.Builder()
                .setSignInCardEntity(SIGN_IN_CARD_ENTITY)
                .build());

Lorsque le service reçoit la requête, les actions suivantes ont lieu dans une seule transaction :

  • Les données UserAccountManagementCluster existantes du développeur partenaire sont supprimées.
  • Les données de la requête sont analysées et stockées dans le cluster "UserAccountManagementCluster" mis à jour.

En cas d'erreur, la requête entière est rejetée, et l'état existant est maintenu.

updatePublishStatus

Si, pour une raison opérationnelle interne, aucun des clusters n'est publié, nous vous recommandons vivement de mettre à jour l'état de publication à l'aide de l'API updatePublishStatus. Ce point est important pour les raisons suivantes :

  • Il est essentiel d'indiquer l'état dans tous les scénarios, même lorsque le contenu est publié (STATUS == PUBLISHED) pour renseigner les tableaux de bord qui utilisent cet état explicite afin de transmettre l'état et d'autres métriques de votre intégration.
  • Si aucun contenu n'est publié, mais que l'état de l'intégration fonctionne correctement (STATUS == NOT_PUBLISHED), Google peut éviter de déclencher des alertes dans les tableaux de bord concernant l'état de l'application. Cela confirme que le contenu n'est pas publié en raison d'une situation attendue du point de vue du fournisseur.
  • Cela permet aux développeurs de fournir des informations concernant la date de publication des données.
  • Google peut utiliser les codes d'état pour encourager l'utilisateur à effectuer certaines actions dans l'application, afin qu'il puisse afficher ou contourner le contenu de l'application.

Voici la liste des codes d'état de publication éligibles :

// Content is published
AppEngagePublishStatusCode.PUBLISHED,

// Content is not published as user is not signed in
AppEngagePublishStatusCode.NOT_PUBLISHED_REQUIRES_SIGN_IN,

// Content is not published as user is not subscribed
AppEngagePublishStatusCode.NOT_PUBLISHED_REQUIRES_SUBSCRIPTION,

// Content is not published as user location is ineligible
AppEngagePublishStatusCode.NOT_PUBLISHED_INELIGIBLE_LOCATION,

// Content is not published as there is no eligible content
AppEngagePublishStatusCode.NOT_PUBLISHED_NO_ELIGIBLE_CONTENT,

// Content is not published as the feature is disabled by the client
// Available in v1.3.1
AppEngagePublishStatusCode.NOT_PUBLISHED_FEATURE_DISABLED_BY_CLIENT,

// Content is not published as the feature due to a client error
// Available in v1.3.1
AppEngagePublishStatusCode.NOT_PUBLISHED_CLIENT_ERROR,

// Content is not published as the feature due to a service error
// Available in v1.3.1
AppEngagePublishStatusCode.NOT_PUBLISHED_SERVICE_ERROR,

// Content is not published due to some other reason
// Reach out to engage-developers@ before using this enum.
AppEngagePublishStatusCode.NOT_PUBLISHED_OTHER

Si le contenu n'est pas publié parce que l'utilisateur n'est pas connecté, Google vous recommande de publier la fiche de connexion. Si, pour une raison quelconque, les fournisseurs ne peuvent pas publier la fiche de connexion, nous vous recommandons d'appeler l'API updatePublishStatus avec le code d'état NOT_PUBLISHED_REQUIRES_SIGN_IN.

Kotlin

client.updatePublishStatus(
   PublishStatusRequest.Builder()
     .setStatusCode(AppEngagePublishStatusCode.NOT_PUBLISHED_REQUIRES_SIGN_IN)
     .build())

Java

client.updatePublishStatus(
    new PublishStatusRequest.Builder()
        .setStatusCode(AppEngagePublishStatusCode.NOT_PUBLISHED_REQUIRES_SIGN_IN)
        .build());

deleteRecommendationClusters

Cette API permet de supprimer le contenu des clusters "Recommendation".

Kotlin

client.deleteRecommendationClusters()

Java

client.deleteRecommendationClusters();

Lorsque le service reçoit la requête, il supprime les données existantes des clusters "Recommendation". En cas d'erreur, la requête entière est rejetée, et l'état existant est maintenu.

deleteFeaturedCluster

Cette API permet de supprimer le contenu du cluster "Featured".

Kotlin

client.deleteFeaturedCluster()

Java

client.deleteFeaturedCluster();

Lorsque le service reçoit la requête, il supprime les données existantes du cluster "Featured". En cas d'erreur, la requête entière est rejetée, et l'état existant est maintenu.

deleteReservationCluster

Cette API permet de supprimer le contenu du cluster "Reservation Cluster".

Kotlin

client.deleteReservationCluster()

Java

client.deleteReservationCluster();

Lorsque le service reçoit la requête, il supprime les données existantes du cluster "Reservation". En cas d'erreur, la requête entière est rejetée, et l'état existant est maintenu.

deleteUserManagementCluster

Cette API permet de supprimer le contenu du cluster "UserAccountManagement".

Kotlin

client.deleteUserManagementCluster()

Java

client.deleteUserManagementCluster();

Lorsque le service reçoit la requête, il supprime les données existantes du cluster "UserAccountManagement". En cas d'erreur, la requête entière est rejetée, et l'état existant est maintenu.

deleteContinueSearchCluster

Cette API permet de supprimer le contenu du cluster "Continue Search".

Kotlin

client.deleteContinueSearchCluster()

Java

client.deleteContinueSearchCluster();

Lorsque le service reçoit la requête, il supprime les données existantes du cluster "Continue Search". En cas d'erreur, la requête entière est rejetée, et l'état existant est maintenu.

deleteClusters

Cette API permet de supprimer le contenu d'un type de cluster donné.

Kotlin

client.deleteClusters(
    DeleteClustersRequest.Builder()
      .addClusterType(ClusterType.TYPE_RESERVATION)
      .addClusterType(ClusterType.TYPE_FEATURED)
      .addClusterType(ClusterType.TYPE_RECOMMENDATION)
      .addClusterType(ClusterType.TYPE_CONTINUE_SEARCH)
      .build())

Java

client.deleteClusters(
            new DeleteClustersRequest.Builder()
                .addClusterType(ClusterType.TYPE_RESERVATION)
                .addClusterType(ClusterType.TYPE_FEATURED)
                .addClusterType(ClusterType.TYPE_RECOMMENDATION)
                .addClusterType(ClusterType.TYPE_CONTINUE_SEARCH)
                .build());

Lorsque le service reçoit la requête, il supprime les données existantes de tous les clusters correspondant aux types de clusters spécifiés. Les clients peuvent choisir de transmettre un ou plusieurs types de clusters. En cas d'erreur, la requête entière est rejetée, et l'état existant est maintenu.

Gestion des exceptions

Il est fortement recommandé d'écouter le résultat de la tâche à partir des API de publication afin qu'une action de suivi puisse être effectuée pour récupérer et renvoyer une tâche réussie.

Kotlin

client.publishRecommendationClusters(
        PublishRecommendationClustersRequest.Builder()
          .addRecommendationCluster(..)
          .build())
      .addOnCompleteListener { task ->
        if (task.isSuccessful) {
          // do something
        } else {
          val exception = task.exception
          if (exception is AppEngageException) {
            @AppEngageErrorCode val errorCode = exception.errorCode
            if (errorCode == AppEngageErrorCode.SERVICE_NOT_FOUND) {
              // do something
            }
          }
        }
      }

Java

client.publishRecommendationClusters(
              new PublishRecommendationClustersRequest.Builder()
                  .addRecommendationCluster(...)
                  .build())
          .addOnCompleteListener(
              task -> {
                if (task.isSuccessful()) {
                  // do something
                } else {
                  Exception exception = task.getException();
                  if (exception instanceof AppEngageException) {
                    @AppEngageErrorCode
                    int errorCode = ((AppEngageException) exception).getErrorCode();
                    if (errorCode == AppEngageErrorCode.SERVICE_NOT_FOUND) {
                      // do something
                    }
                  }
                }
              });

L'erreur est renvoyée au format AppEngageException. La cause est incluse sous la forme d'un code d'erreur.

Code d'erreur Nom de l'erreur Remarque
1 SERVICE_NOT_FOUND Le service n'est pas disponible sur l'appareil donné.
2 SERVICE_NOT_AVAILABLE Le service est disponible sur l'appareil donné, mais pas au moment de l'appel (par exemple, il est explicitement désactivé).
3 SERVICE_CALL_EXECUTION_FAILURE L'exécution de la tâche a échoué en raison de problèmes de thread. Dans ce cas, vous pouvez réessayer.
4 SERVICE_CALL_PERMISSION_DENIED L'appelant n'est pas autorisé à effectuer l'appel du service.
5 SERVICE_CALL_INVALID_ARGUMENT La requête contient des données non valides (par exemple, un nombre plus élevé que le nombre de clusters autorisé).
6 SERVICE_CALL_INTERNAL Une erreur s'est produite au niveau du service.
7 SERVICE_CALL_RESOURCE_EXHAUSTED L'appel du service est effectué trop fréquemment.

Étape 3 : Gérer les intents de diffusion

En plus d'effectuer des appels d'API de publication de contenu via une tâche, vous devez également configurer un objet BroadcastReceiver pour recevoir la requête de publication de contenu.

L'objectif des intents de diffusion est principalement de réactiver des applications et de forcer la synchronisation des données. Les intents de diffusion ne sont pas conçus pour être envoyés très fréquemment. Ils ne se déclenchent que lorsque le service Engage détermine que le contenu est peut-être obsolète (par exemple, s'il date d'il y a une semaine). De cette façon, l'utilisateur a plus de chances de bénéficier d'une expérience de contenu actualisée, même si l'application n'a pas été exécutée pendant une longue période.

Le BroadcastReceiver doit être configuré de deux manières :

  • Enregistrez dynamiquement une instance de la classe BroadcastReceiver à l'aide de Context.registerReceiver(). Cela permet la communication à partir d'applications restées actives en mémoire.

Kotlin

class AppEngageBroadcastReceiver : BroadcastReceiver(){
  // Trigger recommendation cluster publish when PUBLISH_RECOMMENDATION broadcast
  // is received
  // Trigger featured cluster publish when PUBLISH_FEATURED broadcast is received
}

fun registerBroadcastReceivers(context: Context){
  var  context = context
  context = context.applicationContext

// Register Recommendation Cluster Publish Intent
  context.registerReceiver(AppEngageBroadcastReceiver(),
                           IntentFilter(Intents.ACTION_PUBLISH_RECOMMENDATION))

// Register Featured Cluster Publish Intent
  context.registerReceiver(AppEngageBroadcastReceiver(),
                           IntentFilter(Intents.ACTION_PUBLISH_FEATURED))
}

Java

class AppEngageBroadcastReceiver extends BroadcastReceiver {
// Trigger recommendation cluster publish when PUBLISH_RECOMMENDATION broadcast
// is received

// Trigger featured cluster publish when PUBLISH_FEATURED broadcast is received
}

public static void registerBroadcastReceivers(Context context) {

context = context.getApplicationContext();

// Register Recommendation Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
new IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_RECOMMENDATION));

// Register Featured Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
new IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_FEATURED));

}
  • Déclarez une implémentation de manière statique avec la balise <receiver> dans le fichier AndroidManifest.xml. Cela permet à l'application de recevoir des intents de diffusion lorsqu'elle n'est pas en cours d'exécution, et de publier le contenu.
<application>
   <receiver
      android:name=".AppEngageBroadcastReceiver"
      android:exported="true"
      android:enabled="true">
      <intent-filter>
         <action android:name="com.google.android.engage.action.PUBLISH_RECOMMENDATION" />
      </intent-filter>
      <intent-filter>
         <action android:name="com.google.android.engage.action.PUBLISH_FEATURED" />
      </intent-filter>
   </receiver>
</application>

Les intents suivants sont envoyés par le service :

  • com.google.android.engage.action.PUBLISH_RECOMMENDATION Nous vous recommandons de démarrer un appel publishRecommendationClusters lors de la réception de cet intent.
  • com.google.android.engage.action.PUBLISH_FEATURED Nous vous recommandons de démarrer un appel publishFeaturedCluster lors de la réception de cet intent.

Workflow d'intégration

Pour vous procurer un guide par étapes sur la validation de votre intégration une fois celle-ci terminée, consultez la page Workflow d'intégration pour les développeurs d'Engage.

Questions fréquentes

Pour en savoir plus, consultez les questions fréquentes concernant le SDK Engage.

Contact

Contactez engage-developers@google.com si vous avez des questions au cours du processus d'intégration.

Étapes suivantes

Une fois cette intégration effectuée, procédez comme suit :

  • Envoyez un e-mail à l'adresse engage-developers@google.com et joignez-y votre APK intégré prêt à être testé par Google.
  • Google effectue une vérification et des examens en interne pour s'assurer que l'intégration fonctionne comme prévu. Si des modifications sont nécessaires, nous vous contacterons avec toutes les informations nécessaires.
  • Une fois les tests terminés, si aucune modification n'est nécessaire, nous vous informerons que vous pouvez commencer à publier le fichier APK mis à jour et intégré sur le Play Store.
  • Une fois que nous aurons confirmé la publication de votre APK mis à jour sur le Play Store, vos clusters Recommendation (Recommandations), Featured (Sélection), Reservation (Réservation) et Continue Search (Continuer la recherche) pourront être publiés et visibles par les utilisateurs.