- Recurso: Label
- LabelType
- UserInfo
- Propiedades
- Lifecycle
- Estado
- DisabledPolicy
- DisplayHints
- AppliedCapabilities
- SchemaCapabilities
- AppliedLabelPolicy
- CopyMode
- Campo
- TextOptions
- IntegerOptions
- DateOptions
- DateFormat
- Fecha
- SelectionOptions
- ListOptions
- Opción
- Propiedades
- BadgeConfig
- Color
- DisplayHints
- BadgeColors
- SchemaCapabilities
- AppliedCapabilities
- LockStatus
- UserOptions
- Propiedades
- DisplayHints
- SchemaCapabilities
- AppliedCapabilities
- EnabledAppSettings
- EnabledApp
- Aplicaciones
- Métodos
Recurso: Label
Una etiqueta define una taxonomía que se puede aplicar a los elementos de Drive para organizarlos y realizar búsquedas en ellos. Las etiquetas pueden ser cadenas simples o contener campos que describan metadatos adicionales que se pueden usar 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 a nivel global de esta etiqueta. El ID forma parte de la etiqueta |
revisionId |
Solo salida. Es el ID de revisión de la etiqueta. El ID de revisión puede formar parte de la etiqueta |
labelType |
Es obligatorio. Es el tipo de etiqueta. |
creator |
Solo salida. Es el usuario que creó esta etiqueta. |
createTime |
Solo salida. Es la fecha y hora en que se creó esta etiqueta. |
revisionCreator |
Solo salida. Es el usuario que creó esta revisión de la etiqueta. |
revisionCreateTime |
Solo salida. Es la fecha y hora en que se creó esta revisión de la etiqueta. |
publisher |
Solo salida. Es el usuario que publicó esta etiqueta. Este valor no tiene significado cuando la etiqueta no se publica. |
publishTime |
Solo salida. Fecha y hora en que se publicó la etiqueta. Este valor no tiene significado cuando la etiqueta no se publica. |
disabler |
Solo salida. Es el usuario que inhabilitó esta etiqueta. Este valor no tiene significado cuando la etiqueta no está inhabilitada. |
disableTime |
Solo salida. Fecha y hora en que se inhabilitó esta etiqueta. Este valor no tiene significado cuando la etiqueta no está inhabilitada. |
customer |
Solo salida. Es el cliente al que pertenece esta etiqueta. Por ejemplo: |
properties |
Es obligatorio. Son las propiedades básicas de la etiqueta. |
lifecycle |
Solo salida. Es el estado del ciclo de vida de la etiqueta, que incluye si se publicó, si está obsoleta y si tiene cambios en el borrador. |
displayHints |
Solo salida. Sugerencias de visualización de la IU para renderizar la etiqueta. |
appliedCapabilities |
Solo salida. Son las capacidades relacionadas con esta etiqueta en los metadatos aplicados. |
schemaCapabilities |
Solo salida. Son las capacidades que tiene el usuario en esta etiqueta. |
appliedLabelPolicy |
Solo salida. Es el comportamiento de esta etiqueta cuando se aplica a elementos de Drive. |
fields[] |
Es la lista de campos en orden de prioridad descendente. |
learnMoreUri |
Es la URL personalizada que se presenta a los usuarios para que obtengan más información sobre esta etiqueta y cómo se debe usar. |
lockStatus |
Solo salida. Es el |
enabledAppSettings |
Opcional. Es el |
LabelType
Es el tipo de esta etiqueta.
Enumeraciones | |
---|---|
LABEL_TYPE_UNSPECIFIED |
Tipo de etiqueta desconocido. |
SHARED |
Las etiquetas compartidas se pueden compartir con los usuarios para que las apliquen a los elementos de Drive. |
ADMIN |
Es una etiqueta propiedad del administrador. Solo los administradores pueden crearla y editarla. Admite algunas funciones adicionales exclusivas para administradores. |
GOOGLE_APP |
Es una etiqueta que pertenece a una aplicación interna de Google en lugar de a un cliente. Estas etiquetas son de solo lectura. |
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, |
Propiedades
Son las propiedades básicas de la etiqueta.
Representación JSON |
---|
{ "title": string, "description": string } |
Campos | |
---|---|
title |
Es obligatorio. Es el título de la etiqueta. |
description |
Es la descripción de la etiqueta. |
Lifecycle
Es el estado del ciclo de vida de un objeto, como una etiqueta, un campo o una opción. Para obtener más información, consulta Ciclo de vida de las etiquetas.
El ciclo de vida aplica las siguientes transiciones:
UNPUBLISHED_DRAFT
(estado inicial)UNPUBLISHED_DRAFT
->PUBLISHED
UNPUBLISHED_DRAFT
-> (Borrado)PUBLISHED
->DISABLED
DISABLED
->PUBLISHED
DISABLED
-> (Borrado)
Los estados publicado y inhabilitado tienen algunas características distintivas:
Published
: Es posible que se realicen algunos tipos de cambios en un objeto en este estado, en cuyo casohasUnpublishedChanges
será verdadero. Además, no se permiten algunos tipos de cambios. En general, se rechaza cualquier cambio que invalide o genere nuevas restricciones en los metadatos existentes relacionados con la etiqueta.Disabled
: Cuando se inhabilita, se aplica elDisabledPolicy
configurado.
Representación JSON |
---|
{ "state": enum ( |
Campos | |
---|---|
state |
Solo salida. Es el estado del objeto asociado a este ciclo de vida. |
hasUnpublishedChanges |
Solo salida. Indica si el objeto asociado a este ciclo de vida tiene cambios sin publicar. |
disabledPolicy |
Es la política que rige cómo mostrar una etiqueta, un campo o una opción de selección inhabilitados. |
Estado
Es el estado del objeto asociado a este ciclo de vida.
Enumeraciones | |
---|---|
STATE_UNSPECIFIED |
Estado desconocido. |
UNPUBLISHED_DRAFT |
Es el estado inicial de un objeto. Una vez publicado, el objeto nunca podrá 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 de borrador no publicados, como se indica con hasUnpublishedChanges . |
DISABLED |
El objeto se publicó y, luego, se inhabilitó. Es posible que el objeto tenga cambios de borrador no publicados, como se indica con hasUnpublishedChanges . |
DELETED |
Se borró el objeto. |
DisabledPolicy
Es la política que rige cómo tratar una etiqueta, un campo o una opción de selección inhabilitados 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 elementos de Drive.
|
showInApply |
Indica si se debe mostrar este objeto inhabilitado en el menú de aplicación de los elementos de Drive.
|
DisplayHints
Son las 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 debe mostrarse inhabilitada en la IU. |
shownInApply |
Esta etiqueta se debe mostrar en el menú de aplicación cuando se apliquen valores a un elemento de Drive. |
priority |
Es el orden en el que se mostrarán las etiquetas en una lista. |
AppliedCapabilities
Son 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 capacidades 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
Es el comportamiento de esta etiqueta cuando se aplica a elementos de Drive.
Representación JSON |
---|
{
"copyMode": enum ( |
Campos | |
---|---|
copyMode |
Indica cómo se deben copiar la etiqueta aplicada y los valores de los campos cuando se copia un elemento de Drive. |
CopyMode
Indica cómo se deben copiar la etiqueta aplicada y los valores de los campos cuando se copia un elemento de Drive.
Enumeraciones | |
---|---|
COPY_MODE_UNSPECIFIED |
No se especificó el modo de copia. |
DO_NOT_COPY |
La etiqueta y los valores de campo aplicados no se copian de forma predeterminada cuando se copia el elemento de Drive al que se aplicaron. |
ALWAYS_COPY |
La etiqueta y los valores de campo aplicados siempre se copian cuando se copia el elemento de Drive al que se aplicaron. Solo los administradores pueden usar este modo. |
COPY_APPLIABLE |
La etiqueta aplicada y los valores de campo se copian si el usuario que realiza 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 establecer en un elemento de Drive.
Representación JSON |
---|
{ "id": string, "queryKey": string, "properties": { object ( |
Campos | |
---|---|
id |
Solo salida. Es la clave de un campo, que es única dentro de una etiqueta o biblioteca. Este valor se genera automáticamente. Coincide con la regex: |
queryKey |
Solo salida. Es la clave que se usa cuando se construyen consultas de búsqueda de Drive para encontrar archivos según los valores definidos para este campo en los archivos. Por ejemplo, " |
properties |
Son las propiedades básicas del campo. |
lifecycle |
Solo salida. Es el ciclo de vida de este campo. |
displayHints |
Solo salida. Son sugerencias de visualización de la IU para renderizar un campo. |
schemaCapabilities |
Solo salida. Son las capacidades que tiene este usuario cuando edita este campo. |
appliedCapabilities |
Solo salida. Son 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. Es el usuario que creó este campo. |
createTime |
Solo salida. Es la fecha y hora en que se creó este campo. |
updater |
Solo salida. Es el usuario que modificó este campo. |
updateTime |
Solo salida. Fecha y hora en que se actualizó este campo. |
publisher |
Solo salida. Es el usuario que publicó este campo. Este valor no tiene significado cuando el campo no se publica. |
disabler |
Solo salida. Es el usuario que inhabilitó este campo. Este valor no tiene significado cuando el campo no está inhabilitado. |
disableTime |
Solo salida. Es la fecha y hora en que se inhabilitó este campo. Este valor no tiene significado cuando el campo no está inhabilitado. |
lockStatus |
Solo salida. Es el |
Campo de unión type . Son el tipo de datos y las opciones de este campo. Una vez publicado, no se puede cambiar el tipo de datos. Las direcciones (type ) solo pueden ser una de las siguientes opciones: |
|
textOptions |
Opciones de campo de texto |
integerOptions |
Son las opciones de campo de número entero. |
dateOptions |
Son las opciones del campo de fecha. |
selectionOptions |
Opciones de campo de selección. |
userOptions |
Son las opciones de campos del usuario. |
TextOptions
Son las opciones para el tipo de campo de texto.
Representación JSON |
---|
{ "minLength": integer, "maxLength": integer } |
Campos | |
---|---|
minLength |
Solo salida. Es la longitud mínima válida de los valores para el campo de texto. |
maxLength |
Solo salida. Es la longitud máxima válida de los valores para el campo de texto. |
IntegerOptions
Son las opciones para el tipo de campo Integer.
Representación JSON |
---|
{ "minValue": string, "maxValue": string } |
Campos | |
---|---|
minValue |
Solo salida. Es el valor válido mínimo para el campo de número entero. |
maxValue |
Solo salida. Es el valor máximo válido para el campo de número entero. |
DateOptions
Son las opciones para el tipo de campo de fecha.
Representación JSON |
---|
{ "dateFormatType": enum ( |
Campos | |
---|---|
dateFormatType |
Opción de formato de fecha localizada. Los valores de los campos se renderizan en este formato según su configuración regional. |
dateFormat |
Solo salida. Es el formato de fecha de ICU. |
minValue |
Solo salida. Es el valor mínimo válido (año, mes, día). |
maxValue |
Solo salida. Es el valor máximo válido (año, mes, día). |
DateFormat
Son opciones de formato de fecha localizadas.
Enumeraciones | |
---|---|
DATE_FORMAT_UNSPECIFIED |
No se especificó el formato de fecha. |
LONG_DATE |
Incluye el nombre completo del mes. Por ejemplo, 12 de enero de 1999 (MMMM d, aaaa) |
SHORT_DATE |
Es una representación numérica corta. Por ejemplo, 13/12/99 (d/M/aa) |
Fecha
Representa una fecha de calendario completa o parcial, como un cumpleaños. La hora del día y la zona horaria se especifican en otro lugar o son insignificantes. La fecha está relacionada con el calendario gregoriano. Puede representar una de las siguientes opciones:
- Una fecha completa con valores para el año, mes y día que no sean cero.
- Un mes y un día, con cero año (por ejemplo, un aniversario).
- Un año por sí solo, con un mes cero y un día cero.
- Es un año y un mes, con un día cero (por ejemplo, la fecha de vencimiento de una tarjeta de crédito).
Tipos relacionados:
google.type.TimeOfDay
google.type.DateTime
google.protobuf.Timestamp
Representación JSON |
---|
{ "year": integer, "month": integer, "day": integer } |
Campos | |
---|---|
year |
Año de la fecha. Debe ser entre 1 y 9,999, o bien 0 para especificar una fecha sin año. |
month |
Mes del año. Debe ser del 1 al 12 o 0 para especificar un año sin un mes ni un día. |
day |
Día del mes. Debe ser entre 1 y 31 y ser válido para el año y el mes o bien 0 para especificar un año solo o un año y un mes en los que el día no sea significativo. |
SelectionOptions
Son las 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 publica el campo, no se puede cambiar. |
choices[] |
Son las opciones disponibles para este campo de selección. El orden de la lista es coherente y se modifica con |
ListOptions
Son las opciones para una variante con varios valores de un tipo de campo asociado.
Representación JSON |
---|
{ "maxEntries": integer } |
Campos | |
---|---|
maxEntries |
Es la cantidad máxima de entradas permitidas. |
Opciones
Es la opció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 |
Son las propiedades básicas de la opción. |
lifecycle |
Solo salida. Es el ciclo de vida de la elección. |
displayHints |
Solo salida. Son sugerencias de visualización de la IU para renderizar una opción. |
schemaCapabilities |
Solo salida. Son las capacidades relacionadas con esta opción cuando se edita. |
appliedCapabilities |
Solo salida. Son 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. Fecha y hora en que se creó esta opción. |
updater |
Solo salida. Es el usuario que actualizó esta opción por última vez. |
updateTime |
Solo salida. Fecha y hora en la que se actualizó esta elección por última vez. |
publisher |
Solo salida. Es el usuario que publicó esta opción. Este valor no tiene significado cuando la opción no se publica. |
publishTime |
Solo salida. Fecha y hora en que se publicó esta elección. Este valor no tiene significado cuando la opción no se publica. |
disabler |
Solo salida. Es el usuario que inhabilitó esta opción. Este valor no tiene significado cuando la opción no está inhabilitada. |
disableTime |
Solo salida. Fecha y hora en que se inhabilitó esta opción. Este valor no tiene significado cuando la opción no está inhabilitada. |
lockStatus |
Solo salida. Es el |
Propiedades
Son las propiedades básicas de la opción.
Representación JSON |
---|
{
"displayName": string,
"description": string,
"badgeConfig": {
object ( |
Campos | |
---|---|
displayName |
Es obligatorio. Es el texto que se muestra en la IU para identificar este campo. |
description |
Es la descripción de esta etiqueta. |
badgeConfig |
Es la configuración de distintivo para esta opción. Cuando se configura, la etiqueta que posee esta opción se considera una "etiqueta con distintivo". |
insertBeforeChoice |
Solo entrada. Inserta o mueve esta opción antes de la opción indicada. Si está vacío, la opción se coloca al final de la lista. |
BadgeConfig
Es el estado de la insignia de la etiqueta.
Representación JSON |
---|
{
"color": {
object ( |
Campos | |
---|---|
color |
Color de la insignia. Cuando no se especifica, no se renderiza ninguna insignia. Los colores de fondo, primer plano y solo (modo claro y oscuro) que se configuran 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. |
Color
Representa un color en el espacio de color RGBA. Esta representación está diseñada para facilitar la conversión a representaciones de color y desde ellas en varios idiomas, en lugar de priorizar la compacidad. Por ejemplo, los campos de esta representación se pueden proporcionar de forma trivial al constructor de java.awt.Color
en Java, también se pueden proporcionar de forma trivial al método +colorWithRed:green:blue:alpha
de UIColor en iOS y, con un poco de trabajo, se pueden formatear fácilmente en una cadena rgba()
de CSS en JavaScript.
Esta página de referencia no contiene información sobre el espacio de color absoluto que se debe usar para interpretar el valor RGB (por ejemplo, sRGB, Adobe RGB, DCI-P3 y BT.2020). De forma predeterminada, las aplicaciones deben tener el espacio de color sRGB.
Cuando se debe decidir la igualdad de color, las implementaciones, a menos que se documente lo contrario, tratan dos colores como iguales si todos sus valores de rojo, verde, azul y alfa difieren en un máximo de 1e-5
.
Ejemplo (Java):
import com.google.type.Color;
// ...
public static java.awt.Color fromProto(Color protocolor) {
float alpha = protocolor.hasAlpha()
? protocolor.getAlpha().getValue()
: 1.0;
return new java.awt.Color(
protocolor.getRed(),
protocolor.getGreen(),
protocolor.getBlue(),
alpha);
}
public static Color toProto(java.awt.Color color) {
float red = (float) color.getRed();
float green = (float) color.getGreen();
float blue = (float) color.getBlue();
float denominator = 255.0;
Color.Builder resultBuilder =
Color
.newBuilder()
.setRed(red / denominator)
.setGreen(green / denominator)
.setBlue(blue / denominator);
int alpha = color.getAlpha();
if (alpha != 255) {
result.setAlpha(
FloatValue
.newBuilder()
.setValue(((float) alpha) / denominator)
.build());
}
return resultBuilder.build();
}
// ...
Ejemplo (iOS / Obj-C):
// ...
static UIColor* fromProto(Color* protocolor) {
float red = [protocolor red];
float green = [protocolor green];
float blue = [protocolor blue];
FloatValue* alpha_wrapper = [protocolor alpha];
float alpha = 1.0;
if (alpha_wrapper != nil) {
alpha = [alpha_wrapper value];
}
return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
}
static Color* toProto(UIColor* color) {
CGFloat red, green, blue, alpha;
if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
return nil;
}
Color* result = [[Color alloc] init];
[result setRed:red];
[result setGreen:green];
[result setBlue:blue];
if (alpha <= 0.9999) {
[result setAlpha:floatWrapperWithValue(alpha)];
}
[result autorelease];
return result;
}
// ...
Ejemplo (JavaScript):
// ...
var protoToCssColor = function(rgb_color) {
var redFrac = rgb_color.red || 0.0;
var greenFrac = rgb_color.green || 0.0;
var blueFrac = rgb_color.blue || 0.0;
var red = Math.floor(redFrac * 255);
var green = Math.floor(greenFrac * 255);
var blue = Math.floor(blueFrac * 255);
if (!('alpha' in rgb_color)) {
return rgbToCssColor(red, green, blue);
}
var alphaFrac = rgb_color.alpha.value || 0.0;
var rgbParams = [red, green, blue].join(',');
return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
};
var rgbToCssColor = function(red, green, blue) {
var rgbNumber = new Number((red << 16) | (green << 8) | blue);
var hexString = rgbNumber.toString(16);
var missingZeros = 6 - hexString.length;
var resultBuilder = ['#'];
for (var i = 0; i < missingZeros; i++) {
resultBuilder.push('0');
}
resultBuilder.push(hexString);
return resultBuilder.join('');
};
// ...
Representación JSON |
---|
{ "red": number, "green": number, "blue": number, "alpha": number } |
Campos | |
---|---|
red |
La cantidad de rojo en el color como un valor en el intervalo [0, 1]. |
green |
La cantidad de verde en el color como un valor en el intervalo [0, 1]. |
blue |
La cantidad de azul en el color como un valor en el intervalo [0, 1]. |
alpha |
La fracción de este color que se debe aplicar al píxel. Es decir, el color del píxel final se define mediante la siguiente ecuación:
Esto significa que el valor 1.0 corresponde a un color sólido, mientras que el valor 0.0 corresponde a un color completamente transparente. Esto utiliza un mensaje de wrapper en lugar de un escalar flotante simple, para que sea posible distinguir entre un valor predeterminado y el valor que no se configura. Si se omite, este objeto de color se renderiza como un color sólido (como si el valor alfa se hubiera proporcionado de forma explícita con un valor de 1.0). |
DisplayHints
Son sugerencias de visualización de la IU para renderizar una opción.
Representación JSON |
---|
{ "disabled": boolean, "hiddenInSearch": boolean, "shownInApply": boolean, "badgeColors": { object ( |
Campos | |
---|---|
disabled |
Indica si la opción debe mostrarse inhabilitada en la IU. |
shownInApply |
Esta opción debe mostrarse en el menú de aplicación cuando se apliquen valores a un elemento de Drive. |
badgeColors |
Son los colores que se usarán para la insignia. Se cambiaron a los colores de Material de Google según el |
darkBadgeColors |
Color del modo oscuro que se usará para la insignia. Se cambiaron a los colores de Material de Google según el |
badgePriority |
Es la prioridad de esta insignia. Se usa para comparar y ordenar varias insignias. Un número más bajo significa que la insignia debe mostrarse primero. Cuando no hay una configuración de insignias, este valor será 0. De lo contrario, se establecerá en |
BadgeColors
Es el color derivado de BadgeConfig y cambiado al color compatible recomendado más cercano.
Representación JSON |
---|
{ "backgroundColor": { object ( |
Campos | |
---|---|
backgroundColor |
Solo salida. Es el fondo de la insignia que se combina con el primer plano. |
foregroundColor |
Solo salida. Es el primer plano de la insignia que se combina con el fondo. |
soloColor |
Solo salida. Color que se puede usar para el texto sin fondo. |
SchemaCapabilities
Son las capacidades relacionadas con esta opción cuando se edita.
Representación JSON |
---|
{ "canUpdate": boolean, "canDelete": boolean, "canDisable": boolean, "canEnable": boolean } |
Campos | |
---|---|
canUpdate |
Indica si el usuario puede actualizar esta elección. |
canDelete |
Indica si el usuario puede borrar esta elección. |
canDisable |
Indica si el usuario puede inhabilitar esta opción. |
canEnable |
Indica si el usuario puede habilitar esta opción. |
AppliedCapabilities
Son 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 los 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 bloqueo de etiqueta. Un componente de etiqueta se puede bloquear de forma implícita, incluso si no es el objetivo directo de un bloqueo de etiqueta, en cuyo caso este campo se establece como falso. |
UserOptions
Son las opciones del tipo de campo de usuario.
Representación JSON |
---|
{
"listOptions": {
object ( |
Campos | |
---|---|
listOptions |
Cuando se especifica, indica que este campo admite una lista de valores. Una vez que se publica el campo, no se puede cambiar. |
Propiedades
Son las propiedades básicas del campo.
Representación JSON |
---|
{ "displayName": string, "required": boolean, "insertBeforeField": string } |
Campos | |
---|---|
displayName |
Es obligatorio. Es el texto que se muestra en la IU para identificar este campo. |
required |
Indica si el campo debe marcarse 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
Son sugerencias de visualización de la IU para renderizar un campo.
Representación JSON |
---|
{ "required": boolean, "disabled": boolean, "hiddenInSearch": boolean, "shownInApply": boolean } |
Campos | |
---|---|
required |
Indica si el campo debe mostrarse como obligatorio en la IU. |
disabled |
Indica si el campo debe mostrarse inhabilitado en la IU. |
shownInApply |
Este campo se debe mostrar en el menú de aplicación cuando se apliquen valores a un elemento de Drive. |
SchemaCapabilities
Son las capacidades relacionadas con este campo cuando se edita.
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 estar en desuso. |
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
Son 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 los 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. |
EnabledAppSettings
Describe las apps de Google Workspace en las que se puede usar la etiqueta.
Representación JSON |
---|
{
"enabledApps": [
{
object ( |
Campos | |
---|---|
enabledApps[] |
Opcional. Es la lista de apps en las que se puede usar la etiqueta. |
EnabledApp
Es una app en la que se puede usar la etiqueta.
Representación JSON |
---|
{
"app": enum ( |
Campos | |
---|---|
app |
Opcional. Corresponde al nombre de la app. |
Aplicación
Es el conjunto de apps de Google Workspace en las que se pueden usar etiquetas.
Enumeraciones | |
---|---|
APP_UNSPECIFIED |
Sin especificar |
DRIVE |
Drive |
GMAIL |
Gmail |
Métodos |
|
---|---|
|
Crea una etiqueta. |
|
Borra de forma permanente una etiqueta y los metadatos relacionados en los elementos de Drive. |
|
Actualiza una sola etiqueta aplicando un conjunto de solicitudes de actualización que dan como resultado una nueva revisión de borrador. |
|
Inhabilita una etiqueta publicada. |
|
Habilita una etiqueta inhabilitada y restablécela a su estado publicado. |
|
Obtiene una etiqueta por su nombre de recurso. |
|
Enumera etiquetas. |
|
Publica todos los cambios del borrador en el sello. |
|
Actualiza el CopyMode de una etiqueta. |
|
Actualiza el EnabledAppSettings de una etiqueta. |
|
Actualiza los permisos de una etiqueta. |