Creare e pubblicare un'etichetta

In questa pagina viene descritto come creare e pubblicare un'etichetta.

Crea 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:

• Una 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 "Gestione delle etichette" prima di consentire l'accesso.

In questo esempio viene creata un'etichetta amministratore standard con un titolo specificato e una 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 essere utilizzata sui file ed essere visibile agli utenti. Per ulteriori informazioni, vedi Ciclo di vita delle etichette.

Limiti delle etichette

Durante la creazione e l'applicazione di 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 e limiti relativi al formato
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 in base alla configurazione in ListOptions
IntegerOptions	Inserisci un valore numerico	Sono supportati solo i numeri interi
DateOptions	Seleziona una data di calendario	(Facoltativo) Date format può essere impostato su "Long: Month DD, YYYY" o "Short: MM/GG/AA"
TextOptions	Inserisci il testo in una casella di testo	Il numero massimo di caratteri supportato è 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 consente di pubblicare un'etichetta bozza 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 "Gestione delle etichette" prima di consentire l'accesso.

In questo esempio viene utilizzato 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 si sposta in PUBLISHED State e l'ID revisione dell'etichetta viene incrementato. L'etichetta è quindi visibile agli utenti e può essere applicata ai file. Per ulteriori informazioni, vedi 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 ulteriori informazioni, vedi Ciclo di vita delle etichette.

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

• Una volta pubblicate, alcune modifiche non sono più consentite. In genere, ciò significa che qualsiasi modifica che invalida o attiva nuove limitazioni sui metadati esistenti relativi 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 prima disattivata e poi eliminata.
  • Field.FieldType è cambiato.
  • Gli aggiornamenti alle opzioni di convalida dei campi rifiutano qualcosa accettato in precedenza.
  • Una riduzione del numero massimo di voci.