Method: labels.delta

Aktualisiert ein einzelnes Label durch Anwendung einer Reihe von Aktualisierungsanfragen, was zu einem neuen Entwurf führt. Bei der Batch-Aktualisierung handelt es sich um alles oder nichts: Ist eine der Aktualisierungsanfragen ungültig, werden keine Änderungen angewendet. Der resultierende Entwurf muss veröffentlicht werden, bevor die Änderungen für Drive-Elemente verwendet werden können.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
name

string

Erforderlich. Der Ressourcenname des Labels, das aktualisiert werden soll.

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

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

object (WriteControl)

Bietet Kontrolle darüber, wie Schreibanfragen ausgeführt werden.
requests[]

object (Request)

Eine Liste der Aktualisierungen, die auf das Label angewendet werden sollen. Anfragen werden in der angegebenen Reihenfolge angewendet.
useAdminAccess

boolean

Legen Sie true fest, um die Administratoranmeldedaten des Nutzers zu verwenden. Der Server prüft, ob der Nutzer ein Administrator für das Label ist, bevor er den Zugriff gewährt.
view

enum (LabelView)

Wenn angegeben, werden nur bestimmte Felder zurückgegeben, die zur angegebenen Ansicht gehören.
languageCode

string

Der BCP-47-Sprachcode, der zur Auswertung lokalisierter Feldlabels verwendet wird, wenn include_label_in_response den Wert true hat.

Antworttext

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

Antwort für Labelaktualisierung.

JSON-Darstellung 
{
  "responses": [
    {
      object (Response)
    }
  ],
  "updatedLabel": {
    object (Label)
  }
}
Felder
responses[]

object (Response)

Die Antwort auf die Updates. So wird eine 1:1-Zuordnung zu den Aktualisierungen durchgeführt, auch wenn die Antworten auf einige Anfragen leer sein können.
updatedLabel

object (Label)

Das Label nach dem Anwenden von Aktualisierungen. Dieser Parameter wird nur festgelegt, wenn [BatchUpdateLabelResponse2.include_label_in_response] den Wert true hat und keine Fehler aufgetreten sind.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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

Weitere Informationen finden Sie im Leitfaden zur Autorisierung.

Anfragen

Eine einzelne Art von Aktualisierung, die auf ein Label angewendet werden soll.

JSON-Darstellung 
{

  // 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.
}
Felder
Union-Feld kind. Die Art des Updates. Es ist genau ein Feld erforderlich. Für kind ist nur einer der folgenden Werte zulässig:
updateLabel

object (UpdateLabelPropertiesRequest)

Aktualisiert die Labeleigenschaften.
createField

object (CreateFieldRequest)

Erstellt ein neues Feld.
updateField

object (UpdateFieldPropertiesRequest)

Aktualisiert grundlegende Eigenschaften eines Felds.
updateFieldType

object (UpdateFieldTypeRequest)

Aktualisieren Sie die Optionen für den Feldtyp und/oder den Feldtyp.
enableField

object (EnableFieldRequest)

Aktiviert das Feld.
disableField

object (DisableFieldRequest)

Deaktiviert das Feld.
deleteField

object (DeleteFieldRequest)

Löscht ein Feld aus dem Label.
createSelectionChoice

object (CreateSelectionChoiceRequest)

Erstellt Auswahl in einem Auswahlfeld.
updateSelectionChoiceProperties

object (UpdateSelectionChoicePropertiesRequest)

Auswahleigenschaften innerhalb eines Auswahlfelds aktualisieren
enableSelectionChoice

object (EnableSelectionChoiceRequest)

Auswahl innerhalb eines Auswahlfelds aktivieren
disableSelectionChoice

object (DisableSelectionChoiceRequest)

Auswahl in einem Auswahlfeld deaktivieren
deleteSelectionChoice

object (DeleteSelectionChoiceRequest)

Auswahl in einem Auswahlfeld löschen

UpdateLabelPropertiesRequest

Aktualisiert grundlegende Eigenschaften eines Labels.

JSON-Darstellung 
{
  "updateMask": string,
  "properties": {
    object (Properties)
  }
}
Felder
updateMask

string (FieldMask format)

Die Felder, die aktualisiert werden sollen. Es muss mindestens ein Feld angegeben werden. Die Stamm-label_properties ist impliziert und sollte nicht angegeben werden. Eine einzelne * kann als Abkürzung zum Aktualisieren jedes Felds verwendet werden.
properties

object (Properties)

Erforderlich. Labeleigenschaften, die aktualisiert werden sollen.

CreateFieldRequest

Anfrage zum Erstellen eines Felds in einem Label.

JSON-Darstellung 
{
  "field": {
    object (Field)
  }
}
Felder
field

object (Field)

Erforderlich. Zu erstellendes Feld.

UpdateFieldPropertiesRequest

Anfrage zum Aktualisieren von Feldeigenschaften.

JSON-Darstellung 
{
  "updateMask": string,
  "id": string,
  "properties": {
    object (Properties)
  }
}
Felder
updateMask

string (FieldMask format)

Die Felder, die aktualisiert werden sollen. Es muss mindestens ein Feld angegeben werden. Die Stamm-properties ist impliziert und sollte nicht angegeben werden. Eine einzelne * kann als Abkürzung zum Aktualisieren jedes Felds verwendet werden.
id

string

Erforderlich. Das zu aktualisierende Feld.
properties

object (Properties)

Erforderlich. Grundlegende Feldeigenschaften.

UpdateFieldTypeRequest

Anfrage zum Ändern des Feldtyps

JSON-Darstellung 
{
  "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.
}
Felder
updateMask

string (FieldMask format)

Die Felder, die aktualisiert werden sollen. Es muss mindestens ein Feld angegeben werden. Die Wurzel von type_options ist impliziert und sollte nicht angegeben werden. Eine einzelne * kann als Abkürzung zum Aktualisieren jedes Felds verwendet werden.
id

string

Erforderlich. Das zu aktualisierende Feld.

Union-Feld type_options.

Für type_options ist nur einer der folgenden Werte zulässig:
textOptions

object (TextOptions)

Feld in Text ändern.
longTextOptions

object (LongTextOptions)

Ändere das Feld zu „Langer Text“.
integerOptions

object (IntegerOptions)

Aktualisieren Sie das Feld in eine Ganzzahl.
dateOptions

object (DateOptions)

Aktualisieren Sie das Feld auf „Datum“.
selectionOptions

object (SelectionOptions)

Aktualisieren Sie das Feld auf „Auswahl“.
userOptions

object (UserOptions)

Ändern Sie das Feld in „Nutzer“.

LongTextOptions

Optionen für den Feldtyp „Langer Text“.

JSON-Darstellung 
{
  "minLength": integer,
  "maxLength": integer
}
Felder
minLength

integer

Nur Ausgabe Die gültige Mindestlänge von Werten für das Textfeld.
maxLength

integer

Nur Ausgabe Die maximal gültige Länge von Werten für das Textfeld.

EnableFieldRequest

Anfrage zum Aktivieren des Felds.

JSON-Darstellung 
{
  "id": string
}
Felder
id

string

Erforderlich. ID des zu aktivierenden Feldes.

DisableFieldRequest

Anfrage zur Deaktivierung des Felds.

JSON-Darstellung 
{
  "updateMask": string,
  "id": string,
  "disabledPolicy": {
    object (DisabledPolicy)
  }
}
Felder
updateMask

string (FieldMask format)

Die Felder, die aktualisiert werden sollen. Es muss mindestens ein Feld angegeben werden. Die Stamm-disabledPolicy ist impliziert und sollte nicht angegeben werden. Eine einzelne * kann als Abkürzung zum Aktualisieren jedes Felds verwendet werden.
id

string

Erforderlich. Schlüssel des zu deaktivierenden Felds.
disabledPolicy

object (DisabledPolicy)

Erforderlich. Richtlinie für deaktivierte Felder.

DeleteFieldRequest

Anfrage zum Löschen des Felds.

JSON-Darstellung 
{
  "id": string
}
Felder
id

string

Erforderlich. ID des zu löschenden Felds.

CreateSelectionChoiceRequest

Anfrage zum Erstellen einer Auswahlmöglichkeit.

JSON-Darstellung 
{
  "fieldId": string,
  "choice": {
    object (Choice)
  }
}
Felder
fieldId

string

Erforderlich. Das Auswahlfeld, in dem eine Auswahl erstellt wird.
choice

object (Choice)

Erforderlich. Die Entscheidung für einen Creator.

UpdateSelectionChoicePropertiesRequest

Anfrage zum Aktualisieren einer Auswahl-Property

JSON-Darstellung 
{
  "updateMask": string,
  "fieldId": string,
  "id": string,
  "properties": {
    object (Properties)
  }
}
Felder
updateMask

string (FieldMask format)

Die Felder, die aktualisiert werden sollen. Es muss mindestens ein Feld angegeben werden. Die Stamm-properties ist impliziert und sollte nicht angegeben werden. Eine einzelne * kann als Abkürzung zum Aktualisieren jedes Felds verwendet werden.
fieldId

string

Erforderlich. Das zu aktualisierende Auswahlfeld.
id

string

Erforderlich. Die Auswahl zum Aktualisieren.
properties

object (Properties)

Erforderlich. Die Auswahleigenschaften, die aktualisiert werden sollen.

EnableSelectionChoiceRequest

Anfrage zum Aktivieren einer Auswahlmöglichkeit.

JSON-Darstellung 
{
  "fieldId": string,
  "id": string
}
Felder
fieldId

string

Erforderlich. Das Auswahlfeld, in dem eine Auswahl aktiviert wird.
id

string

Erforderlich. Zu aktivierende Auswahl.

DisableSelectionChoiceRequest

Anfrage zur Deaktivierung einer Auswahlmöglichkeit.

JSON-Darstellung 
{
  "updateMask": string,
  "fieldId": string,
  "id": string,
  "disabledPolicy": {
    object (DisabledPolicy)
  }
}
Felder
updateMask

string (FieldMask format)

Die Felder, die aktualisiert werden sollen. Es muss mindestens ein Feld angegeben werden. Die Stamm-disabledPolicy ist impliziert und sollte nicht angegeben werden. Eine einzelne * kann als Abkürzung zum Aktualisieren jedes Felds verwendet werden.
fieldId

string

Erforderlich. Das Auswahlfeld, in dem eine Auswahlmöglichkeit deaktiviert wird.
id

string

Erforderlich. Auswahl zum Deaktivieren.
disabledPolicy

object (DisabledPolicy)

Erforderlich. Die zu aktualisierende deaktivierte Richtlinie.

DeleteSelectionChoiceRequest

Anfrage zum Löschen einer Auswahlmöglichkeit.

JSON-Darstellung 
{
  "fieldId": string,
  "id": string
}
Felder
fieldId

string

Erforderlich. Das Auswahlfeld, aus dem eine Auswahl gelöscht wird.
id

string

Erforderlich. Auswahl zum Löschen.

Antwort

Eine einzelne Antwort von einem Update.

JSON-Darstellung 
{

  // 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.
}
Felder
Union-Feld response. Die Antwort auf die entsprechende Anfrage. Für response ist nur einer der folgenden Werte zulässig:
updateLabel

object (UpdateLabelPropertiesResponse)

Die grundlegenden Eigenschaften eines Labels wurden aktualisiert.
createField

object (CreateFieldResponse)

Erstellt ein neues Feld.
updateField

object (UpdateFieldPropertiesResponse)

Aktualisiert grundlegende Eigenschaften eines Felds.
updateFieldType

object (UpdateFieldTypeResponse)

Aktualisieren Sie die Optionen für den Feldtyp und/oder den Feldtyp.
enableField

object (EnableFieldResponse)

Aktiviert Feld.
disableField

object (DisableFieldResponse)

Deaktiviert das Feld.
deleteField

object (DeleteFieldResponse)

Löscht ein Feld aus dem Label.
createSelectionChoice

object (CreateSelectionChoiceResponse)

Erstellt eine neue Auswahllistenoption, die einem Auswahlfeld hinzugefügt werden kann.
updateSelectionChoiceProperties

object (UpdateSelectionChoicePropertiesResponse)

Aktualisiert eine Auswahl in einem Auswahlfeld.
enableSelectionChoice

object (EnableSelectionChoiceResponse)

Aktiviert eine Auswahl innerhalb eines Auswahlfelds.
disableSelectionChoice

object (DisableSelectionChoiceResponse)

Deaktiviert eine Auswahl in einem Auswahlfeld.
deleteSelectionChoice

object (DeleteSelectionChoiceResponse)

Löscht eine Auswahl aus einem Auswahlfeld.

UpdateLabelPropertiesResponse

Antwort nach der Aktualisierung der Labeleigenschaften.

CreateFieldResponse

Antwort nach Erstellung des Felds.

JSON-Darstellung 
{
  "id": string,
  "priority": integer
}
Felder
id

string

Das Feld des erstellten Felds. Wenn das Feld in einer Anfrage zur Erstellung leer bleibt, wird automatisch ein Schlüssel generiert und kann hier identifiziert werden.
priority

integer

Die Priorität des erstellten Felds. Die Priorität kann sich von der angegebenen unterscheiden, um zusammenhängende Prioritäten zwischen den Feldern (1–n) sicherzustellen.

UpdateFieldPropertiesResponse

Antwort nach der Aktualisierung der Feldeigenschaften.

JSON-Darstellung 
{
  "priority": integer
}
Felder
priority

integer

Die Priorität des aktualisierten Felds. Die Priorität kann sich von der angegebenen unterscheiden, um zusammenhängende Prioritäten zwischen den Feldern (1–n) sicherzustellen.

UpdateFieldTypeResponse

Antwort nach der Aktualisierung des Feldtyps.

EnableFieldResponse

Antwort nach Feldaktivierung.

DisableFieldResponse

Antwort nach Feld deaktiviert.

DeleteFieldResponse

Antwort nach Feldlöschung.

CreateSelectionChoiceResponse

Antwort nach Erstellung der Auswahlauswahl.

JSON-Darstellung 
{
  "fieldId": string,
  "id": string
}
Felder
fieldId

string

Die vom Server generierte ID des Felds.
id

string

Die vom Server generierte ID der erstellten Auswahl im Feld

UpdateSelectionChoicePropertiesResponse

Antwort nach der Aktualisierung der Eigenschaften für Auswahlmöglichkeiten.

JSON-Darstellung 
{
  "priority": integer
}
Felder
priority

integer

Die Priorität der aktualisierten Auswahl. Die Priorität kann sich gegenüber der angegebenen ändern, um zusammenhängende Prioritäten zwischen den Auswahlmöglichkeiten (1–n) sicherzustellen.

EnableSelectionChoiceResponse

Antwort nach Auswahl aktivieren.

DisableSelectionChoiceResponse

Antwort nach Auswahl deaktiviert.

DeleteSelectionChoiceResponse

Antwort nach Löschung der Auswahl.