- Richiesta HTTP
- Parametri percorso
- Corpo della richiesta
- Corpo della risposta
- Ambiti di autorizzazione
- Richiedi
- UpdateLabelPropertiesRequest
- CreateFieldRequest
- UpdateFieldPropertiesRequest
- UpdateFieldTypeRequest
- LongTextOptions
- EnableFieldRequest
- DisableFieldRequest
- DeleteFieldRequest
- CreateSelectionChoiceRequest
- UpdateSelectionChoicePropertiesRequest
- EnableSelectionChoiceRequest
- DisableSelectionChoiceRequest
- DeleteSelectionChoiceRequest
- Risposta
- UpdateLabelPropertiesResponse
- CreateFieldResponse
- UpdateFieldPropertiesResponse
- UpdateFieldTypeResponse
- EnableFieldResponse
- DisableFieldResponse
- DeleteFieldResponse
- CreateSelectionChoiceResponse
- UpdateSelectionChoicePropertiesResponse
- EnableSelectionChoiceResponse
- DisableSelectionChoiceResponse
- DeleteSelectionChoiceResponse
- Prova!
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 |
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 ( |
Campi | |
---|---|
writeControl |
Consente di controllare il modo in cui vengono eseguite le richieste di scrittura. |
requests[] |
Un elenco di aggiornamenti da applicare all'etichetta. Le richieste verranno applicate nell'ordine in cui sono specificate. |
useAdminAccess |
Imposta su |
view |
Se specificati, verranno restituiti solo alcuni campi appartenenti alla vista indicata. |
languageCode |
Il codice lingua BCP-47 da utilizzare per valutare le etichette dei campi localizzati quando |
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 ( |
Campi | |
---|---|
responses[] |
La risposta degli aggiornamenti. Mappa 1:1 con gli aggiornamenti, anche se le risposte ad alcune richieste potrebbero essere vuote. |
updatedLabel |
L'etichetta dopo l'applicazione degli aggiornamenti. Il valore viene impostato solo se [BatchUpdateLabelResponse2.include_label_in_response] è |
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 |
Campi | |
---|---|
Campo unione kind . Il tipo di aggiornamento. È richiesto esattamente un campo. kind può essere solo uno dei seguenti: |
|
updateLabel |
Aggiorna le proprietà dell'etichetta. |
createField |
Crea un nuovo campo. |
updateField |
Aggiorna le proprietà di base di un campo. |
updateFieldType |
Aggiorna le opzioni del tipo di campo e/o del tipo. |
enableField |
Attiva il campo. |
disableField |
Disattiva il campo. |
deleteField |
Elimina un campo dall'etichetta. |
createSelectionChoice |
Crea l'opzione Choice all'interno di un campo Selection. |
updateSelectionChoiceProperties |
Aggiornare le proprietà di un'opzione Scelta all'interno di un campo di selezione. |
enableSelectionChoice |
Abilita una scelta all'interno di un campo di selezione. |
disableSelectionChoice |
Disattivare una Scelta all'interno di un campo di selezione. |
deleteSelectionChoice |
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 ( |
Campi | |
---|---|
updateMask |
I campi che devono essere aggiornati. È necessario specificare almeno un campo. Il valore principale |
properties |
Obbligatorio. Proprietà dell'etichetta da aggiornare. |
CreateFieldRequest
Richiesta di creazione di un campo in un'etichetta.
Rappresentazione JSON |
---|
{
"field": {
object ( |
Campi | |
---|---|
field |
Obbligatorio. Campo da creare. |
UpdateFieldPropertiesRequest
Richiesta di aggiornamento delle proprietà dei campi.
Rappresentazione JSON |
---|
{
"updateMask": string,
"id": string,
"properties": {
object ( |
Campi | |
---|---|
updateMask |
I campi che devono essere aggiornati. È necessario specificare almeno un campo. Il valore principale |
id |
Obbligatorio. Il campo da aggiornare. |
properties |
Obbligatorio. Proprietà dei campi di base. |
UpdateFieldTypeRequest
Richiesta di modifica del tipo di un campo.
Rappresentazione JSON |
---|
{ "updateMask": string, "id": string, // Union field |
Campi | |
---|---|
updateMask |
I campi che devono essere aggiornati. È necessario specificare almeno un campo. La radice di |
id |
Obbligatorio. Il campo da aggiornare. |
Campo unione
|
|
textOptions |
Aggiorna il campo impostandolo su Testo. |
longTextOptions |
Aggiorna il campo in Testo lungo. |
integerOptions |
Aggiorna il campo impostandolo su Numero intero. |
dateOptions |
Aggiorna il campo impostandolo su Data. |
selectionOptions |
Aggiorna il campo su Selezione. |
userOptions |
Aggiorna il campo in Utente. |
LongTextOptions
Consente di scegliere il tipo di campo Testo lungo.
Rappresentazione JSON |
---|
{ "minLength": integer, "maxLength": integer } |
Campi | |
---|---|
minLength |
Solo output. La lunghezza minima valida dei valori per il campo di testo. |
maxLength |
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 |
Obbligatorio. ID del campo da attivare. |
DisableFieldRequest
Richiedi di disattivare il campo.
Rappresentazione JSON |
---|
{
"updateMask": string,
"id": string,
"disabledPolicy": {
object ( |
Campi | |
---|---|
updateMask |
I campi che devono essere aggiornati. È necessario specificare almeno un campo. Il valore principale |
id |
Obbligatorio. Chiave del campo da disabilitare. |
disabledPolicy |
Obbligatorio. Norma campo disattivato. |
DeleteFieldRequest
Richiesta di eliminazione del campo.
Rappresentazione JSON |
---|
{ "id": string } |
Campi | |
---|---|
id |
Obbligatorio. ID del campo da eliminare. |
CreateSelectionChoiceRequest
Richiedi di creare una scelta di selezione.
Rappresentazione JSON |
---|
{
"fieldId": string,
"choice": {
object ( |
Campi | |
---|---|
fieldId |
Obbligatorio. Il campo di selezione in cui verrà creata una scelta. |
choice |
Obbligatorio. la scelta di creare. |
UpdateSelectionChoicePropertiesRequest
Richiedi l'aggiornamento di una proprietà Choice.
Rappresentazione JSON |
---|
{
"updateMask": string,
"fieldId": string,
"id": string,
"properties": {
object ( |
Campi | |
---|---|
updateMask |
I campi che devono essere aggiornati. È necessario specificare almeno un campo. Il valore principale |
fieldId |
Obbligatorio. Il campo di selezione da aggiornare. |
id |
Obbligatorio. La scelta di aggiornare. |
properties |
Obbligatorio. Le proprietà Choice da aggiornare. |
EnableSelectionChoiceRequest
Richiedi di attivare una scelta.
Rappresentazione JSON |
---|
{ "fieldId": string, "id": string } |
Campi | |
---|---|
fieldId |
Obbligatorio. Il campo di selezione in cui verrà abilitata una scelta. |
id |
Obbligatorio. Scelta di abilitare. |
DisableSelectionChoiceRequest
Richiedi la disattivazione di una Choice.
Rappresentazione JSON |
---|
{
"updateMask": string,
"fieldId": string,
"id": string,
"disabledPolicy": {
object ( |
Campi | |
---|---|
updateMask |
I campi che devono essere aggiornati. È necessario specificare almeno un campo. Il valore principale |
fieldId |
Obbligatorio. Il campo di selezione in cui una selezione verrà disabilitata. |
id |
Obbligatorio. Scelta di disattivare. |
disabledPolicy |
Obbligatorio. Il criterio disattivato da aggiornare. |
DeleteSelectionChoiceRequest
Richiesta di eliminazione di una scelta.
Rappresentazione JSON |
---|
{ "fieldId": string, "id": string } |
Campi | |
---|---|
fieldId |
Obbligatorio. Il campo di selezione da cui verrà eliminata una scelta. |
id |
Obbligatorio. Scelta di eliminazione. |
Risposta
Una singola risposta a un aggiornamento.
Rappresentazione JSON |
---|
{ // Union field |
Campi | |
---|---|
Campo unione response . La risposta per la richiesta corrispondente. response può essere solo uno dei seguenti: |
|
updateLabel |
Proprietà di base aggiornate di un'etichetta. |
createField |
Crea un nuovo campo. |
updateField |
Aggiorna le proprietà di base di un campo. |
updateFieldType |
Aggiorna le opzioni del tipo di campo e/o del tipo. |
enableField |
Attiva campo. |
disableField |
Disattiva Field. |
deleteField |
Elimina un campo dall'etichetta. |
createSelectionChoice |
Crea una nuova opzione dell'elenco di selezione da aggiungere a un campo di selezione. |
updateSelectionChoiceProperties |
Aggiorna una scelta all'interno di un campo di selezione. |
enableSelectionChoice |
Consente di attivare una scelta all'interno di un campo di selezione. |
disableSelectionChoice |
Disattiva una scelta all'interno di un campo di selezione. |
deleteSelectionChoice |
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 |
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 |
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 |
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 |
L'ID del campo generato dal server. |
id |
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 |
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.