Products: getAppRestrictionsSchema

Récupère le schéma qui définit les propriétés configurables pour ce produit. Tous les produits ont un schéma, mais celui-ci peut être vide si aucune configuration gérée n'a été définie. Ce schéma peut être utilisé pour renseigner une UI permettant à un administrateur de configurer le produit. Pour appliquer une configuration gérée en fonction du schéma obtenu à l'aide de cette API, consultez Configurations gérées via Play.

Demande

Requête HTTP :

GET https://www.googleapis.com/androidenterprise/v1/enterprises/enterpriseId/products/productId/appRestrictionsSchema

Paramètres

Nom du paramètre Valeur Description
Paramètres de chemin d'accès
enterpriseId string ID de l'entreprise.
productId string ID du produit.
Paramètres de requête facultatifs
language string Tag BCP47 pour la langue préférée de l'utilisateur (par exemple, "en-US" ou "de")

Autorisation

Cette requête nécessite une autorisation dont la portée est la suivante:

Portée
https://www.googleapis.com/auth/androidenterprise

Pour en savoir plus, consultez la page Authentification et autorisation.

Corps de la requête

Ne spécifiez pas de corps de requête pour cette méthode.

Réponse

Si la requête aboutit, cette méthode renvoie un corps de réponse présentant la structure suivante :

{
  "kind": string,
  "restrictions": [
    {
      "key": string,
      "title": string,
      "restrictionType": string,
      "description": string,
      "entry": [
        string
      ],
      "entryValue": [
        string
      ],
      "defaultValue": {
        "type": string,
        "valueBool": boolean,
        "valueString": string,
        "valueInteger": integer,
        "valueMultiselect": [
          string
        ]
      },
      "nestedRestriction": [
        (AppRestrictionsSchemaRestriction)
      ]
    }
  ]
}
Nom de propriété Valeur Description Remarques
restrictions[] list Ensemble de restrictions qui composent ce schéma.
restrictions[].key string Clé unique utilisée par le produit pour identifier la restriction, par exemple "com.google.android.gm.fieldname".
restrictions[].title string Nom de la restriction.
restrictions[].restrictionType string Type de restriction.

Les valeurs autorisées sont les suivantes :
  • "bool"
  • "bundle"
  • "bundleArray"
  • "choice"
  • "hidden"
  • "integer"
  • "multiselect"
  • "string"
restrictions[].description string Description plus détaillée de la restriction indiquant en détail les conséquences de cette restriction
restrictions[].entry[] list Pour les restrictions choice ou multiselect, la liste des noms lisibles des entrées possibles.
restrictions[].entryValue[] list Pour les restrictions choice ou multiselect, la liste des valeurs lisibles par l'ordinateur des entrées possibles. Ces valeurs doivent être utilisées dans la configuration, soit en tant que valeur string unique pour une restriction choice, soit sous forme de valeur stringArray pour une restriction multiselect.
restrictions[].defaultValue nested object Valeur par défaut de la restriction. Les restrictions bundle et bundleArray n'ont jamais de valeur par défaut.
restrictions[].defaultValue.type string Type de la valeur fournie.

Les valeurs autorisées sont les suivantes :
  • "bool"
  • "bundle"
  • "bundleArray"
  • "choice"
  • "hidden"
  • "integer"
  • "multiselect"
  • "string"
restrictions[].defaultValue.valueBool boolean Valeur booléenne. Elle n'est présente que si le type est de type bool.
restrictions[].defaultValue.valueString string Valeur de la chaîne : elle sera présente pour les types chaîne, choix et masqués.
restrictions[].defaultValue.valueInteger integer Valeur entière : elle ne sera présente que si le type est entier.
restrictions[].defaultValue.valueMultiselect[] list Liste des valeurs de chaîne. Elle ne sera présente que si le type est à sélections multiples.
restrictions[].nestedRestriction[] list Pour les restrictions bundle ou bundleArray, la liste des restrictions imbriquées. Une restriction bundle est toujours imbriquée dans une restriction bundleArray, et une restriction bundleArray ne peut pas dépasser deux niveaux.
kind string Obsolète.