Method: users.messages.batchModify

Ändert die Labels und die Werte für Klassifikationslabels in den angegebenen Nachrichten. Wenn Administratoren Nachrichten für Nutzer in ihrer Organisation ändern, erfordern Anfragen die Autorisierung mit einem Dienstkonto, das die domänenweite Delegierungsberechtigung hat, um Nutzer mit dem https://www.googleapis.com/auth/gmail.modify.restricted Bereich zu vertreten.

HTTP-Anfrage

POST https://gmail.googleapis.com/gmail/v1/users/{userId}/messages/batchModify

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
userId

string

Die E-Mail-Adresse des Nutzers. Mit dem Sonderwert me kann der authentifizierte Nutzer angegeben werden.

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung 
{
  "ids": [
    string
  ],
  "addLabelIds": [
    string
  ],
  "removeLabelIds": [
    string
  ],
  "addClassificationLabels": [
    {
      object (ClassificationLabelValue)
    }
  ],
  "removeClassificationLabelIds": [
    string
  ]
}
Felder
ids[]

string

Die IDs der zu ändernden Nachrichten. Pro Anfrage sind maximal 1.000 IDs zulässig.
addLabelIds[]

string

Eine Liste der Label-IDs, die Nachrichten hinzugefügt werden sollen.
removeLabelIds[]

string

Eine Liste der Label-IDs, die aus Nachrichten entfernt werden sollen.
addClassificationLabels[]

object (ClassificationLabelValue)

Eine Liste der hinzuzufügenden Werte für Klassifikationslabels. Wenn ein Klassifikationslabel mit derselben Label-ID bereits auf die Nachricht angewendet wurde, werden Felder mit vorhandenen Feld-IDs aktualisiert und Felder mit neuen Feld-IDs hinzugefügt. Pro Anfrage sind maximal 20 Werte für Klassifikationslabels zulässig. Wenn die Nachricht bereits klassifiziert ist und die endgültige Gesamtzahl der Werte für Klassifikationslabels die maximal zulässige Anzahl von Werten für Klassifikationslabels pro Nachricht überschreitet, schlägt die Änderung fehl.
removeClassificationLabelIds[]

string

Eine Liste der Werte für Klassifikationslabels, die aus Nachrichten entfernt werden sollen.

Antworttext

Wenn der Vorgang erfolgreich ist, ist der Antworttext leer.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://mail.google.com/
  • https://www.googleapis.com/auth/gmail.modify
  • https://www.googleapis.com/auth/gmail.modify.restricted

Weitere Informationen finden Sie im Autorisierungsleitfaden.