Creare e pubblicare un'etichetta

Questa pagina descrive come creare e pubblicare un'etichetta.

Creare un'etichetta

Per creare un'etichetta, utilizza il metodo create nella raccolta labels. Le etichette possono facoltativamente contenere uno o più Fields.

Devi inoltre specificare:

• A LabelType.

• Un'etichetta title tramite il metodo property.

• useAdminAccess è true per utilizzare le credenziali di amministratore dell'utente. Il server verifica che l'utente sia un amministratore con il privilegio "Gestisci etichette" prima di consentire l'accesso.

Questo esempio crea un'etichetta amministrativa standard con un titolo specificato e un SelectionOptions Field con 2 Choices.

Python

label_body = {
'label_type': 'ADMIN',
'properties': {
    'title': 'TITLE'
},
'fields': [{
    'properties': {
        'display_name': 'DISPLAY_NAME'
    },
    'selection_options': {
        'list_options': {},
        'choices': [{
            'properties': {
                'display_name': 'CHOICE_1'
            }
        }, {
            'properties': {
                'display_name': 'CHOICE_2'
            }
        }]
    }
}]
}
response = service.labels().create(
    body=label_body, useAdminAccess=True).execute()

Node.js

var label = {
'label_type': 'ADMIN',
'properties': {
    'title': 'TITLE'
},
'fields': [{
    'properties': {
    'display_name': 'DISPLAY_NAME'
    },
    'selection_options': {
    'list_options': {},
    'choices': [{
        'properties': {
        'display_name': 'CHOICE_1'
        }
    }, {
        'properties': {
        'display_name': 'CHOICE_2'
        }
    }]
    }
}]
};

service.labels.create({
  'resource': label,
  'use_admin_access': true
}, (err, res) => {
if (err) return console.error('The API returned an error: ' + err);
  console.log(res);
});

L'etichetta viene creata in UNPUBLISHED_DRAFT State. Deve essere PUBLISHED per l'utilizzo sui file e per essere visibile agli utenti. Per maggiori informazioni, consulta la sezione Ciclo di vita dell'etichetta.

Limiti delle etichette

Quando crei e applichi le etichette, si applicano i seguenti limiti:

• Etichette standard: 150
• Campi per etichetta: 10
• Etichette applicate dall'utente per file: 5

Utilizzare i campi nelle etichette

Field Type	Cosa possono fare gli utenti	Considerazioni sul formato e limiti
SelectionOptions	Seleziona una o più opzioni da un elenco	Il numero massimo di opzioni supportate è 200 Il numero massimo di selezioni per un file è 10, come configurato in ListOptions
IntegerOptions	Inserisci un valore numerico	Sono supportati solo i numeri interi
DateOptions	Selezionare una data del calendario	(Facoltativo) Date format può essere impostato su "Formato esteso: mese GG, AAAA" o "Formato breve: MM/GG/AA"
TextOptions	Inserisci il testo in una casella di testo	Il numero massimo di caratteri supportati è 100
UserOptions	Seleziona uno o più utenti dai contatti di Google Workspace.	Il numero massimo di voci utente per un file è 10, come configurato in ListOptions

Pubblicare un'etichetta

L'API Labels ti consente di pubblicare una bozza di etichetta una volta completata.

Per pubblicare un'etichetta, utilizza il metodo publish e specifica:

• Una risorsa Etichetta che rappresenta ogni etichetta. Contiene una risorsa Name e ID, che è un identificatore univoco globale per l'etichetta.

• useAdminAccess è true per utilizzare le credenziali di amministratore dell'utente. Il server verifica che l'utente sia un amministratore con il privilegio "Gestisci etichette" prima di consentire l'accesso.

Questo esempio utilizza ID per identificare e pubblicare l'etichetta corretta.

Python

service.labels().publish(
name='labels/ID',
body={
  'use_admin_access': True
}).execute()

Node.js

service.labels.publish({
  'resource': {
    'use_admin_access': true
},
'name': 'labels/ID'
}, (err, res) => {
  if (err) return console.error('The API returned an error: ' + err);
  console.log(res);
});

Una volta pubblicata, l'etichetta viene spostata in PUBLISHED State e l'ID revisione dell'etichetta viene incrementato. L'etichetta è quindi visibile agli utenti e può essere applicata ai file. Per maggiori informazioni, consulta la sezione Ciclo di vita dell'etichetta.

Vincoli per la pubblicazione delle etichette

• Una volta pubblicata, un'etichetta non può tornare allo stato di bozza originale. Per maggiori informazioni, consulta la sezione Ciclo di vita delle etichette.

• La pubblicazione di un'etichetta crea una nuova revisione pubblicata. Tutte le revisioni precedenti della bozza vengono eliminate. Le revisioni pubblicate in precedenza vengono conservate, ma sono soggette a eliminazione automatica in base alle esigenze.

• Una volta pubblicate, alcune modifiche non sono più consentite. In genere, ciò significa che viene rifiutata qualsiasi modifica che invalida o attiva nuove limitazioni ai metadati esistenti correlati all'etichetta. Ad esempio, le seguenti modifiche a un'etichetta non sono consentite dopo la pubblicazione:

  • L'etichetta viene eliminata direttamente. Deve essere prima disattivato, poi eliminato.
  • Il Field.FieldType è stato modificato.
  • Gli aggiornamenti alle opzioni di convalida dei campi rifiutano qualcosa che in precedenza era accettato.
  • Una riduzione delle voci massime.