Creare e pubblicare un'etichetta

Questo documento descrive come creare e pubblicare etichette utilizzando l'API Google Drive Labels.

Creare un'etichetta

Per creare un'etichetta, utilizza il create metodo sulla risorsa labels. Le etichette possono facoltativamente contenere uno o più Field oggetti.

Devi anche specificare:

  • Un LabelType oggetto.

  • Un title dell'etichetta tramite l'Properties oggetto.

  • Il parametro di query useAdminAccess è impostato su true per utilizzare le credenziali di amministratore dell'utente. Prima di consentire l'accesso, il server verifica che l'utente disponga di i privilegi di amministratore Gestisci classificazione Etichette richiesti.

Il seguente esempio di codice mostra come utilizzare il metodo create per creare un' etichetta di amministratore standard con un titolo specificato e un SelectionOptions Field con due Choice oggetti.

Python

label_body = {
    'labelType': 'ADMIN',
    'properties': {
        'title': 'TITLE'
    },
    'fields': [{
        'properties': {
            'displayName': 'DISPLAY_NAME'
        },
        'selectionOptions': {
            'listOptions': {},
            'choices': [{
                'properties': {
                    'displayName': 'CHOICE_1'
                }
            }, {
                'properties': {
                    'displayName': 'CHOICE_2'
                }
            }]
        }
    }]
}
response = service.labels().create(
    body=label_body, useAdminAccess=True).execute()

Node.js

var label = {
  'labelType': 'ADMIN',
  'properties': {
    'title': 'TITLE'
  },
  'fields': [{
    'properties': {
      'displayName': 'DISPLAY_NAME'
    },
    'selectionOptions': {
      'listOptions': {},
      'choices': [{
        'properties': {
          'displayName': 'CHOICE_1'
        }
      }, {
        'properties': {
          'displayName': 'CHOICE_2'
        }
      }]
    }
  }]
};

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

Sostituisci quanto segue:

  • TITLE: il titolo dell'etichetta.
  • DISPLAY_NAME: il nome visualizzato del campo.
  • CHOICE_1: la prima scelta nel campo SelectionOptions.
  • CHOICE_2: la seconda scelta nel SelectionOptions campo.

L'etichetta viene creata nello UNPUBLISHED_DRAFT State. L'etichetta deve essere PUBLISHED per essere visibile agli utenti e per l'utilizzo sui file. Per saperne di più, 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

Utilizzare i campi nelle etichette

La tabella seguente descrive i tipi di campi che puoi aggiungere a un'etichetta, il modo in cui gli utenti interagiscono con questi campi e le considerazioni sul formato e i limiti:

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 numeri interi
DateOptions Seleziona una data di calendario (Facoltativo) Il DateFormat 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 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 Drive Labels ti consente di pubblicare una bozza di etichetta una volta completata. L'etichetta è quindi visibile agli utenti e può essere applicata ai file.

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

  • Una risorsa labels che rappresenta ogni etichetta. Contiene un name della risorsa e un id, che è un identificatore univoco globale per l'etichetta.

  • Il parametro di query useAdminAccess è impostato su true per utilizzare le credenziali di amministratore dell'utente. Prima di consentire l'accesso, il server verifica che l'utente disponga di i privilegi di amministratore Gestisci classificazione Etichette richiesti.

Il seguente esempio di codice mostra come utilizzare l'id dell'etichetta per identificare e pubblicare l'etichetta corretta.

Python

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

Node.js

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

Sostituisci ID con l'ID dell'etichetta da pubblicare.

Una volta pubblicata l'etichetta, questa 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 saperne di più, consulta Label lifecycle.

Vincoli durante la pubblicazione delle etichette

Quando ti prepari a pubblicare le etichette, tieni presente questi vincoli:

  • Una volta pubblicata, un'etichetta non può tornare allo stato di bozza originale. Per saperne di più, 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 pubblicate, 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 alle opzioni di convalida Field rifiutano qualcosa che in precedenza era accettato.
    • Una riduzione delle voci massime.