Aggiornare un'etichetta

Puoi aggiornare una singola etichetta applicando un insieme di richieste di aggiornamento che generano una nuova revisione della bozza. Ad esempio, puoi aggiornare una proprietà dell'etichetta esistente (la descrizione dell'etichetta) o aggiungere una nuova Field all'etichetta.

L'aggiornamento dell'etichetta funziona come un aggiornamento collettivo perché il metodo prende un elenco di oggetti update Request. Effettua gli aggiornamenti in base allo stesso ordine specificato nella richiesta batch. Gli aggiornamenti nell'aggiornamento batch vengono applicati in modo atomico. In altre parole, se una richiesta nel batch non va a buon fine, l'intero aggiornamento non va a buon fine e nessuna delle modifiche (potenzialmente dipendenti) viene applicata. L'etichetta rimane invariata.

Se l'aggiornamento va a buon fine, la revisione della bozza risultante deve essere pubblicata prima che le modifiche possano essere utilizzate con qualsiasi elemento di Drive.

Aggiorna gli oggetti delle etichette

Un'etichetta include molti altri tipi di oggetti che possono essere aggiornati, ad esempio:

• Proprietà etichetta
• Campi e tipi di campi
• Scelte di selezione e proprietà di scelta di selezione

Questi sono alcuni dei molti oggetti che controllano l'aspetto e il funzionamento di un'etichetta.

Categorie di operazioni

Le seguenti operazioni supportate dal metodo labels.delta possono essere raggruppate nelle seguenti categorie generali:

Categoria	Descrizione
Crea	Aggiungi oggetti.
Aggiorna	Aggiornare determinate proprietà di un oggetto.
Attiva	Attiva gli oggetti.
Disattiva	Disattiva gli oggetti.
Elimina	Rimuovi gli oggetti.

Queste categorie vengono utilizzate nella sezione successiva per descrivere il comportamento di operazioni specifiche.

Aggiorna richieste

Il metodo labels.delta funziona prendendo uno o più oggetti Request, ciascuno dei quali specifica un singolo tipo di richiesta da eseguire. Esistono molti tipi di richieste. Ecco una suddivisione dei tipi di richieste, raggruppate in diverse categorie.

Tipo di richiesta
Proprietà etichetta	Aggiorna UpdateLabelPropertiesRequest
Campo	Crea CreateFieldRequest Aggiorna UpdateFieldPropertiesRequest UpdateFieldTypeRequest Attiva EnableFieldRequest Disattiva DisableFieldRequest Elimina DeleteFieldRequest
Scelta selezione	Crea CreateSelectionChoiceRequest Aggiorna UpdateSelectionChoicePropertiesRequest Attiva EnableSelectionChoiceRequest Disattiva DisableSelectionChoiceRequest Elimina DeleteSelectionChoiceRequest

Maschere di campo

Molte richieste di tipo "Aggiorna" e "Disattiva" richiedono un FieldMask. Si tratta di un elenco delimitato da virgole dei campi da aggiornare, lasciando invariati gli altri campi. La maschera è obbligatoria per assicurarti che vengano aggiornati solo i campi che vuoi modificare. Devi specificare almeno un campo.

Una maschera di campo * viene trattata come una stringa jolly e rappresenta un'abbreviazione per specificare ogni campo di un messaggio. La sintassi dei caratteri jolly può produrre risultati indesiderati perché un campo potrebbe tornare al suo stato predefinito se non specifichi un valore nella richiesta di aggiornamento. Per le applicazioni di produzione, elenca sempre i campi specifici da aggiornare nelle maschere dei campi ed evita di utilizzare i caratteri jolly *.

Esempio

Per aggiornare un'etichetta, utilizza il metodo delta nella raccolta labels.

Devi anche specificare:

• useAdminAccess è true per utilizzare le credenziali di amministratore dell'utente. Il server verifica che l'utente sia un amministratore dell'etichetta prima di consentire l'accesso.

• Un Request che specifica gli aggiornamenti applicabili all'etichetta.

• Un'etichetta title tramite il metodo property.

• Uno o più Field.

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

• LabelView è LABEL_VIEW_FULL per impostare la visualizzazione Risorse applicata alle risposte alle etichette. LABEL_VIEW_FULL restituisce tutti i campi possibili.

In questo esempio viene utilizzato ID per aggiornare l'etichetta corretta.

PythonNode.js

body = {
'use_admin_access': True,
'requests': [{
  'update_label': {
    'properties': {
      'title': 'TITLE'
    },
    'update_mask': {
      'paths': ['title']
    }
  },
}, {
  'create_field': {
    'field': {
      'properties': {
        'display_name': 'DISPLAY_NAME'
      },
      'text_options': {}
    }
  }
}],
'view': 'LABEL_VIEW_FULL'
}
response = service.labels().delta(
  body=body,
  name='labels/ID').execute()

var body = {
  'use_admin_access': true,
  'requests': [{
    'update_label': {
      'properties': {
        'title': 'TITLE'
      },
      'update_mask': {
        'paths': ['title']
      }
    },
  }, {
    'create_field': {
      'field': {
        'properties': {
          'display_name': 'DISPLAY_NAME'
        },
        'text_options': {}
      }
    }
  }],
  'view': 'LABEL_VIEW_FULL'
};
service.labels.delta({
  'resource': body,
  'name': 'labels/ID'
}, (err, res) => {
  if (err) return console.error('The API returned an error: ' + err);
  console.log(res);
});

L'etichetta, il campo o la scelta vengono aggiornati, l'ID revisione dell'etichetta viene incrementato e l'etichetta viene archiviata in un database come bozza. L'etichetta ha il valore State di PUBLISHED con hasUnpublishedChanges=true, il che significa che ci sono modifiche in bozza, ma non sono disponibili per gli utenti. L'etichetta aggiornata deve essere PUBLISHED prima che le modifiche diventino visibili agli utenti. Per ulteriori informazioni, consulta la sezione Ciclo di vita delle etichette.