Creare e pubblicare un'etichetta

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

Creare un'etichetta

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

Devi inoltre specificare:

  • Un LabelType.

  • Un'etichetta title tramite property.

  • useAdminAccess è true per utilizzare le credenziali di amministratore dell'utente. La server verifica che l'utente sia un amministratore con la sezione privilegio prima di consentire l'accesso.

Questo esempio crea 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 l'utilizzo nei file e per essere visibili agli utenti. Per ulteriori informazioni, consulta la sezione Etichette del ciclo di vita.

Limiti delle etichette

Durante la creazione e l'applicazione delle etichette si applicano i seguenti limiti:

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

Utilizzo dei 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 secondo la configurazione in ListOptions
IntegerOptions Inserisci un valore numerico Sono supportati solo numeri interi
DateOptions Seleziona una data di calendario (Facoltativo) Date format può essere impostato su "Long: Mese GG, AAAA" o "Breve: 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

Pubblica un'etichetta

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

Per pubblicare un'etichetta, utilizza publish e specifica:

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

  • useAdminAccess è true per utilizzare le credenziali di amministratore dell'utente. La server verifica che l'utente sia un amministratore con la sezione privilegio 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 la revisione dell'etichetta L'ID viene incrementato. L'etichetta è quindi visibile agli utenti e può essere applicata . Per ulteriori informazioni, consulta la sezione Etichette del ciclo di vita.

Vincoli per la pubblicazione delle etichette

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

  • La pubblicazione di un'etichetta crea una revisione appena pubblicata. Tutte le bozze precedenti le revisioni vengono eliminate. Le revisioni pubblicate in precedenza vengono conservate, ma vengono soggetti all'eliminazione automatica in base alle esigenze.

  • Una volta pubblicate, alcune modifiche non sono più consentite. In genere, questo significa qualsiasi modifica che invalidi o attivi nuove restrizioni sui i metadati relativi all'etichetta vengono rifiutati. Ad esempio, non sono consentite modifiche a un'etichetta dopo la pubblicazione dell'etichetta:

    • L'etichetta viene eliminata direttamente. Deve essere prima disabilitata, quindi deleted.)
    • Il valore Field.FieldType è stato modificato.
    • Gli aggiornamenti alle opzioni di convalida dei campi rifiutano i contenuti precedentemente inviati accettato.
    • Una riduzione del numero massimo di voci.