- Recurso: Etiqueta
- LabelType
- UserInfo
- Propiedades
- Ciclo de vida
- Estado
- DisabledPolicy
- DisplayHints
- AppliedCapabilities
- SchemaCapabilities
- AppliedLabelPolicy
- CopyMode
- Campo
- TextOptions
- IntegerOptions
- DateOptions
- DateFormat
- SelectionOptions
- ListOptions
- Opción
- Propiedades
- BadgeConfig
- DisplayHints
- BadgeColors
- SchemaCapabilities
- AppliedCapabilities
- LockStatus
- UserOptions
- Propiedades
- DisplayHints
- SchemaCapabilities
- AppliedCapabilities
- Métodos
Recurso: Etiqueta
Una etiqueta define una taxonomía que se puede aplicar a los elementos de Drive para organizarlos y buscarlos en ellos. Las etiquetas pueden ser cadenas simples o pueden contener campos que describen metadatos adicionales que se pueden usar más adelante para organizar y buscar elementos de Drive.
Representación JSON |
---|
{ "name": string, "id": string, "revisionId": string, "labelType": enum ( |
Campos | |
---|---|
name |
Solo salida. Es el nombre del recurso de la etiqueta. Tendrá el formato |
id |
Solo salida. Es el identificador único global de esta etiqueta. El ID forma parte de la etiqueta |
revisionId |
Solo salida. ID de revisión de la etiqueta. El ID de revisión puede formar parte de la etiqueta |
labelType |
Obligatorio. Es el tipo de etiqueta. |
creator |
Solo salida. El usuario que creó esta etiqueta. |
createTime |
Solo salida. La hora en la que se creó esta etiqueta. |
revisionCreator |
Solo salida. El usuario que creó esta revisión de la etiqueta. |
revisionCreateTime |
Solo salida. La hora en la que se creó esta revisión de la etiqueta. |
publisher |
Solo salida. El usuario que publicó esta etiqueta. Este valor no tiene significado cuando no se publica la etiqueta. |
publishTime |
Solo salida. Es la hora en la que se publicó esta etiqueta. Este valor no tiene significado cuando no se publica la etiqueta. |
disabler |
Solo salida. El usuario que inhabilitó esta etiqueta. Este valor no tiene sentido cuando la etiqueta no está inhabilitada. |
disableTime |
Solo salida. La hora a la que se inhabilitó esta etiqueta. Este valor no tiene sentido cuando la etiqueta no está inhabilitada. |
customer |
Solo salida. El cliente al que pertenece esta etiqueta. Por ejemplo: “customers/123abc789”. |
properties |
Obligatorio. Las propiedades básicas de la etiqueta. |
lifecycle |
Solo salida. El estado del ciclo de vida de la etiqueta, lo que incluye si está publicada, obsoleta y tiene cambios en borrador. |
displayHints |
Solo salida. Sugerencias de visualización de la IU para renderizar la etiqueta. |
appliedCapabilities |
Solo salida. Las capacidades relacionadas con esta etiqueta en los metadatos aplicados. |
schemaCapabilities |
Solo salida. Las capacidades que el usuario tiene en esta etiqueta. |
appliedLabelPolicy |
Solo salida. Comportamiento de esta etiqueta cuando se aplica a elementos de Drive. |
fields[] |
Lista de campos en orden de prioridad descendente. |
learnMoreUri |
URL personalizada para mostrar a los usuarios a fin de que obtengan más información sobre esta etiqueta y cómo se debe usar. |
lockStatus |
Solo salida. El LockStatus de esta etiqueta. |
LabelType
Es el tipo de esta etiqueta.
Enumeradores | |
---|---|
LABEL_TYPE_UNSPECIFIED |
El tipo de etiqueta es desconocido. |
SHARED |
Es posible que se compartan etiquetas compartidas con los usuarios para aplicarlas a los elementos de Drive. |
ADMIN |
Etiqueta de propiedad del administrador. Solo los administradores pueden crear y editar. Es compatible con algunas funciones adicionales exclusivas para administradores. |
UserInfo
Es la información sobre un usuario.
Representación JSON |
---|
{ "person": string } |
Campos | |
---|---|
person |
Es el identificador de este usuario que se puede usar con la API de People para obtener más información. Por ejemplo, personas/12345678. |
Propiedades
Propiedades básicas de la etiqueta
Representación JSON |
---|
{ "title": string, "description": string } |
Campos | |
---|---|
title |
Obligatorio. Es el título de la etiqueta. |
description |
Es la descripción de la etiqueta. |
Ciclo de vida
El estado del ciclo de vida de un objeto, como una etiqueta, un campo o una elección. El ciclo de vida aplica las siguientes transiciones:
UNPUBLISHED_DRAFT
(estado inicial)UNPUBLISHED_DRAFT
->PUBLISHED
UNPUBLISHED_DRAFT
-> (Eliminado)PUBLISHED
->DISABLED
DISABLED
->PUBLISHED
DISABLED
-> (Eliminado)
Los estados inhabilitado y publicado tienen algunas características distintivas:
- Publicada: Se pueden realizar algunos tipos de cambios en un objeto con este estado, en cuyo caso
hasUnpublishedChanges
será verdadero. Además, no se permiten algunos tipos de cambios. Por lo general, se rechaza cualquier cambio que invalide o genere restricciones nuevas en los metadatos existentes relacionados con la etiqueta. - Inhabilitada: Cuando se inhabilita, se aplica el
DisabledPolicy
configurado.
Representación JSON |
---|
{ "state": enum ( |
Campos | |
---|---|
state |
Solo salida. El estado del objeto asociado con este ciclo de vida. |
hasUnpublishedChanges |
Solo salida. Indica si el objeto asociado con este ciclo de vida tiene cambios no publicados. |
disabledPolicy |
La política que rige cómo mostrar una etiqueta, un campo o una opción de selección inhabilitados. |
Estado
El estado del objeto asociado con este ciclo de vida.
Enumeradores | |
---|---|
STATE_UNSPECIFIED |
Estado desconocido. |
UNPUBLISHED_DRAFT |
El estado inicial de un objeto. Una vez publicado, el objeto nunca puede volver a este estado. Una vez que se publica un objeto, ya no se permiten ciertos tipos de cambios. |
PUBLISHED |
Se publicó el objeto. Es posible que el objeto tenga cambios en borrador no publicados como lo indica hasUnpublishedChanges . |
DISABLED |
El objeto se publicó y, desde entonces, se inhabilitó. Es posible que el objeto tenga cambios en borrador no publicados como lo indica hasUnpublishedChanges . |
DELETED |
Se borró el objeto. |
DisabledPolicy
La política que rige cómo tratar una etiqueta, un campo o una elección de selección inhabilitada en diferentes contextos.
Representación JSON |
---|
{ "hideInSearch": boolean, "showInApply": boolean } |
Campos | |
---|---|
hideInSearch |
Indica si se debe ocultar este objeto inhabilitado en el menú de búsqueda de los elementos de Drive.
|
showInApply |
Indica si se muestra este objeto inhabilitado en el menú Aplicar de los elementos de Drive.
|
DisplayHints
Sugerencias de visualización de la IU para renderizar la etiqueta.
Representación JSON |
---|
{ "disabled": boolean, "hiddenInSearch": boolean, "shownInApply": boolean, "priority": string } |
Campos | |
---|---|
disabled |
Indica si la etiqueta se debe mostrar en la IU como inhabilitada. |
shownInApply |
Esta etiqueta debe mostrarse en el menú Aplicar cuando se aplican valores a un elemento de Drive. |
priority |
Orden para mostrar la etiqueta en una lista. |
AppliedCapabilities
Las capacidades que tiene un usuario en los metadatos aplicados de esta etiqueta.
Representación JSON |
---|
{ "canRead": boolean, "canApply": boolean, "canRemove": boolean } |
Campos | |
---|---|
canRead |
Indica si el usuario puede leer los metadatos aplicados relacionados con esta etiqueta. |
canApply |
Indica si el usuario puede aplicar esta etiqueta a los elementos. |
canRemove |
Indica si el usuario puede quitar esta etiqueta de los elementos. |
SchemaCapabilities
Son las funciones relacionadas con esta etiqueta cuando se edita.
Representación JSON |
---|
{ "canUpdate": boolean, "canDelete": boolean, "canDisable": boolean, "canEnable": boolean } |
Campos | |
---|---|
canUpdate |
Indica si el usuario puede cambiar esta etiqueta. |
canDelete |
Indica si el usuario puede borrar esta etiqueta. El usuario debe tener permiso y la etiqueta debe estar inhabilitada. |
canDisable |
Indica si el usuario puede inhabilitar esta etiqueta. El usuario debe tener permiso y esta etiqueta no debe estar inhabilitada. |
canEnable |
Indica si el usuario puede habilitar esta etiqueta. El usuario debe tener permiso y esta etiqueta debe estar inhabilitada. |
AppliedLabelPolicy
Comportamiento de esta etiqueta cuando se aplica a elementos de Drive.
Representación JSON |
---|
{
"copyMode": enum ( |
Campos | |
---|---|
copyMode |
Indica cómo se deben copiar los valores de la etiqueta y del campo aplicados cuando se copia un elemento de Drive. |
CopyMode
Indica cómo se deben copiar los valores de la etiqueta y del campo aplicados cuando se copia un elemento de Drive.
Enumeradores | |
---|---|
COPY_MODE_UNSPECIFIED |
Modo de copia no especificado. |
DO_NOT_COPY |
Los valores de la etiqueta y del campo aplicados no se copian de forma predeterminada cuando se copia el elemento de Drive al que se aplica. |
ALWAYS_COPY |
Los valores de la etiqueta y del campo aplicados siempre se copian cuando se copia el elemento de Drive al que se aplica. Solo los administradores pueden usar este modo. |
COPY_APPLIABLE |
Los valores de la etiqueta y del campo aplicados se copian si el usuario que hace la copia puede aplicar la etiqueta. |
Campo
Define un campo que tiene un nombre visible, un tipo de datos y otras opciones de configuración. Este campo define el tipo de metadatos que se pueden configurar en un elemento de Drive.
Representación JSON |
---|
{ "id": string, "queryKey": string, "properties": { object ( |
Campos | |
---|---|
id |
Solo salida. La clave de un campo, única dentro de una etiqueta o biblioteca. Este valor se genera automáticamente. Coincide con la regex |
queryKey |
Solo salida. La clave que se debe usar cuando se crean consultas de búsqueda en Drive para encontrar archivos en función de los valores definidos para este campo en los archivos. Por ejemplo, “ |
properties |
Las propiedades básicas del campo. |
lifecycle |
Solo salida. El ciclo de vida de este campo. |
displayHints |
Solo salida. Sugerencias de visualización de la IU para renderizar un campo |
schemaCapabilities |
Solo salida. Las capacidades que tiene este usuario al editar este campo. |
appliedCapabilities |
Solo salida. Las capacidades que tiene este usuario en este campo y su valor cuando se aplica la etiqueta a los elementos de Drive. |
creator |
Solo salida. El usuario que creó este campo. |
createTime |
Solo salida. Indica la hora en la que se creó este campo. |
updater |
Solo salida. El usuario que modificó este campo. |
updateTime |
Solo salida. La hora en la que se actualizó este campo. |
publisher |
Solo salida. El usuario que publicó este campo. Este valor no tiene significado cuando el campo no está publicado. |
disabler |
Solo salida. El usuario que inhabilitó este campo. Este valor no tiene sentido cuando el campo no está inhabilitado. |
disableTime |
Solo salida. La hora en la que se inhabilitó este campo. Este valor no tiene sentido cuando el campo no está inhabilitado. |
lockStatus |
Solo salida. El LockStatus de este campo. |
Campo de unión type . El tipo de datos y las opciones de este campo. Una vez publicados, no se puede cambiar el tipo de datos. Las direcciones (type ) solo pueden ser una de las siguientes opciones: |
|
textOptions |
Opciones de campos de texto. |
integerOptions |
Opciones del campo de número entero. |
dateOptions |
Opciones del campo de fecha. |
selectionOptions |
Opciones del campo de selección. |
userOptions |
Opciones de los campos de usuario. |
TextOptions
Opciones para el tipo de campo Texto.
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. |
IntegerOptions
Opciones para el tipo de campo Número entero.
Representación JSON |
---|
{ "minValue": string, "maxValue": string } |
Campos | |
---|---|
minValue |
Solo salida. El valor mínimo válido para el campo de número entero. |
maxValue |
Solo salida. El valor máximo válido para el campo de número entero. |
DateOptions
Opciones para el tipo de campo date.
Representación JSON |
---|
{ "dateFormatType": enum ( |
Campos | |
---|---|
dateFormatType |
Opción de formato de fecha localizado. Los valores de campo se procesan en este formato según su configuración regional. |
dateFormat |
Solo salida. Formato de fecha de ICU. |
minValue |
Solo salida. Valor mínimo válido (año, mes, día). |
maxValue |
Solo salida. Valor válido máximo (año, mes, día). |
DateFormat
Opciones de formato de fecha localizadas.
Enumeradores | |
---|---|
DATE_FORMAT_UNSPECIFIED |
Formato de fecha sin especificar. |
LONG_DATE |
Incluye el nombre del mes completo. Por ejemplo, 12 de enero de 1999 (MMMM d, y) |
SHORT_DATE |
Representación corta y numérica. Por ejemplo, 12/13/99 (d/M/yy) |
SelectionOptions
Opciones para el tipo de campo de selección.
Representación JSON |
---|
{ "listOptions": { object ( |
Campos | |
---|---|
listOptions |
Cuando se especifica, indica que este campo admite una lista de valores. Una vez que se publique el campo, no se podrá modificar. |
choices[] |
Son las opciones disponibles para este campo de selección. El orden de la lista es coherente y se modifica con |
ListOptions
Opciones para una variante con valores múltiples de un tipo de campo asociado.
Representación JSON |
---|
{ "maxEntries": integer } |
Campos | |
---|---|
maxEntries |
Cantidad máxima de entradas permitidas. |
Opciones
Elección del campo de selección.
Representación JSON |
---|
{ "id": string, "properties": { object ( |
Campos | |
---|---|
id |
Es el valor único de la opción. Este ID se genera automáticamente. Coincide con la regex |
properties |
Propiedades básicas de tu elección |
lifecycle |
Solo salida. Ciclo de vida de tu elección |
displayHints |
Solo salida. La IU muestra sugerencias para renderizar una opción. |
schemaCapabilities |
Solo salida. Son las funciones relacionadas con esta opción cuando la editas. |
appliedCapabilities |
Solo salida. Las capacidades relacionadas con esta elección en los metadatos aplicados. |
creator |
Solo salida. Es el usuario que creó esta opción. |
createTime |
Solo salida. La hora en que se creó esta elección. |
updater |
Solo salida. Indica el usuario que actualizó esta opción por última vez. |
updateTime |
Solo salida. La última vez que se actualizó esta opción |
publisher |
Solo salida. Es el usuario que publicó esta opción. Este valor no tiene sentido cuando no se publica la opción. |
publishTime |
Solo salida. Es la hora en que se publicó esta opción. Este valor no tiene sentido cuando no se publica la opción. |
disabler |
Solo salida. El usuario que inhabilitó esta opción. Este valor no tiene sentido cuando la opción no está inhabilitada. |
disableTime |
Solo salida. La hora en la que se inhabilitó esta opción. Este valor no tiene sentido cuando la opción no está inhabilitada. |
lockStatus |
Solo salida. Es el LockStatus de esta opción. |
Propiedades
Propiedades básicas de tu elección
Representación JSON |
---|
{
"displayName": string,
"description": string,
"badgeConfig": {
object ( |
Campos | |
---|---|
displayName |
Obligatorio. Es el texto visible que se mostrará en la IU que identifica este campo. |
description |
Es la descripción de esta etiqueta. |
badgeConfig |
Es la configuración de la insignia para esta opción. Cuando se establece, la etiqueta a la que pertenece esta opción se considera una "etiqueta con insignia". |
insertBeforeChoice |
Solo entrada. Inserta o mueve esta opción antes de la opción indicada. Si está vacío, la opción se ubica al final de la lista. |
BadgeConfig
Estado de la insignia de la etiqueta.
Representación JSON |
---|
{
"color": {
object ( |
Campos | |
---|---|
color |
El color de la insignia Si no se especifica, no se mostrará ninguna insignia. Los colores de fondo, primero y solo (modo claro y oscuro) que se definen aquí se cambian en la IU de Drive al color compatible recomendado más cercano. |
priorityOverride |
Anula la prioridad global predeterminada de esta insignia. Cuando se establece en 0, se usa la heurística de prioridad predeterminada. |
DisplayHints
La IU muestra sugerencias para renderizar una opción.
Representación JSON |
---|
{ "disabled": boolean, "hiddenInSearch": boolean, "shownInApply": boolean, "badgeColors": { object ( |
Campos | |
---|---|
disabled |
Indica si la opción se debe mostrar en la IU como inhabilitada. |
shownInApply |
Esta opción debe aparecer en el menú Aplicar cuando se aplican valores a un elemento de Drive. |
badgeColors |
Los colores que se usarán para la insignia. Se cambiaron a los colores de Google Material en función del |
darkBadgeColors |
Indica el color de modo oscuro que se usará para la insignia. Se cambiaron a los colores de Google Material en función del |
badgePriority |
La prioridad de esta insignia. Se usa para comparar y ordenar entre múltiples insignias. Un número menor significa que la insignia debe mostrarse primero. Si no hay una configuración de insignia, el valor será 0. De lo contrario, se establecerá como |
BadgeColors
El color derivado de BadgeConfig y cambió al color admitido recomendado más parecido.
Representación JSON |
---|
{ "backgroundColor": { object ( |
Campos | |
---|---|
backgroundColor |
Solo salida. Fondo de la insignia que se sincroniza con el primer plano. |
foregroundColor |
Solo salida. Agrega una insignia en primer plano que se sincroniza con el fondo. |
soloColor |
Solo salida. Color que se puede usar para el texto sin fondo. |
SchemaCapabilities
Son las funciones relacionadas con esta opción cuando la editas.
Representación JSON |
---|
{ "canUpdate": boolean, "canDelete": boolean, "canDisable": boolean, "canEnable": boolean } |
Campos | |
---|---|
canUpdate |
Indica si el usuario puede actualizar esta opción. |
canDelete |
Indica si el usuario puede borrar esta opción. |
canDisable |
Indica si el usuario puede inhabilitar esta opción. |
canEnable |
Indica si el usuario puede habilitar esta opción. |
AppliedCapabilities
Las capacidades relacionadas con esta elección en los metadatos aplicados.
Representación JSON |
---|
{ "canRead": boolean, "canSearch": boolean, "canSelect": boolean } |
Campos | |
---|---|
canRead |
Indica si el usuario puede leer metadatos aplicados relacionados en los elementos. |
canSearch |
Indica si el usuario puede usar esta opción en las búsquedas. |
canSelect |
Indica si el usuario puede seleccionar esta opción en un elemento. |
LockStatus
Contiene información sobre si un componente de etiqueta debe considerarse bloqueado.
Representación JSON |
---|
{ "locked": boolean } |
Campos | |
---|---|
locked |
Solo salida. Indica si este componente de etiqueta es el objetivo (directo) de un LabelLock. Un componente de etiqueta se puede bloquear de forma implícita incluso si no es el destino directo de un LabelLock, en cuyo caso este campo se establece como false. |
UserOptions
Opciones para el tipo de campo del usuario.
Representación JSON |
---|
{
"listOptions": {
object ( |
Campos | |
---|---|
listOptions |
Cuando se especifica, indica que este campo admite una lista de valores. Una vez que se publique el campo, no se podrá modificar. |
Propiedades
Las propiedades básicas del campo.
Representación JSON |
---|
{ "displayName": string, "required": boolean, "insertBeforeField": string } |
Campos | |
---|---|
displayName |
Obligatorio. Es el texto visible que se mostrará en la IU que identifica este campo. |
required |
Si el campo se debe marcar como obligatorio. |
insertBeforeField |
Solo entrada. Inserta o mueve este campo antes del campo indicado. Si está vacío, el campo se coloca al final de la lista. |
DisplayHints
Sugerencias de visualización de la IU para renderizar un campo
Representación JSON |
---|
{ "required": boolean, "disabled": boolean, "hiddenInSearch": boolean, "shownInApply": boolean } |
Campos | |
---|---|
required |
Si el campo se debe mostrar como obligatorio en la IU |
disabled |
Indica si el campo se debe mostrar en la IU como inhabilitado. |
shownInApply |
Este campo debe mostrarse en el menú Aplicar cuando se aplican valores a un elemento de Drive. |
SchemaCapabilities
Corresponde a las funciones relacionadas con este campo cuando lo editas.
Representación JSON |
---|
{ "canUpdate": boolean, "canDelete": boolean, "canDisable": boolean, "canEnable": boolean } |
Campos | |
---|---|
canUpdate |
Indica si el usuario puede cambiar este campo. |
canDelete |
Indica si el usuario puede borrar este campo. El usuario debe tener permiso y el campo debe quedar obsoleto. |
canDisable |
Indica si el usuario puede inhabilitar este campo. El usuario debe tener permiso y este campo no debe estar inhabilitado. |
canEnable |
Indica si el usuario puede habilitar este campo. El usuario debe tener permiso y este campo debe estar inhabilitado. |
AppliedCapabilities
Las capacidades relacionadas con este campo en los metadatos aplicados.
Representación JSON |
---|
{ "canRead": boolean, "canSearch": boolean, "canWrite": boolean } |
Campos | |
---|---|
canRead |
Indica si el usuario puede leer metadatos aplicados relacionados en los elementos. |
canSearch |
Indica si el usuario puede buscar elementos de Drive que hagan referencia a este campo. |
canWrite |
Indica si el usuario puede establecer este campo en los elementos de Drive. |
Métodos |
|
---|---|
|
Crea una etiqueta nueva. |
|
Borra de forma permanente una etiqueta y los metadatos relacionados de los elementos de Drive. |
|
Actualiza una sola etiqueta mediante la aplicación de un conjunto de solicitudes de actualización, lo que genera un nuevo borrador de revisión. |
|
Inhabilitar una etiqueta publicada |
|
Habilitar una etiqueta inhabilitada y restablecerla a su estado publicado. |
|
Obtén una etiqueta por su nombre de recurso. |
|
Enumerar etiquetas |
|
Publicar todos los cambios en borrador de la etiqueta |
|
Actualiza el CopyMode de una etiqueta. |
|
Actualiza los permisos de una etiqueta. |