Créer un fichier shortcuts.xml

Après avoir identifié la fonctionnalité de votre application ainsi que l'intent intégré à mettre en œuvre, déclarez les intents intégrés compatibles en définissant un élément capability dans un fichier de ressources shortcuts.xml. La déclaration d'un intent intégré en tant que capability permet d'enregistrer la compatibilité de cet intent sémantique dans votre application. Par ailleurs, cette démarche active le traitement des requêtes vocales de l'intent à l'aide de l'Assistant Google.

L'Assistant utilise le traitement du langage naturel pour extraire les paramètres d'une requête utilisateur. Le document de référence sur les intents intégrés recense les champs que chaque intent intégré peut extraire à partir d'une requête utilisateur associée. Par exemple, lorsqu'un utilisateur appelle la capacité actions.intent.ORDER_MENU_ITEM de votre application en disant : "Hey Google, commande une pizza chez ExempleRestaurant dans ExempleAppli", l'Assistant extrait de cette requête les paramètres d'intent intégré suivants :

• menuItem.name = "pizza"
• menuItem.inMenuSection.inMenu.forRestaurant.name = "ExempleRestaurant"

L'Assistant transmet les paramètres d'intent intégré à l'intent de traitement défini dans capability. Un ou plusieurs éléments intent peuvent être définis dans une capacité afin de prendre en compte les différentes manières dont un utilisateur peut appeler un intent intégré. Par exemple, vous pouvez définir un intent de traitement qui nécessite les deux paramètres d'intent intégré de l'exemple précédent. Vous pouvez ensuite définir un deuxième intent exigeant un seul paramètre d'intent intégré (menuItem.name), qui affiche les restaurants situés à proximité lorsqu'un utilisateur formule une requête plus simple (par exemple : "Hey Google, commande une pizza sur ExempleAppli").

Remarque : Un intent de secours qui ne nécessite aucun paramètre pour traiter la requête d'un utilisateur est obligatoire pour chaque élément capability. Ces intents de secours améliorent l'expérience utilisateur en permettant l'exécution d'actions y compris lorsque la requête est vague (par exemple : "Hey Google, commande à manger sur ExempleAppli"

).

Présentation

Pour configurer les actions dans les applications, vous devez utiliser un fichier shortcuts.xml placé dans le répertoire res/xml de votre projet d'application, puis créer une référence à shortcuts.xml dans le fichier manifeste de votre application. Voici comment procéder :

1. Dans le fichier manifeste de votre application (AndroidManifest.xml), recherchez une activité dont les filtres d'intent sont définis sur l'action android.intent.action.MAIN et la catégorie android.intent.category.LAUNCHER.

2. Ajoutez une référence à shortcuts.xml dans AndroidManifest.xml en utilisant une balise <meta-data> dans l'élément Activity qui contient des filtres d'intent pour MAIN et LAUNCHER. Voici comment :

   <meta-data
      android:name="android.app.shortcuts"
      android:resource="@xml/shortcuts" />
   

L'exemple ci-dessus déclare une ressource XML pour le fichier xml/shortcuts.xml dans l'APK. Pour en savoir plus sur la configuration des raccourcis, consultez la page Créer des raccourcis statiques dans la documentation destinée aux développeurs Android.

Remarque : Si vous utilisez un outil d'obscurcissement pour l'APK de votre version, désactivez l'obscurcissement du fichier shortcuts.xml de votre application à l'aide d'une liste d'autorisation. À défaut, vous risquez de rencontrer une erreur d'importation de votre APK dans la Google Play Console.

La bibliothèque Jetpack androidx.core:core:1.6.0 (ou toute version ultérieure) est requise dans votre projet Android pour éviter les erreurs de compilation lorsque vous définissez les capacités d'actions dans l'application dans le fichier shortcuts.xml. Pour en savoir plus, consultez Premiers pas avec Android Jetpack.

Raccourcis statiques

Lorsque vous définissez votre élément capability, vous pouvez en étendre la fonctionnalité en déclarant des éléments shortcut statiques dans shortcuts.xml. Les raccourcis statiques sont ingérés par l'Assistant lorsque vous importez une version dans la Google Play Console. Les raccourcis statiques ne peuvent être créés et mis à jour qu'à partir de nouvelles versions. Ce faisant, ils sont particulièrement utiles pour mettre en avant des activités et des contenus courants dans votre application.

Remarque : L'Assistant peut également afficher des raccourcis dynamiques pour vos utilisateurs. Les raccourcis dynamiques sont personnalisés pour vos utilisateurs et peuvent être créés et mis à jour au moment de l'exécution. Pour en savoir plus, consultez la rubrique Envoyer des raccourcis dynamiques à l'Assistant.

Vous pouvez activer les fonctionnalités d'Actions dans les applications suivantes à l'aide de raccourcis statiques :

• Raccourcis de capacité. Créez des raccourcis pour lancer une instance de votre élément capability contenant des valeurs de paramètres d'intent prédéfinies. Par exemple, vous pouvez déclarer un raccourci d'application "Démarrer une course à pied" qui appelle la capacité d'intent intégré START_EXERCISE dans votre application de fitness.

  Ces raccourcis contiennent les attributs intent, shortLabel et longLabel. Ils peuvent donc être suggérés et traités sous forme de chips sur des surfaces proactives telles que l'Assistant, ou en appuyant de manière prolongée sur l'icône d'une appli dans les lanceurs d'applications Android. Un raccourci d'action peut également servir de raccourci d'entité (voir ci-dessous) en l'associant à une capability à l'aide d'une balise <capability-binding>.

• Raccourcis d'entité. Les raccourcis d'entité fournissent une liste de valeurs de paramètres pris en charge avec le traitement des requêtes vocales pour les éléments capability. Prenons l'exemple d'un raccourci d'entité contenant plusieurs types d'activités ("randonnée", "course", etc.) lié au paramètre d'intent intégré exercise.name de la capacité START_EXERCISE. Lorsqu'un énoncé d'utilisateur correspond à une entité, l'ID shortcutId est transmis à l'intent à la place de la valeur de requête brute.

  Les raccourcis d'éléments Entity ne définissent pas d'attributs intent, shortLabel ni longLabel. Par conséquent, ils ne sont pas suggérés sur les surfaces proactives. Pour en savoir plus, consultez la section Inventaire intégré pour les actions dans les applications.

  Remarque : Les raccourcis statiques déclarés comme raccourcis d'entité sont ignorés par l'LauncherApps API, ce qui signifie qu'ils sont disponibles pour les lanceurs d'applications Android.

Schéma de capacité

Le tableau suivant décrit le schéma d'Actions dans les applications pour les éléments capability dans shortcuts.xml. Lorsque vous ajoutez une balise, tous ses attributs sont obligatoires, sauf s'ils sont marqués comme "facultatifs".

Balise shortcuts.xml	Contenue dans	Attributs
<capability>	<shortcuts>	android:name app:queryPatterns (s'applique uniquement aux intents personnalisés)
<intent>	<capability>	android:action (facultatif) android:targetClass (facultatif) android:targetPackage (facultatif) android:data (facultatif)
<url-template>	<intent>	android:value
<extra>	<intent>	android:key android:value S'applique uniquement aux appels d'applications au premier plan
<parameter>	<intent>	android:name android:key android:mimeType (s'applique uniquement aux intents personnalisés) android:required (facultatif) app:shortcutMatchRequired (facultatif)
<data>	<parameter>	android:pathPattern (s'applique uniquement à l'inventaire Web)
<shortcut-fulfillment>	<capability>	S'applique uniquement à l'inventaire intégré
<parameter>	<shortcut-fulfillment>	android:name
<slice>	<capability>	S'applique uniquement aux segments d'applications Android

Description du schéma de capacité

Cette section décrit les éléments de schéma capability.

<capability>

Élément capability qui définit l'intent d'action dans l'application que votre appli prend en charge. Chaque balise <capability> de votre fichier shortcuts.xml doit fournir au moins un élément <intent> pour gérer l'exécution de l'action.

Attributs :

• android:name : identifiant de l'action d'intent intégré (par exemple, actions.intent.CREATE_TAXI_RESERVATION). Pour obtenir la liste des intents intégrés pris en charge, consultez la documentation de référence sur les intents intégrés.
• app:queryPatterns : ressource de tableau de chaînes de requêtes attendues de la part de l'utilisateur pour cet intent. Cet attribut ne s'applique qu'aux intents personnalisés, puisque les intents intégrés incluent déjà des modèles d'expressions courantes employées par les utilisateurs pour décrire les tâches qu'ils tentent d'effectuer ou les informations qu'ils recherchent.

Remarque : Les intents intégrés aux actions dans les applications diffèrent des intents Android. Les intents intégrés modélisent une requête utilisateur pour la tâche que celui-ci souhaite effectuer dans votre application. Les intents Android lancent quant à eux des destinations dans votre application, avec du contexte. Vous déclarez des balises capability pour mapper un intent intégré à un intent Android correspondant, ce qui permet aux utilisateurs de lancer la fonctionnalité dans l'application en appelant l'intent intégré avec l'Assistant.

<intent>

Élément intent Android qui définit le mode de traitement d'une requête utilisateur à l'aide de fonctionnalités intégrées à l'application. Les développeurs peuvent inclure plusieurs balises <intent> dans un élément capability. L'Assistant tente d'exécuter une requête utilisateur en s'appuyant sur le premier <intent> d'une capability pour laquelle tous les paramètres requis sont fournis.

Attributs :

• android:action : type d'Action de l'intent. La valeur par défaut est ACTION_VIEW.
• android:targetClass : classe d'activité cible, par exemple "com.example.food.OrderActivity"
• android:targetPackage : package contenant la classe d'activité cible, par exemple "com.example.food"
• android:data : ce champ est remplacé par <url-template> lorsque cette balise est déclarée dans l'intent.

Remarque : android:targetClass et android:targetPackage sont obligatoires pour les intents qui ciblent explicitement une activité. L'attribut android:data peut également être utilisé pour définir une activité cible. Pour en savoir plus, reportez-vous à la section Options de traitement des intents.

<url-template>

Modèle permettant de créer un URI de lien profond à ouvrir sur l'appareil. Celui-ci peut être développé avec des paramètres d'intent intégrés si tous les paramètres requis sont disponibles. Des exemples de modèle d'URL HTTP sont disponibles dans l'article Wikipédia sur les modèles d'URL. Le format utilisé respecte la spécification de modèle d'URI RFC6570.

Voici quelques exemples de valeurs de modèles d'URL :

Modèle	Valeurs	Valeur développée
https://example.com/test{?foo,bar}	"foo": "123" "bar": "456"	https://example.com/test?foo=123&bar=456
https://example.com/test?utm_campaign=appactions{&foo,bar}	"foo": "123" "bar": "456"	https://example.com/test?utm_campaign=appactions&foo=123&bar=456
https://example.com/test?utm_campaign=appactions{#foo}	"foo": "123"	https://example.com/test?utm_campaign=appactions#foo=123
myapp://example/{foo}	"foo": "123"	myapp://example/123

Pour en savoir plus sur la configuration des modèles d'URL, consultez la section Modèles d'URL dans le traitement.

Remarque : <url-template> constitue une méthode facultative permettant de cibler une activité dans un intent. Pour en savoir plus, reportez-vous à la section Options de traitement des intents.

<extra>

Définit les données supplémentaires d'un intent. En ce qui concerne les Actions dans les applications, ce champ sert uniquement à activer l'appel de l'application au premier plan pour un élément capability.

<parameter>

Mappe un paramètre d'intent intégré avec des valeurs des paramètres d'intent. Pour en savoir plus, consultez la section Données et correspondance des paramètres.

Attributs :

• android:name : nom du paramètre d'intent intégré à associer à ce paramètre d'intent. Ce nom doit être un champ feuille du paramètre d'intent intégré (par exemple, foodObservation.aboutFood.name).
• android:key : clé définie par les développeurs pour une valeur de paramètre d'intent intégré (par exemple : contact_name pour le paramètre d'intent intégré message.recipient.name).
• android:mimeType : type MIME du paramètre, par exemple text/*. Ce champ n'est obligatoire que pour les paramètres d'intents personnalisés.
• android:required : indique si la requête de l'utilisateur doit inclure ce paramètre pour que cet intent soit utilisé aux fins de traitement. Lorsque le paramètre est indisponible, l'Assistant tente de répondre à la requête utilisateur à l'aide de l'intent suivant défini pour l'élément capability.

<data>

Associe un inventaire Web à un parameter.

Attribut :

• android:pathPattern : format d'URL entity à renvoyer via l'inventaire Web. Cet attribut accepte deux caractères génériques :

  • * : un astérisque correspond à une séquence de zéro ou plusieurs occurrences du caractère qui précède immédiatement.

  • .* : un point suivi d'un astérisque correspond à n'importe quelle séquence de zéro ou plusieurs caractères.

  • Les caractères d'échappement ne sont nécessaires que pour les valeurs littérales * et \. Vous pouvez les échapper respectivement à l'aide de \\* et \\\\.

<shortcut-fulfillment>

Spécifie qu'un intent défini dans un raccourci d'inventaire intégré pour un paramètre donné doit être utilisé pour le traitement. Pour en savoir plus, consultez Traitement à l'aide d'intents de raccourcis.

<parameter> (pour <shortcut-fulfillment>)

Attribut facultatif mappant un seul paramètre d'intent intégré au traitement du raccourci d'inventaire intégré. Pour en savoir plus, consultez Traitement à l'aide d'intents de raccourcis.

Attribut :

• android:name : nom du paramètre d'intent intégré à associer au traitement de raccourci d'inventaire intégré. Ce nom doit être un champ feuille du paramètre d'intent intégré (par exemple, menuItem.name).

<slice>

Permet à l'Assistant d'intégrer le résultat d'une requête correspondant à cet élément capability en tant que segment d'application Android. Pour en savoir plus, consultez la rubrique Intégrer les actions dans les applications avec les segments d'application Android.

Schéma de raccourci

Le tableau suivant décrit les attributs des éléments shortcut utilisés pour activer les fonctionnalités des Actions dans les applications. Lorsque vous ajoutez une balise, tous ses attributs sont obligatoires, sauf s'ils sont marqués comme "facultatifs".

Balise shortcuts.xml	Contenue dans	Attributs
<shortcut>	<shortcuts>	android:shortcutId android:shortcutShortLabel android:shortcutLongLabel (facultatif) android:icon (facultatif)
<intent>	<shortcut>	android:action android:targetClass (facultatif) android:targetPackage (facultatif) android:data (facultatif)
<capability-binding>	<shortcut>	android:key
<parameter-binding>	<capability-binding>	android:key (facultatif) android:value
<extra>	<shortcut>	android:name (facultatif) android:value S'applique uniquement à la correspondance des paramètres d'énumération.

Description du schéma de raccourci

Cette section décrit les éléments de schéma shortcut.

<shortcut>

Balise <shortcut> Android définie dans shortcuts.xml avec certains attributs pertinents pour les actions dans les applications. Les valeurs de chaîne des champs shortcutShortLabel et shortcutLongLabel sont référencées via les ressources de chaîne de l'APK.

Attributs :

• android:shortcutId : identifiant de ce raccourci.
• android:shortcutShortLabel : ressource de chaîne représentant une brève expression de raccourci. Par exemple, "@string/callDavidShort" représentant la valeur "Appelle David".
• android:shortcutLongLabel : ressource de chaîne représentant une longue expression de raccourci. Par exemple, "@string/callDavidLong" représentant la valeur "Passe un appel audio à David".

<intent>

Intent Android associé à ce raccourci. Cet intent s'exécute lorsqu'un utilisateur lance ce raccourci par commande vocale ou tactile.

Les attributs d'intent pour shortcut sont identiques aux attributs d'intent pour capability.

<capability-binding>

Associe un élément shortcut à un élément capability d'Actions dans les applications. L'ajout de celui-ci à un élément shortcut permet son exécution vocale à l'aide de l'Assistant.

Attributs :

• android:key : attribut android:name de la capability à laquelle ce shortcut est lié. Exemple : actions.intent.CREATE_TAXI_RESERVATION.

<parameter-binding>

Attribut facultatif qui associe un élément shortcut à un paramètre unique d'un élément capability d'Actions dans les applications. Lorsqu'un élément parameter-binding est défini pour un élément shortcut, le raccourci peut être utilisé en vue de fournir une entité d'inventaire intégré à un paramètre d'intent intégré. Pour en savoir plus, consultez la section Inventaire intégré pour les actions dans les applications.

Attributs :

• android:key : nom du paramètre d'intent intégré d'élément capability auquel associer ce raccourci. Exemple : foodObservation.aboutFood.name.
• android:value : valeur pour entity. Il peut s'agir d'un élément entity unique ou d'une liste de ressources.

<extra>

Données du bundle extra pour le raccourci. sameAs est la seule donnée pertinente pour les éléments shortcut des actions dans les applications. L'URL sameAs se rapporte à une page Web de référence, qui identifie l'entité sans aucune ambiguïté. Permet de spécifier une valeur d'énumération si et seulement si le type de paramètre d'intent est un sous-type de schema.org/Enumeration. Ceci est obligatoire pour les champs de paramètre dont les types sont des sous-types de schema.org/Enumeration (par exemple : MealTypeBreakfast).

Attributs :

• android:key : la valeur prise en charge pour Actions dans les applications est sameAs
• android:value : valeur de l'URL sameAs

Pour en savoir plus, consultez la section Mettre en correspondance des valeurs de paramètres énumérées.

Options de traitement des intents

Vous devez définir des éléments intent dans une balise <capability> pour déclarer la manière dont l'Assistant répond aux commandes vocales de l'utilisateur qui correspondent à cette capacité (c'est-à-dire comment il les traite). Il existe plusieurs façons de configurer la manière dont un intent lance une destination de traitement dans votre application, en fonction de la structure de navigation de votre application.

Les options de traitement suivantes sont disponibles :

• Intents explicites : lancez un composant d'application spécifique en définissant les attributs targetClass et targetPackage pour l'intent. Cette méthode est recommandée pour le traitement des actions dans les applications.

• Liens profonds : lancez des destinations d'application à l'aide de liens profonds Android en définissant une balise <url-template> dans l'élément intent. Cette méthode est utile si la navigation dans votre application repose déjà sur des liens profonds.

• Données d'intent : vous pouvez fournir un URI de traitement dans l'attribut intent android:data. Ce champ est écrasé par les données <url-template> si cette balise est également définie dans l'intent.

Remarque : Ces options de traitement s'excluent mutuellement. Par exemple, si vous définissez un intent explicite à l'aide des attributs targetClass et targetPackage, il n'est pas nécessaire de définir également une balise <url-template>.

Données et correspondance des paramètres

Par défaut, l'Assistant envoie à votre application les paramètres d'intent intégré extraits de la requête de l'utilisateur en tant que données extra de l'intent Android défini dans l'élément capability.

Vous pouvez également déclarer une balise <url-template> dans l'élément capability contenant des espaces réservés pour les paramètres dynamiques. Ce modèle est mappé vers l'une de vos activités Android, à l'aide d'une URL de liens vers une application, d'un schéma personnalisé ou d'une URL basée sur l'intent.

Utiliser des extras d'intent

L'exemple suivant illustre un intent explicite défini pour le traitement d'un élément capability :

<capability android:name="actions.intent.ORDER_MENU_ITEM">
  <intent
    android:targetPackage="com.example.myapp"
    android:targetClass="com.example.myapp.OrderMenuItemActivity">
    <parameter android:name="menuItem.name" android:key="menu" />
  </intent>
</capability>

Dans cet exemple, pour une requête utilisateur telle que "Hey Google, commande un latte sur ExempleAppli", l'application en question reçoit un intent qui appelle le composant : targetPackage targetClass. Celui-ci reçoit un Extra avec key = ”menu”, value = ”latte”.

Utiliser un modèle d'URL pour les liens profonds Android

Si votre application gère déjà les URL liées aux applications, vous pouvez utiliser des paramètres dynamiques pour définir une balise <url-template> dans l'intent, ce qui vous permet de générer des liens profonds Android aux fins de traitement. L'exemple suivant définit une balise <url-template> :

<capability android:name="actions.intent.ORDER_MENU_ITEM">
  <intent>
    <url-template android:value="myapp://order{?menu}" />
    <parameter android:name="menuItem.name" android:key="menu" />
  </intent>
</capability>

Ici, pour une requête utilisateur telle que "Hey Google, commande un latte sur ExempleAppli", l'application reçoit l'URL générée : "myapp://order?menu".=latte".

Remarque : Lorsque l'URL générée pour un intent utilisant une balise <url-template> aux fins de traitement est associée à l'application et que des filtres d'intent pertinents sont ajoutés dans le fichier de ressources AndroidManifest.xml, vous n'avez pas besoin de définir les attributs targetClass et targetActivity dans l'intent.

Pour mapper le paramètre d'intent intégré à une position dans votre URL, utilisez l'attribut android:name de la balise <parameter>. Il correspond à la valeur android:key du modèle d'URL que vous souhaitez remplacer par les informations de l'utilisateur. La valeur android:key doit être présente dans votre <url-template> et entourée d'accolades ({}).

Assurer la correspondance des valeurs de paramètres énumérées

Certains paramètres d'intent intégré fournissent des valeurs énumérées à votre intent de traitement, à l'image des valeurs textuelles prises en charge de l'intent intégré RECORD_FOOD_OBSERVATION. Pour ces paramètres, l'Assistant associe la requête de l'utilisateur ("petit déjeuner") à une entité dont la valeur sameAs correspond à l'URL du schéma d'énumération (https://schema.googleapis.com/MealTypeBreakfast). de Google. Afin d'associer des valeurs énumérées pour une entity compatible, vous devez déclarer une association sameAs dans votre élément shortcut. L'exemple suivant illustre une association sameAs pour un raccourci d'entité intégrée :

<shortcut android:shortcutId="meal_breakfast" >
    <capability-binding android:key="actions.intent.RECORD_FOOD_OBSERVATION">
        <parameter-binding android:key="foodObservation.forMeal" />
    </capability-binding>
    <extra
        android:key="sameAs"
        android:value="http://schema.googleapis.com/MealTypeBreakfast" />
</shortcut>

<capability android:name="actions.intent.RECORD_FOOD_OBSERVATION">
  <intent targetPackage="com.example.app" targetClass="com.example.app.Class">
    <parameter android:name="foodObservation.forMeal" android:key="for_meal" />
  </intent>
</capability>

Dans notre exemple, lorsque la capacité RECORD_FOOD_OBSERVATION déclenche une correspondance pour le type de repas "petit déjeuner", les éléments Extra suivants sont envoyés avec l'intent de traitement :

• key = "for_meal"
• value = "meal_breakfast"

Fonctionnalités

Les fonctionnalités d'Actions dans les applications suivantes sont disponibles dans shortcuts.xml.

Inventaire intégré pour les actions dans les applications

Pour certains paramètres d'intent intégré, les raccourcis peuvent servir à guider l'extraction d'entités vers un ensemble d'entités prises en charge (l'inventaire intégré) spécifiées dans shortcuts.xml. Pour en savoir plus, consultez la page dédiée à l'Inventaire intégré.

Inventaire Web pour les actions dans les applications

Pour certains intents intégrés, vous pouvez utiliser un inventaire Web comme méthode de génération d'URL pour le traitement. L'inventaire Web utilise votre site Web pour découvrir les URL de traitement des actions dans les applications. Cette fonctionnalité est particulièrement utile lorsque vous disposez d'une forte présence sur Internet et que les liens profonds intégrés à votre application sont organisés autour d'un contenu Web accessible au public.

Attention : L'inventaire Web renvoie des URL basées sur l'élément pathPattern renseigné par vos soins, étant donné que ces URL existent et sont classées sur Internet. Si votre application n'est pas en mesure d'analyser les URL de ce format, l'action dans l'application ne se déclenche pas correctement.

Pour en savoir plus, consultez la section Inventaire Web.

Remarque : L'inventaire Web n'accepte pas plus d'un élément parameter par intent de traitement de capacité.

Intents personnalisés

Vous pouvez déclarer des intents personnalisés dans shortcuts.xml pour activer par commande vocale des fonctionnalités applicatives qui ne correspondent pas aux intents intégrés disponibles. Les intents personnalisés, qui présente pourtant des fonctions similaires à celles d'une définition d'intent intégré, nécessitent deux attributs supplémentaires dans shortcuts.xml :

• app:queryPatterns : ressource de tableau qui déclare les différents modèles de requête pour un intent personnalisé.

• android:mimeType : type de paramètre d'un intent personnalisé. Ce champ n'est pas obligatoire pour les intents intégrés, où le type de paramètre est connu. En ce qui concerne les paramètres d'intent personnalisés, un type sémantique pris en charge doit être déclaré.

Pour en savoir plus, consultez la section Intents personnalisés.