Products: getAppRestrictionsSchema

Recupera o esquema que define as propriedades configuráveis para este produto. Todos os produtos têm um esquema, mas ele pode estar vazio se nenhuma configuração gerenciada tiver sido definida. Esse esquema pode ser usado para preencher uma interface que permite que um administrador configure o produto. Para aplicar uma configuração gerenciada com base no esquema recebido usando essa API, consulte Configurações gerenciadas pelo Google Play.

Solicitação

Solicitação HTTP

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

Parâmetros

Nome do parâmetro Valor Descrição
Parâmetros de caminho
enterpriseId string O ID da empresa.
productId string O ID do produto.
Parâmetros de consulta opcionais
language string A tag BCP47 para o idioma preferido do usuário (por exemplo, "en-US", "de").

Autorização

Esta solicitação requer autorização com o seguinte escopo:

Escopo
https://www.googleapis.com/auth/androidenterprise

Para mais informações, consulte a página de autenticação e autorização.

Corpo da solicitação

Não forneça um corpo de solicitação com este método.

Resposta

Se for bem-sucedido, esse método retornará um corpo de resposta com esta estrutura:

{
  "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)
      ]
    }
  ]
}
Nome da propriedade Valor Descrição Observações
restrictions[] list O conjunto de restrições que compõem este esquema.
restrictions[].key string A chave exclusiva que o produto usa para identificar a restrição, por exemplo, "com.google.android.gm.fieldname".
restrictions[].title string O nome da restrição.
restrictions[].restrictionType string O tipo de restrição.

Os valores aceitáveis são:
  • "bool"
  • "bundle"
  • "bundleArray"
  • "choice"
  • "hidden"
  • "integer"
  • "multiselect"
  • "string"
restrictions[].description string Uma descrição mais longa da restrição, com mais detalhes sobre o que ela afeta.
restrictions[].entry[] list Para restrições choice ou multiselect, a lista de nomes legíveis das entradas possíveis.
restrictions[].entryValue[] list Para restrições choice ou multiselect, a lista de valores legíveis por máquina das entradas possíveis. Esses valores precisam ser usados na configuração, como um único valor string para uma restrição choice ou em um stringArray para uma restrição multiselect.
restrictions[].defaultValue nested object O valor padrão da restrição. As restrições bundle e bundleArray nunca têm um valor padrão.
restrictions[].defaultValue.type string O tipo de valor que está sendo fornecido.

Os valores aceitáveis são:
  • "bool"
  • "bundle"
  • "bundleArray"
  • "choice"
  • "hidden"
  • "integer"
  • "multiselect"
  • "string"
restrictions[].defaultValue.valueBool boolean O valor booleano - só estará presente se o tipo for booleano.
restrictions[].defaultValue.valueString string O valor da string: estará presente para os tipos string, choice e oculto.
restrictions[].defaultValue.valueInteger integer O valor inteiro: só vai estar presente se o tipo for um número inteiro.
restrictions[].defaultValue.valueMultiselect[] list A lista de valores de string: só vai estar presente se o tipo for de seleção múltipla.
restrictions[].nestedRestriction[] list Para restrições bundle ou bundleArray, é a lista de restrições aninhadas. Uma restrição bundle é sempre aninhada em uma restrição bundleArray, e uma restrição bundleArray tem no máximo dois níveis de profundidade.
kind string Descontinuado.