Method: users.messages.batchModify

Modyfikuje etykiety i wartości etykiet klasyfikacji w określonych wiadomościach. W przypadku administratorów modyfikujących wiadomości użytkowników w swojej organizacji żądania wymagają autoryzacji za pomocą konta usługi, które ma uprawnienia do delegowania w całej domenie, aby podszywać się pod użytkowników z zakresem https://www.googleapis.com/auth/gmail.modify.restricted.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
userId

string

Adres e-mail użytkownika. Możesz użyć wartości specjalnej me, aby wskazać uwierzytelnionego użytkownika.

Treść żądania

Treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "ids": [
    string
  ],
  "addLabelIds": [
    string
  ],
  "removeLabelIds": [
    string
  ],
  "addClassificationLabels": [
    {
      object (ClassificationLabelValue)
    }
  ],
  "removeClassificationLabelIds": [
    string
  ]
}
Pola
ids[]

string

Identyfikatory wiadomości do zmodyfikowania. Liczba identyfikatorów w żądaniu jest ograniczona do 1000.
addLabelIds[]

string

Lista identyfikatorów etykiet do dodania do wiadomości.
removeLabelIds[]

string

Lista identyfikatorów etykiet do usunięcia z wiadomości.
addClassificationLabels[]

object (ClassificationLabelValue)

Lista wartości etykiet klasyfikacji do dodania. Jeśli do wiadomości jest już zastosowana etykieta klasyfikacji o tym samym identyfikatorze, pola z istniejącymi identyfikatorami zostaną zaktualizowane, a pola z nowymi identyfikatorami zostaną dodane. Liczba wartości etykiet klasyfikacji w żądaniu jest ograniczona do 20. Jeśli wiadomość jest już sklasyfikowana, a łączna liczba wartości etykiet klasyfikacji przekracza maksymalną dozwoloną liczbę wartości etykiet klasyfikacji w wiadomości, modyfikacja nie powiedzie się.
removeClassificationLabelIds[]

string

Lista wartości etykiet klasyfikacji do usunięcia z wiadomości.

Treść odpowiedzi

Jeśli operacja się uda, treść odpowiedzi będzie pusta.

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w przewodniku Autoryzacja.