Method: labels.delta

Actualiza una sola etiqueta mediante la aplicación de un conjunto de solicitudes de actualización que dan como resultado 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 aplicará ningún cambio. El borrador de revisión resultante debe publicarse antes de que se puedan usar los cambios 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. 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 las actualizaciones que se aplicarán a la etiqueta. Las solicitudes se aplicarán en el orden en que se especifiquen.

useAdminAccess

boolean

Configúralo como true para usar las credenciales de administrador del usuario. El servidor verificará que el usuario sea un administrador de la etiqueta antes de permitir el acceso.

view

enum (LabelView)

Cuando se especifica, solo se muestran ciertos campos que pertenecen a la vista indicada.

languageCode

string

El código de idioma BCP-47 que se debe usar para evaluar etiquetas de campo localizadas cuando include_label_in_response es true.

Cuerpo de la respuesta

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

Respuesta a la actualización de la etiqueta.

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

object (Response)

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

updatedLabel

object (Label)

La etiqueta posterior a la aplicación de las actualizaciones. Esto solo se establece si [BatchUpdateLabelResponse2.include_label_in_response] es true y no hubo errores.

Permisos de autorización

Se necesita uno de los siguientes alcances 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 único 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 las opciones de tipo o tipo de campo.

enableField

object (EnableFieldRequest)

Habilita el campo.

disableField

object (DisableFieldRequest)

Inhabilita el campo.

deleteField

object (DeleteFieldRequest)

Borra un campo de la etiqueta.

createSelectionChoice

object (CreateSelectionChoiceRequest)

Crea Choice dentro de un campo Selection.

updateSelectionChoiceProperties

object (UpdateSelectionChoicePropertiesRequest)

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

enableSelectionChoice

object (EnableSelectionChoiceRequest)

Habilita una opción en un campo de selección.

disableSelectionChoice

object (DisableSelectionChoiceRequest)

Inhabilita una opción en un campo de selección.

deleteSelectionChoice

object (DeleteSelectionChoiceRequest)

Borra una opción 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. La raíz label_properties está implícita y no se debe especificar. Se puede usar un solo * como atajo para actualizar cada campo.

properties

object (Properties)

Obligatorio. Etiqueta las propiedades que se actualizarán.

CreateFieldRequest

Solicitud para crear un campo en 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 cada campo.

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 * como atajo 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)

Actualiza el campo a Texto.

longTextOptions

object (LongTextOptions)

Actualizar el campo a texto largo.

integerOptions

object (IntegerOptions)

Actualizar campo a número entero.

dateOptions

object (DateOptions)

Actualiza el campo a Fecha.

selectionOptions

object (SelectionOptions)

Actualiza el campo a Selección.

userOptions

object (UserOptions)

Actualiza el campo a Usuario.

LongTextOptions

Opciones para 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. La longitud máxima válida de los valores para el campo de texto.

EnableFieldRequest

Solicita habilitar el campo.

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

string

Obligatorio. ID del campo que se habilitará.

DisableFieldRequest

Solicita 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 * como atajo para actualizar cada campo.

id

string

Obligatorio. Clave del campo que se inhabilitará.

disabledPolicy

object (DisabledPolicy)

Obligatorio. Política de campo inhabilitada.

DeleteFieldRequest

Solicita borrar el campo.

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

string

Obligatorio. ID del campo que se borrará.

CreateSelectionChoiceRequest

Solicita crear una opción de selección.

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

string

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

choice

object (Choice)

Obligatorio. La opción para crear.

UpdateSelectionChoicePropertiesRequest

Solicita actualizar propiedades 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 cada campo.

fieldId

string

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

id

string

Obligatorio. La opción para actualizar.

properties

object (Properties)

Obligatorio. Las propiedades 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

Solicita 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 * como atajo para actualizar cada campo.

fieldId

string

Obligatorio. 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 debe 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 a partir 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. La respuesta de 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 las opciones de tipo o tipo de campo.

enableField

object (EnableFieldResponse)

Habilita el campo.

disableField

object (DisableFieldResponse)

Inhabilita el campo.

deleteField

object (DeleteFieldResponse)

Borra un campo de la etiqueta.

createSelectionChoice

object (CreateSelectionChoiceResponse)

Crea una opción de lista de selección nueva 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 en un campo de selección.

disableSelectionChoice

object (DisableSelectionChoiceResponse)

Inhabilita una opción en un campo de selección.

deleteSelectionChoice

object (DeleteSelectionChoiceResponse)

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

UpdateLabelPropertiesResponse

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

CreateFieldResponse

Respuesta después de la creación de un campo

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

string

El campo del campo creado. Si se deja en blanco durante una solicitud de creación, se generará una clave de forma automática y podrá identificarse aquí.

priority

integer

La prioridad del campo creado. La prioridad puede ser diferente de la que se especificó para garantizar prioridades contiguas entre campos (1-n).

UpdateFieldPropertiesResponse

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

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

integer

La prioridad del campo actualizado. La prioridad puede ser diferente de la que se especificó para garantizar prioridades contiguas entre campos (1-n).

UpdateFieldTypeResponse

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

EnableFieldResponse

Respuesta siguiente a la función Habilitar

DisableFieldResponse

Respuesta siguiente a Campo inhabilitado

DeleteFieldResponse

Respuesta siguiente a 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 de la opción creada en el campo

UpdateSelectionChoicePropertiesResponse

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

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

integer

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

EnableSelectionChoiceResponse

Respuesta después de habilitar la opción.

DisableSelectionChoiceResponse

La respuesta después de la opción está inhabilitada.

DeleteSelectionChoiceResponse

Respuesta después de eliminar la opción.