- Solicitação HTTP
- Parâmetros de caminho
- Corpo da solicitação
- Corpo da resposta
- Escopos de autorização
- Solicitação
- UpdateLabelPropertiesRequest
- CreateFieldRequest
- UpdateFieldPropertiesRequest
- UpdateFieldTypeRequest
- LongTextOptions
- EnableFieldRequest
- DisableFieldRequest
- DeleteFieldRequest
- CreateSelectionChoiceRequest
- UpdateSelectionChoicePropertiesRequest
- EnableSelectionChoiceRequest
- DisableSelectionChoiceRequest
- DeleteSelectionChoiceRequest
- Resposta
- UpdateLabelPropertiesResponse
- CreateFieldResponse
- UpdateFieldPropertiesResponse
- UpdateFieldTypeResponse
- EnableFieldResponse
- DisableFieldResponse
- DeleteFieldResponse
- CreateSelectionChoiceResponse
- UpdateSelectionChoicePropertiesResponse
- EnableSelectionChoiceResponse
- DisableSelectionChoiceResponse
- DeleteSelectionChoiceResponse
- Faça um teste
Atualiza um único marcador aplicando um conjunto de solicitações de atualização, resultando em uma nova revisão de rascunho. A atualização em lote é tudo ou nada: se alguma das solicitações de atualização for inválida, nenhuma alteração será aplicada. O rascunho da revisão resultante precisa ser publicado antes que as alterações possam ser usadas com os itens do Drive.
Solicitação HTTP
POST https://drivelabels.googleapis.com/v2/{name=labels/*}:delta
O URL usa a sintaxe de transcodificação gRPC.
Parâmetros de caminho
Parâmetros | |
---|---|
name |
Obrigatório. O nome do recurso do rótulo a ser atualizado. |
Corpo da solicitação
O corpo da solicitação contém dados com a seguinte estrutura:
Representação JSON |
---|
{ "writeControl": { object ( |
Campos | |
---|---|
writeControl |
Fornece controle sobre como as solicitações de gravação são executadas. |
requests[] |
Uma lista de atualizações para aplicar ao rótulo. As solicitações serão aplicadas na ordem em que forem especificadas. |
useAdminAccess |
Defina como |
view |
Quando especificado, apenas alguns campos pertencentes à visualização indicada serão retornados. |
languageCode |
O código de idioma BCP-47 a ser usado para avaliar rótulos de campo localizados quando |
Corpo da resposta
Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:
Resposta para atualização do marcador.
Representação JSON |
---|
{ "responses": [ { object ( |
Campos | |
---|---|
responses[] |
A resposta das atualizações. Ele mapeia individualmente com as atualizações, embora as respostas a algumas solicitações possam ficar vazias. |
updatedLabel |
O marcador após a aplicação das atualizações. Isso só será definido se [BatchUpdateLabelResponse2.include_label_in_response] for |
Escopos de autorização
Requer um dos seguintes escopos de OAuth:
https://www.googleapis.com/auth/drive.labels
https://www.googleapis.com/auth/drive.admin.labels
Para mais informações, consulte o Guia de autorização.
Solicitação
Um único tipo de atualização para aplicar a um rótulo.
Representação JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de união kind . O tipo de atualização. Exatamente um campo é obrigatório. kind pode ser apenas de um dos tipos a seguir: |
|
updateLabel |
Atualiza as propriedades do rótulo. |
createField |
Cria um novo Field. |
updateField |
Atualiza as propriedades básicas de um Field. |
updateFieldType |
Atualize as opções de tipo e/ou tipo de campo. |
enableField |
Ativa o campo. |
disableField |
Desativa o campo. |
deleteField |
Exclui um campo do rótulo. |
createSelectionChoice |
Cria Escolha em um campo "Selection". |
updateSelectionChoiceProperties |
Atualizar as propriedades de uma Opção em um campo de seleção. |
enableSelectionChoice |
Ativar uma Opção em um campo de seleção. |
disableSelectionChoice |
Desativar uma Opção em um campo de seleção. |
deleteSelectionChoice |
Excluir uma Opção em um Campo de Seleção. |
UpdateLabelPropertiesRequest
Atualiza as propriedades básicas de um identificador.
Representação JSON |
---|
{
"updateMask": string,
"properties": {
object ( |
Campos | |
---|---|
updateMask |
Os campos que serão atualizados. É necessário especificar pelo menos um campo. A raiz |
properties |
Obrigatório. Propriedades do rótulo a serem atualizadas. |
CreateFieldRequest
Solicitação para criar um campo dentro de um marcador.
Representação JSON |
---|
{
"field": {
object ( |
Campos | |
---|---|
field |
Obrigatório. Campo a ser criado. |
UpdateFieldPropertiesRequest
Solicitação para atualizar as propriedades de campo.
Representação JSON |
---|
{
"updateMask": string,
"id": string,
"properties": {
object ( |
Campos | |
---|---|
updateMask |
Os campos que serão atualizados. É necessário especificar pelo menos um campo. A raiz |
id |
Obrigatório. O campo a ser atualizado. |
properties |
Obrigatório. Propriedades básicas de campo. |
UpdateFieldTypeRequest
Solicitação para alterar o tipo de um campo.
Representação JSON |
---|
{ "updateMask": string, "id": string, // Union field |
Campos | |
---|---|
updateMask |
Os campos que serão atualizados. É necessário especificar pelo menos um campo. A raiz de |
id |
Obrigatório. O campo a ser atualizado. |
Campo de união
|
|
textOptions |
Atualize o campo para "Text". |
longTextOptions |
Atualize o campo para "Texto longo". |
integerOptions |
Atualize o campo para número inteiro. |
dateOptions |
Atualize o campo para "Data". |
selectionOptions |
Atualização do campo para seleção. |
userOptions |
Atualize o campo para "Usuário". |
LongTextOptions
Opções do tipo de campo "Texto longo".
Representação JSON |
---|
{ "minLength": integer, "maxLength": integer } |
Campos | |
---|---|
minLength |
Apenas saída. O tamanho mínimo válido dos valores para o campo de texto. |
maxLength |
Apenas saída. O tamanho máximo válido dos valores para o campo de texto. |
EnableFieldRequest
Solicitação para ativar o campo.
Representação JSON |
---|
{ "id": string } |
Campos | |
---|---|
id |
Obrigatório. ID do campo a ser ativado. |
DisableFieldRequest
Solicitação para desativar o campo.
Representação JSON |
---|
{
"updateMask": string,
"id": string,
"disabledPolicy": {
object ( |
Campos | |
---|---|
updateMask |
Os campos que serão atualizados. É necessário especificar pelo menos um campo. A raiz |
id |
Obrigatório. Chave do campo a ser desativada. |
disabledPolicy |
Obrigatório. Política de campo desativada. |
DeleteFieldRequest
Solicitação para excluir o campo.
Representação JSON |
---|
{ "id": string } |
Campos | |
---|---|
id |
Obrigatório. ID do campo a ser excluído. |
CreateSelectionChoiceRequest
Solicitação para criar uma Opção de seleção.
Representação JSON |
---|
{
"fieldId": string,
"choice": {
object ( |
Campos | |
---|---|
fieldId |
Obrigatório. O campo de seleção em que uma Opção será criada. |
choice |
Obrigatório. A escolha de criar. |
UpdateSelectionChoicePropertiesRequest
Solicitação para atualizar as propriedades de Choice.
Representação JSON |
---|
{
"updateMask": string,
"fieldId": string,
"id": string,
"properties": {
object ( |
Campos | |
---|---|
updateMask |
Os campos que serão atualizados. É necessário especificar pelo menos um campo. A raiz |
fieldId |
Obrigatório. O campo de seleção a ser atualizado. |
id |
Obrigatório. A Opção de atualizar. |
properties |
Obrigatório. As propriedades de Escolha a serem atualizadas. |
EnableSelectionChoiceRequest
Solicitação para ativar uma Opção.
Representação JSON |
---|
{ "fieldId": string, "id": string } |
Campos | |
---|---|
fieldId |
Obrigatório. O campo de seleção em que uma Opção será ativada. |
id |
Obrigatório. Opção de ativar. |
DisableSelectionChoiceRequest
Solicitação para desativar uma Opção.
Representação JSON |
---|
{
"updateMask": string,
"fieldId": string,
"id": string,
"disabledPolicy": {
object ( |
Campos | |
---|---|
updateMask |
Os campos que serão atualizados. É necessário especificar pelo menos um campo. A raiz |
fieldId |
Obrigatório. O campo de seleção em que uma Opção será desativada. |
id |
Obrigatório. Opção de desativar. |
disabledPolicy |
Obrigatório. A política desativada a ser atualizada. |
DeleteSelectionChoiceRequest
Pedido para excluir uma Opção.
Representação JSON |
---|
{ "fieldId": string, "id": string } |
Campos | |
---|---|
fieldId |
Obrigatório. O campo de seleção do qual uma Opção será excluída. |
id |
Obrigatório. Opção de excluir. |
Resposta
Uma única resposta de uma atualização.
Representação JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de união response . A resposta para a solicitação correspondente. response pode ser apenas de um dos tipos a seguir: |
|
updateLabel |
Atualização das propriedades básicas de um identificador. |
createField |
Cria um novo Field. |
updateField |
Atualiza as propriedades básicas de um Field. |
updateFieldType |
Atualize as opções de tipo e/ou tipo de campo. |
enableField |
Ativa o campo. |
disableField |
Desativa o campo. |
deleteField |
Exclui um campo do rótulo. |
createSelectionChoice |
Cria uma nova opção de lista de seleção para adicionar a um campo de seleção. |
updateSelectionChoiceProperties |
Atualiza uma opção em um campo de seleção. |
enableSelectionChoice |
Ativa uma Opção em um campo de seleção. |
disableSelectionChoice |
Desativa uma Opção em um campo de seleção. |
deleteSelectionChoice |
Exclui uma opção de um campo de seleção. |
UpdateLabelPropertiesResponse
Resposta após a atualização das propriedades do identificador.
CreateFieldResponse
Resposta após criação de campo.
Representação JSON |
---|
{ "id": string, "priority": integer } |
Campos | |
---|---|
id |
O campo do campo criado. Quando deixado em branco em uma solicitação de criação, uma chave é gerada automaticamente e pode ser identificada aqui. |
priority |
A prioridade do campo criado. A prioridade pode mudar em relação à especificada para garantir prioridades contíguas entre os campos (1-n). |
UpdateFieldPropertiesResponse
Resposta após a atualização das propriedades de campo.
Representação JSON |
---|
{ "priority": integer } |
Campos | |
---|---|
priority |
A prioridade do campo atualizado. A prioridade pode mudar em relação à especificada para garantir prioridades contíguas entre os campos (1-n). |
UpdateFieldTypeResponse
Resposta após atualização do tipo de campo.
EnableFieldResponse
Resposta após ativação de campo.
DisableFieldResponse
Campo de resposta seguinte desativado.
DeleteFieldResponse
Resposta após a exclusão de campo.
CreateSelectionChoiceResponse
Resposta após a criação da escolha da seleção.
Representação JSON |
---|
{ "fieldId": string, "id": string } |
Campos | |
---|---|
fieldId |
O ID do campo gerado pelo servidor. |
id |
O ID gerado pelo servidor da opção criada no campo |
UpdateSelectionChoicePropertiesResponse
Resposta após a atualização das propriedades da Escolha da seleção.
Representação JSON |
---|
{ "priority": integer } |
Campos | |
---|---|
priority |
A prioridade da opção atualizada. A prioridade pode mudar em relação à especificada para garantir prioridades contíguas entre as opções (1-n). |
EnableSelectionChoiceResponse
Resposta ativada após a escolha.
DisableSelectionChoiceResponse
Resposta após escolha desativada.
DeleteSelectionChoiceResponse
Resposta após a exclusão da Opção.