Creare e pubblicare un'etichetta

Questa pagina descrive come creare e pubblicare un'etichetta.

Creare un'etichetta

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

Devi anche specificare:

• Un LabelType.

• Un title dell'etichetta tramite il property metodo.

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

Questo esempio crea un'etichetta di amministratore standard con un titolo specificato e uno 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 nello UNPUBLISHED_DRAFT State. Deve essere PUBLISHED per essere utilizzata sui file ed essere visibile agli utenti. Per maggiori informazioni, consulta Ciclo di vita delle etichette.

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	Selezionare 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	Inserire un valore numerico	Sono supportati solo numeri interi
DateOptions	Selezionare una data di calendario	(Facoltativo) Date format può essere impostato su "Long: Month DD, YYYY" o "Short: MM/DD/YY"
TextOptions	Inserire il testo in una casella di testo	Il numero massimo di caratteri supportato è 100
UserOptions	Selezionare 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 Etichette ti consente di pubblicare una bozza di etichetta una volta completata.

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

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

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

Questo esempio utilizza l'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 passa allo 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 Ciclo di vita delle etichette.

Vincoli durante la pubblicazione delle etichette

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

• La pubblicazione di un'etichetta crea una revisione appena pubblicata. Tutte le revisioni delle bozze precedenti vengono eliminate. Le revisioni pubblicate in precedenza vengono conservate, ma sono soggette a eliminazione automatica, se necessario.

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

  • L'etichetta viene eliminata direttamente. (Deve essere disattivata e poi eliminata.)
  • Il Field.FieldType viene modificato.
  • Gli aggiornamenti delle opzioni di convalida dei campi rifiutano qualcosa che in precedenza era stato accettato.
  • Una riduzione delle voci massime.