- Risorsa: etichetta
- LabelType
- UserInfo
- Proprietà
- Ciclo di vita
- Stato
- DisabledPolicy
- DisplayHints
- AppliedCapabilities
- SchemaCapabilities
- AppliedLabelPolicy
- CopyMode
- Campo
- TextOptions
- IntegerOptions
- DateOptions
- DateFormat
- SelectionOptions
- ListOptions
- Scelta
- Proprietà
- BadgeConfig
- DisplayHints
- BadgeColors
- SchemaCapabilities
- AppliedCapabilities
- LockStatus
- UserOptions
- Proprietà
- DisplayHints
- SchemaCapabilities
- AppliedCapabilities
- Metodi
Risorsa: etichetta
Un'etichetta definisce una tassonomia che può essere applicata agli elementi di Drive per organizzare e cercare tra gli elementi. Le etichette possono essere stringhe semplici o contenere campi che descrivono metadati aggiuntivi che possono essere ulteriormente utilizzati per organizzare e cercare elementi di Drive.
Rappresentazione JSON |
---|
{ "name": string, "id": string, "revisionId": string, "labelType": enum ( |
Campi | |
---|---|
name |
Solo output. Nome della risorsa dell'etichetta. nel formato |
id |
Solo output. Identificatore univoco a livello globale di questa etichetta. L'ID fa parte dell'etichetta |
revisionId |
Solo output. ID revisione dell'etichetta. A seconda della richiesta inviata, l'ID revisione potrebbe far parte dell'etichetta |
labelType |
Obbligatorio. Il tipo di etichetta. |
creator |
Solo output. L'utente che ha creato questa etichetta. |
createTime |
Solo output. L'ora di creazione dell'etichetta. |
revisionCreator |
Solo output. L'utente che ha creato questa revisione dell'etichetta. |
revisionCreateTime |
Solo output. L'ora in cui è stata creata questa revisione dell'etichetta. |
publisher |
Solo output. L'utente che ha pubblicato questa etichetta. Questo valore non ha significato quando l'etichetta non viene pubblicata. |
publishTime |
Solo output. L'ora in cui è stata pubblicata questa etichetta. Questo valore non ha significato quando l'etichetta non viene pubblicata. |
disabler |
Solo output. L'utente che ha disattivato questa etichetta. Questo valore non ha significato quando l'etichetta non è disabilitata. |
disableTime |
Solo output. L'ora in cui questa etichetta è stata disattivata. Questo valore non ha significato quando l'etichetta non è disabilitata. |
customer |
Solo output. Il cliente a cui appartiene questa etichetta. Ad esempio: "customers/123abc789". |
properties |
Obbligatorio. Le proprietà di base dell'etichetta. |
lifecycle |
Solo output. Lo stato del ciclo di vita dell'etichetta, incluso se è pubblicata, deprecata e se presenta modifiche in bozza. |
displayHints |
Solo output. UI che mostra suggerimenti per il rendering dell'etichetta. |
appliedCapabilities |
Solo output. Le funzionalità relative a questa etichetta sui metadati applicati. |
schemaCapabilities |
Solo output. Le funzionalità dell'utente relative a questa etichetta. |
appliedLabelPolicy |
Solo output. Comportamento di questa etichetta quando viene applicata a elementi di Drive. |
fields[] |
Elenco di campi in ordine di priorità decrescente. |
learnMoreUri |
URL personalizzato da presentare agli utenti per consentire loro di saperne di più su questa etichetta e su come dovrebbe essere utilizzata. |
lockStatus |
Solo output. Il LockStatus di questa etichetta. |
LabelType
Il tipo di questa etichetta.
Enum | |
---|---|
LABEL_TYPE_UNSPECIFIED |
Tipo di etichetta sconosciuto. |
SHARED |
Le etichette condivise possono essere condivise con gli utenti per essere applicate agli elementi di Drive. |
ADMIN |
Etichetta di proprietà dell'amministratore. Possono essere creati e modificabili solo dagli amministratori. Supporta alcune funzionalità aggiuntive riservate agli amministratori. |
UserInfo
Informazioni su un utente.
Rappresentazione JSON |
---|
{ "person": string } |
Campi | |
---|---|
person |
L'identificatore di questo utente che può essere utilizzato con l'API People per ottenere ulteriori informazioni. Ad esempio, people/12345678. |
Proprietà
Proprietà di base dell'etichetta.
Rappresentazione JSON |
---|
{ "title": string, "description": string } |
Campi | |
---|---|
title |
Obbligatorio. Titolo dell'etichetta. |
description |
La descrizione dell'etichetta. |
Lifecycle
Lo stato del ciclo di vita di un oggetto, ad esempio etichetta, campo o scelta. Il ciclo di vita applica le seguenti transizioni:
UNPUBLISHED_DRAFT
(stato iniziale)UNPUBLISHED_DRAFT
->PUBLISHED
UNPUBLISHED_DRAFT
-> (Eliminata)PUBLISHED
->DISABLED
DISABLED
->PUBLISHED
DISABLED
-> (Eliminata)
Gli stati Pubblicato e Disattivato hanno alcune caratteristiche distinte:
- Pubblicato: è possibile apportare alcuni tipi di modifiche a un oggetto con questo stato, nel qual caso
hasUnpublishedChanges
sarà true. Inoltre, alcuni tipi di modifiche non sono ammessi. In genere, qualsiasi modifica che invaliderebbe o causerebbe nuove restrizioni sui metadati esistenti relativi all'etichetta viene rifiutata. - Disattivato: se disattivato, il criterio
DisabledPolicy
configurato viene applicato.
Rappresentazione JSON |
---|
{ "state": enum ( |
Campi | |
---|---|
state |
Solo output. Lo stato dell'oggetto associato a questo ciclo di vita. |
hasUnpublishedChanges |
Solo output. Indica se l'oggetto associato a questo ciclo di vita contiene modifiche non pubblicate. |
disabledPolicy |
La norma che regola come mostrare un'etichetta, un campo o una scelta di selezione disattivati. |
Stato
Lo stato dell'oggetto associato a questo ciclo di vita.
Enum | |
---|---|
STATE_UNSPECIFIED |
Stato sconosciuto. |
UNPUBLISHED_DRAFT |
Lo stato iniziale di un oggetto. Una volta pubblicato, l'oggetto non può più tornare a questo stato. Una volta pubblicato un oggetto, alcuni tipi di modifiche non sono più consentiti. |
PUBLISHED |
L'oggetto è stato pubblicato. L'oggetto potrebbe avere modifiche alla bozza non pubblicate, come indicato da hasUnpublishedChanges . |
DISABLED |
L'oggetto è stato pubblicato ed è stato disabilitato. L'oggetto potrebbe avere modifiche alla bozza non pubblicate, come indicato da hasUnpublishedChanges . |
DELETED |
L'oggetto è stato eliminato. |
DisabledPolicy
La norma che regola il trattamento di un'etichetta, di un campo o di una scelta di selezione disattivati in contesti diversi.
Rappresentazione JSON |
---|
{ "hideInSearch": boolean, "showInApply": boolean } |
Campi | |
---|---|
hideInSearch |
Indica se nascondere questo oggetto disattivato nel menu di ricerca per gli elementi di Drive.
|
showInApply |
Indica se mostrare questo oggetto disattivato nel menu Applica sugli elementi di Drive.
|
DisplayHints
UI che mostra suggerimenti per il rendering dell'etichetta.
Rappresentazione JSON |
---|
{ "disabled": boolean, "hiddenInSearch": boolean, "shownInApply": boolean, "priority": string } |
Campi | |
---|---|
disabled |
Indica se l'etichetta deve essere visualizzata nella UI come disabilitata. |
shownInApply |
Questa etichetta dovrebbe essere visualizzata nel menu Applica quando applichi valori a un elemento di Drive. |
priority |
Ordina per visualizzare l'etichetta in un elenco. |
AppliedCapabilities
Le funzionalità di un utente per i metadati applicati a questa etichetta.
Rappresentazione JSON |
---|
{ "canRead": boolean, "canApply": boolean, "canRemove": boolean } |
Campi | |
---|---|
canRead |
Indica se l'utente può leggere i metadati applicati relativi a questa etichetta. |
canApply |
Indica se l'utente può applicare questa etichetta agli elementi. |
canRemove |
Indica se l'utente può rimuovere questa etichetta dagli elementi. |
SchemaCapabilities
Le funzionalità relative a questa etichetta quando la modifichi.
Rappresentazione JSON |
---|
{ "canUpdate": boolean, "canDelete": boolean, "canDisable": boolean, "canEnable": boolean } |
Campi | |
---|---|
canUpdate |
Indica se l'utente può modificare questa etichetta. |
canDelete |
Indica se l'utente può eliminare questa etichetta. L'utente deve disporre dell'autorizzazione e l'etichetta deve essere disattivata. |
canDisable |
Indica se l'utente può disattivare questa etichetta. L'utente deve disporre dell'autorizzazione e questa etichetta non deve essere già disattivata. |
canEnable |
Indica se l'utente può attivare questa etichetta. L'utente deve disporre dell'autorizzazione e questa etichetta deve essere disattivata. |
AppliedLabelPolicy
Comportamento di questa etichetta quando viene applicata a elementi di Drive.
Rappresentazione JSON |
---|
{
"copyMode": enum ( |
Campi | |
---|---|
copyMode |
Indica come copiare le etichette e i valori dei campi applicati quando viene copiato un elemento di Drive. |
CopyMode
Indica come copiare le etichette e i valori dei campi applicati quando viene copiato un elemento di Drive.
Enum | |
---|---|
COPY_MODE_UNSPECIFIED |
Modalità di copia non specificata. |
DO_NOT_COPY |
Per impostazione predefinita, i valori dell'etichetta e dei campi applicati non vengono copiati quando viene copiato l'elemento di Drive a cui è applicata. |
ALWAYS_COPY |
I valori dell'etichetta e dei campi applicati vengono sempre copiati quando viene copiato l'elemento di Drive a cui è applicata. Solo gli amministratori possono utilizzare questa modalità. |
COPY_APPLIABLE |
I valori dell'etichetta e dei campi applicati vengono copiati se l'etichetta è applicabile dall'utente che effettua la copia. |
Campo
Definisce un campo con un nome visualizzato, un tipo di dati e altre opzioni di configurazione. Questo campo definisce il tipo di metadati che è possibile impostare su un elemento di Drive.
Rappresentazione JSON |
---|
{ "id": string, "queryKey": string, "properties": { object ( |
Campi | |
---|---|
id |
Solo output. La chiave di un campo, univoca all'interno di un'etichetta o libreria. Questo valore viene generato automaticamente. Corrisponde alla regex: |
queryKey |
Solo output. La chiave da utilizzare durante la creazione delle query di ricerca di Drive per trovare i file in base ai valori definiti per questo campo sui file. Ad esempio, " |
properties |
Le proprietà di base del campo. |
lifecycle |
Solo output. Il ciclo di vita di questo campo. |
displayHints |
Solo output. Suggerimenti dell'interfaccia utente per il rendering di un campo. |
schemaCapabilities |
Solo output. Le capacità dell'utente durante la modifica di questo campo. |
appliedCapabilities |
Solo output. Le funzionalità dell'utente in questo campo e il relativo valore quando l'etichetta viene applicata agli elementi di Drive. |
creator |
Solo output. L'utente che ha creato questo campo. |
createTime |
Solo output. L'ora di creazione di questo campo. |
updater |
Solo output. L'utente che ha modificato questo campo. |
updateTime |
Solo output. L'ora in cui questo campo è stato aggiornato. |
publisher |
Solo output. L'utente che ha pubblicato questo campo. Questo valore non ha significato quando il campo non viene pubblicato. |
disabler |
Solo output. L'utente che ha disattivato questo campo. Questo valore non ha significato se il campo non è disabilitato. |
disableTime |
Solo output. L'ora in cui questo campo è stato disattivato. Questo valore non ha significato se il campo non è disabilitato. |
lockStatus |
Solo output. Il valore LockStatus di questo campo. |
Campo di unione type . Il tipo di dati e le opzioni di questo campo. Una volta pubblicato, il tipo di dati non può essere modificato. type può essere solo uno dei seguenti: |
|
textOptions |
Opzioni del campo di testo. |
integerOptions |
Opzioni del campo del numero intero. |
dateOptions |
Opzioni del campo data. |
selectionOptions |
Opzioni del campo di selezione. |
userOptions |
Opzioni del campo utente. |
TextOptions
Opzioni per il tipo di campo Testo.
Rappresentazione JSON |
---|
{ "minLength": integer, "maxLength": integer } |
Campi | |
---|---|
minLength |
Solo output. La lunghezza minima dei valori valida per il campo di testo. |
maxLength |
Solo output. La lunghezza massima valida dei valori per il campo di testo. |
IntegerOptions
Opzioni per il tipo di campo Numero intero.
Rappresentazione JSON |
---|
{ "minValue": string, "maxValue": string } |
Campi | |
---|---|
minValue |
Solo output. Il valore minimo valido per il campo numero intero. |
maxValue |
Solo output. Il valore massimo valido per il campo Numero intero. |
DateOptions
Opzioni per il tipo di campo data.
Rappresentazione JSON |
---|
{ "dateFormatType": enum ( |
Campi | |
---|---|
dateFormatType |
Opzione di formattazione della data localizzata. I valori dei campi vengono visualizzati in questo formato in base alle impostazioni internazionali. |
dateFormat |
Solo output. Formato della data in T.I. |
minValue |
Solo output. Valore minimo valido (anno, mese, giorno). |
maxValue |
Solo output. Valore massimo valido (anno, mese, giorno). |
DateFormat
Opzioni di formato della data localizzate.
Enum | |
---|---|
DATE_FORMAT_UNSPECIFIED |
Formato data non specificato. |
LONG_DATE |
Include il nome completo del mese. Ad esempio, 12 gennaio 1999 (d MMMM y) |
SHORT_DATE |
Breve, numerico, rappresentazione. Ad esempio, 12/13/99 (M/g/aa) |
SelectionOptions
Opzioni per il tipo di campo di selezione.
Rappresentazione JSON |
---|
{ "listOptions": { object ( |
Campi | |
---|---|
listOptions |
Se specificato, indica che questo campo supporta un elenco di valori. Una volta pubblicato, il campo non può essere modificato. |
choices[] |
Le opzioni disponibili per questo campo di selezione. L'ordine dell'elenco è coerente ed è stato modificato con |
ListOptions
Opzioni per una variante a più valori di un tipo di campo associato.
Rappresentazione JSON |
---|
{ "maxEntries": integer } |
Campi | |
---|---|
maxEntries |
Numero massimo di voci consentito. |
Scelta
Scelta del campo di selezione.
Rappresentazione JSON |
---|
{ "id": string, "properties": { object ( |
Campi | |
---|---|
id |
Il valore univoco della scelta. Questo ID viene generato automaticamente. Corrisponde alla regex: |
properties |
Proprietà di base della scelta. |
lifecycle |
Solo output. Ciclo di vita della scelta. |
displayHints |
Solo output. Suggerimenti della visualizzazione dell'interfaccia utente per il rendering di una scelta. |
schemaCapabilities |
Solo output. Le funzionalità correlate a questa opzione durante la modifica dell'opzione. |
appliedCapabilities |
Solo output. Le funzionalità relative a questa scelta sui metadati applicati. |
creator |
Solo output. L'utente che ha creato questa scelta. |
createTime |
Solo output. L'ora in cui è stata creata la scelta. |
updater |
Solo output. L'utente che ha aggiornato questa scelta per ultimo. |
updateTime |
Solo output. L'ora dell'ultimo aggiornamento di questa scelta. |
publisher |
Solo output. L'utente che ha pubblicato questa scelta. Questo valore non ha significato quando la scelta non viene pubblicata. |
publishTime |
Solo output. L'ora in cui è stata pubblicata questa scelta. Questo valore non ha significato quando la scelta non viene pubblicata. |
disabler |
Solo output. L'utente che ha disattivato questa scelta. Questo valore non ha significato quando l'opzione non è disabilitata. |
disableTime |
Solo output. L'ora in cui questa scelta è stata disattivata. Questo valore non ha significato quando la scelta non è disabilitata. |
lockStatus |
Solo output. Il valore LockStatus di questa scelta. |
Proprietà
Proprietà di base della scelta.
Rappresentazione JSON |
---|
{
"displayName": string,
"description": string,
"badgeConfig": {
object ( |
Campi | |
---|---|
displayName |
Obbligatorio. Il testo visualizzato nell'interfaccia utente che identifica questo campo. |
description |
La descrizione di questa etichetta. |
badgeConfig |
La configurazione del badge per questa scelta. Se impostata, l'etichetta a cui appartiene la scelta viene considerata "etichetta con badge". |
insertBeforeChoice |
Solo input. Inserisci o sposta questa scelta prima di quella indicata. Se vuota, l'opzione viene inserita alla fine dell'elenco. |
BadgeConfig
Lo stato del badge dell'etichetta.
Rappresentazione JSON |
---|
{
"color": {
object ( |
Campi | |
---|---|
color |
Il colore del badge. Se non specificato, non viene visualizzato alcun badge. I colori dello sfondo, in primo piano e in modalità Solo (modalità Luce e Buio) impostati qui vengono modificati nell'interfaccia utente di Drive con il colore più simile consigliato supportato. |
priorityOverride |
Sostituisci la priorità globale predefinita di questo badge. Se impostato su 0, viene utilizzata l'euristica di priorità predefinita. |
DisplayHints
Suggerimenti di visualizzazione dell'interfaccia utente per il rendering di un'opzione.
Rappresentazione JSON |
---|
{ "disabled": boolean, "hiddenInSearch": boolean, "shownInApply": boolean, "badgeColors": { object ( |
Campi | |
---|---|
disabled |
Indica se l'opzione deve essere visualizzata nella UI come disabilitata. |
shownInApply |
Questa opzione dovrebbe essere mostrata nel menu Applica quando applichi valori a un elemento di Drive. |
badgeColors |
I colori da utilizzare per il badge. Sono stati modificati i colori del materiale Google in base al |
darkBadgeColors |
Il colore della modalità Buio da utilizzare per il badge. Sono stati modificati i colori del materiale Google in base al |
badgePriority |
La priorità di questo badge. Utilizzato per confrontare e ordinare tra più badge. Un numero inferiore indica che il badge deve essere mostrato per primo. Se non è presente una configurazione del badge, il valore sarà 0. In caso contrario, verrà impostato su |
BadgeColors
Il colore derivato da BadgeConfig e modificato nel colore più simile consigliato supportato.
Rappresentazione JSON |
---|
{ "backgroundColor": { object ( |
Campi | |
---|---|
backgroundColor |
Solo output. Sfondo del badge abbinato al primo piano. |
foregroundColor |
Solo output. Badge in primo piano che si accoppia allo sfondo. |
soloColor |
Solo output. Colore utilizzabile per il testo senza sfondo. |
SchemaCapabilities
Le funzionalità relative a questa scelta durante la modifica della scelta.
Rappresentazione JSON |
---|
{ "canUpdate": boolean, "canDelete": boolean, "canDisable": boolean, "canEnable": boolean } |
Campi | |
---|---|
canUpdate |
Indica se l'utente può aggiornare questa scelta. |
canDelete |
Indica se l'utente può eliminare questa scelta. |
canDisable |
Indica se l'utente può disabilitare questa scelta. |
canEnable |
Indica se l'utente può attivare questa scelta. |
AppliedCapabilities
Le funzionalità relative a questa scelta sui metadati applicati.
Rappresentazione JSON |
---|
{ "canRead": boolean, "canSearch": boolean, "canSelect": boolean } |
Campi | |
---|---|
canRead |
Indica se l'utente può leggere i metadati applicati correlati agli elementi. |
canSearch |
Indica se l'utente può utilizzare questa scelta nelle query di ricerca. |
canSelect |
Indica se l'utente può selezionare questa scelta per un elemento. |
LockStatus
Contiene informazioni che indicano se un componente dell'etichetta deve essere considerato bloccato.
Rappresentazione JSON |
---|
{ "locked": boolean } |
Campi | |
---|---|
locked |
Solo output. Indica se questo componente dell'etichetta è il target (diretto) di un'etichetta LabelLock. Un componente dell'etichetta può essere bloccato implicitamente anche se non è la destinazione diretta di un'etichetta LabelLock. In questo caso questo campo è impostato su false. |
UserOptions
Opzioni per il tipo di campo utente.
Rappresentazione JSON |
---|
{
"listOptions": {
object ( |
Campi | |
---|---|
listOptions |
Se specificato, indica che il campo supporta un elenco di valori. Una volta pubblicato, il campo non può essere modificato. |
Proprietà
Le proprietà di base del campo.
Rappresentazione JSON |
---|
{ "displayName": string, "required": boolean, "insertBeforeField": string } |
Campi | |
---|---|
displayName |
Obbligatorio. Il testo visualizzato nell'interfaccia utente che identifica questo campo. |
required |
Indica se il campo deve essere contrassegnato come obbligatorio. |
insertBeforeField |
Solo input. Inserisci o sposta questo campo prima del campo indicato. Se vuoto, il campo viene posizionato alla fine dell'elenco. |
DisplayHints
Suggerimenti dell'interfaccia utente per il rendering di un campo.
Rappresentazione JSON |
---|
{ "required": boolean, "disabled": boolean, "hiddenInSearch": boolean, "shownInApply": boolean } |
Campi | |
---|---|
required |
Indica se il campo deve essere visualizzato come richiesto nella UI. |
disabled |
Indica se il campo deve essere visualizzato nella UI come disabilitato. |
shownInApply |
Questo campo dovrebbe essere mostrato nel menu Applica quando applichi valori a un elemento di Drive. |
SchemaCapabilities
Le funzionalità relative a questo campo durante la modifica.
Rappresentazione JSON |
---|
{ "canUpdate": boolean, "canDelete": boolean, "canDisable": boolean, "canEnable": boolean } |
Campi | |
---|---|
canUpdate |
Indica se l'utente può modificare questo campo. |
canDelete |
Indica se l'utente può eliminare questo campo. L'utente deve disporre dell'autorizzazione e il campo deve essere obsoleto. |
canDisable |
Indica se l'utente può disabilitare questo campo. L'utente deve disporre dell'autorizzazione e questo campo non deve essere già disattivato. |
canEnable |
Indica se l'utente può attivare questo campo. L'utente deve disporre dell'autorizzazione e questo campo deve essere disattivato. |
AppliedCapabilities
Le funzionalità relative a questo campo sui metadati applicati.
Rappresentazione JSON |
---|
{ "canRead": boolean, "canSearch": boolean, "canWrite": boolean } |
Campi | |
---|---|
canRead |
Indica se l'utente può leggere i metadati applicati correlati agli elementi. |
canSearch |
Indica se l'utente può cercare elementi di Drive che fanno riferimento a questo campo. |
canWrite |
Indica se l'utente può impostare questo campo sugli elementi di Drive. |
Metodi |
|
---|---|
|
Crea una nuova etichetta. |
|
Elimina definitivamente un'etichetta e i relativi metadati negli elementi di Drive. |
|
Aggiorna una singola etichetta applicando una serie di richieste di aggiornamento che generano una nuova revisione della bozza. |
|
Disattivare un'etichetta pubblicata. |
|
Abilita un'etichetta disattivata e ripristinala allo stato di pubblicazione. |
|
Recupera un'etichetta in base al nome della risorsa. |
|
Elenca etichette. |
|
Pubblica tutte le modifiche alla bozza apportate all'etichetta. |
|
Aggiorna il valore CopyMode di un'etichetta. |
|
Aggiorna le autorizzazioni di un'etichetta. |