Google utilise la technologie IA pour traduire le contenu dans votre langue préférée. Les traductions générées par IA peuvent contenir des erreurs.

Engage SDK Autres secteurs: instructions d'intégration technique tierce

Boostez l'engagement dans votre application en touchant vos utilisateurs là où ils se trouvent. Intégrez le SDK Engage pour proposer des recommandations personnalisées et du contenu de suivi directement aux utilisateurs sur plusieurs surfaces de l'appareil, comme Collections, Entertainment Space et le Play Store. L'intégration ajoute moins de 50 Ko (compressés) à l'APK moyen et prend environ une semaine de temps de développement pour la plupart des applications. Pour en savoir plus, consultez notre site pour les entreprises.

Ce document contient des instructions permettant aux partenaires développeurs d'intégrer de nouveaux contenus tels que des réservations, des événements, des hébergements, des lieux d'intérêt, des personnes et d'autres contenus qui n'appartiennent peut-être à aucune de ces catégories.

Compétences Android

Afficher sur GitHub

Intégrer le SDK Engage

Utilisez la compétence Android du SDK Engage pour intégrer, déboguer et résoudre les problèmes d'implémentation.

Pour installer la compétence à partir de la CLI Android, exécutez la commande suivante :

android skills add engage-sdk-integration

Détails de l'intégration

Cette section décrit les étapes, les modèles de données et la terminologie nécessaires pour intégrer le SDK Engage à d'autres catégories de contenu.

Terminologie

Cette intégration comprend les trois types de clusters suivants : Recommendation (Recommandations), Featured (Sélection) et Continuation (Suite).

Les clusters Recommandations affichent des suggestions personnalisées d'un développeur partenaire individuel. Il s'agit d'une vue de l'interface utilisateur contenant un groupe de recommandations du même développeur partenaire.
- ArticleEntity : ArticleEntity qui représente une recommandation textuelle pour un contenu pertinent pour plusieurs catégories de contenu. L'élément ArticleEntity permet aux développeurs de fournir une variété de contenus textuels et d'images avec plus de métadonnées pour articuler les informations destinées aux utilisateurs par rapport à GenericFeaturedEntity. Ex. : contenu marketing, extrait d'actualités
  
  Figure 1 : Interface utilisateur affichant une seule entité ArticleEntity dans le cluster "Recommendations".
- 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 communiquée aux utilisateurs.
  
  Figure 2 : Interface utilisateur affichant une seule entité EventEntity dans le cluster "Recommendations".
- LodgingEntity : LodgingEntity représente un hébergement, tel qu'un hôtel, un appartement ou une maison de vacances pour une location à court et à long terme.
  
  Figure 3 : Interface utilisateur affichant une seule LodgingEntity dans le cluster "Recommendations".
- StoreEntity : StoreEntity représente un magasin, un restaurant, un café, etc. Il met en avant le contenu où un restaurant ou un magasin est l'information essentielle à transmettre aux utilisateurs.
  
  Figure 4 : Interface utilisateur montrant une seule entité StoreEntity dans le cluster "Recommendations".
- 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 le lieu 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é PointOfInterestEntity dans le cluster "Recommandations".
- PersonEntity : PersonEntity représente une personne. Les recommandations peuvent consister à mettre en avant une personne dans des catégories telles que la santé et la remise en forme, le sport, les rencontres, etc.
  
  Figure 5 : Interface utilisateur affichant une seule entité PersonEntity dans le cluster "Recommendations".
Le cluster Suite affiche dans un regroupement d'UI le contenu de plusieurs partenaires développeurs, contenu avec lequel les utilisateurs ont interagi récemment. Chaque développeur partenaire est autorisé à diffuser au maximum 10 entités dans le cluster "Continuation".

Le contenu de continuation peut présenter la structure suivante :
- ArticleEntity : ArticleEntity qui représente une recommandation textuelle pour un contenu pertinent pour plusieurs catégories de contenu. Cette entité peut être utilisée pour représenter des articles d'actualité inachevés ou d'autres contenus que l'utilisateur souhaite continuer à consommer là où il s'est arrêté. Ex. : contenu marketing, extrait d'actualités
  
  Figure 6 : UI montrant une seule ArticleEntity dans un cluster Continuation.
- RestaurantReservationEntity : RestaurantReservationEntity représente une réservation pour un restaurant ou un café, et aide les utilisateurs à suivre les réservations de restaurant à venir ou en cours.
  
  Figure 7. UI montrant une seule entité RestaurantReservationEntity dans un cluster Continuation.
- 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, mais 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 l'e-sport
  - Événements de divertissement, comme une réservation pour une séance de cinéma, un concert, une pièce de théâtre ou une séance de dédicace
  - Réservations de voyages ou de points d'intérêt, comme des visites guidées ou des billets de musée
  - Réservations pour des événements sociaux, des séminaires ou des conférences
  - Réservations de sessions d'enseignement / de formation
  Figure 8. UI montrant une seule EventReservationEntity dans un cluster Continuation.
- 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 9. UI affichant une seule LodgingReservationEntity dans un cluster Continuation.
- TransportationReservationEntity : TransportationReservationEntity représente une réservation de transport par n'importe quel mode et aide les utilisateurs à suivre les réservations pour un vol, un ferry, un train, un bus, un taxi ou un VTC, ou une croisière à venir ou en cours.
  
  Figure 10. UI montrant une seule TransportationReservationEntity dans un cluster Continuation.
- VehicleRentalReservationEntity : VehicleRentalReservationEntity représente une réservation de location de véhicule et aide les utilisateurs à suivre les réservations de location de véhicule à venir ou en cours.
  
  Figure 11. UI montrant une seule entité VehicleRentalReservationEntity dans un cluster Continuation.
Le cluster Sélection est une vue d'interface utilisateur qui présente l'entité phare GenericFeaturedEntity de nombreux développeurs partenaires dans un seul regroupement d'UI. Il n'existe qu'un seul cluster "Sélection", situé dans la partie supérieure de l'UI avec un emplacement prioritaire au-dessus de tous les clusters "Recommandations". Chaque développeur partenaire est autorisé à diffuser une seule entité dont le type est compatible dans la sélection, avec de nombreuses entités (qui peuvent être de types différents) de plusieurs développeurs d'applications dans le cluster "Sélection".
- GenericFeaturedEntity : GenericFeaturedEntity diffère de l'élément de recommandation, car l'élément mis en avant doit être utilisé pour un seul contenu principal des développeurs et doit représenter le contenu le plus important qui sera intéressant et pertinent pour les utilisateurs.
  
  Figure 12 : UI affichant une seule fiche GenericFeaturedEntity principale dans un cluster de contenus mis en avant

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.6.0'
}

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"	7 maximum	Au moins 1	50 maximum (`ArticleEntity`, `EventEntity`, `LodgingEntity`, `StoreEntity`, `PointOfInterestEntity` ou `PersonEntity`)
Cluster "Continuation"	1 maximum	Au moins 1	20 maximum (`ArticleEntity`, `EventReservationEntity`, `LodgingReservationEntity`, `TransportationReservationEntity` ou `VehicleRentalReservationEntity`)
Cluster "Featured"	1 maximum	Au moins 1	20 maximum (`GenericFeaturedEntity`)

É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 "Autres" :

GenericFeaturedEntity
ArticleEntity
EventEntity
LodgingEntity
StoreEntity
PointOfInterestEntity
PersonEntity
RestaurantReservationEntity
EventReservationEntity
LodgingReservationEntity
TransportationReservationEntity
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'afficherons qu'une seule image lorsque plusieurs images sont fournies. Le format 16:9 est recommandé. Remarque : Si un badge est fourni, assurez-vous de laisser un espace 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 : Soit la liste de descriptions, soit la liste de sous-titres s'affiche pour l'utilisateur, mais pas les deux.	Texte libre Taille de texte recommandée : 180 caractères
Liste des sous-titres	Facultatif	Jusqu'à trois sous-titres, chacun composé d'une seule ligne de texte. Remarque : Soit la liste de descriptions, soit la liste de sous-titres s'affiche pour l'utilisateur, mais pas les deux.	Texte libre Taille de texte recommandée pour chaque sous-titre : 50 caractères maximum
Badges	Facultatif	Chaque badge est soit du texte libre (15 caractères maximum), soit une petite image. Traitement UX spécial au-dessus de l'image/la vidéo, par exemple, sous forme de badge superposé sur l'image "Infos en direct" Durée de lecture de l'article
Badge - Texte	Facultatif	Titre du badge Remarque : Le badge doit comporter du texte ou une image.	Texte libre Taille de texte recommandée : 15 caractères maximum
Badge - Image	Facultatif	Petite image Traitement UX spécial, par exemple sous forme de badge superposé sur la miniature de l'image ou de la vidéo. Remarque : Le badge doit comporter du texte ou une image.	Consultez la section Caractéristiques des images pour en savoir plus.
Catégories de contenu	Facultatif	Décrivez la catégorie du contenu de l'entité.	Liste des énumérations Pour en savoir plus, 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'afficherons qu'une seule image lorsque plusieurs images sont fournies. Le format 16:9 est recommandé. 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 dp en haut et en bas de l'image.	Consultez la section Caractéristiques des images pour en savoir plus.
Source - Title	Facultatif	Nom de l'auteur, de l'organisation ou du journaliste	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 : Soit la liste de descriptions, soit la liste de sous-titres s'affiche pour l'utilisateur, mais pas les deux.	Texte libre Taille de texte recommandée : 180 caractères
Liste des sous-titres	Facultatif	Jusqu'à trois sous-titres, chacun composé d'une seule ligne de texte. Remarque : Soit la liste de descriptions, soit la liste de sous-titres s'affiche pour l'utilisateur, mais pas les deux.	Texte libre Taille de texte recommandée pour chaque sous-titre : 50 caractères maximum
Badges	Facultatif	Chaque badge est soit du texte libre (15 caractères maximum), soit une petite image. Traitement UX spécial au-dessus de l'image/la vidéo, par exemple sous forme de badge superposé sur l'image "Infos en direct" Durée de lecture de l'article
Badge - Texte	Facultatif	Titre du badge Remarque : Le badge doit comporter du texte ou une image.	Texte libre Taille de texte recommandée : 15 caractères maximum
Badge - Image	Facultatif	Petite image Traitement UX spécial, par exemple sous forme de badge superposé sur la miniature de l'image ou de la vidéo. Remarque : Le badge doit comporter du texte ou une image.	Consultez la section Caractéristiques des images pour en savoir plus.
Date et heure de publication du contenu	Facultatif	Il s'agit du code temporel de l'epoch (en millisecondes) indiquant quand 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 de la dernière interaction de l'utilisateur avec cette entité. Remarque : Ce champ est obligatoire si cette entité fait partie du cluster de continuation.	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 continuation.	Valeur entière comprise entre 0 et 100 inclus.
Catégories de contenu	Facultatif	Décrivez la catégorie du contenu de l'entité.	Liste des énumérations Pour en savoir plus, 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	Obligatoire	Code temporel de l'epoch correspondant au début prévu de l'événement. Remarque : Cette valeur est exprimée en millisecondes.	Code temporel de l'epoch (en millisecondes)
Mode événement	Obligatoire	Un champ indiquant si l'événement sera virtuel, en présentiel ou les deux.	Enum : VIRTUAL, IN_PERSON ou HYBRID
Images poster	Obligatoire	Nous n'afficherons qu'une seule image lorsque plusieurs images sont fournies. Le format 16:9 est recommandé. 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 dp 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 l'événement a lieu. Remarque : Ce champ est obligatoire pour les événements IN_PERSON ou HYBRID.	Texte libre Taille de texte recommandée : 20 caractères maximum
Emplacement - Ville	Obligatoire sous certaines conditions	Ville où se déroule l'événement. Remarque : Ce champ est obligatoire pour les événements IN_PERSON ou HYBRID.	Texte libre Taille de texte recommandée : 20 caractères maximum
Établissement - Adresse affichée	Obligatoire sous certaines conditions	Adresse ou nom du lieu où se déroulera l'événement, qui doit être affiché pour l'utilisateur. Remarque : Ce champ est obligatoire pour les événements IN_PERSON ou HYBRID.	Texte libre Taille de texte recommandée : 20 caractères maximum
Lieu : adresse postale	Facultatif	Adresse postale (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	Le quartier (le cas échéant) dans lequel l'événement est organisé.	Texte libre Taille de texte recommandée : 20 caractères maximum
Heure de fin	Facultatif	Horodatage de l'époque à laquelle l'événement devrait se terminer. 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 : Soit la liste de descriptions, soit la liste de sous-titres s'affiche pour l'utilisateur, mais pas les deux.	Texte libre Taille de texte recommandée : 180 caractères
Liste des sous-titres	Facultatif	Jusqu'à trois sous-titres, chacun composé d'une seule ligne de texte. Remarque : Soit la liste de descriptions, soit la liste de sous-titres s'affiche pour l'utilisateur, mais pas les deux.	Texte libre Taille de texte recommandée pour chaque sous-titre : 50 caractères maximum
Badges	Facultatif	Chaque badge est soit du texte libre (15 caractères maximum), soit une petite image.
Badge - Texte	Facultatif	Titre du badge Remarque : Le badge doit comporter du texte ou une image.	Texte libre Taille de texte recommandée : 15 caractères maximum
Badge - Image	Facultatif	Petite image Traitement UX spécial, par exemple sous forme de badge superposé sur la miniature de l'image ou de la vidéo. Remarque : Le badge doit comporter du texte ou une image.	Consultez la section Caractéristiques des images pour en savoir plus.
Prix - Prix actuel	Obligatoire sous certaines conditions	Prix actuel du billet/pass pour l'événement. À fournir si le prix barré est indiqué.	Texte libre
Prix - Prix barré	Facultatif	Prix d'origine du billet/pass pour l'événement.	Texte libre
Accroche de prix	Facultatif	Accroche de prix qui met 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écrivez 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 (exemple : visite, festival) TYPE_HEALTH_AND_FITENESS (exemple : cours de yoga) TYPE_EDUCATION (exemple : cours) TYPE_SPORTS (exemple : match de football) TYPE_DATING (exemple : meetup) Pour en savoir plus, 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'afficherons qu'une seule image lorsque plusieurs images sont fournies. Le format recommandé est 16:9. Remarque : Si un badge est fourni, assurez-vous de laisser un espace 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.
Emplacement - Pays	Obligatoire	Pays dans lequel se trouve l'hébergement.	Texte libre Taille de texte recommandée : 20 caractères maximum
Emplacement - Ville	Obligatoire	Ville où se trouve l'hébergement.	Texte libre Taille de texte recommandée : 20 caractères maximum
Établissement - Adresse affichée	Obligatoire	Adresse de l'hébergement qui sera présentée à 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) où l'établissement est situé.	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	Le 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 soit du texte libre (15 caractères maximum), soit une petite image.
Badge - Texte	Facultatif	Titre du badge Remarque : Le badge doit comporter du texte ou une image.	Texte libre Taille de texte recommandée : 15 caractères maximum
Badge - Image	Facultatif	Petite image Traitement UX spécial, par exemple sous forme de badge superposé sur la miniature de l'image ou de la vidéo. Remarque : Le badge doit comporter du texte ou une 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 : Soit la liste de descriptions, soit la liste de sous-titres s'affiche pour l'utilisateur, mais pas les deux.	Texte libre Taille de texte recommandée : 180 caractères
Liste des sous-titres	Facultatif	Jusqu'à trois sous-titres, chacun composé d'une seule ligne de texte. Remarque : Soit la liste de descriptions, soit la liste de sous-titres s'affiche pour l'utilisateur, mais pas les deux.	Texte libre Taille de texte recommandée pour chaque sous-titre : 50 caractères maximum
AvailabilityTimeWindow - Heure de début	Facultatif	Code temporel de l'epoch (en millisecondes) correspondant à la date d'ouverture/de disponibilité prévue de l'hébergement.	Code temporel de l'epoch (en millisecondes)
AvailabilityTimeWindow - End Time	Facultatif	Horodatage de l'epoch en millisecondes jusqu'auquel l'hébergement est censé être ouvert/disponible.	Code temporel de l'epoch (en millisecondes)
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'hébergement. Remarque : Indiquez ce champ si votre application contrôle la façon dont le nombre est affiché aux utilisateurs. Utilisez une chaîne concise. Par exemple, si le nombre est de 1 000 000, envisagez d'utiliser une abréviation telle que 1M pour éviter qu'il ne soit tronqué sur les écrans de petite taille.	Chaîne
Note (nombre de valeurs)	Facultatif	Nombre de notes pour l'hébergement. Remarque : Indiquez ce champ si vous ne gérez pas vous-même la logique d'abréviation de l'affichage. Si les deux sont présents, "Nombre" est affiché pour les utilisateurs.	Long
Prix - Prix actuel	Obligatoire sous certaines conditions	Prix actuel de l'hébergement. À fournir si le prix barré est indiqué.	Texte libre
Prix - Prix barré	Facultatif	Prix d'origine de l'hébergement, qui sera barré dans l'UI.	Texte libre
Accroche de prix	Facultatif	Accroche de prix qui met 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 une épicerie.

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)
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'hébergement. Remarque : Indiquez ce champ si votre application souhaite contrôler la façon dont il est affiché 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 1M, afin qu'il ne soit pas tronqué sur les écrans de plus petite taille.	Chaîne
Note (nombre de valeurs)	Facultatif	Nombre de notes pour l'hébergement. Remarque : Indiquez ce champ si vous ne souhaitez pas gérer vous-même la logique d'abréviation de l'affichage. Si les deux sont présents, nous utiliserons le nombre pour l'afficher aux utilisateurs.	Long

`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'afficherons qu'une seule image lorsque plusieurs images sont fournies. Le format 16:9 est recommandé. 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 dp 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
Emplacement - Ville	Obligatoire	Ville où se trouve le point d'intérêt.	Texte libre Taille de texte recommandée : 20 caractères maximum
Établissement - Adresse affichée	Obligatoire	Adresse du point d'intérêt qui sera affichée 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	Le quartier (le cas échéant) du point d'intérêt.	Texte libre Taille de texte recommandée : 20 caractères maximum
AvailabilityTimeWindow - Heure de début	Facultatif	Code temporel de l'epoch (en millisecondes) indiquant quand le point d'intérêt devrait être ouvert/disponible.	Code temporel de l'epoch (en millisecondes)
AvailabilityTimeWindow - End Time	Facultatif	Horodatage de l'epoch en millisecondes jusqu'auquel le point d'intérêt devrait être ouvert/disponible.	Code temporel de l'epoch (en millisecondes)
Badges	Facultatif	Chaque badge est soit du texte libre (15 caractères maximum), soit une petite image.
Badge - Texte	Facultatif	Titre du badge Remarque : Le badge doit comporter du texte ou une image.	Texte libre Taille de texte recommandée : 15 caractères maximum
Badge - Image	Facultatif	Petite image Traitement UX spécial, par exemple sous forme de badge superposé sur la miniature de l'image ou de la vidéo. Remarque : Le badge doit comporter du texte ou une 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 : Soit la liste de descriptions, soit la liste de sous-titres s'affiche pour l'utilisateur, mais pas les deux.	Texte libre Taille de texte recommandée : 180 caractères
Liste des sous-titres	Facultatif	Jusqu'à trois sous-titres, chacun composé d'une seule ligne de texte. Remarque : Soit la liste de descriptions, soit la liste de sous-titres s'affiche pour l'utilisateur, mais pas 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 contrôle la façon dont le nombre est affiché aux utilisateurs. Utilisez une chaîne concise. Par exemple, si le nombre est de 1 000 000, envisagez d'utiliser une abréviation telle que 1M pour éviter qu'il ne soit tronqué sur les écrans de petite taille.	Chaîne
Note (nombre de valeurs)	Facultatif	Nombre de notes pour le point d'intérêt. Remarque : Indiquez ce champ si vous ne gérez pas vous-même la logique d'abréviation de l'affichage. Si les deux sont présents, "Nombre" est affiché aux utilisateurs.	Long
Prix - Prix actuel	Obligatoire sous certaines conditions	Prix actuel des billets/du pass d'entrée pour le point d'intérêt. À fournir si le prix barré est indiqué.	Texte libre
Prix - Prix barré	Facultatif	Prix d'origine des billets/pass d'entrée pour le point d'intérêt.	Texte libre
Accroche de prix	Facultatif	Accroche de prix qui met 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écrivez la catégorie du contenu de l'entité.	Liste des énumérations éligibles TYPE_TRAVEL_AND_LOCAL TYPE_MOVIES_AND_TV_SHOWS (exemple : cinéma) TYPE_MEDICAL (exemple : hôpital) TYPE_EDUCATION (exemple : école) TYPE_SPORTS (exemple : stade) Pour en savoir plus, consultez la section Catégorie de contenu.

`PersonEntity`

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
Profil - Nom	Obligatoire	Nom ou identifiant du profil, par exemple "Jean Dupont", "@TeamPixel", etc.	Chaîne Taille de texte recommandée : 50 caractères maximum
Profil - Avatar	Obligatoire	Photo de profil ou avatar de l'utilisateur. Remarque : L'image doit être au format carré 1:1.	Consultez la section Caractéristiques des images pour en savoir plus.
Profil - Texte supplémentaire	Facultatif	Texte libre, comme l'identifiant du profil.	Texte libre Taille de texte recommandée : 15 caractères maximum
Profil - Image supplémentaire	Facultatif	Petite image, comme un badge de validation.	Consultez la section Caractéristiques des images pour en savoir plus.
Image d'en-tête	Facultatif	Nous n'afficherons qu'une seule image lorsque plusieurs images sont fournies. Le format 16:9 est recommandé. 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 dp en haut et en bas de l'image.	Consultez la section Caractéristiques des images pour en savoir plus.
Popularité - Nombre	Facultatif	Indiquez le nombre de followers ou la valeur de popularité (par exemple, "3,7 M"). Remarque : Si les deux valeurs sont fournies, "Nombre" sera utilisé.	Chaîne Taille de texte recommandée : 20 caractères max. au total pour le nombre et le libellé
Popularité - Valeur du nombre	Facultatif	Nombre de followers ou valeur de popularité. Remarque : Indiquez la valeur du nombre si votre application ne souhaite pas gérer la logique d'optimisation d'un grand nombre pour différentes tailles d'écran. Si les deux sont fournis, "Nombre" sera utilisé.	Long
Popularité – Libellé	Facultatif	Indiquez le libellé de popularité. Par exemple : "J'aime".	Chaîne Taille de texte recommandée : 20 caractères max. au total pour le nombre et le libellé
Popularité – Visuel	Facultatif	Indiquez à quoi sert l'interaction. Par exemple : Image montrant l'icône J'aime et les emoji. Peut fournir plusieurs images, mais il est possible qu'elles ne s'affichent pas toutes avec tous les facteurs de forme. Remarque : L'image doit être au format carré 1:1.	Consultez la section Caractéristiques des images pour en savoir plus.
Note (valeur maximale)	Obligatoire	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)	Obligatoire	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'entité. Remarque : Indiquez ce champ si votre application souhaite contrôler la façon dont il est affiché 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 1M, afin qu'il ne soit pas tronqué sur les écrans de plus petite taille.	Chaîne
Note (nombre de valeurs)	Facultatif	Nombre de notes pour l'entité. Remarque : Indiquez ce champ si vous ne souhaitez pas gérer vous-même la logique d'abréviation de l'affichage. Si les deux sont présents, nous utiliserons le nombre pour l'afficher aux utilisateurs.	Long
Emplacement - Pays	Facultatif	Pays où la personne se trouve ou exerce ses fonctions.	Texte libre Taille de texte recommandée : 20 caractères maximum
Emplacement - Ville	Facultatif	Ville où se trouve la personne ou où elle exerce ses fonctions.	Texte libre Taille de texte recommandée : 20 caractères maximum
Établissement - Adresse affichée	Facultatif	L'adresse où se trouve la personne ou l'endroit où elle sert sera affichée pour l'utilisateur.	Texte libre Taille de texte recommandée : 20 caractères maximum
Lieu : adresse postale	Facultatif	Adresse postale (le cas échéant) où se trouve la personne ou l'endroit où elle exerce ses fonctions.	Texte libre Taille de texte recommandée : 20 caractères maximum
Emplacement : État	Facultatif	L'État (le cas échéant) où la personne se trouve ou exerce ses fonctions.	Texte libre Taille de texte recommandée : 20 caractères maximum
Lieu : code postal	Facultatif	Le code postal (le cas échéant) de l'endroit où se trouve la personne ou où elle propose ses services.	Texte libre Taille de texte recommandée : 20 caractères maximum
Emplacement - Quartier	Facultatif	Le quartier (le cas échéant) où se trouve la personne ou où elle propose ses services.	Texte libre Taille de texte recommandée : 20 caractères maximum
Badges	Facultatif	Chaque badge est soit du texte libre (15 caractères maximum), soit une petite image.
Badge - Texte	Facultatif	Titre du badge Remarque : Le badge doit comporter du texte ou une image.	Texte libre Taille de texte recommandée : 15 caractères maximum
Badge - Image	Facultatif	Petite image Traitement UX spécial, par exemple sous forme de badge superposé sur la miniature de l'image ou de la vidéo. Remarque : Le badge doit comporter du texte ou une 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 : Soit la liste de descriptions, soit la liste de sous-titres s'affiche pour l'utilisateur, mais pas les deux.	Texte libre Taille de texte recommandée : 180 caractères
Liste des sous-titres	Facultatif	Jusqu'à trois sous-titres, chacun composé d'une seule ligne de texte. Remarque : Soit la liste de descriptions, soit la liste de sous-titres s'affiche pour l'utilisateur, mais pas les deux.	Texte libre Taille de texte recommandée pour chaque sous-titre : 50 caractères maximum
Catégories de contenu	Facultatif	Décrivez la catégorie du contenu de l'entité.	Liste des énumérations éligibles TYPE_HEALTH_AND_FITENESS (par exemple, coach de yoga/fitness) TYPE_HOME_AND_AUTO (exemple : plombier) TYPE_SPORTS (exemple : joueur) TYPE_DATING Pour en savoir plus, 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	Obligatoire	Horodatage d'epoch en millisecondes correspondant au début prévu de la réservation.	Code temporel de l'epoch (en millisecondes)
Emplacement - Pays	Obligatoire	Pays dans lequel se trouve le restaurant.	Texte libre Taille de texte recommandée : 20 caractères maximum
Emplacement - Ville	Obligatoire	Ville où se trouve le restaurant.	Texte libre Taille de texte recommandée : 20 caractères maximum
Établissement - Adresse affichée	Obligatoire	Adresse du restaurant qui sera affichée 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 restaurant.	Texte libre Taille de texte recommandée : 20 caractères maximum
Emplacement : État	Facultatif	État ou province (le cas échéant) où 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	Le quartier (le cas échéant) du restaurant.	Texte libre Taille de texte recommandée : 20 caractères maximum
Images poster	Facultatif	Nous n'afficherons qu'une seule image lorsque plusieurs images sont fournies. Le format recommandé est 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 : Soit la liste de descriptions, soit la liste de sous-titres s'affiche pour l'utilisateur, mais pas les deux.	Texte libre Taille de texte recommandée : 180 caractères
Liste des sous-titres	Facultatif	Jusqu'à trois sous-titres, chacun composé d'une seule ligne de texte. Remarque : Soit la liste de descriptions, soit la liste de sous-titres s'affiche pour l'utilisateur, mais pas 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	Obligatoire	Code temporel de l'epoch correspondant au début prévu de l'événement. Remarque : Cette valeur est exprimée en millisecondes.	Code temporel de l'epoch (en millisecondes)
Mode événement	Obligatoire	Un champ indiquant si l'événement sera virtuel, en présentiel ou les deux.	Enum : VIRTUAL, IN_PERSON ou HYBRID
Emplacement - Pays	Obligatoire sous certaines conditions	Pays dans lequel l'événement a lieu. Remarque : Ce champ est obligatoire pour les événements IN_PERSON ou HYBRID.	Texte libre Taille de texte recommandée : 20 caractères maximum
Emplacement - Ville	Obligatoire sous certaines conditions	Ville où se déroule l'événement. Remarque : Ce champ est obligatoire pour les événements IN_PERSON ou HYBRID.	Texte libre Taille de texte recommandée : 20 caractères maximum
Établissement - Adresse affichée	Obligatoire sous certaines conditions	Adresse ou nom du lieu où se déroulera l'événement, qui doit être affiché pour l'utilisateur. Remarque : Ce champ est obligatoire pour les événements IN_PERSON ou HYBRID.	Texte libre Taille de texte recommandée : 20 caractères maximum
Lieu : adresse postale	Facultatif	Adresse postale (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	Le quartier (le cas échéant) dans lequel l'événement est organisé.	Texte libre Taille de texte recommandée : 20 caractères maximum
Images poster	Facultatif	Nous n'afficherons qu'une seule image lorsque plusieurs images sont fournies. Le format 16:9 est recommandé. 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 dp en haut et en bas de l'image.	Consultez la section Caractéristiques des images pour en savoir plus.
Heure de fin	Facultatif	Horodatage de l'époque à laquelle l'événement devrait se terminer. Remarque : Cette valeur est exprimée en millisecondes.	Code temporel de l'epoch (en millisecondes)
Fournisseur de services - Nom	Facultatif	Nom du fournisseur de services. Remarque : Vous devez fournir du texte ou une image pour le fournisseur de services.	Texte libre. Par exemple, le nom de l'organisateur de l'événement ou de la tournée
Fournisseur de services - Image	Facultatif	Logo/Image du fournisseur de services. Remarque : Vous devez fournir 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 : Soit la liste de descriptions, soit la liste de sous-titres s'affiche pour l'utilisateur, mais pas les deux.	Texte libre Taille de texte recommandée : 180 caractères
Liste des sous-titres	Facultatif	Jusqu'à trois sous-titres, chacun composé d'une seule ligne de texte. Remarque : Soit la liste de descriptions, soit la liste de sous-titres s'affiche pour l'utilisateur, mais pas les deux.	Texte libre Taille de texte recommandée pour chaque sous-titre : 50 caractères maximum
Badges	Facultatif	Chaque badge est soit du texte libre (15 caractères maximum), soit une petite image.
Badge - Texte	Facultatif	Titre du badge Remarque : Le badge doit comporter du texte ou une image.	Texte libre Taille de texte recommandée : 15 caractères maximum
Badge - Image	Facultatif	Petite image Traitement UX spécial, par exemple sous forme de badge superposé sur la miniature de l'image ou de la vidéo. Remarque : Le badge doit comporter du texte ou une image.	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 - Prix actuel	Obligatoire sous certaines conditions	Prix actuel du billet/pass pour l'événement. À fournir si le prix barré est indiqué.	Texte libre
Prix - Prix barré	Facultatif	Prix d'origine du billet/pass pour l'événement.	Texte libre
Accroche de prix	Facultatif	Accroche de prix qui met 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 il est affiché 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 1M, afin qu'il ne soit pas tronqué sur les écrans de plus petite taille.	Chaîne
Note (nombre de valeurs)	Facultatif	Nombre de notes pour l'événement. Remarque : Indiquez ce champ si vous ne souhaitez pas gérer vous-même la logique d'abréviation de l'affichage. Si les deux sont présents, nous utiliserons le nombre pour l'afficher aux utilisateurs.	Long
Catégories de contenu	Facultatif	Décrivez 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 (exemple : visite, festival) TYPE_HEALTH_AND_FITENESS (exemple : cours de yoga) TYPE_EDUCATION (exemple : cours) TYPE_SPORTS (exemple : match de football) TYPE_DATING (exemple : meetup) Pour en savoir plus, 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 à partir du 12 décembre". Taille de texte recommandée : 50 caractères maximum
Heure d'arrivée	Obligatoire	Code temporel de l'epoch (en millisecondes) représentant l'heure d'arrivée de la réservation.	Code temporel de l'epoch (en millisecondes)
Heure de départ	Obligatoire	Code temporel de l'epoch (en millisecondes) représentant l'heure de départ de la réservation.	Code temporel de l'epoch (en millisecondes)
Emplacement - Pays	Obligatoire	Pays où se trouve l'hébergement.	Texte libre Taille de texte recommandée : 20 caractères maximum
Emplacement - Ville	Obligatoire	Ville où se trouve l'établissement.	Texte libre Taille de texte recommandée : 20 caractères maximum
Établissement - Adresse affichée	Obligatoire	Adresse de l'hébergement qui sera présentée à 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) où l'établissement est situé.	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	Le 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'afficherons qu'une seule image lorsque plusieurs images sont fournies. Le format recommandé est 16:9. Remarque : Si un badge est fourni, assurez-vous de laisser un espace 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.
Description	Facultatif	Un seul paragraphe de texte pour décrire l'entité. Remarque : Soit la liste de descriptions, soit la liste de sous-titres s'affiche pour l'utilisateur, mais pas les deux.	Texte libre Taille de texte recommandée : 180 caractères
Liste des sous-titres	Facultatif	Jusqu'à trois sous-titres, chacun composé d'une seule ligne de texte. Remarque : Soit la liste de descriptions, soit la liste de sous-titres s'affiche pour l'utilisateur, mais pas 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 pour l'hébergement. Remarque : Indiquez ce champ si votre application souhaite contrôler la façon dont il est affiché 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 1M, afin qu'il ne soit pas tronqué sur les écrans de plus petite taille.	Chaîne
Note (nombre de valeurs)	Facultatif	Nombre de notes pour l'hébergement. Remarque : Indiquez ce champ si vous ne souhaitez pas gérer vous-même la logique d'abréviation de l'affichage. Si les deux sont présents, nous utiliserons le nombre pour l'afficher aux utilisateurs.	Long
Prix - Prix actuel	Obligatoire sous certaines conditions	Prix actuel de l'hébergement. À fournir si le prix barré est indiqué.	Texte libre
Prix - Prix barré	Facultatif	Prix d'origine de l'hébergement, qui sera barré dans l'UI.	Texte libre
Accroche de prix	Facultatif	Accroche de prix qui met 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 pour la réservation.	Énumération : FLIGHT, TRAIN, BUS ou FERRY
Heure de départ	Obligatoire	Code temporel de l'epoch (en millisecondes) représentant l'heure de départ.	Code temporel de l'epoch (en millisecondes)
Heure d'arrivée	Obligatoire	Code temporel de l'epoch (en millisecondes) représentant l'heure d'arrivée.	Code temporel de l'epoch (en millisecondes)
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 qui sera affiché 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	Le 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	Le quartier (le cas échéant) du lieu 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	La 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 sera affiché pour l'utilisateur.	Texte libre Taille de texte recommandée : 20 caractères maximum
Lieu d'arrivée : adresse postale	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) du lieu 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) du lieu d'arrivée.	Texte libre Taille de texte recommandée : 20 caractères maximum
Lieu d'arrivée – Quartier	Facultatif	Le quartier (le cas échéant) du lieu 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 fournir du texte ou une image pour le fournisseur de services.	Texte libre. Exemple : Nom de la compagnie aérienne
Fournisseur de services - Image	Facultatif	Logo/Image du fournisseur de services. Remarque : Vous devez fournir 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'afficherons qu'une seule image lorsque plusieurs images sont fournies. Le format recommandé est 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 : Soit la liste de descriptions, soit la liste de sous-titres s'affiche pour l'utilisateur, mais pas les deux.	Texte libre Taille de texte recommandée : 180 caractères
Liste des sous-titres	Facultatif	Jusqu'à trois sous-titres, chacun composé d'une seule ligne de texte. Remarque : Soit la liste de descriptions, soit la liste de sous-titres s'affiche pour l'utilisateur, mais pas 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 - Prix actuel	Obligatoire sous certaines conditions	Prix actuel de la réservation. À fournir si le prix barré est indiqué.	Texte libre
Prix - Prix barré	Facultatif	Prix d'origine de la réservation, qui sera barré dans l'UI.	Texte libre
Accroche de prix	Facultatif	Accroche de prix qui met 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)
Numéro de transport	Obligatoire	Numéro de vol, de bus, de train ou de ferry/croisière.	Texte libre
Heure d'embarquement	Obligatoire	Horodatage d'epoch représentant l'heure d'embarquement pour la réservation (le cas échéant)	Code temporel de l'epoch (en millisecondes)

`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 prise en charge	Obligatoire	Horodatage Epoch représentant l'heure de retrait de la réservation.	Code temporel de l'epoch (en millisecondes)
Heure de retour	Facultatif	Code temporel de l'epoch qui représente l'heure de départ de la réservation.	Code temporel de l'epoch (en millisecondes)
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 sera affiché pour 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 prise en charge.	Texte libre Taille de texte recommandée : 20 caractères maximum
Adresse de retrait – État	Facultatif	L'État ou la province (le cas échéant) du lieu de retrait.	Texte libre Taille de texte recommandée : 20 caractères maximum
Adresse de retrait : code postal	Facultatif	Le 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	Le quartier (le cas échéant) du point de retrait.	Texte libre Taille de texte recommandée : 20 caractères maximum
Adresse de retour - Pays	Facultatif	Pays de l'adresse 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	Adresse de retour qui sera présentée à 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) de l'adresse 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) de l'adresse de retour.	Texte libre Taille de texte recommandée : 20 caractères maximum
Adresse de retour – Code postal	Facultatif	Le code postal (le cas échéant) de l'adresse de retour.	Texte libre Taille de texte recommandée : 20 caractères maximum
Adresse de retour - Quartier	Facultatif	Le quartier (le cas échéant) de l'adresse 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 fournir 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 fournir 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'afficherons qu'une seule image lorsque plusieurs images sont fournies. Le format recommandé est 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 : Soit la liste de descriptions, soit la liste de sous-titres s'affiche pour l'utilisateur, mais pas les deux.	Texte libre Taille de texte recommandée : 180 caractères
Liste des sous-titres	Facultatif	Jusqu'à trois sous-titres, chacun composé d'une seule ligne de texte. Remarque : Soit la liste de descriptions, soit la liste de sous-titres s'affiche pour l'utilisateur, mais pas 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 - Prix actuel	Obligatoire sous certaines conditions	Prix actuel de la réservation. À fournir si le prix barré est indiqué.	Texte libre
Prix - Prix barré	Facultatif	Prix d'origine de la réservation, qui sera barré dans l'UI.	Texte libre
Accroche de prix	Facultatif	Accroche de prix qui met 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

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. Cela permet de mapper le contenu 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 d'utilisation des catégories de contenu

Certaines entités, comme ArticleEntity et GenericFeaturedEntity, peuvent utiliser n'importe quelle catégorie de contenu. Pour les 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 pour un type d'entité avant de remplir la liste.
Utilisez le type d'entité spécifique pour certaines catégories de contenu plutôt qu'une combinaison d'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.
Le champ ContentCategory est facultatif et doit être laissé vide si le contenu n'appartient à aucune des catégories mentionnées précédemment.
Si plusieurs catégories de contenu sont fournies, indiquez-les par ordre de pertinence par rapport au contenu, la catégorie la plus pertinente étant placée 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).

AppEngagePublishClient permet la publication des clusters.

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

isServiceAvailable
publishRecommendationClusters
publishFeaturedCluster
publishContinuationCluster
publishUserAccountManagementRequest
updatePublishStatus
deleteRecommendationsClusters
deleteFeaturedCluster
deleteContinuationCluster
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.

Pour le SDK Engage v1.6.0 et versions ultérieures (recommandé)

Compétences Android

Afficher sur GitHub

Intégration du SDK Engage

Pour installer la compétence à partir de la CLI Android, exécutez la commande suivante :

android skills add engage-sdk-integration

Si votre équipe utilise des outils de codage IA (comme Gemini dans Android Studio), vous pouvez automatiser cette migration en demandant à votre assistant IA :

Use the engage-sdk-integration skill to use Engage SDK 1.6.0 and refactor isServiceAvailable to pass ServiceAvailabilityRequest for publishing all cluster types.

Vous pouvez vérifier la disponibilité du service pour chaque type de cluster que vous avez l'intention de publier. L'API isServiceAvailable accepte un objet de requête, ServiceAvailabilityRequest, qui contient les types de clusters pour lesquels la disponibilité du service doit être vérifiée. Vous trouverez les valeurs d'énumération ClusterType requises pour ServiceAvailabilityRequest dans le tableau suivant.

Type de cluster	Constante de type de cluster	Valeur entière
Inconnu	`TYPE_UNKNOWN`	0
Cluster "Recommandation"	`TYPE_RECOMMENDATION`	1
Cluster "Featured"	`TYPE_FEATURED`	2
Cluster "Continuation"	`TYPE_CONTINUATION`	3
Cluster "Shopping Cart"	`TYPE_SHOPPING_CART`	4
Cluster "Food Reorder"	`TYPE_FOOD_REORDER`	5
Cluster "Food Shopping Cart"	`TYPE_FOOD_SHOPPING_CART`	6
Cluster "Food Shopping List"	`TYPE_FOOD_SHOPPING_LIST`	7
Cluster de gestion des utilisateurs	`TYPE_ENGAGEMENT`	8
Cluster "Shopping List"	`TYPE_SHOPPING_LIST`	9
Cluster "Shopping Reorder"	`TYPE_SHOPPING_REORDER`	10
Cluster "Shopping Order Tracking"	`TYPE_SHOPPING_ORDER_TRACKING`	11
Cluster d'abonnement	`TYPE_SUBSCRIPTION`	12
Cluster "Continue Search"	`TYPE_CONTINUE_SEARCH`	13
Cluster de réservation	`TYPE_RESERVATION`	14

Kotlin

val request = ServiceAvailabilityRequest.Builder()
    .addIntendedClusterType(ClusterType.TYPE_CONTINUATION)
    .addIntendedClusterType(ClusterType.TYPE_RECOMMENDATION)
    .build()

client.isServiceAvailable(request).addOnCompleteListener { task ->
    if (task.isSuccessful) {
        val availabilityMap = task.result
        if (availabilityMap[ClusterType.TYPE_CONTINUATION] == true) {
            // Proceed with publishing continuation content
        }
        if (availabilityMap[ClusterType.TYPE_RECOMMENDATION] == true) {
            // Proceed with publishing recommendation content
        }
    } else {
        // The IPC call itself fails, proceed with error handling logic here,
        // such as retry.
    }
}

Java

ServiceAvailabilityRequest request =
    new ServiceAvailabilityRequest.Builder()
        .addIntendedClusterType(ClusterType.TYPE_CONTINUATION)
        .addIntendedClusterType(ClusterType.TYPE_RECOMMENDATION)
        .build();

client.isServiceAvailable(request).addOnCompleteListener(task -> {
    if (task.isSuccessful()) {
        Map<Integer, Boolean> availabilityMap = task.getResult();
        if (Boolean.TRUE.equals(availabilityMap.get(ClusterType.TYPE_CONTINUATION))) {
            // Proceed with publishing continuation content
        }
        if (Boolean.TRUE.equals(availabilityMap.get(ClusterType.TYPE_RECOMMENDATION))) {
            // Proceed with publishing recommendation content
        }
    } else {
        // The IPC call itself fails, proceed with error handling logic here,
        // such as retry.
    }
});

Fonctionnalité de disponibilité conditionnelle du service

Certaines applications intégrées demandent une configuration spéciale qui active et désactive le service Engage par intermittence afin de réduire les coûts de diffusion. Cependant, cette stratégie d'ingestion de contenu intermittente a un impact négatif sur l'expérience utilisateur : le contenu obsolète ne sera pas présenté et certaines surfaces ne seront pas diffusées.

À partir de la version 1.6.0, le SDK Engage permet de vérifier la disponibilité de types de clusters spécifiques. Si votre application utilise l'ingestion intermittente :

Les clusters de continuation (comme "Continuer la lecture" et "Réservations") restent activés par défaut sur tous les appareils compatibles.
Les autres types de clusters (tels que les recommandations) sont activés et désactivés par intermittence.

Si cette configuration par défaut ne répond pas à vos besoins, contactez engage-developers@google.com.

Pour les versions du SDK antérieures à la version 1.6.0 (obsolète)

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 PublishFeaturedClusterRequest.Builder()
                .setFeaturedCluster(
                    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.

`publishContinuationCluster`

Cette API permet de publier un objet ContinuationCluster.

Kotlin

client.publishContinuationCluster(
    PublishContinuationClusterRequest.Builder()
      .setContinuationCluster(
        ContinuationCluster.Builder()
          .addEntity(entity1)
          .addEntity(entity2)
          .build())
      .build())

Java

client.publishContinuationCluster(
            new PublishContinuationClusterRequest.Builder()
                .setContinuationCluster(
                    new ContinuationCluster.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 ContinuationCluster existantes du développeur partenaire sont supprimées.
Les données de la requête sont analysées et stockées dans le cluster "Continuation" 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());

`deleteRecommendationsClusters`

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

Kotlin

client.deleteRecommendationsClusters()

Java

client.deleteRecommendationsClusters();

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.

`deleteContinuationCluster`

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

Kotlin

client.deleteContinuationCluster()

Java

client.deleteContinuationCluster();

Lorsque le service reçoit la requête, il supprime les données existantes du cluster "Continuation". 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.

`deleteClusters`

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

Kotlin

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

Java

client.deleteClusters(
            new DeleteClustersRequest.Builder()
                .addClusterType(ClusterType.TYPE_CONTINUATION)
                .addClusterType(ClusterType.TYPE_FEATURED)
                .addClusterType(ClusterType.TYPE_RECOMMENDATION)
                .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
  // Trigger continuation cluster publish when PUBLISH_CONTINUATION 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),
                           com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
                           /*scheduler=*/null)

// Register Featured Cluster Publish Intent
  context.registerReceiver(AppEngageBroadcastReceiver(),
                           IntentFilter(Intents.ACTION_PUBLISH_FEATURED),
                           com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
                           /*scheduler=*/null)

// Register Continuation Cluster Publish Intent
  context.registerReceiver(AppEngageBroadcastReceiver(),
                           IntentFilter(Intents.ACTION_PUBLISH_CONTINUATION),
                           com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
                           /*scheduler=*/null)
}

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

// Trigger continuation cluster publish when PUBLISH_CONTINUATION 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),
                         com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
                         /*scheduler=*/null);

// Register Featured Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
                         new IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_FEATURED),
                         com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
                         /*scheduler=*/null);

// Register Continuation Cluster Publish Intent
context.registerReceiver(new AppEngageBroadcastReceiver(),
                         new IntentFilter(com.google.android.engage.service.Intents.ACTION_PUBLISH_CONTINUATION),
                         com.google.android.engage.service.BroadcastReceiverPermissions.BROADCAST_REQUEST_DATA_PUBLISH_PERMISSION,
                         /*scheduler=*/null);
}

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:permission="com.google.android.engage.REQUEST_ENGAGE_DATA"
      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>
      <intent-filter>
         <action android:name="com.google.android.engage.action.PUBLISH_CONTINUATION" />
      </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.
com.google.android.engage.action.PUBLISH_CONTINUATION Nous vous recommandons de démarrer un appel publishContinuationCluster 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

Veuillez contacter 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) et Continuation (Suite) pourront être publiés et visibles par les utilisateurs.

Engage SDK Autres secteurs: instructions d'intégration technique tierce Restez organisé à l'aide des collections Enregistrez et classez les contenus selon vos préférences.

Détails de l'intégration

Terminologie

Travail préalable

Résumé

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

GenericFeaturedEntity

ArticleEntity

EventEntity

LodgingEntity

StoreEntity

PointOfInterestEntity

PersonEntity

RestaurantReservationEntity

EventReservationEntity

LodgingReservationEntity

TransportationReservationEntity

VehicleRentalReservationEntity

Caractéristiques des images

Catégorie de contenu

Étape 2 : Fournir les données de cluster

isServiceAvailable

Pour le SDK Engage v1.6.0 et versions ultérieures (recommandé)

Kotlin

Java

Fonctionnalité de disponibilité conditionnelle du service

Pour les versions du SDK antérieures à la version 1.6.0 (obsolète)

Kotlin

Java

publishRecommendationClusters

Kotlin

Java

publishFeaturedCluster

Kotlin

Java

publishContinuationCluster

Kotlin

Java

publishUserAccountManagementRequest

Kotlin

Java

updatePublishStatus

Kotlin

Java

deleteRecommendationsClusters

Kotlin

Java

deleteFeaturedCluster

Kotlin

Java

deleteContinuationCluster

Kotlin

Java

deleteUserManagementCluster

Kotlin

Java

deleteClusters

Kotlin

Java

Gestion des exceptions

Kotlin

Java

Étape 3 : Gérer les intents de diffusion

Kotlin

Java

Workflow d'intégration

Questions fréquentes

Contact

Étapes suivantes

Engage SDK Autres secteurs: instructions d'intégration technique tierce

`GenericFeaturedEntity`

`ArticleEntity`

`EventEntity`

`LodgingEntity`

`StoreEntity`

`PointOfInterestEntity`

`PersonEntity`

`RestaurantReservationEntity`

`EventReservationEntity`

`LodgingReservationEntity`

`TransportationReservationEntity`

`VehicleRentalReservationEntity`

`isServiceAvailable`

`publishRecommendationClusters`

`publishFeaturedCluster`

`publishContinuationCluster`

`publishUserAccountManagementRequest`

`updatePublishStatus`

`deleteRecommendationsClusters`

`deleteFeaturedCluster`

`deleteContinuationCluster`

`deleteUserManagementCluster`

`deleteClusters`