Method: labels.delta

Consente di aggiornare una singola etichetta applicando un insieme di richieste di aggiornamento che genera una nuova revisione della bozza. L'aggiornamento batch è tutto o niente: se una delle richieste di aggiornamento non è valida, non viene applicata alcuna modifica. La revisione della bozza risultante deve essere pubblicata prima che le modifiche possano essere utilizzate con gli elementi di Drive.

Richiesta HTTP

POST https://drivelabels.googleapis.com/v2/{name=labels/*}:delta

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
name

string

Obbligatorio. Il nome della risorsa dell'etichetta da aggiornare.

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Rappresentazione JSON
{
  "writeControl": {
    object (WriteControl)
  },
  "requests": [
    {
      object (Request)
    }
  ],
  "useAdminAccess": boolean,
  "view": enum (LabelView),
  "languageCode": string
}
Campi
writeControl

object (WriteControl)

Consente di controllare il modo in cui vengono eseguite le richieste di scrittura.

requests[]

object (Request)

Un elenco di aggiornamenti da applicare all'etichetta. Le richieste verranno applicate nell'ordine in cui sono specificate.

useAdminAccess

boolean

Imposta su true per utilizzare le credenziali di amministratore dell'utente. Il server verificherà che l'utente sia un amministratore dell'etichetta prima di consentire l'accesso.

view

enum (LabelView)

Se specificati, verranno restituiti solo alcuni campi appartenenti alla vista indicata.

languageCode

string

Il codice lingua BCP-47 da utilizzare per valutare le etichette dei campi localizzati quando include_label_in_response è true.

Corpo della risposta

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Risposta per l'aggiornamento dell'etichetta.

Rappresentazione JSON
{
  "responses": [
    {
      object (Response)
    }
  ],
  "updatedLabel": {
    object (Label)
  }
}
Campi
responses[]

object (Response)

La risposta degli aggiornamenti. Mappa 1:1 con gli aggiornamenti, anche se le risposte ad alcune richieste potrebbero essere vuote.

updatedLabel

object (Label)

L'etichetta dopo l'applicazione degli aggiornamenti. Il valore viene impostato solo se [BatchUpdateLabelResponse2.include_label_in_response] è true e non si sono verificati errori.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/drive.labels
  • https://www.googleapis.com/auth/drive.admin.labels

Per ulteriori informazioni, consulta la Guida all'autorizzazione.

Richiesta

Un singolo tipo di aggiornamento da applicare a un'etichetta.

Rappresentazione JSON
{

  // Union field kind can be only one of the following:
  "updateLabel": {
    object (UpdateLabelPropertiesRequest)
  },
  "createField": {
    object (CreateFieldRequest)
  },
  "updateField": {
    object (UpdateFieldPropertiesRequest)
  },
  "updateFieldType": {
    object (UpdateFieldTypeRequest)
  },
  "enableField": {
    object (EnableFieldRequest)
  },
  "disableField": {
    object (DisableFieldRequest)
  },
  "deleteField": {
    object (DeleteFieldRequest)
  },
  "createSelectionChoice": {
    object (CreateSelectionChoiceRequest)
  },
  "updateSelectionChoiceProperties": {
    object (UpdateSelectionChoicePropertiesRequest)
  },
  "enableSelectionChoice": {
    object (EnableSelectionChoiceRequest)
  },
  "disableSelectionChoice": {
    object (DisableSelectionChoiceRequest)
  },
  "deleteSelectionChoice": {
    object (DeleteSelectionChoiceRequest)
  }
  // End of list of possible types for union field kind.
}
Campi
Campo unione kind. Il tipo di aggiornamento. È richiesto esattamente un campo. kind può essere solo uno dei seguenti:
updateLabel

object (UpdateLabelPropertiesRequest)

Aggiorna le proprietà dell'etichetta.

createField

object (CreateFieldRequest)

Crea un nuovo campo.

updateField

object (UpdateFieldPropertiesRequest)

Aggiorna le proprietà di base di un campo.

updateFieldType

object (UpdateFieldTypeRequest)

Aggiorna le opzioni del tipo di campo e/o del tipo.

enableField

object (EnableFieldRequest)

Attiva il campo.

disableField

object (DisableFieldRequest)

Disattiva il campo.

deleteField

object (DeleteFieldRequest)

Elimina un campo dall'etichetta.

createSelectionChoice

object (CreateSelectionChoiceRequest)

Crea l'opzione Choice all'interno di un campo Selection.

updateSelectionChoiceProperties

object (UpdateSelectionChoicePropertiesRequest)

Aggiornare le proprietà di un'opzione Scelta all'interno di un campo di selezione.

enableSelectionChoice

object (EnableSelectionChoiceRequest)

Abilita una scelta all'interno di un campo di selezione.

disableSelectionChoice

object (DisableSelectionChoiceRequest)

Disattivare una Scelta all'interno di un campo di selezione.

deleteSelectionChoice

object (DeleteSelectionChoiceRequest)

Elimina una scelta all'interno di un campo di selezione.

UpdateLabelPropertiesRequest

Aggiorna le proprietà di base di un'etichetta.

Rappresentazione JSON
{
  "updateMask": string,
  "properties": {
    object (Properties)
  }
}
Campi
updateMask

string (FieldMask format)

I campi che devono essere aggiornati. È necessario specificare almeno un campo. Il valore principale label_properties è implicito e non deve essere specificato. Un singolo * può essere utilizzato come forma breve per aggiornare ogni campo.

properties

object (Properties)

Obbligatorio. Proprietà dell'etichetta da aggiornare.

CreateFieldRequest

Richiesta di creazione di un campo in un'etichetta.

Rappresentazione JSON
{
  "field": {
    object (Field)
  }
}
Campi
field

object (Field)

Obbligatorio. Campo da creare.

UpdateFieldPropertiesRequest

Richiesta di aggiornamento delle proprietà dei campi.

Rappresentazione JSON
{
  "updateMask": string,
  "id": string,
  "properties": {
    object (Properties)
  }
}
Campi
updateMask

string (FieldMask format)

I campi che devono essere aggiornati. È necessario specificare almeno un campo. Il valore principale properties è implicito e non deve essere specificato. Un singolo * può essere utilizzato come forma breve per aggiornare ogni campo.

id

string

Obbligatorio. Il campo da aggiornare.

properties

object (Properties)

Obbligatorio. Proprietà dei campi di base.

UpdateFieldTypeRequest

Richiesta di modifica del tipo di un campo.

Rappresentazione JSON
{
  "updateMask": string,
  "id": string,

  // Union field type_options can be only one of the following:
  "textOptions": {
    object (TextOptions)
  },
  "longTextOptions": {
    object (LongTextOptions)
  },
  "integerOptions": {
    object (IntegerOptions)
  },
  "dateOptions": {
    object (DateOptions)
  },
  "selectionOptions": {
    object (SelectionOptions)
  },
  "userOptions": {
    object (UserOptions)
  }
  // End of list of possible types for union field type_options.
}
Campi
updateMask

string (FieldMask format)

I campi che devono essere aggiornati. È necessario specificare almeno un campo. La radice di type_options è implicita e non deve essere specificata. Un singolo * può essere utilizzato come forma breve per aggiornare ogni campo.

id

string

Obbligatorio. Il campo da aggiornare.

Campo unione type_options.

type_options può essere solo uno dei seguenti:

textOptions

object (TextOptions)

Aggiorna il campo impostandolo su Testo.

longTextOptions

object (LongTextOptions)

Aggiorna il campo in Testo lungo.

integerOptions

object (IntegerOptions)

Aggiorna il campo impostandolo su Numero intero.

dateOptions

object (DateOptions)

Aggiorna il campo impostandolo su Data.

selectionOptions

object (SelectionOptions)

Aggiorna il campo su Selezione.

userOptions

object (UserOptions)

Aggiorna il campo in Utente.

LongTextOptions

Consente di scegliere il tipo di campo Testo lungo.

Rappresentazione JSON
{
  "minLength": integer,
  "maxLength": integer
}
Campi
minLength

integer

Solo output. La lunghezza minima valida dei valori per il campo di testo.

maxLength

integer

Solo output. La lunghezza massima valida dei valori per il campo di testo.

EnableFieldRequest

Richiedi l'attivazione del campo.

Rappresentazione JSON
{
  "id": string
}
Campi
id

string

Obbligatorio. ID del campo da attivare.

DisableFieldRequest

Richiedi di disattivare il campo.

Rappresentazione JSON
{
  "updateMask": string,
  "id": string,
  "disabledPolicy": {
    object (DisabledPolicy)
  }
}
Campi
updateMask

string (FieldMask format)

I campi che devono essere aggiornati. È necessario specificare almeno un campo. Il valore principale disabledPolicy è implicito e non deve essere specificato. Un singolo * può essere utilizzato come forma breve per aggiornare ogni campo.

id

string

Obbligatorio. Chiave del campo da disabilitare.

disabledPolicy

object (DisabledPolicy)

Obbligatorio. Norma campo disattivato.

DeleteFieldRequest

Richiesta di eliminazione del campo.

Rappresentazione JSON
{
  "id": string
}
Campi
id

string

Obbligatorio. ID del campo da eliminare.

CreateSelectionChoiceRequest

Richiedi di creare una scelta di selezione.

Rappresentazione JSON
{
  "fieldId": string,
  "choice": {
    object (Choice)
  }
}
Campi
fieldId

string

Obbligatorio. Il campo di selezione in cui verrà creata una scelta.

choice

object (Choice)

Obbligatorio. la scelta di creare.

UpdateSelectionChoicePropertiesRequest

Richiedi l'aggiornamento di una proprietà Choice.

Rappresentazione JSON
{
  "updateMask": string,
  "fieldId": string,
  "id": string,
  "properties": {
    object (Properties)
  }
}
Campi
updateMask

string (FieldMask format)

I campi che devono essere aggiornati. È necessario specificare almeno un campo. Il valore principale properties è implicito e non deve essere specificato. Un singolo * può essere utilizzato come forma breve per aggiornare ogni campo.

fieldId

string

Obbligatorio. Il campo di selezione da aggiornare.

id

string

Obbligatorio. La scelta di aggiornare.

properties

object (Properties)

Obbligatorio. Le proprietà Choice da aggiornare.

EnableSelectionChoiceRequest

Richiedi di attivare una scelta.

Rappresentazione JSON
{
  "fieldId": string,
  "id": string
}
Campi
fieldId

string

Obbligatorio. Il campo di selezione in cui verrà abilitata una scelta.

id

string

Obbligatorio. Scelta di abilitare.

DisableSelectionChoiceRequest

Richiedi la disattivazione di una Choice.

Rappresentazione JSON
{
  "updateMask": string,
  "fieldId": string,
  "id": string,
  "disabledPolicy": {
    object (DisabledPolicy)
  }
}
Campi
updateMask

string (FieldMask format)

I campi che devono essere aggiornati. È necessario specificare almeno un campo. Il valore principale disabledPolicy è implicito e non deve essere specificato. Un singolo * può essere utilizzato come forma breve per aggiornare ogni campo.

fieldId

string

Obbligatorio. Il campo di selezione in cui una selezione verrà disabilitata.

id

string

Obbligatorio. Scelta di disattivare.

disabledPolicy

object (DisabledPolicy)

Obbligatorio. Il criterio disattivato da aggiornare.

DeleteSelectionChoiceRequest

Richiesta di eliminazione di una scelta.

Rappresentazione JSON
{
  "fieldId": string,
  "id": string
}
Campi
fieldId

string

Obbligatorio. Il campo di selezione da cui verrà eliminata una scelta.

id

string

Obbligatorio. Scelta di eliminazione.

Risposta

Una singola risposta a un aggiornamento.

Rappresentazione JSON
{

  // Union field response can be only one of the following:
  "updateLabel": {
    object (UpdateLabelPropertiesResponse)
  },
  "createField": {
    object (CreateFieldResponse)
  },
  "updateField": {
    object (UpdateFieldPropertiesResponse)
  },
  "updateFieldType": {
    object (UpdateFieldTypeResponse)
  },
  "enableField": {
    object (EnableFieldResponse)
  },
  "disableField": {
    object (DisableFieldResponse)
  },
  "deleteField": {
    object (DeleteFieldResponse)
  },
  "createSelectionChoice": {
    object (CreateSelectionChoiceResponse)
  },
  "updateSelectionChoiceProperties": {
    object (UpdateSelectionChoicePropertiesResponse)
  },
  "enableSelectionChoice": {
    object (EnableSelectionChoiceResponse)
  },
  "disableSelectionChoice": {
    object (DisableSelectionChoiceResponse)
  },
  "deleteSelectionChoice": {
    object (DeleteSelectionChoiceResponse)
  }
  // End of list of possible types for union field response.
}
Campi
Campo unione response. La risposta per la richiesta corrispondente. response può essere solo uno dei seguenti:
updateLabel

object (UpdateLabelPropertiesResponse)

Proprietà di base aggiornate di un'etichetta.

createField

object (CreateFieldResponse)

Crea un nuovo campo.

updateField

object (UpdateFieldPropertiesResponse)

Aggiorna le proprietà di base di un campo.

updateFieldType

object (UpdateFieldTypeResponse)

Aggiorna le opzioni del tipo di campo e/o del tipo.

enableField

object (EnableFieldResponse)

Attiva campo.

disableField

object (DisableFieldResponse)

Disattiva Field.

deleteField

object (DeleteFieldResponse)

Elimina un campo dall'etichetta.

createSelectionChoice

object (CreateSelectionChoiceResponse)

Crea una nuova opzione dell'elenco di selezione da aggiungere a un campo di selezione.

updateSelectionChoiceProperties

object (UpdateSelectionChoicePropertiesResponse)

Aggiorna una scelta all'interno di un campo di selezione.

enableSelectionChoice

object (EnableSelectionChoiceResponse)

Consente di attivare una scelta all'interno di un campo di selezione.

disableSelectionChoice

object (DisableSelectionChoiceResponse)

Disattiva una scelta all'interno di un campo di selezione.

deleteSelectionChoice

object (DeleteSelectionChoiceResponse)

Elimina una scelta da un campo di selezione.

UpdateLabelPropertiesResponse

Risposta in seguito all'aggiornamento alle proprietà delle etichette.

CreateFieldResponse

Risposta dopo la creazione del campo.

Rappresentazione JSON
{
  "id": string,
  "priority": integer
}
Campi
id

string

Il campo del campo creato. Se viene lasciata vuota in una richiesta di creazione, viene generata automaticamente una chiave che può essere identificata qui.

priority

integer

La priorità del campo creato. La priorità può cambiare rispetto a quanto specificato per garantire priorità contigue tra i campi (1-n).

UpdateFieldPropertiesResponse

Risposta dopo l'aggiornamento alle proprietà del campo.

Rappresentazione JSON
{
  "priority": integer
}
Campi
priority

integer

La priorità del campo aggiornato. La priorità può cambiare rispetto a quanto specificato per garantire priorità contigue tra i campi (1-n).

UpdateFieldTypeResponse

Risposta dopo l'aggiornamento al tipo di campo.

EnableFieldResponse

Risposta dopo l'abilitazione del campo.

DisableFieldResponse

Risposta dopo il campo disattivata.

DeleteFieldResponse

Risposta dopo l'eliminazione del campo.

CreateSelectionChoiceResponse

Risposta dopo la creazione di Scelta di selezione.

Rappresentazione JSON
{
  "fieldId": string,
  "id": string
}
Campi
fieldId

string

L'ID del campo generato dal server.

id

string

L'ID generato dal server della scelta creata all'interno del campo

UpdateSelectionChoicePropertiesResponse

Risposta in seguito all'aggiornamento alle proprietà di Scelta di selezione.

Rappresentazione JSON
{
  "priority": integer
}
Campi
priority

integer

La priorità della scelta aggiornata. La priorità può cambiare rispetto a quanto specificato per garantire priorità contigue tra le scelte (1-n).

EnableSelectionChoiceResponse

Risposta dopo Scelta abilitata.

DisableSelectionChoiceResponse

Risposta dopo la disattivazione di Choice.

DeleteSelectionChoiceResponse

Risposta dopo l'eliminazione di Choice.