Method: users.messages.modify

Ändert die Labels und die Werte für Klassifizierungslabel in der angegebenen Nachricht. 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 Bereich https://www.googleapis.com/auth/gmail.modify.restricted zu vertreten.

HTTP-Anfrage

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

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.
id

string

Die ID der zu ändernden Nachricht.

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

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

string

Eine Liste der IDs von Labels, die dieser Nachricht hinzugefügt werden sollen. Sie können mit jeder Aktualisierung bis zu 100 Labels hinzufügen.
removeLabelIds[]

string

Eine Liste der IDs von Labels, die aus dieser Nachricht entfernt werden sollen. Sie können mit jeder Aktualisierung bis zu 100 Labels entfernen.
addClassificationLabels[]

object (ClassificationLabelValue)

Eine Liste der Werte für Klassifizierungslabel, die hinzugefügt werden sollen. Wenn bereits ein Klassifizierungslabel mit derselben Label-ID 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 Klassifizierungslabel zulässig. Wenn die Nachricht bereits klassifiziert ist und die endgültige Gesamtzahl der Werte für Klassifizierungslabel die maximal zulässige Anzahl von Werten für Klassifizierungslabel pro Nachricht überschreitet, schlägt die Änderung fehl.
removeClassificationLabelIds[]

string

Eine Liste der Werte für Klassifizierungslabel, die aus dieser Nachricht entfernt werden sollen.

Antworttext

Wenn der Vorgang erfolgreich abgeschlossen wurde, enthält der Antworttext eine Instanz von Message.

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.