- HTTP-Anfrage
- Pfadparameter
- Anfragetext
- Antworttext
- Autorisierungsbereiche
- Anfrage
- UpdateLabelPropertiesRequest
- CreateFieldRequest
- UpdateFieldPropertiesRequest
- UpdateFieldTypeRequest
- LongTextOptions
- EnableFieldRequest
- DisableFieldRequest
- DeleteFieldRequest
- CreateSelectionChoiceRequest
- UpdateSelectionChoicePropertiesRequest
- EnableSelectionChoiceRequest
- DisableSelectionChoiceRequest
- DeleteSelectionChoiceRequest
- Antwort
- UpdateLabelPropertiesResponse
- CreateFieldResponse
- UpdateFieldPropertiesResponse
- UpdateFieldTypeResponse
- EnableFieldResponse
- DisableFieldResponse
- DeleteFieldResponse
- CreateSelectionChoiceResponse
- UpdateSelectionChoicePropertiesResponse
- EnableSelectionChoiceResponse
- DisableSelectionChoiceResponse
- DeleteSelectionChoiceResponse
- Testen!
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 |
Erforderlich. Der Ressourcenname des Labels, das aktualisiert werden soll. |
Anfragetext
Der Anfragetext enthält Daten mit folgender Struktur:
JSON-Darstellung |
---|
{ "writeControl": { object ( |
Felder | |
---|---|
writeControl |
Bietet Kontrolle darüber, wie Schreibanfragen ausgeführt werden. |
requests[] |
Eine Liste der Aktualisierungen, die auf das Label angewendet werden sollen. Anfragen werden in der angegebenen Reihenfolge angewendet. |
useAdminAccess |
Legen Sie |
view |
Wenn angegeben, werden nur bestimmte Felder zurückgegeben, die zur angegebenen Ansicht gehören. |
languageCode |
Der BCP-47-Sprachcode, der zur Auswertung lokalisierter Feldlabels verwendet wird, wenn |
Antworttext
Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:
Antwort für Labelaktualisierung.
JSON-Darstellung |
---|
{ "responses": [ { object ( |
Felder | |
---|---|
responses[] |
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 |
Das Label nach dem Anwenden von Aktualisierungen. Dieser Parameter wird nur festgelegt, wenn [BatchUpdateLabelResponse2.include_label_in_response] den Wert |
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 |
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 |
Aktualisiert die Labeleigenschaften. |
createField |
Erstellt ein neues Feld. |
updateField |
Aktualisiert grundlegende Eigenschaften eines Felds. |
updateFieldType |
Aktualisieren Sie die Optionen für den Feldtyp und/oder den Feldtyp. |
enableField |
Aktiviert das Feld. |
disableField |
Deaktiviert das Feld. |
deleteField |
Löscht ein Feld aus dem Label. |
createSelectionChoice |
Erstellt Auswahl in einem Auswahlfeld. |
updateSelectionChoiceProperties |
Auswahleigenschaften innerhalb eines Auswahlfelds aktualisieren |
enableSelectionChoice |
Auswahl innerhalb eines Auswahlfelds aktivieren |
disableSelectionChoice |
Auswahl in einem Auswahlfeld deaktivieren |
deleteSelectionChoice |
Auswahl in einem Auswahlfeld löschen |
UpdateLabelPropertiesRequest
Aktualisiert grundlegende Eigenschaften eines Labels.
JSON-Darstellung |
---|
{
"updateMask": string,
"properties": {
object ( |
Felder | |
---|---|
updateMask |
Die Felder, die aktualisiert werden sollen. Es muss mindestens ein Feld angegeben werden. Die Stamm- |
properties |
Erforderlich. Labeleigenschaften, die aktualisiert werden sollen. |
CreateFieldRequest
Anfrage zum Erstellen eines Felds in einem Label.
JSON-Darstellung |
---|
{
"field": {
object ( |
Felder | |
---|---|
field |
Erforderlich. Zu erstellendes Feld. |
UpdateFieldPropertiesRequest
Anfrage zum Aktualisieren von Feldeigenschaften.
JSON-Darstellung |
---|
{
"updateMask": string,
"id": string,
"properties": {
object ( |
Felder | |
---|---|
updateMask |
Die Felder, die aktualisiert werden sollen. Es muss mindestens ein Feld angegeben werden. Die Stamm- |
id |
Erforderlich. Das zu aktualisierende Feld. |
properties |
Erforderlich. Grundlegende Feldeigenschaften. |
UpdateFieldTypeRequest
Anfrage zum Ändern des Feldtyps
JSON-Darstellung |
---|
{ "updateMask": string, "id": string, // Union field |
Felder | |
---|---|
updateMask |
Die Felder, die aktualisiert werden sollen. Es muss mindestens ein Feld angegeben werden. Die Wurzel von |
id |
Erforderlich. Das zu aktualisierende Feld. |
Union-Feld Für |
|
textOptions |
Feld in Text ändern. |
longTextOptions |
Ändere das Feld zu „Langer Text“. |
integerOptions |
Aktualisieren Sie das Feld in eine Ganzzahl. |
dateOptions |
Aktualisieren Sie das Feld auf „Datum“. |
selectionOptions |
Aktualisieren Sie das Feld auf „Auswahl“. |
userOptions |
Ändern Sie das Feld in „Nutzer“. |
LongTextOptions
Optionen für den Feldtyp „Langer Text“.
JSON-Darstellung |
---|
{ "minLength": integer, "maxLength": integer } |
Felder | |
---|---|
minLength |
Nur Ausgabe Die gültige Mindestlänge von Werten für das Textfeld. |
maxLength |
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 |
Erforderlich. ID des zu aktivierenden Feldes. |
DisableFieldRequest
Anfrage zur Deaktivierung des Felds.
JSON-Darstellung |
---|
{
"updateMask": string,
"id": string,
"disabledPolicy": {
object ( |
Felder | |
---|---|
updateMask |
Die Felder, die aktualisiert werden sollen. Es muss mindestens ein Feld angegeben werden. Die Stamm- |
id |
Erforderlich. Schlüssel des zu deaktivierenden Felds. |
disabledPolicy |
Erforderlich. Richtlinie für deaktivierte Felder. |
DeleteFieldRequest
Anfrage zum Löschen des Felds.
JSON-Darstellung |
---|
{ "id": string } |
Felder | |
---|---|
id |
Erforderlich. ID des zu löschenden Felds. |
CreateSelectionChoiceRequest
Anfrage zum Erstellen einer Auswahlmöglichkeit.
JSON-Darstellung |
---|
{
"fieldId": string,
"choice": {
object ( |
Felder | |
---|---|
fieldId |
Erforderlich. Das Auswahlfeld, in dem eine Auswahl erstellt wird. |
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 ( |
Felder | |
---|---|
updateMask |
Die Felder, die aktualisiert werden sollen. Es muss mindestens ein Feld angegeben werden. Die Stamm- |
fieldId |
Erforderlich. Das zu aktualisierende Auswahlfeld. |
id |
Erforderlich. Die Auswahl zum Aktualisieren. |
properties |
Erforderlich. Die Auswahleigenschaften, die aktualisiert werden sollen. |
EnableSelectionChoiceRequest
Anfrage zum Aktivieren einer Auswahlmöglichkeit.
JSON-Darstellung |
---|
{ "fieldId": string, "id": string } |
Felder | |
---|---|
fieldId |
Erforderlich. Das Auswahlfeld, in dem eine Auswahl aktiviert wird. |
id |
Erforderlich. Zu aktivierende Auswahl. |
DisableSelectionChoiceRequest
Anfrage zur Deaktivierung einer Auswahlmöglichkeit.
JSON-Darstellung |
---|
{
"updateMask": string,
"fieldId": string,
"id": string,
"disabledPolicy": {
object ( |
Felder | |
---|---|
updateMask |
Die Felder, die aktualisiert werden sollen. Es muss mindestens ein Feld angegeben werden. Die Stamm- |
fieldId |
Erforderlich. Das Auswahlfeld, in dem eine Auswahlmöglichkeit deaktiviert wird. |
id |
Erforderlich. Auswahl zum Deaktivieren. |
disabledPolicy |
Erforderlich. Die zu aktualisierende deaktivierte Richtlinie. |
DeleteSelectionChoiceRequest
Anfrage zum Löschen einer Auswahlmöglichkeit.
JSON-Darstellung |
---|
{ "fieldId": string, "id": string } |
Felder | |
---|---|
fieldId |
Erforderlich. Das Auswahlfeld, aus dem eine Auswahl gelöscht wird. |
id |
Erforderlich. Auswahl zum Löschen. |
Antwort
Eine einzelne Antwort von einem Update.
JSON-Darstellung |
---|
{ // Union field |
Felder | |
---|---|
Union-Feld response . Die Antwort auf die entsprechende Anfrage. Für response ist nur einer der folgenden Werte zulässig: |
|
updateLabel |
Die grundlegenden Eigenschaften eines Labels wurden aktualisiert. |
createField |
Erstellt ein neues Feld. |
updateField |
Aktualisiert grundlegende Eigenschaften eines Felds. |
updateFieldType |
Aktualisieren Sie die Optionen für den Feldtyp und/oder den Feldtyp. |
enableField |
Aktiviert Feld. |
disableField |
Deaktiviert das Feld. |
deleteField |
Löscht ein Feld aus dem Label. |
createSelectionChoice |
Erstellt eine neue Auswahllistenoption, die einem Auswahlfeld hinzugefügt werden kann. |
updateSelectionChoiceProperties |
Aktualisiert eine Auswahl in einem Auswahlfeld. |
enableSelectionChoice |
Aktiviert eine Auswahl innerhalb eines Auswahlfelds. |
disableSelectionChoice |
Deaktiviert eine Auswahl in einem Auswahlfeld. |
deleteSelectionChoice |
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 |
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 |
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 |
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 |
Die vom Server generierte ID des Felds. |
id |
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 |
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.