Method: files.modifyLabels

Ändert die Labels, die auf eine Datei angewendet werden. Gibt eine Liste der Labels zurück, die hinzugefügt oder geändert wurden.

HTTP-Anfrage

POST https://www.googleapis.com/drive/v3/files/{fileId}/modifyLabels

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
fileId

string

Die ID der Datei, zu der die Labels gehören.

Anfragetext

Der Anfragetext enthält eine Instanz von ModifyLabelsRequest.

Antworttext

Antwort auf eine files.modifyLabels-Anfrage Diese Liste enthält nur die Labels, die durch die Anfrage hinzugefügt oder aktualisiert wurden.

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

JSON-Darstellung
{
  "modifiedLabels": [
    {
      object (Label)
    }
  ],
  "kind": string
}
Felder
modifiedLabels[]

object (Label)

Die Liste der Labels, die durch die Anfrage hinzugefügt oder aktualisiert wurden.

kind

string

Dies ist immer „drive#modifyLabelsResponse“.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.file
  • https://www.googleapis.com/auth/drive.metadata

Einige Bereiche sind eingeschränkt und erfordern eine Sicherheitsprüfung, damit Ihre App sie verwenden kann. Weitere Informationen finden Sie im Leitfaden zur Autorisierung.

ModifyLabelsRequest

Eine Anfrage zum Ändern der Labels für eine Datei. Diese Anfrage kann viele Änderungen enthalten, die entweder alle erfolgreich sind oder alle atomar fehlschlagen.

JSON-Darstellung
{
  "labelModifications": [
    {
      object (LabelModification)
    }
  ],
  "kind": string
}
Felder
labelModifications[]

object (LabelModification)

Die Liste der Änderungen, die auf die Labels in der Datei angewendet werden sollen.

kind

string

Dies ist immer „drive#modifyLabelsRequest“.

LabelModification

Eine Änderung an einem Label in einer Datei. Mit einer Labeländerung können Sie ein Label auf eine Datei anwenden, ein vorhandenes Label in einer Datei aktualisieren oder ein Label aus einer Datei entfernen.

JSON-Darstellung
{
  "labelId": string,
  "fieldModifications": [
    {
      object (FieldModification)
    }
  ],
  "removeLabel": boolean,
  "kind": string
}
Felder
labelId

string

Die ID des Labels, das geändert werden soll.

fieldModifications[]

object (FieldModification)

Liste der Änderungen an den Feldern dieses Labels.

removeLabel

boolean

Wenn „true“ festgelegt ist, wird das Label aus der Datei entfernt.

kind

string

Dies ist immer „drive#labelModification“.

FieldModification

Eine Änderung am Feld eines Labels.

JSON-Darstellung
{
  "fieldId": string,
  "kind": string,
  "setDateValues": [
    string
  ],
  "setTextValues": [
    string
  ],
  "setSelectionValues": [
    string
  ],
  "setIntegerValues": [
    string
  ],
  "setUserValues": [
    string
  ],
  "unsetValues": boolean
}
Felder
fieldId

string

Die ID des zu ändernden Felds.

kind

string

Dies ist immer „drive#labelFieldModification“.

setDateValues[]

string

Ersetzt den Wert eines date-Felds durch diese neuen Werte. Der String muss im Vollformat des RFC 3339-Datums angegeben werden: JJJJ-MM-TT.

setTextValues[]

string

Legt den Wert eines text-Felds fest.

setSelectionValues[]

string

Ersetzt ein selection-Feld durch diese neuen Werte.

setIntegerValues[]

string (int64 format)

Ersetzt den Wert eines integer-Felds durch diese neuen Werte.

setUserValues[]

string

Ersetzt ein user-Feld durch diese neuen Werte. Die Werte müssen gültige E-Mail-Adressen sein.

unsetValues

boolean

Die Werte für dieses Feld werden zurückgesetzt.