Protocollo XMPP di Firebase Cloud Messaging

Questo parametro specifica il destinatario di un messaggio.

Il valore può essere il token di registrazione di un dispositivo, la chiave di notifica di un gruppo di dispositivi o un singolo argomento (con prefisso /topics/). Per l'invio a più argomenti, utilizza il parametro condition.

Questo parametro specifica un'espressione logica di condizioni che determina il target del messaggio.

Condizione supportata: Argomento, formattato come "'yourTopic' in topics". Questo valore non è sensibile alle maiuscole.

Operatori supportati: &&, ||. Sono supportati al massimo due operatori per messaggio dell'argomento.

Questo parametro identifica in modo univoco un messaggio in una connessione XMPP.

Questo parametro identifica un gruppo di messaggi (ad es. con collapse_key: "Updates Available") che possono essere compressi in modo che solo il ultimo messaggio venga inviato quando la pubblicazione viene ripresa. Lo scopo è evitare di inviare troppi messaggi uguali quando il dispositivo torna online o esce dalla modalità sospensione.

Non è garantito l'ordine in cui i messaggi vengono inviati.

Nota: in un determinato momento sono consentite al massimo 4 chiavi di collasso diverse. Ciò significa che FCM può memorizzare contemporaneamente 4 messaggi diversi per app client. Se superi questo numero, non è garantito quali 4 chiavi di collasso verranno conservate da FCM.

Imposta la priorità del messaggio. I valori validi sono "normale" e "alto". Sulle piattaforme Apple, queste corrispondono alle priorità APN 5 e 10.

Per impostazione predefinita, i messaggi di notifica vengono inviati con priorità elevata e i messaggi di dati vengono inviati con priorità normale. La priorità normale ottimizza il consumo della batteria dell'app client e deve essere utilizzata a meno che non sia richiesta l'invio immediato. Per i messaggi con priorità normale, l'app potrebbe riceverli con un ritardo non specificato.

Quando un messaggio viene inviato con priorità elevata, viene inviato immediatamente e l'app può mostrare una notifica.

Sulle piattaforme Apple, utilizza questo campo per rappresentare content-available nel payload APNs. Quando viene inviata una notifica o un messaggio e questo valore è impostato su true, viene risvegliata un'app client inattiva e il messaggio viene inviato tramite APN come notifica silenziosa e non tramite FCM. Tieni presente che non è garantito che le notifiche silenziose negli APN vengano recapitate e che possono dipendere da fattori quali l'attivazione della modalità a basso consumo da parte dell'utente, l'uscita forzata dall'app e così via. Su Android, i messaggi di dati riattivano l'app per impostazione predefinita. Su Chrome, non è attualmente supportato.

Sulle piattaforme Apple, utilizza questo campo per rappresentare mutable-content nel payload APNs. Quando viene inviata una notifica e questo valore è impostato su true, i contenuti della notifica possono essere modificati prima che vengano visualizzati utilizzando un' estensione dell'app Notification Service. Questo parametro verrà ignorato per Android e il web.

Questo parametro specifica per quanto tempo (in secondi) il messaggio deve essere conservato nello spazio di archiviazione FCM se il dispositivo è offline. La durata (TTL) massima supportata è di 4 settimane e il valore predefinito è 4 settimane. Per ulteriori informazioni, vedi Impostare la durata di un messaggio.

Se questo parametro viene impostato su true, consente agli sviluppatori di testare una richiesta senza inviare effettivamente un messaggio.

Il valore predefinito è false.

Questo parametro specifica le coppie chiave/valore del payload del messaggio.

Ad esempio, con data:{"score":"3x1"}:

Sulle piattaforme Apple, se il messaggio viene inviato tramite APN, rappresenta i campi di dati personalizzati. Se viene fornito da FCM, viene rappresentato come un dizionario di valori chiave in AppDelegate application:didReceiveRemoteNotification:.

Su Android, ne risulta un intent extra denominato score con il valore di stringa 3x1.

La chiave non deve essere una parola riservata ("from", "message_type" o qualsiasi parola che inizi con "google" o "gcm"). Non utilizzare le parole definite in questa tabella (ad esempio collapse_key).

Si consiglia di utilizzare valori di tipo stringa. Devi convertire i valori in oggetti o altri tipi di dati non di stringa (ad es. interi o booleani) in stringa.

Il titolo della notifica.

Questo campo non è visibile su smartphone e tablet.

Il corpo del testo della notifica.

Il suono da riprodurre quando il dispositivo riceve la notifica.

Stringa che specifica i file audio nel bundle principale dell'app client o nella cartella Library/Sounds del contenitore di dati dell'app. Per scoprire di più, consulta la libreria degli sviluppatori iOS.

Il valore del badge sull'icona dell'app nella schermata Home.

Se non viene specificato, il badge non viene modificato.

Se impostato su 0, il badge viene rimosso.

L'azione associata al clic di un utente sulla notifica.

Corrisponde a category nel payload APN.

Il sottotitolo della notifica.

La chiave della stringa del corpo nelle risorse stringa dell'app da utilizzare per localizzare il testo del corpo in base alla localizzazione corrente dell'utente.

Corrisponde a loc-key nel payload APN.

Per ulteriori informazioni, consulta Riferimento alle chiavi del payload e Localizzazione dei contenuti delle notifiche remote.

Valori di stringa variabili da utilizzare al posto degli specificatori di formato in body_loc_key da utilizzare per localizzare il testo del corpo in base alla localizzazione corrente dell'utente.

Corrisponde a loc-args nel payload APN.

Per ulteriori informazioni, consulta Riferimento alle chiavi del payload e Localizzazione dei contenuti delle notifiche remote.

La chiave della stringa del titolo nelle risorse stringa dell'app da utilizzare per localizzare il testo del titolo in base alla localizzazione corrente dell'utente.

Corrisponde a title-loc-key nel payload APN.

Per ulteriori informazioni, consulta Riferimento alle chiavi del payload e Localizzazione dei contenuti delle notifiche remote.

Valori di stringa variabili da utilizzare al posto degli specificatori di formato in title_loc_key da utilizzare per localizzare il testo del titolo in base alla localizzazione corrente dell'utente.

Corrisponde a title-loc-args nel payload APN.

Per ulteriori informazioni, consulta Riferimento alle chiavi del payload e Localizzazione dei contenuti delle notifiche remote.

Il titolo della notifica.

Il corpo del testo della notifica.

L' ID canale della notifica (novità di Android O).

L'app deve creare un canale con questo ID prima che venga ricevuta una notifica con questo ID canale.

Se non invii questo ID canale nella richiesta o se l'ID canale fornito non è stato ancora creato dall'app, FCM utilizza l'ID canale specificato nel file manifest dell'app.

L'icona della notifica.

Imposta l'icona di notifica su myicon per la risorsa drawable myicon. Se non invii questa chiave nella richiesta, FCM mostra l'icona del programma di avvio specificata nel file manifest dell'app.

Il suono da riprodurre quando il dispositivo riceve la notifica.

Supporta "default" o il nome file di una risorsa audio inclusa nell'app. I file audio devono trovarsi in /res/raw/.

Identificatore utilizzato per sostituire le notifiche esistenti nel riquadro a scomparsa delle notifiche.

Se non specificato, ogni richiesta crea una nuova notifica.

Se specificato e se è già visualizzata una notifica con lo stesso tag, la nuova notifica sostituisce quella esistente nel riquadro delle notifiche.

Il colore dell'icona della notifica, espresso in formato #rrggbb.

L'azione associata al clic di un utente sulla notifica.

Se specificato, un'attività con un filtro per intenzione corrispondente viene avviata quando un utente fa clic sulla notifica.

La chiave della stringa del corpo nelle risorse stringa dell'app da utilizzare per localizzare il testo del corpo in base alla localizzazione corrente dell'utente.

Per saperne di più, consulta la sezione Risorse stringa.

Valori di stringa variabili da utilizzare al posto degli specificatori di formato in body_loc_key da utilizzare per localizzare il testo del corpo in base alla localizzazione corrente dell'utente.

Per ulteriori informazioni, consulta Formattazione e stili.

La chiave della stringa del titolo nelle risorse stringa dell'app da utilizzare per localizzare il testo del titolo in base alla localizzazione corrente dell'utente.

Per saperne di più, consulta la sezione Risorse stringa.

Valori di stringa variabili da utilizzare al posto degli specificatori di formato in title_loc_key da utilizzare per localizzare il testo del titolo in base alla localizzazione corrente dell'utente.

Per ulteriori informazioni, consulta Formattazione e stili.

Il titolo della notifica.

Il corpo del testo della notifica.

L'URL da utilizzare per l'icona della notifica.

L'azione associata al clic di un utente sulla notifica.

Per tutti i valori dell'URL, è obbligatorio HTTPS.

Questo parametro specifica chi ha inviato questa risposta.

Il valore è il token di registrazione dell'app client.

Questo parametro specifica un messaggio ack o nack da FCM al server dell'app.

Se il valore è impostato su nack, l'app server deve esaminare error e error_description per ottenere informazioni sull'errore.

• Se l'app client si annulla la registrazione con FCM.
• Se l'app client non è registrata automaticamente, il che può accadere se l'utente disinstalla l'applicazione. Ad esempio, su iOS, se APNs ha segnalato il token APNs come non valido.
• Se il token di registrazione scade (ad esempio, Google potrebbe decidere di aggiornare i token di registrazione o il token APN è scaduto per i dispositivi).
• Se l'app client è aggiornata, ma la nuova versione non è configurata per ricevere messaggi.

Il server non è riuscito a elaborare la richiesta in tempo. Riprova a inviare la stessa richiesta, ma devi:

• Implementa il backoff esponenziale nel meccanismo di nuovo tentativo. Ad esempio, se hai aspettato un secondo prima del primo tentativo, attendi almeno due secondi prima del successivo, poi quattro secondi e così via. Se invii più messaggi, ritardali singolarmente di un'ulteriore quantità casuale per evitare di emettere una nuova richiesta per tutti i messaggi contemporaneamente.
• Il ritardo del primo tentativo deve essere impostato su 1 secondo.

Nota: i mittenti che causano problemi rischiano di essere inseriti nella lista nera.

Questo parametro specifica chi ha inviato il messaggio.

Il valore è il token di registrazione dell'app client.

Questo parametro specifica il destinatario di un messaggio di risposta.

Il valore deve essere un token di registrazione dell'app client che ha inviato il messaggio a monte.

Questo parametro specifica il tipo di messaggio: controllo.

Se è impostato su control, il messaggio include control_type per indicare il tipo di messaggio di controllo.

Questo parametro specifica il tipo di messaggio di controllo inviato da FCM.

Al momento è supportato solo CONNECTION_DRAINING. FCM invia questo messaggio di controllo prima di chiudere una connessione per eseguire il bilanciamento del carico. Quando la connessione si esaurisce, non è più consentito inviare messaggi alla connessione, ma i messaggi esistenti nella pipeline continuano a essere elaborati.