REST Resource: customers.policySchemas

Recurso: PolicySchema

Recurso que representa um esquema de política.

Representação JSON 
{
  "name": string,
  "policyDescription": string,
  "additionalTargetKeyNames": [
    {
      object (AdditionalTargetKeyName)
    }
  ],
  "definition": {
    object (FileDescriptorProto)
  },
  "fieldDescriptions": [
    {
      object (PolicySchemaFieldDescription)
    }
  ],
  "accessRestrictions": [
    string
  ],
  "notices": [
    {
      object (PolicySchemaNoticeDescription)
    }
  ],
  "supportUri": string,
  "schemaName": string,
  "validTargetResources": [
    enum (TargetResource)
  ],
  "policyApiLifecycle": {
    object (PolicyApiLifecycle)
  },
  "categoryTitle": string,
  "supportedPlatforms": [
    enum (Platform)
  ]
}
Campos
name

string

Formato: name=customers/{customer}/policySchemas/{schema_namespace}
policyDescription

string

Apenas saída. Descrição sobre o esquema de política para consumo de usuários.
additionalTargetKeyNames[]

object (AdditionalTargetKeyName)

Apenas saída. Outros nomes de chave que serão usados para identificar o destino do valor da política. Ao especificar um policyTargetKey, cada uma das chaves extras especificadas aqui terá que ser incluída no mapa additionalTargetKeys.
definition

object (FileDescriptorProto)

Definição do esquema usando o descritor proto.
fieldDescriptions[]

object (PolicySchemaFieldDescription)

Apenas saída. Descrição detalhada de cada campo que faz parte do esquema. Os campos são sugeridos para serem exibidos pela ordem nesta lista, não por número de campo.
accessRestrictions[]

string

Apenas saída. Restrições de acesso específicas relacionadas a esta política.
notices[]

object (PolicySchemaNoticeDescription)

Apenas saída. Mensagens de aviso especiais relacionadas à configuração de determinados valores em determinados campos no esquema.
supportUri

string

Apenas saída. URI para o artigo de suporte relacionado a este esquema.
schemaName

string

Apenas saída. O nome totalmente qualificado do esquema de política. Esse valor é usado para preencher o campo policySchema em PolicyValue ao chamar BatchInheritOrgUnitPolicies BatchModifyOrgUnitPolicies BatchModifyGroupPolicies ou BatchDeleteGroupPolicies.
validTargetResources[]

enum (TargetResource)

Apenas saída. Informações sobre os recursos de destino aplicáveis à política.
policyApiLifecycle

object (PolicyApiLifecycle)

Apenas saída. Informações atuais do ciclo de vida.
categoryTitle

string

Título da categoria a que uma configuração pertence.
supportedPlatforms[]

enum (Platform)

Apenas saída. A lista indica que a política será aplicada apenas a dispositivos/usuários nessas plataformas.

AdditionalTargetKeyName

Outros nomes de chave que serão usados para identificar o destino do valor da política.

Representação JSON 
{
  "key": string,
  "keyDescription": string
}
Campos
key

string

Nome da chave.
keyDescription

string

Descrição da chave.

FileDescriptorProto

Descreve um arquivo .proto completo.

Representação JSON 
{
  "name": string,
  "package": string,
  "messageType": [
    {
      object (DescriptorProto)
    }
  ],
  "enumType": [
    {
      object (EnumDescriptorProto)
    }
  ],
  "syntax": string,
}
Campos
name

string

nome do arquivo, relativo à raiz da árvore de origem
package

string

Por exemplo: "foo", "foo.bar" etc.
messageType[]

object (DescriptorProto)

Todas as definições de nível superior neste arquivo.
enumType[]

object (EnumDescriptorProto)
syntax

string

A sintaxe do arquivo proto. Os valores aceitos são "proto2", "proto3" e "editions".

Se edition estiver presente, esse valor precisará ser "editions".

DescriptorProto

Descreve um tipo de mensagem.

Representação JSON 
{
  "name": string,
  "field": [
    {
      object (FieldDescriptorProto)
    }
  ],
  "nestedType": [
    {
      object (DescriptorProto)
    }
  ],
  "enumType": [
    {
      object (EnumDescriptorProto)
    }
  ],
  "oneofDecl": [
    {
      object (OneofDescriptorProto)
    }
  ]
}
Campos
name

string
field[]

object (FieldDescriptorProto)
nestedType[]

object (DescriptorProto)
enumType[]

object (EnumDescriptorProto)
oneofDecl[]

object (OneofDescriptorProto)

FieldDescriptorProto

Descreve um campo em uma mensagem.

Representação JSON 
{
  "name": string,
  "number": integer,
  "label": enum (Label),
  "type": enum (Type),
  "typeName": string,
  "defaultValue": string,
  "oneofIndex": integer,
  "jsonName": string,
  "proto3Optional": boolean
}
Campos
name

string
number

integer
label

enum (Label)
type

enum (Type)

Se typeName estiver definido, não precisará ser definido. Se este e typeName estiverem definidos, deverá ser TYPE_ENUM, TYPE_MESSAGE ou TYPE_GROUP.
typeName

string

Para tipos de mensagem e enum, esse é o nome do tipo. Se o nome começar com '.', ele é totalmente qualificado. Caso contrário, as regras de escopo como C++ são usadas para encontrar o tipo, ou seja, primeiro os tipos aninhados nesta mensagem são pesquisados e depois dentro do pai até o namespace raiz.
defaultValue

string

Para tipos numéricos, contém a representação de texto original do valor. Para booleanos, "true" ou "false". Para strings, contém o conteúdo de texto padrão (sem escape). Para bytes, contém o valor de escape C. Todos os bytes >= 128 têm escape.
oneofIndex

integer

Se definido, fornece o índice de oneof na lista oneofDecl do tipo que o contém. Este campo faz parte do oneof.
jsonName

string

Nome JSON deste campo. O valor é definido pelo compilador de protocolos. Se o usuário tiver definido um "jsonName" neste campo, o valor dela será usado. Caso contrário, ele será deduzido do nome do campo convertendo-o em camelCase.
proto3Optional

boolean

Se verdadeiro, será um proto3 "opcional". Quando um campo proto3 é opcional, ele rastreia a presença independentemente do tipo de campo.

Quando proto3Optional é verdadeiro, esse campo precisa pertencer a um oneof para sinalizar aos clientes antigos do proto3 que a presença é rastreada para esse campo. Esse oneof é conhecido como oneof, e esse campo precisa ser o único membro (cada campo opcional proto3 recebe seu próprio oneof sintético). Um oneof sintético existe apenas no descritor e não gera nenhuma API. O oneofs sintético precisa ser pedido depois de "real" oneofs.

Nos campos de mensagem, o proto3Optional não cria nenhuma alteração semântica, já que campos de mensagem não repetidos sempre rastreiam a presença. No entanto, ainda indica os detalhes semânticos que indicam se o usuário escreveu "opcional" ou não. Isso pode ser útil para percorrer o arquivo .proto. Para fins de consistência, também fornecemos aos campos de mensagem um oneof sintético, mesmo que não seja obrigatório rastrear a presença. Isso é ainda mais importante porque o analisador não consegue determinar se um campo é uma mensagem ou um tipo enumerado. Por isso, ele sempre precisa criar um oneof sintético.

Os campos opcionais do Proto2 não definem essa flag, porque já indicam opcionais com LABEL_OPTIONAL.

Rótulo

Enums
LABEL_OPTIONAL 0 é reservado para erros
LABEL_REPEATED
LABEL_REQUIRED O rótulo obrigatório só é permitido no proto2. No proto3 e no Editions, isso é explicitamente proibido. Nas edições, o recurso fieldPresence pode ser usado para conseguir esse comportamento.

Tipo

Enums
TYPE_DOUBLE 0 é reservado para erros. A ordem é estranha por motivos históricos.
TYPE_FLOAT
TYPE_INT64 Não codificado em ZigZag. Números negativos têm 10 bytes. Use TYPE_SINT64 se forem prováveis valores negativos.
TYPE_UINT64
TYPE_INT32 Não codificado em ZigZag. Números negativos têm 10 bytes. Use TYPE_SINT32 se forem prováveis valores negativos.
TYPE_FIXED64
TYPE_FIXED32
TYPE_BOOL
TYPE_STRING
TYPE_GROUP Agregado delimitado por tag. O tipo de grupo foi descontinuado e não recebe suporte após o proto2. No entanto, as implementações do Proto3 ainda precisam ser capazes de analisar o formato de representação do grupo e tratar os campos do grupo como campos desconhecidos. Nas edições, o formato de conexão do grupo pode ser ativado com o recurso messageEncoding.
TYPE_MESSAGE Agregado delimitado por comprimento.
TYPE_BYTES Novidades na versão 2.
TYPE_UINT32
TYPE_ENUM
TYPE_SFIXED32
TYPE_SFIXED64
TYPE_SINT32 Usa codificação ZigZag.
TYPE_SINT64 Usa codificação ZigZag.

EnumDescriptorProto

Descreve um tipo de enumeração.

Representação JSON 
{
  "name": string,
  "value": [
    {
      object (EnumValueDescriptorProto)
    }
  ]
}
Campos
name

string
value[]

object (EnumValueDescriptorProto)

EnumValueDescriptorProto

Descreve um valor dentro de uma enumeração.

Representação JSON 
{
  "name": string,
  "number": integer
}
Campos
name

string
number

integer

OneofDescriptorProto

Descreve um oneof.

Representação JSON 
{
  "name": string
}
Campos
name

string

PolicySchemaFieldDescription

Fornece informações detalhadas sobre um campo específico que faz parte de um PolicySchema.

Representação JSON 
{
  "field": string,
  "description": string,
  "inputConstraint": string,
  "knownValueDescriptions": [
    {
      object (PolicySchemaFieldKnownValueDescription)
    }
  ],
  "nestedFieldDescriptions": [
    {
      object (PolicySchemaFieldDescription)
    }
  ],
  "fieldDependencies": [
    {
      object (PolicySchemaFieldDependencies)
    }
  ],
  "requiredItems": [
    {
      object (PolicySchemaRequiredItems)
    }
  ],
  "defaultValue": value,
  "name": string,
  "fieldDescription": string,
  "fieldConstraints": {
    object (FieldConstraints)
  }
}
Campos
field

string

Apenas saída. Nome do campo associado a essa descrição.
description
(deprecated)

string

Obsoleto. Use name e fieldDescription. A descrição do campo.
inputConstraint

string

Apenas saída. Quaisquer restrições de entrada associadas aos valores do campo.
knownValueDescriptions[]

object (PolicySchemaFieldKnownValueDescription)

Apenas saída. Se o campo tiver um conjunto de valores conhecidos, ele fornecerá uma descrição desses valores.
nestedFieldDescriptions[]

object (PolicySchemaFieldDescription)

Apenas saída. Fornece a descrição dos campos aninhados nesse campo se o campo for um tipo de mensagem que define vários campos. Os campos são sugeridos para serem exibidos pela ordem nesta lista, não por número de campo.
fieldDependencies[]

object (PolicySchemaFieldDependencies)

Apenas saída. Fornece uma lista de campos e valores. Pelo menos um dos campos precisa ter o valor correspondente para que esse campo seja configurado.
requiredItems[]

object (PolicySchemaRequiredItems)

Apenas saída. Fornece uma lista de campos que precisam ser definidos se esse campo tiver um determinado valor.
defaultValue

value (Value format)

Apenas saída. Padrão do cliente se a política não for definida.
name

string

Apenas saída. Nome do campo.
fieldDescription

string

Apenas saída. A descrição do campo.
fieldConstraints

object (FieldConstraints)

Apenas saída. Informações sobre restrições de entrada associadas aos valores do campo.

PolicySchemaFieldKnownValueDescription

Fornece informações detalhadas sobre um valor conhecido que é permitido para um campo específico em um PolicySchema.

Representação JSON 
{
  "value": string,
  "description": string,
  "fieldDependencies": [
    {
      object (PolicySchemaFieldDependencies)
    }
  ]
}
Campos
value

string

Apenas saída. A representação da string do valor que pode ser definido para o campo.
description

string

Apenas saída. Descrição adicional para esse valor.
fieldDependencies[]

object (PolicySchemaFieldDependencies)

Apenas saída. Condições de campo necessárias para que esse valor seja válido.

PolicySchemaFieldDependencies

O campo e o valor que ele precisa ter para que outro campo seja definido.

Representação JSON 
{
  "sourceField": string,
  "sourceFieldValue": string
}
Campos
sourceField

string

O campo de origem do qual este campo depende.
sourceFieldValue

string

O valor que o campo de origem precisa ter para que este campo possa ser definido.

PolicySchemaRequiredItems

Os campos que se tornarão obrigatórios com base no valor deste campo.

Representação JSON 
{
  "fieldConditions": [
    string
  ],
  "requiredFields": [
    string
  ]
}
Campos
fieldConditions[]

string

São os valores do campo que provocam a aplicação obrigatória de campo. Um fieldConditions vazio implica que qualquer valor atribuído a esse campo provocará a aplicação obrigatória do campo.
requiredFields[]

string

Os campos que são obrigatórios como consequência das condições dos campos.

FieldConstraints

Informações sobre restrições de intervalo.

Representação JSON 
{
  "numericRangeConstraint": {
    object (NumericRangeConstraint)
  },
  "uploadedFileConstraints": {
    object (UploadedFileConstraints)
  }
}
Campos
numericRangeConstraint

object (NumericRangeConstraint)

O intervalo permitido para campos numéricos.
uploadedFileConstraints

object (UploadedFileConstraints)

Restrições no arquivo enviado por upload de uma política de arquivos. Se presente, esta política requer um URL que pode ser buscado fazendo upload de um arquivo com as restrições especificadas neste proto.

NumericRangeConstraint

Uma restrição nos limites superior e/ou inferior, com pelo menos um definido.

Representação JSON 
{
  "minimum": string,
  "maximum": string
}
Campos
minimum

string (int64 format)

Valor mínimo.
maximum

string (int64 format)

Valor máximo.

UploadedFileConstraints

Restrições no arquivo enviado por upload de uma política de arquivos.

Representação JSON 
{
  "supportedContentTypes": [
    enum (ContentType)
  ],
  "sizeLimitBytes": string
}
Campos
supportedContentTypes[]

enum (ContentType)

Tipos de arquivo que podem ser enviados para uma configuração.
sizeLimitBytes

string (int64 format)

É o limite de tamanho em bytes dos arquivos enviados por upload para uma configuração.

ContentType

Tipos de arquivo que podem ser enviados para uma configuração.

Enums
CONTENT_TYPE_UNSPECIFIED Tipo de conteúdo não especificado.
CONTENT_TYPE_PLAIN_TEXT Texto simples.
CONTENT_TYPE_HTML HTML.
CONTENT_TYPE_IMAGE_JPEG JPEG.
CONTENT_TYPE_IMAGE_GIF GIF.
CONTENT_TYPE_IMAGE_PNG PNG.
CONTENT_TYPE_JSON JSON.
CONTENT_TYPE_ZIP ZIP.
CONTENT_TYPE_GZIP pelo GZIP.
CONTENT_TYPE_CSV CSV.
CONTENT_TYPE_YAML YAML.
CONTENT_TYPE_IMAGE_WEBP WEBP.

PolicySchemaNoticeDescription

Mostra mensagens de aviso especiais relacionadas a um valor específico em um campo que faz parte de um PolicySchema.

Representação JSON 
{
  "field": string,
  "noticeValue": string,
  "noticeMessage": string,
  "acknowledgementRequired": boolean
}
Campos
field

string

Apenas saída. Nome do campo associado ao aviso.
noticeValue

string

Apenas saída. O valor do campo que tem um aviso. Ao definir o campo com esse valor, talvez o usuário precise confirmar a mensagem de aviso para que o valor seja definido.
noticeMessage

string

Apenas saída. A mensagem de aviso associada ao valor do campo.
acknowledgementRequired

boolean

Apenas saída. Se o usuário precisa confirmar a mensagem de aviso antes de o valor ser definido.

TargetResource

Tipos de recursos de destino

Enums
TARGET_RESOURCE_UNSPECIFIED Recurso de destino não especificado.
ORG_UNIT Recurso de destino da unidade organizacional.
GROUP recurso de destino de grupo.

PolicyApiLifecycle

Informações do ciclo de vida.

Representação JSON 
{
  "deprecatedInFavorOf": [
    string
  ],
  "scheduledToDeprecatePolicies": [
    string
  ],
  "policyApiLifecycleStage": enum (PolicyApiLifecycleEnum),
  "description": string,
  "endSupport": {
    object (Date)
  }
}
Campos
deprecatedInFavorOf[]

string

Caso esta política tenha sido descontinuada e substituída por outra, os namespaces totalmente qualificados das novas políticas serão mostrados na PolicyAPI. Só poderá ser definido se policyApiLifecycleStage for API_DEPRECATED.
scheduledToDeprecatePolicies[]

string

Os namespaces totalmente qualificados das políticas antigas que serão descontinuadas devido à introdução desta política e correspondem a "deprecationInFavorOf".
policyApiLifecycleStage

enum (PolicyApiLifecycleEnum)

Indica o estágio atual do ciclo de vida da API Policy.
description

string

Descrição sobre o ciclo de vida atual.
endSupport

object (Date)

Data de término da compatibilidade com a política atual. A tentativa de modificar uma política após a data final do suporte resultará em uma solicitação inválida (erro 400). Só poderá ser definido se policyApiLifecycleStage for API_DEPRECATED.

PolicyApiLifecycleEnum

Estágio do ciclo de vida da API de política.

Enums
API_UNSPECIFIED O ciclo de vida da API Policy não foi especificado.
API_PREVIEW A política ainda não está funcionando, mas estamos informando aos desenvolvedores sobre o formato. Este estágio pode ser transferido para API_DElabsNT ou API_CURRENT.
API_DEVELOPMENT A política pode alterar o formato de maneira incompatível com versões anteriores (alteração interruptiva). Este estágio pode ser transferido para API_CURRENT ou API_DEPRECATED. Isso pode ser usado em políticas lançadas apenas para TTs ou para clientes selecionados para uso emergencial.
API_CURRENT Política no formato oficial. A política pode alterar o formato de maneira compatível com versões anteriores (alteração não interruptiva). Exemplo: esta política pode introduzir um novo campo, o que é considerado uma alteração não interruptiva, quando as máscaras de campo são usadas corretamente. Este estágio pode ser transferido para API_DEPRECATED.
API_DEPRECATED Pare de usar essa política. Esta política foi descontinuada e será removida no futuro. É provável que uma nova política tenha sido introduzida para substituir essa.

Data

Representa uma data inteira ou parcial do calendário, como um aniversário. A hora do dia e o fuso horário são especificados em outro lugar ou são insignificantes. A data é referente ao calendário gregoriano. Isso pode representar uma das seguintes opções:

  • uma data completa, com valores de ano, mês e dia diferentes de zero;
  • um mês e dia, com um ano zero (por exemplo, uma data comemorativa);
  • um ano sozinho, com um mês zero e um dia zero;
  • um ano e mês, com um dia zero (por exemplo, uma data de validade de cartão de crédito).

Tipos relacionados:

Representação JSON 
{
  "year": integer,
  "month": integer,
  "day": integer
}
Campos
year

integer

Ano da data. Precisa ser de 1 a 9.999 ou 0 para especificar uma data sem ano.
month

integer

Mês do ano. Precisa ser de 1 a 12, ou 0 para especificar um ano sem um mês e dia.
day

integer

Dia do mês. Precisa ser de 1 a 31 e válido para o ano e o mês, ou 0 para especificar um ano sozinho ou um ano e mês em que o dia não é significativo.

Plataforma

Esta é uma enum dos diferentes grupos de plataformas em que o Chrome é compatível.

Enums
PLATFORM_UNSPECIFIED Plataforma não especificada.
CHROME_OS ChromeOS.
CHROME_BROWSER Navegador Chrome para OSX/Windows/Linux.
CHROME_BROWSER_FOR_ANDROID Navegador Chrome para Android.
CHROME_BROWSER_FOR_IOS Navegador Chrome para iOS.

Métodos

get

 Encontre um esquema de política específico para um cliente pelo nome do recurso.

list

 Recebe uma lista de esquemas de política que correspondem a um valor de filtro especificado para um determinado cliente.