Protokół HTTP Firebase Cloud Messaging

Ten parametr określa adresata wiadomości.

Wartością może być token rejestracji urządzenia, identyfikator grupy urządzeń klucza powiadomień lub pojedynczego tematu (z przedrostkiem /topics/). Aby wysłać wiadomość do wielu tematów, użyj condition.

Ten parametr określa adresata wiadomości multicast, wysłane do więcej niż jednego tokena rejestracji.

Wartość powinna być tablicą tokenów rejestracji, do których ma zostać wysłana wiadomość grupową. Tablica musi zawierać od 1 do 1000 tokeny rejestracji. Aby wysłać wiadomość na jedno urządzenie, użyj to.

Komunikaty multicast są dozwolone tylko w formacie HTTP JSON.

Ten parametr określa wyrażenie logiczne warunków, które określić cel wiadomości.

Obsługiwany warunek: temat w formacie „TwójTemat” w tematach”. Ten Wielkość liter w wartości nie jest rozróżniana.

Obsługiwane operatory: &&, ||. Maksymalnie 2 operatorów na wiadomość w temacie.

Ten parametr został wycofany. Zamiast tego użyj to, aby określić odbiorców wiadomości. Więcej informacji o wysyłaniu wiadomości do dla wielu urządzeń znajdziesz w dokumentacji danej platformy.

Ten parametr określa grupę wiadomości (np. collapse_key: "Updates Available"), które można zwinąć, tak aby tylko gdy można wznowić dostarczanie, ostatnia wiadomość jest wysyłana. Ma to na celu uniknięcie wysyłania wiele takich samych wiadomości, gdy urządzenie znów będzie online lub będzie aktywne.

Pamiętaj, że nie możemy zagwarantować kolejności wysyłania wiadomości.

Uwaga: w danym momencie dozwolone są maksymalnie 4 różne klucze zwijania. Oznacza to, że FCM może jednocześnie przechowywać 4 różne wiadomości na aplikację kliencką. Jeśli przekracza tę liczbę, nie ma gwarancji, które 4 klucze zwijania zachowa FCM.

Określa priorytet wiadomości. Prawidłowe wartości to „normal” i „wysoka”. Na platformach Apple odpowiadają priorytetom 5 i 10 APNs.

Domyślnie powiadomienia są wysyłane z wysokim priorytetem oraz wiadomościami zawierającymi dane. wysyłane z normalnym priorytetem. Normalny priorytet optymalizuje zużycia baterii i należy go używać, chyba że wymagane jest natychmiastowe W przypadku wiadomości o normalnym priorytecie aplikacja może otrzymać wiadomość z kodem nieokreślone opóźnienie.

Gdy wiadomość o wysokim priorytecie jest wysyłana, jest ona wysyłana natychmiast, a aplikacja może wyświetlić powiadomienie.

Na platformach Apple użyj tego pola do reprezentowania tego pola w polu content-available Ładunek APNs. Gdy zostanie wysłane powiadomienie lub wiadomość z ustawieniem true, pojawi się nieaktywna aplikacja kliencka jest wybudzana, a wiadomość jest wysyłana za pośrednictwem punktów APN jako ciche powiadomienie. a nie przez FCM. Pamiętaj, że ciche powiadomienia w APN-ach nie są jest gwarantowane i może zależeć od takich czynników jak włączenie przez użytkownika trybu niskiego zużycia energii. Tryb, wymuszanie zamknięcia aplikacji itp. Na Androidzie wiadomości z danymi domyślnie wybudzają aplikację. Wł. Chrome, obecnie nieobsługiwany.

Na platformach Apple użyj tego pola, aby określić, mutable-content w ładunku APNs. Gdy zostanie wysłane powiadomienie, do true, treść powiadomienia można zmienić przed jego wyświetleniem, za pomocą funkcji Rozszerzenie aplikacji usługi powiadomień. W przypadku Androida i internetu ten parametr będzie ignorowany.

Ten parametr określa czas (w sekundach), przez jaki wiadomość ma być przechowywana w pamięci FCM jeśli urządzenie jest offline. Maksymalny obsługiwany czas życia to 4 tygodnie, a wartość domyślna to 4 tygodnie. Więcej informacji znajdziesz w artykule Ustawianie okresu ważności wiadomości.

Po ustawieniu tego parametru na true deweloperzy mogą testować żądania bez wysyłania wiadomości.

Wartością domyślną jest false.

Ten parametr określa niestandardowe pary klucz-wartość ładunku wiadomości.

Przykład: data:{"score":"3x1"}:

Na platformach Apple wiadomość jest wysyłana przez APN, czyli reprezentuje niestandardowe pola danych. Jeśli jest wysyłana przez FCM, w AppDelegate application:didReceiveRemoteNotification: zostanie on przedstawiony jako słownik wartości klucz-wartość.

W przypadku Androida spowodowałoby to dodatkową intencję o nazwie score z wartością ciągu znaków 3x1.

Klucz nie może być słowem zarezerwowanym („z”, „message_type” ani innym słowem rozpoczynającym się od „Google” lub „gcm”). Nie używaj żadnych słów zdefiniowanych w tej tabeli (np. collapse_key).

Zalecane są wartości w typach ciągów znaków. Musisz przekonwertować wartości w obiektach lub innych typach danych niebędących ciągami znaków (np. liczby całkowite lub logiczne) na ciąg znaków.

Tytuł powiadomienia.

To pole jest niewidoczne na telefonach i tabletach.

Treść powiadomienia.

Dźwięk do odtwarzania, gdy urządzenie otrzyma powiadomienie.

Ciąg tekstowy określający pliki dźwiękowe w głównym pakiecie aplikacji klienckiej lub w pliku Folder Library/Sounds kontenera danych aplikacji. Zobacz w Bibliotece deweloperów iOS, aby dowiedzieć się więcej.

Wartość plakietki na ikonie aplikacji na ekranie głównym.

Jeśli go nie podasz, identyfikator się nie zmieni.

Jeśli ma wartość 0, plakietka zostanie usunięta.

Działanie powiązane z użytkownikiem kliknie powiadomienie.

Odpowiada parametrowi category w ładunku APNs.

Podtytuł powiadomienia.

Klucz do ciągu treści w zasobach ciągu tekstowego aplikacji, który ma być używany do zlokalizuj tekst główny do bieżącej lokalizacji użytkownika.

Odpowiada parametrowi loc-key w ładunku APNs.

Zobacz Dokumentacja klucza ładunku Lokalizuję zawartość powiadomień zdalnych, aby dowiedzieć się więcej i informacjami o nich.

Ciągi znaków zmiennych, które mają być używane zamiast specyfikatorów formatu w body_loc_key, który służy do lokalizowania tekstu głównego w sekcji bieżącej lokalizacji użytkownika.

Odpowiada parametrowi loc-args w ładunku APNs.

Zobacz Dokumentacja klucza ładunku Lokalizuję zawartość powiadomień zdalnych, aby dowiedzieć się więcej i informacjami o nich.

Klucz do ciągu tytułu w zasobach ciągu tekstowego aplikacji, który ma służyć do przetłumaczyć tekst tytułu do bieżącej lokalizacji użytkownika.

Odpowiada parametrowi title-loc-key w ładunku APNs.

Zobacz Dokumentacja klucza ładunku Lokalizuję zawartość powiadomień zdalnych, aby dowiedzieć się więcej i informacjami o nich.

Ciągi znaków zmiennych, które mają być używane zamiast specyfikatorów formatu w title_loc_key służy do zlokalizowania tekstu tytułu w sekcji bieżącej lokalizacji użytkownika.

Odpowiada parametrowi title-loc-args w ładunku APNs.

Zobacz Dokumentacja klucza ładunku Lokalizuję zawartość powiadomień zdalnych, aby dowiedzieć się więcej i informacjami o nich.

Tytuł powiadomienia.

Treść powiadomienia.

identyfikator kanału powiadomienia (nowość w Androidzie O).

Aplikacja musi utworzyć kanał z tym identyfikatorem, zanim powiadomienie z tym identyfikatorem zostanie odebrane.

Jeśli nie podasz tego identyfikatora kanału w prośbie lub jeśli podany identyfikator kanału nie został jeszcze utworzony przez aplikację, FCM używa identyfikatora kanału określonego w manifeście aplikacji.

Ikona powiadomienia.

Ustawia ikonę powiadomień na myicon dla zasobu rysowalnego myicon Jeśli nie wyślesz tego klucza w żądaniu, FCM wyświetla ikonę programu uruchamiającego określoną w manifeście aplikacji.

Dźwięk do odtwarzania, gdy urządzenie otrzyma powiadomienie.

Obsługuje pole "default" lub nazwę pliku zasobu dźwiękowego zawarte w pakiecie do aplikacji. Pliki dźwiękowe muszą znajdować się w lokalizacji /res/raw/.

Identyfikator używany do zastępowania obecnych powiadomień w powiadomieniu szuflady.

Jeśli go nie podasz, dla każdego żądania tworzone będzie nowe powiadomienie.

Jeśli został określony, a powiadomienie z tym samym tagiem jest już wysyłane nowe powiadomienie zastąpi dotychczasowe panelu powiadomień.

Kolor ikony powiadomienia w formacie #rrggbb.

Działanie powiązane z użytkownikiem kliknie powiadomienie.

Jeśli określisz działanie z pasującym filtrem intencji, zostanie ono uruchomione, gdy użytkownik klika je.

Klucz do ciągu treści w zasobach ciągu tekstowego aplikacji, który ma być używany do zlokalizuj tekst główny do bieżącej lokalizacji użytkownika.

Zobacz String Resources.

Ciągi znaków zmiennych, które mają być używane zamiast specyfikatorów formatu w body_loc_key, który służy do lokalizowania tekstu głównego w sekcji bieżącej lokalizacji użytkownika.

Zobacz Formatowanie i styl.

Klucz do ciągu tytułu w zasobach ciągu tekstowego aplikacji, który ma służyć do przetłumaczyć tekst tytułu do bieżącej lokalizacji użytkownika.

Zobacz String Resources.

Ciągi znaków zmiennych, które mają być używane zamiast specyfikatorów formatu w title_loc_key służy do zlokalizowania tekstu tytułu w sekcji bieżącej lokalizacji użytkownika.

Zobacz Formatowanie i styl.

Tytuł powiadomienia.

Treść powiadomienia.

Adres URL, który ma być używany na potrzeby ikony powiadomienia.

Działanie powiązane z użytkownikiem kliknie powiadomienie.

W przypadku wszystkich wartości adresów URL wymagany jest protokół HTTPS.

Ten parametr określa aplikacje klienckie (tokeny rejestracji), które otrzymują wiadomość.

Przesyłanie zbiorcze (na więcej niż 1 token rejestracji) jest dozwolone tylko przy użyciu formatu JSON HTTP.

Ten parametr określa pary klucz-wartość ładunku wiadomości. Nie ma limitu liczby parametrów klucz-wartość, ale obowiązuje limit 4096 bajtów.

Na przykład na Androidzie użycie funkcji "data.score"."3x1" spowodowałoby dodatkowe intencje. score z wartością ciągu znaków 3x1.

Klucz nie może być słowem zarezerwowanym („z”, „message_type” ani innym słowem rozpoczynającym się od „Google” lub „gcm”). Nie używaj żadnych słów zdefiniowanych w tej tabeli (np. collapse_key).

• message_id: ciąg znaków określający unikalny identyfikator każdego przetworzonego każdego pliku. .
• error: ciąg znaków określający błąd, który wystąpił podczas przetwarzania wiadomość dla adresata. Możliwe wartości znajdziesz w tabeli 9.

• Jeśli aplikacja kliencka wyrejestruje się z FCM.
• Jeśli aplikacja kliencka została automatycznie wyrejestrowana, co może się zdarzyć, użytkownik odinstaluje aplikację. Na przykład w iOS, jeśli punkty APN Usługa Feedback Service zgłosiła token APNs jako nieprawidłowy.
• Jeśli token rejestracji wygaśnie (na przykład Google może zdecydować się na odświeżenie strony tokeny rejestracji lub token APNs wygasł w przypadku urządzeń z iOS).
• Jeśli aplikacja kliencka została zaktualizowana, ale nowa wersja nie jest skonfigurowana do odbierania wiadomości.

• Brak nagłówka autoryzacji lub nieprawidłową składnię w żądaniu HTTP.
• Projekt Firebase, do którego należy podany klucz serwera, jest nieprawidłowy.
• Tylko starsze klucze serwera – żądanie pochodzi z serwera, którego nie ma na białej liście adresów IP klucza serwera.

Serwer nie mógł przetworzyć żądania na czas. Ponów tę samą prośbę, ale musisz:

• Uwzględniaj nagłówek Retry-After, jeśli jest on zawarty w odpowiedzi z parametru Serwer połączeń FCM.
• Wdróż wykładniczy czas ponowienia w mechanizmie ponawiania. (np. jeśli odczekano jedną sekundę przed pierwszą próbą, odczekaj co najmniej dwie sekundy przed następną, potem 4 sekundy itd.). Jeśli wysyłasz wiele wiadomości, opóźnij każdą z nich niezależnie o dodatkową losową liczbę , aby uniknąć jednoczesnego zgłaszania nowego żądania dotyczącego wszystkich wiadomości.

Nadawcy, którzy powodują problemy, mogą zostać umieszczone na czarnej liście.

Częstotliwość wiadomości do konkretnego urządzenia jest za duża. Jeśli aplikacja Apple wysyła wiadomości z częstotliwością przekraczającą limity APNs, może zobaczyć ten komunikat o błędzie

Zmniejsz liczbę wiadomości wysłanych na to urządzenie oraz użyj wykładniczego ponowienia aby spróbować wysłać ponownie.