Method: labels.delta

Actualiza una sola etiqueta aplicando un conjunto de solicitudes de actualización que generan una nueva revisión de borrador. La actualización por lotes es todo o nada: si alguna de las solicitudes de actualización no es válida, no se aplican cambios. La revisión del borrador resultante debe publicarse antes de que los cambios se puedan usar con elementos de Drive.

Solicitud HTTP

POST https://drivelabels.googleapis.com/v2/{name=labels/*}:delta

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
name

string

Obligatorio. Es el nombre del recurso de la etiqueta que se actualizará.

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación JSON 
{
  "writeControl": {
    object (WriteControl)
  },
  "requests": [
    {
      object (Request)
    }
  ],
  "useAdminAccess": boolean,
  "view": enum (LabelView),
  "languageCode": string
}
Campos
writeControl

object (WriteControl)

Proporciona control sobre cómo se ejecutan las solicitudes de escritura.
requests[]

object (Request)

Una lista de actualizaciones que se aplicarán a la etiqueta. Las solicitudes se aplicarán en el orden en que se especifiquen.
useAdminAccess

boolean

Establece el valor en true para usar las credenciales de administrador del usuario. El servidor verificará que el usuario sea administrador de la etiqueta antes de permitir el acceso.
view

enum (LabelView)

Cuando se especifica, solo se mostrarán ciertos campos que pertenecen a la vista indicada.
languageCode

string

El código de idioma BCP-47 que se usará para evaluar las etiquetas de los campos localizadas cuando include_label_in_response sea true.

Cuerpo de la respuesta

Es la respuesta para la actualización de etiquetas.

Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:

Representación JSON 
{
  "responses": [
    {
      object (Response)
    }
  ],
  "updatedLabel": {
    object (Label)
  }
}
Campos
responses[]

object (Response)

La respuesta de las actualizaciones. Este mapa se asigna 1:1 con las actualizaciones, aunque las respuestas a algunas solicitudes pueden estar vacías.
updatedLabel

object (Label)

La etiqueta después de aplicar las actualizaciones Solo se configura si [BatchUpdateLabelResponse2.include_label_in_response] es true y no hay errores.

Alcances de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/drive.labels
  • https://www.googleapis.com/auth/drive.admin.labels

Para obtener más información, consulta la Guía de autorización.

Solicitud

Un solo tipo de actualización para aplicar a una etiqueta.

Representación JSON 
{

  // Union field kind can be only one of the following:
  "updateLabel": {
    object (UpdateLabelPropertiesRequest)
  },
  "createField": {
    object (CreateFieldRequest)
  },
  "updateField": {
    object (UpdateFieldPropertiesRequest)
  },
  "updateFieldType": {
    object (UpdateFieldTypeRequest)
  },
  "enableField": {
    object (EnableFieldRequest)
  },
  "disableField": {
    object (DisableFieldRequest)
  },
  "deleteField": {
    object (DeleteFieldRequest)
  },
  "createSelectionChoice": {
    object (CreateSelectionChoiceRequest)
  },
  "updateSelectionChoiceProperties": {
    object (UpdateSelectionChoicePropertiesRequest)
  },
  "enableSelectionChoice": {
    object (EnableSelectionChoiceRequest)
  },
  "disableSelectionChoice": {
    object (DisableSelectionChoiceRequest)
  },
  "deleteSelectionChoice": {
    object (DeleteSelectionChoiceRequest)
  }
  // End of list of possible types for union field kind.
}
Campos
Campo de unión kind. El tipo de actualización Se requiere exactamente un campo. Las direcciones (kind) solo pueden ser una de las siguientes opciones:
updateLabel

object (UpdateLabelPropertiesRequest)

Actualiza las propiedades de la etiqueta.
createField

object (CreateFieldRequest)

Crea un campo nuevo.
updateField

object (UpdateFieldPropertiesRequest)

Actualiza las propiedades básicas de un campo.
updateFieldType

object (UpdateFieldTypeRequest)

Actualiza el tipo de campo o las opciones de tipo.
enableField

object (EnableFieldRequest)

Habilita el campo.
disableField

object (DisableFieldRequest)

Inhabilita el campo.
deleteField

object (DeleteFieldRequest)

Elimina un campo de la etiqueta.
createSelectionChoice

object (CreateSelectionChoiceRequest)

Crea una opción dentro de un campo de selección.
updateSelectionChoiceProperties

object (UpdateSelectionChoicePropertiesRequest)

Actualiza las propiedades de Choice dentro de un campo de selección.
enableSelectionChoice

object (EnableSelectionChoiceRequest)

Habilita una opción dentro de un campo de selección.
disableSelectionChoice

object (DisableSelectionChoiceRequest)

Inhabilitar una opción dentro de un campo de selección
deleteSelectionChoice

object (DeleteSelectionChoiceRequest)

Eliminar una opción dentro de un campo de selección

UpdateLabelPropertiesRequest

Actualiza las propiedades básicas de una etiqueta.

Representación JSON 
{
  "updateMask": string,
  "properties": {
    object (Properties)
  }
}
Campos
updateMask

string (FieldMask format)

Los campos que se deben actualizar. Se debe especificar al menos un campo. El label_properties raíz se da por sentado y no se debe especificar. Se puede usar un solo * como atajo para actualizar todos los campos.
properties

object (Properties)

Obligatorio. Etiqueta las propiedades que se actualizarán.

CreateFieldRequest

Solicitud para crear un campo dentro de una etiqueta.

Representación JSON 
{
  "field": {
    object (Field)
  }
}
Campos
field

object (Field)

Obligatorio. Campo que se creará.

UpdateFieldPropertiesRequest

Solicitud para actualizar las propiedades del campo.

Representación JSON 
{
  "updateMask": string,
  "id": string,
  "properties": {
    object (Properties)
  }
}
Campos
updateMask

string (FieldMask format)

Los campos que se deben actualizar. Se debe especificar al menos un campo. La raíz properties está implícita y no se debe especificar. Se puede usar un solo * como atajo para actualizar todos los campos.
id

string

Obligatorio. El campo que se actualizará.
properties

object (Properties)

Obligatorio. Propiedades básicas de Campo.

UpdateFieldTypeRequest

Solicitud para cambiar el tipo de un campo.

Representación JSON 
{
  "updateMask": string,
  "id": string,

  // Union field type_options can be only one of the following:
  "textOptions": {
    object (TextOptions)
  },
  "longTextOptions": {
    object (LongTextOptions)
  },
  "integerOptions": {
    object (IntegerOptions)
  },
  "dateOptions": {
    object (DateOptions)
  },
  "selectionOptions": {
    object (SelectionOptions)
  },
  "userOptions": {
    object (UserOptions)
  }
  // End of list of possible types for union field type_options.
}
Campos
updateMask

string (FieldMask format)

Los campos que se deben actualizar. Se debe especificar al menos un campo. La raíz de type_options está implícita y no se debe especificar. Se puede usar un solo elemento * como abreviatura para actualizar cada campo.
id

string

Obligatorio. El campo que se actualizará.

Campo de unión type_options.

type_options puede ser una de las siguientes opciones:
textOptions

object (TextOptions)

Cambia el campo a Texto.
longTextOptions

object (LongTextOptions)

Se actualizó el campo a Texto largo.
integerOptions

object (IntegerOptions)

Se actualizó el campo a Número entero.
dateOptions

object (DateOptions)

Actualiza el campo a Fecha.
selectionOptions

object (SelectionOptions)

Se actualizó el campo a Selección.
userOptions

object (UserOptions)

Actualiza el campo a Usuario.

LongTextOptions

Es el tipo de campo de texto largo.

Representación JSON 
{
  "minLength": integer,
  "maxLength": integer
}
Campos
minLength

integer

Solo salida. La longitud mínima válida de los valores para el campo de texto.
maxLength

integer

Solo salida. Es la longitud máxima válida de los valores para el campo de texto.

EnableFieldRequest

Solicitud para habilitar el campo.

Representación JSON 
{
  "id": string
}
Campos
id

string

Obligatorio. Es el ID del campo que se habilitará.

DisableFieldRequest

Solicitud para inhabilitar el campo

Representación JSON 
{
  "updateMask": string,
  "id": string,
  "disabledPolicy": {
    object (DisabledPolicy)
  }
}
Campos
updateMask

string (FieldMask format)

Los campos que se deben actualizar. Se debe especificar al menos un campo. La raíz disabledPolicy está implícita y no se debe especificar. Se puede usar un solo elemento * como abreviatura para actualizar cada campo.
id

string

Obligatorio. Es la clave del campo que se inhabilitará.
disabledPolicy

object (DisabledPolicy)

Obligatorio. Política de campo inhabilitado

DeleteFieldRequest

Solicitud para borrar el campo

Representación JSON 
{
  "id": string
}
Campos
id

string

Obligatorio. ID del campo que se borrará.

CreateSelectionChoiceRequest

Solicitud para crear una Selection Choice.

Representación JSON 
{
  "fieldId": string,
  "choice": {
    object (Choice)
  }
}
Campos
fieldId

string

Obligatorio. Es el campo de selección en el que se creará una opción.
choice

object (Choice)

Obligatorio. La opción de crear.

UpdateSelectionChoicePropertiesRequest

Solicitud para actualizar una propiedad Choice.

Representación JSON 
{
  "updateMask": string,
  "fieldId": string,
  "id": string,
  "properties": {
    object (Properties)
  }
}
Campos
updateMask

string (FieldMask format)

Los campos que se deben actualizar. Se debe especificar al menos un campo. La raíz properties está implícita y no se debe especificar. Se puede usar un solo * como atajo para actualizar todos los campos.
fieldId

string

Obligatorio. El campo de selección que se actualizará.
id

string

Obligatorio. La opción de actualizar.
properties

object (Properties)

Obligatorio. Las propiedades de Choice que se actualizarán.

EnableSelectionChoiceRequest

Solicitud para habilitar una opción.

Representación JSON 
{
  "fieldId": string,
  "id": string
}
Campos
fieldId

string

Obligatorio. Es el campo de selección en el que se habilitará una opción.
id

string

Obligatorio. Opción para habilitar.

DisableSelectionChoiceRequest

Solicitud para inhabilitar una opción.

Representación JSON 
{
  "updateMask": string,
  "fieldId": string,
  "id": string,
  "disabledPolicy": {
    object (DisabledPolicy)
  }
}
Campos
updateMask

string (FieldMask format)

Los campos que se deben actualizar. Se debe especificar al menos un campo. La raíz disabledPolicy está implícita y no se debe especificar. Se puede usar un solo elemento * como abreviatura para actualizar cada campo.
fieldId

string

Obligatorio. Es el campo de selección en el que se inhabilitará una opción.
id

string

Obligatorio. Opción para inhabilitar.
disabledPolicy

object (DisabledPolicy)

Obligatorio. La política inhabilitada que se actualizará.

DeleteSelectionChoiceRequest

Solicitud para borrar una opción.

Representación JSON 
{
  "fieldId": string,
  "id": string
}
Campos
fieldId

string

Obligatorio. Es el campo de selección del que se borrará una opción.
id

string

Obligatorio. Opción para borrar.

Respuesta

Una sola respuesta de una actualización.

Representación JSON 
{

  // Union field response can be only one of the following:
  "updateLabel": {
    object (UpdateLabelPropertiesResponse)
  },
  "createField": {
    object (CreateFieldResponse)
  },
  "updateField": {
    object (UpdateFieldPropertiesResponse)
  },
  "updateFieldType": {
    object (UpdateFieldTypeResponse)
  },
  "enableField": {
    object (EnableFieldResponse)
  },
  "disableField": {
    object (DisableFieldResponse)
  },
  "deleteField": {
    object (DeleteFieldResponse)
  },
  "createSelectionChoice": {
    object (CreateSelectionChoiceResponse)
  },
  "updateSelectionChoiceProperties": {
    object (UpdateSelectionChoicePropertiesResponse)
  },
  "enableSelectionChoice": {
    object (EnableSelectionChoiceResponse)
  },
  "disableSelectionChoice": {
    object (DisableSelectionChoiceResponse)
  },
  "deleteSelectionChoice": {
    object (DeleteSelectionChoiceResponse)
  }
  // End of list of possible types for union field response.
}
Campos
Campo de unión response. Es la respuesta para la solicitud correspondiente. Las direcciones (response) solo pueden ser una de las siguientes opciones:
updateLabel

object (UpdateLabelPropertiesResponse)

Se actualizaron las propiedades básicas de una etiqueta.
createField

object (CreateFieldResponse)

Crea un campo nuevo.
updateField

object (UpdateFieldPropertiesResponse)

Actualiza las propiedades básicas de un campo.
updateFieldType

object (UpdateFieldTypeResponse)

Actualiza el tipo de campo o las opciones de tipo.
enableField

object (EnableFieldResponse)

Habilita el campo.
disableField

object (DisableFieldResponse)

Inhabilita el campo.
deleteField

object (DeleteFieldResponse)

Elimina un campo de la etiqueta.
createSelectionChoice

object (CreateSelectionChoiceResponse)

Crea una nueva opción de lista de selección para agregarla a un campo de selección.
updateSelectionChoiceProperties

object (UpdateSelectionChoicePropertiesResponse)

Actualiza una opción dentro de un campo de selección.
enableSelectionChoice

object (EnableSelectionChoiceResponse)

Habilita una opción dentro de un campo de selección.
disableSelectionChoice

object (DisableSelectionChoiceResponse)

Inhabilita una opción dentro de un campo de selección.
deleteSelectionChoice

object (DeleteSelectionChoiceResponse)

Borra una opción de un campo de selección.

UpdateLabelPropertiesResponse

Este tipo no tiene campos.

Respuesta después de la actualización de las propiedades de la etiqueta.

CreateFieldResponse

Respuesta siguiente a la creación del campo.

Representación JSON 
{
  "id": string,
  "priority": integer
}
Campos
id

string

Es el campo del campo creado. Cuando se deja en blanco en una solicitud de creación, se genera una clave de manera automática y se puede identificar aquí.
priority

integer

Es la prioridad del campo creado. La prioridad puede cambiar de lo que se especificó para garantizar las prioridades contiguas entre los campos (1-n).

UpdateFieldPropertiesResponse

Respuesta después de la actualización de las propiedades Field.

Representación JSON 
{
  "priority": integer
}
Campos
priority

integer

Es la prioridad del campo actualizado. La prioridad puede cambiar de lo que se especificó para garantizar las prioridades contiguas entre los campos (1-n).

UpdateFieldTypeResponse

Este tipo no tiene campos.

Respuesta después de la actualización del tipo de campo

EnableFieldResponse

Este tipo no tiene campos.

Se habilitó el campo Response following.

DisableFieldResponse

Este tipo no tiene campos.

Se inhabilitó la respuesta siguiente a Campo.

DeleteFieldResponse

Este tipo no tiene campos.

Respuesta después de la eliminación del campo.

CreateSelectionChoiceResponse

Respuesta después de crear la opción de selección.

Representación JSON 
{
  "fieldId": string,
  "id": string
}
Campos
fieldId

string

El ID del campo generado por el servidor.
id

string

El ID generado por el servidor para la opción creada en el campo Field

UpdateSelectionChoicePropertiesResponse

Respuesta después de la actualización de las propiedades de Selection Choice.

Representación JSON 
{
  "priority": integer
}
Campos
priority

integer

La prioridad de la opción actualizada. La prioridad puede cambiar de lo que se especificó para garantizar prioridades contiguas entre opciones (1-n).

EnableSelectionChoiceResponse

Este tipo no tiene campos.

Se habilitó la respuesta después de la opción Elección.

DisableSelectionChoiceResponse

Este tipo no tiene campos.

Se inhabilitó la respuesta después de la opción Elección.

DeleteSelectionChoiceResponse

Este tipo no tiene campos.

Respuesta después de borrar la opción.