Method: users.messages.modify

Modifica le etichette e i valori dell'etichetta di classificazione nel messaggio specificato. Per gli amministratori che modificano il messaggio per gli utenti della propria organizzazione, le richieste richiedono l'autorizzazione con un service account che disponga dell'autorizzazione di delega a livello di dominio per rappresentare gli utenti con l'ambito https://www.googleapis.com/auth/gmail.modify.restricted.

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
userId

string

L'indirizzo email dell'utente. Il valore speciale me può essere utilizzato per indicare l'utente autenticato.

id

string

L'ID del messaggio da modificare.

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Rappresentazione JSON
{
  "addLabelIds": [
    string
  ],
  "removeLabelIds": [
    string
  ],
  "addClassificationLabels": [
    {
      object (ClassificationLabelValue)
    }
  ],
  "removeClassificationLabelIds": [
    string
  ]
}
Campi
addLabelIds[]

string

Un elenco di ID delle etichette da aggiungere a questo messaggio. Puoi aggiungere fino a 100 etichette per ogni aggiornamento.

removeLabelIds[]

string

Un elenco di ID delle etichette da rimuovere da questo messaggio. Puoi rimuovere fino a 100 etichette con ogni aggiornamento.

addClassificationLabels[]

object (ClassificationLabelValue)

Un elenco di valori di etichette di classificazione da aggiungere. Se al messaggio è già applicata un'etichetta di classificazione con lo stesso ID etichetta, i campi con ID campo esistenti verranno aggiornati e i campi con nuovi ID campo verranno aggiunti. È previsto un limite di 20 valori di etichetta di classificazione per richiesta. Se il messaggio è già classificato e il numero totale finale di valori dell'etichetta di classificazione supera il numero massimo consentito di valori dell'etichetta di classificazione per messaggio, la modifica non riesce.

removeClassificationLabelIds[]

string

Un elenco di valori di etichette di classificazione da rimuovere da questo messaggio.

Corpo della risposta

In caso di esito positivo, il corpo della risposta contiene un'istanza di Message.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

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

Per ulteriori informazioni, consulta la Guida all'autorizzazione.