- Solicitud HTTP
- Parámetros de ruta de acceso
- Cuerpo de la solicitud
- Cuerpo de la respuesta
- Alcances de la autorización
- Solicitar
- UpdateLabelPropertiesRequest
- CreateFieldRequest
- UpdateFieldPropertiesRequest
- UpdateFieldTypeRequest
- LongTextOptions
- EnableFieldRequest
- DisableFieldRequest
- DeleteFieldRequest
- CreateSelectionChoiceRequest
- UpdateSelectionChoicePropertiesRequest
- EnableSelectionChoiceRequest
- DisableSelectionChoiceRequest
- DeleteSelectionChoiceRequest
- Respuesta
- UpdateLabelPropertiesResponse
- CreateFieldResponse
- UpdateFieldPropertiesResponse
- UpdateFieldTypeResponse
- EnableFieldResponse
- DisableFieldResponse
- DeleteFieldResponse
- CreateSelectionChoiceResponse
- UpdateSelectionChoicePropertiesResponse
- EnableSelectionChoiceResponse
- DisableSelectionChoiceResponse
- DeleteSelectionChoiceResponse
- Pruébala
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 |
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 ( |
Campos | |
---|---|
writeControl |
Proporciona control sobre cómo se ejecutan las solicitudes de escritura. |
requests[] |
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 |
Configúralo como |
view |
Cuando se especifica, solo se muestran ciertos campos que pertenecen a la vista indicada. |
languageCode |
El código de idioma BCP-47 que se debe usar para evaluar etiquetas de campo localizadas cuando |
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 ( |
Campos | |
---|---|
responses[] |
La respuesta de las actualizaciones. Esto asigna 1:1 con las actualizaciones, aunque las respuestas a algunas solicitudes pueden estar vacías. |
updatedLabel |
La etiqueta posterior a la aplicación de las actualizaciones. Esto solo se establece si [BatchUpdateLabelResponse2.include_label_in_response] es |
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 |
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 |
Actualiza las propiedades de la etiqueta. |
createField |
Crea un campo nuevo. |
updateField |
Actualiza las propiedades básicas de un campo. |
updateFieldType |
Actualiza las opciones de tipo o tipo de campo. |
enableField |
Habilita el campo. |
disableField |
Inhabilita el campo. |
deleteField |
Borra un campo de la etiqueta. |
createSelectionChoice |
Crea Choice dentro de un campo Selection. |
updateSelectionChoiceProperties |
Actualiza las propiedades Choice dentro de un campo de selección. |
enableSelectionChoice |
Habilita una opción en un campo de selección. |
disableSelectionChoice |
Inhabilita una opción en un campo de selección. |
deleteSelectionChoice |
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 ( |
Campos | |
---|---|
updateMask |
Los campos que se deben actualizar. Se debe especificar al menos un campo. La raíz |
properties |
Obligatorio. Etiqueta las propiedades que se actualizarán. |
CreateFieldRequest
Solicitud para crear un campo en una etiqueta.
Representación JSON |
---|
{
"field": {
object ( |
Campos | |
---|---|
field |
Obligatorio. Campo que se creará. |
UpdateFieldPropertiesRequest
Solicitud para actualizar las propiedades del campo.
Representación JSON |
---|
{
"updateMask": string,
"id": string,
"properties": {
object ( |
Campos | |
---|---|
updateMask |
Los campos que se deben actualizar. Se debe especificar al menos un campo. La raíz |
id |
Obligatorio. El campo que se actualizará. |
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 |
Campos | |
---|---|
updateMask |
Los campos que se deben actualizar. Se debe especificar al menos un campo. La raíz de |
id |
Obligatorio. El campo que se actualizará. |
Campo de unión
|
|
textOptions |
Actualiza el campo a Texto. |
longTextOptions |
Actualizar el campo a texto largo. |
integerOptions |
Actualizar campo a número entero. |
dateOptions |
Actualiza el campo a Fecha. |
selectionOptions |
Actualiza el campo a Selección. |
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 |
Solo salida. La longitud mínima válida de los valores para el campo de texto |
maxLength |
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 |
Obligatorio. ID del campo que se habilitará. |
DisableFieldRequest
Solicita inhabilitar el campo.
Representación JSON |
---|
{
"updateMask": string,
"id": string,
"disabledPolicy": {
object ( |
Campos | |
---|---|
updateMask |
Los campos que se deben actualizar. Se debe especificar al menos un campo. La raíz |
id |
Obligatorio. Clave del campo que se inhabilitará. |
disabledPolicy |
Obligatorio. Política de campo inhabilitada. |
DeleteFieldRequest
Solicita borrar el campo.
Representación JSON |
---|
{ "id": string } |
Campos | |
---|---|
id |
Obligatorio. ID del campo que se borrará. |
CreateSelectionChoiceRequest
Solicita crear una opción de selección.
Representación JSON |
---|
{
"fieldId": string,
"choice": {
object ( |
Campos | |
---|---|
fieldId |
Obligatorio. El campo de selección en el que se creará una opción. |
choice |
Obligatorio. La opción para crear. |
UpdateSelectionChoicePropertiesRequest
Solicita actualizar propiedades Choice.
Representación JSON |
---|
{
"updateMask": string,
"fieldId": string,
"id": string,
"properties": {
object ( |
Campos | |
---|---|
updateMask |
Los campos que se deben actualizar. Se debe especificar al menos un campo. La raíz |
fieldId |
Obligatorio. El campo de selección que se actualizará. |
id |
Obligatorio. La opción para actualizar. |
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 |
Obligatorio. Es el campo de selección en el que se habilitará una opción. |
id |
Obligatorio. Opción para habilitar. |
DisableSelectionChoiceRequest
Solicita inhabilitar una opción.
Representación JSON |
---|
{
"updateMask": string,
"fieldId": string,
"id": string,
"disabledPolicy": {
object ( |
Campos | |
---|---|
updateMask |
Los campos que se deben actualizar. Se debe especificar al menos un campo. La raíz |
fieldId |
Obligatorio. El campo de selección en el que se inhabilitará una opción |
id |
Obligatorio. Opción para inhabilitar |
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 |
Obligatorio. Es el campo de selección del que se borrará una opción. |
id |
Obligatorio. Opción para borrar. |
Respuesta
Una sola respuesta a partir de una actualización.
Representación JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de unión response . La respuesta de la solicitud correspondiente. Las direcciones (response ) solo pueden ser una de las siguientes opciones: |
|
updateLabel |
Se actualizaron las propiedades básicas de una etiqueta. |
createField |
Crea un campo nuevo. |
updateField |
Actualiza las propiedades básicas de un campo. |
updateFieldType |
Actualiza las opciones de tipo o tipo de campo. |
enableField |
Habilita el campo. |
disableField |
Inhabilita el campo. |
deleteField |
Borra un campo de la etiqueta. |
createSelectionChoice |
Crea una opción de lista de selección nueva para agregarla a un campo de selección. |
updateSelectionChoiceProperties |
Actualiza una opción dentro de un campo de selección. |
enableSelectionChoice |
Habilita una opción en un campo de selección. |
disableSelectionChoice |
Inhabilita una opción en un campo de selección. |
deleteSelectionChoice |
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 |
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 |
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 |
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 |
El ID del campo generado por el servidor. |
id |
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 |
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.