REST Resource: projects.messages

Zasób: wiadomość

Wiadomość do wysłania przez Komunikację w chmurze Firebase (FCM).

Zapis JSON

{ "name": string, "data": { string: string, ... }, "notification": { object (Notification) }, "android": { object (AndroidConfig) }, "webpush": { object (WebpushConfig) }, "apns": { object (ApnsConfig) }, "fcm_options": { object (FcmOptions) }, // Union field target can be only one of the following: "token": string, "topic": string, "condition": string // End of list of possible types for union field target. }

Pola
name	string Tylko dane wyjściowe. Identyfikator wysłanej wiadomości w formacie projects/*/messages/{message_id}.
data	map (key: string, value: string) Tylko dane wejściowe. Dowolny ładunek klucz/wartość, który musi być zakodowany w formacie UTF-8. Klucz nie może być słowem zarezerwowanym („z”, „message_type” ani żadnym słowem zaczynającym się od „google.” lub „gcm.notification.”). Podczas wysyłania ładunków zawierających tylko pola danych na urządzenia z iOS dozwolony jest w ApnsConfig tylko normalny priorytet ("apns-priority": "5"). Obiekt zawierający listę par "key": value. Przykład: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
notification	object (Notification) Tylko dane wejściowe. Podstawowy szablon powiadomień do użycia na wszystkich platformach.
android	object (AndroidConfig) Tylko dane wejściowe. Opcje przeznaczone dla Androida dotyczące wiadomości wysyłanych przez serwer połączeń FCM.
webpush	object (WebpushConfig) Tylko dane wejściowe. opcji protokołu Webpush.
apns	object (ApnsConfig) Tylko dane wejściowe. Opcje specyficzne dla usługi Apple Push Notification.
fcm_options	object (FcmOptions) Tylko dane wejściowe. Szablon opcji funkcji pakietu SDK FCM do wykorzystania na wszystkich platformach.
Pole sumy target. Wymagane. Tylko dane wejściowe. Cel, do którego chcesz wysłać wiadomość. target może mieć tylko jedną z tych wartości:
token	string Token rejestracji, do którego ma zostać wysłana wiadomość.
topic	string Nazwa tematu, do którego chcesz wysłać wiadomość, np. „pogoda”. Uwaga: „/topics/” nie należy podawać prefiksu.
condition	string Warunek wysłania wiadomości, np. "'foo' w tematach && „bar” w tematach”.

Powiadomienie

Podstawowy szablon powiadomień do użycia na wszystkich platformach.

Zapis JSON
{ "title": string, "body": string, "image": string }

Pola
title	string Tytuł powiadomienia.
body	string Treść powiadomienia.
image	string Zawiera adres URL obrazu, który zostanie pobrany na urządzenie i wyświetlony w powiadomieniu. Formaty JPEG, PNG i BMP są w pełni obsługiwane na wszystkich platformach. Animowane pliki GIF i filmy działają tylko na urządzeniach z iOS. WebP i HEIF są obsługiwane na różnych platformach i w różnych wersjach platformy. W Androidzie obowiązuje limit rozmiaru obrazu wynoszący 1 MB. Wykorzystanie limitu oraz konsekwencje i koszty hostowania obrazu w Firebase Storage: https://firebase.google.com/pricing

Konfiguracja Androida

Opcje przeznaczone dla Androida dotyczące wiadomości wysyłanych przez serwer połączeń FCM.

Zapis JSON
{ "collapse_key": string, "priority": enum (AndroidMessagePriority), "ttl": string, "restricted_package_name": string, "data": { string: string, ... }, "notification": { object (AndroidNotification) }, "fcm_options": { object (AndroidFcmOptions) }, "direct_boot_ok": boolean }

Pola
collapse_key	string Identyfikator grupy wiadomości, które można zwinąć, aby umożliwić wysłanie tylko ostatniej wiadomości, gdy można wznowić jej dostarczanie. W danym momencie dozwolone są maksymalnie 4 różne klucze zwijania.
priority	enum (AndroidMessagePriority) Priorytet wiadomości. Może przyjąć wartość „normalny” i „wysoka” . Więcej informacji znajdziesz w sekcji Ustawianie priorytetu wiadomości.
ttl	string (Duration format) Czas (w sekundach), przez jaki wiadomość ma być przechowywana w pamięci FCM, gdy urządzenie jest offline. Maksymalny obsługiwany czas życia to 4 tygodnie, a jeśli nie zostanie ustawiony, wartość domyślna to 4 tygodnie. Jeśli chcesz wysłać wiadomość od razu, ustaw wartość 0. W formacie JSON typ czasu trwania jest zakodowany jako ciąg, a nie obiekt, gdzie ciąg znaków kończy się sufiksem „s”. (oznaczając sekundy), a jej nazwa jest poprzedzona liczbą sekund, a nanosekundy wyrażone w ułamkach. Na przykład 3 sekundy z 0 nanosekund powinny być zakodowane w formacie JSON jako „3s”, a 3 sekundy i 1 nanosekundę w formacie JSON jako „3.000000001s”. Wartość TTl zostanie zaokrąglona w dół do najbliższej sekundy. Czas trwania w sekundach składający się z maksymalnie 9 cyfr po przecinku, kończący się cyfrą „s”. Przykład: "3.5s".
restricted_package_name	string Nazwa pakietu aplikacji, w której przypadku token rejestracji musi być zgodny, aby otrzymać komunikat.
data	map (key: string, value: string) Dowolny ładunek klucz/wartość. Jeśli jest podany, zastąpi wartość google.firebase.fcm.v1.Message.data. Obiekt zawierający listę par "key": value. Przykład: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
notification	object (AndroidNotification) Powiadomienie do wysłania na urządzenia z Androidem.
fcm_options	object (AndroidFcmOptions) Opcje funkcji dostępnych w pakiecie SDK FCM na Androida.
direct_boot_ok	boolean Jeśli zasada ma wartość Prawda, wiadomości mogą być dostarczane do aplikacji, gdy urządzenie jest w trybie bezpośredniego rozruchu. Zobacz Pomoc w trybie bezpośredniego rozruchu.

AndroidMessagePriority

Priorytet wiadomości wysyłanej na urządzenia z Androidem. Pamiętaj, że ten priorytet jest pojęciem FCM, który określa, kiedy wiadomość jest dostarczana. Zobacz przewodniki po FCM. Możesz też określić priorytet wyświetlania powiadomień na docelowych urządzeniach z Androidem za pomocą ustawienia Android Notification.notificationPriority.

Wartości w polu enum
NORMAL	Domyślny priorytet komunikatów z danymi. Wiadomości o normalnym priorytecie nie nawiązywały połączeń sieciowych na urządzeniu uśpionym, a ich dostarczanie może się opóźniać w celu oszczędzania baterii. W przypadku mniej pilnych wiadomości, takich jak powiadomienia o nowych e-mailach lub innych danych do zsynchronizowania, wybierz normalny priorytet dostarczania.
HIGH	Domyślny priorytet powiadomień. FCM próbuje natychmiast dostarczyć wiadomości o wysokim priorytecie, co pozwala usłudze FCM w miarę możliwości wybudzić urządzenie do snu i nawiązać połączenie sieciowe z serwerem aplikacji. Na przykład aplikacje z komunikatami, czatami lub alertami dotyczącymi połączeń głosowych zwykle muszą nawiązać połączenie sieciowe i upewnić się, że FCM niezwłocznie dostarczy wiadomość na urządzenie. Ustaw wysoki priorytet, jeśli wiadomość ma kluczowe znaczenie i wymaga natychmiastowej interakcji. Pamiętaj jednak, że ustawienie wysokiego priorytetu wiadomości powoduje większe zużycie baterii niż zwykłe wiadomości priorytetowe.

Powiadomienia na Androidzie

Powiadomienie do wysłania na urządzenia z Androidem.

Zapis JSON

{ "title": string, "body": string, "icon": string, "color": string, "sound": string, "tag": string, "click_action": string, "body_loc_key": string, "body_loc_args": [ string ], "title_loc_key": string, "title_loc_args": [ string ], "channel_id": string, "ticker": string, "sticky": boolean, "event_time": string, "local_only": boolean, "notification_priority": enum (NotificationPriority), "default_sound": boolean, "default_vibrate_timings": boolean, "default_light_settings": boolean, "vibrate_timings": [ string ], "visibility": enum (Visibility), "notification_count": integer, "light_settings": { object (LightSettings) }, "image": string, "bypass_proxy_notification": boolean, "proxy": enum (Proxy) }

Pola
title	string Tytuł powiadomienia. Jeśli jest podany, zastąpi wartość google.firebase.fcm.v1.Notification.title.
body	string Treść powiadomienia. Jeśli jest podany, zastąpi wartość google.firebase.fcm.v1.Notification.body.
icon	string Ikona powiadomienia. Ustawia ikonę powiadomień na myicon dla zasobu rysowalnego myicon. Jeśli nie wyślesz tego klucza w żądaniu, FCM wyświetli ikonę programu uruchamiającego określoną w manifeście aplikacji.
color	string Kolor ikony powiadomienia w formacie #rrggbb.
sound	string Dźwięk do odtwarzania, gdy urządzenie otrzyma powiadomienie. Obsługuje ustawienie „default” lub nazwa pliku zasobu dźwiękowego dołączonego do aplikacji. Pliki dźwiękowe muszą znajdować się w folderze /res/raw/.
tag	string Identyfikator używany do zastępowania obecnych powiadomień w panelu powiadomień. Jeśli go nie podasz, dla każdego żądania tworzone będzie nowe powiadomienie. Jeśli określisz powiadomienie z tym samym tagiem i wyświetla się już powiadomienie z tym samym tagiem, nowe powiadomienie zastąpi dotychczasowe w panelu powiadomień.
click_action	string Działanie powiązane z użytkownikiem kliknie powiadomienie. Jeśli określisz działanie z pasującym filtrem intencji, uruchamia się ona, gdy użytkownik kliknie powiadomienie.
body_loc_key	string Klucz do ciągu tekstowego w zasobach ciągu tekstowego aplikacji, który ma być używany do zlokalizowania tekstu głównego w aktualnej lokalizacji użytkownika. Więcej informacji znajdziesz w sekcji Zasoby dotyczące ciągów tekstowych.
body_loc_args[]	string Wartości ciągów zmiennych, które mają być używane zamiast specyfikatorów formatu w parametrze body_loc_key w celu zlokalizowania tekstu głównego w aktualnej lokalizacji użytkownika. Więcej informacji znajdziesz w artykule Formatowanie i style.
title_loc_key	string Klucz do ciągu tytułu w zasobach ciągu tekstowego aplikacji, który ma być używany do zlokalizowania tekstu tytułu w bieżącej lokalizacji użytkownika. Więcej informacji znajdziesz w sekcji Zasoby dotyczące ciągów tekstowych.
title_loc_args[]	string Wartości ciągów zmiennych, które mają być używane zamiast specyfikatorów formatu w polu title_loc_key, używane do zlokalizowania tekstu tytułu w bieżącej lokalizacji użytkownika. Więcej informacji znajdziesz w artykule Formatowanie i style.
channel_id	string Identyfikator kanału powiadomienia (nowość w Androidzie O). Aplikacja musi utworzyć kanał z tym identyfikatorem, zanim zostanie odebrane powiadomienie z tym identyfikatorem. Jeśli nie prześlesz identyfikatora kanału w prośbie lub jeśli podany identyfikator kanału nie został jeszcze utworzony przez aplikację, FCM użyje identyfikatora kanału określonego w pliku manifestu aplikacji.
ticker	string Ustawia pasek aktywności tekst, który jest wysyłany do usług ułatwień dostępu. Przed poziomem interfejsu API 21 (Lollipop) ustawia tekst, który ma być wyświetlany na pasku stanu w chwili otrzymania powiadomienia.
sticky	boolean Jeśli zasada ma wartość Fałsz lub jest nieskonfigurowana, powiadomienie jest automatycznie zamykane, gdy użytkownik kliknie je w panelu. Jeśli ma wartość Prawda, powiadomienie będzie się wyświetlać nawet wtedy, gdy użytkownik je kliknie.
event_time	string (Timestamp format) Ustaw czas wystąpienia zdarzenia wskazanego w powiadomieniu. Powiadomienia w panelu są sortowane według tej godziny. Punkt w czasie jest podawany za pomocą parametru protobuf.Timestamp. Sygnatura czasowa w RFC3339 UTC „Zulu” z rozdzielczością nanosekundową i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".
local_only	boolean Określ, czy to powiadomienie dotyczy tylko bieżącego urządzenia. Niektóre powiadomienia można połączyć z innymi urządzeniami, aby wyświetlać zdalne, np. zegarkiem z Wear OS. Tę wskazówkę można skonfigurować tak, aby zalecała, że to powiadomienie nie jest mostowane. Zobacz przewodniki po Wear OS
notification_priority	enum (NotificationPriority) Ustaw względny priorytet tego powiadomienia. Priorytet wskazuje, jaka część uwagi użytkownika powinna zostać pochłonięta przez to powiadomienie. W niektórych sytuacjach powiadomienia o niskim priorytecie mogą być ukryte przed użytkownikiem, a użytkownik może zostać naruszony po otrzymaniu powiadomienia o wyższym priorytecie. Efekty wyznaczania tych samych priorytetów mogą się nieco różnić w zależności od platformy. Pamiętaj, że ten priorytet różni się od tego priorytetu: AndroidMessagePriority. Ten priorytet jest przetwarzany przez klienta po dostarczeniu wiadomości, podczas gdy AndroidMessagePriority to koncepcja FCM określająca czas dostarczenia wiadomości.
default_sound	boolean Jeśli zasada ma wartość Prawda, użyj w przypadku powiadomienia domyślnego dźwięku platformy Androida. Wartości domyślne są podane w pliku config.xml.
default_vibrate_timings	boolean Jeśli zasada ma wartość Prawda, użyj domyślnego wzoru wibracji platformy Androida dla powiadomienia. Wartości domyślne są podane w pliku config.xml. Jeśli zasada default_vibrate_timings ma wartość Prawda i vibrate_timings jest skonfigurowana, zamiast określonej przez użytkownika wartości vibrate_timings używana jest wartość domyślna.
default_light_settings	boolean Jeśli zasada ma wartość Prawda, w przypadku powiadomienia użyj domyślnych ustawień diody LED na platformie Androida. Wartości domyślne są podane w pliku config.xml. Jeśli zasada default_light_settings ma wartość Prawda, a zasada light_settings jest skonfigurowana, zamiast wartości domyślnej jest używana określona przez użytkownika zasada light_settings.
vibrate_timings[]	string (Duration format) Ustaw używany wzór wibracji. Podaj tablicę protobuf.Duration, aby włączyć lub wyłączyć wibracje. Pierwsza wartość wskazuje, że Duration musi zaczekać, zanim włączy wibracje. Następna wartość wskazuje Duration, który ma utrzymać włączone wibracje. Kolejne wartości naprzemiennie zmieniają się w Duration, aby wyłączyć i włączyć wibracje. Jeśli zasada vibrate_timings jest ustawiona, a default_vibrate_timings ma wartość true, używana jest wartość domyślna zamiast określonej przez użytkownika wartości vibrate_timings. Czas trwania w sekundach składający się z maksymalnie 9 cyfr po przecinku, kończący się cyfrą „s”. Przykład: "3.5s".
visibility	enum (Visibility) Ustaw wartość notification.visibility powiadomienia.
notification_count	integer Ustawia liczbę elementów reprezentowanych przez to powiadomienie. Może być wyświetlana jako liczba plakietek w programach uruchamiających, które obsługują plakietki.Zobacz Plakietka powiadomień. Może to być na przykład przydatne, jeśli używasz tylko jednego powiadomienia do reprezentowania wielu nowych wiadomości, ale chcesz, aby liczba nowych wiadomości odzwierciedlała łączną liczbę nowych wiadomości. Jeśli wartość nie jest określona lub nie ma podanej wartości, systemy obsługujące plakietki używają wartości domyślnej, która powoduje zwiększanie liczby wyświetlanej w menu przytrzymanym za każdym razem, gdy przychodzi nowe powiadomienie.
light_settings	object (LightSettings) Ustawienia sterujące szybkością migania i kolorem diody LED powiadomienia, jeśli na urządzeniu jest dostępna dioda LED. Całkowity czas migania zależy od systemu operacyjnego.
image	string Zawiera adres URL obrazu, który będzie wyświetlany w powiadomieniu. Jeśli jest podany, zastąpi wartość google.firebase.fcm.v1.Notification.image.
bypass_proxy_notification (deprecated)	boolean Ten produkt został wycofany. Jeśli jest włączone, powiadomienia wysyłane na urządzenie są obsługiwane przez aplikację, a nie przez serwer proxy.
proxy	enum (Proxy) Ustawienie pozwalające określić, kiedy powiadomienie może być wysyłane przez serwer proxy.

Priorytet powiadomień

Poziomy priorytetu powiadomienia.

Wartości w polu enum
PRIORITY_UNSPECIFIED	Jeśli priorytet nie jest określony, priorytet powiadomień jest ustawiany na PRIORITY_DEFAULT.
PRIORITY_MIN	Najniższy priorytet powiadomień. Powiadomienia z tym elementem (PRIORITY_MIN) mogą nie być wyświetlane użytkownikowi z wyjątkiem szczególnych okoliczności, takich jak szczegółowe dzienniki powiadomień.
PRIORITY_LOW	Niższy priorytet powiadomień. Interfejs może wyświetlać powiadomienia w mniejszych lub innych miejscach na liście niż powiadomienia z PRIORITY_DEFAULT.
PRIORITY_DEFAULT	Domyślny priorytet powiadomień. Jeśli aplikacja nie nadaje priorytet swoim powiadomieniom, użyj tej wartości w przypadku wszystkich powiadomień.
PRIORITY_HIGH	Wyższy priorytet powiadomień. Używaj, aby otrzymywać ważniejsze powiadomienia lub alerty. Interfejs może wyświetlać te powiadomienia w większym rozmiarze lub na innym miejscu na liście powiadomień niż powiadomienia w usłudze PRIORITY_DEFAULT.
PRIORITY_MAX	Najwyższy priorytet powiadomień. Używaj w przypadku najważniejszych elementów aplikacji, które wymagają natychmiastowej uwagi lub działania użytkownika.

Widoczność

Różne poziomy widoczności powiadomień.

Wartości w polu enum
VISIBILITY_UNSPECIFIED	Jeśli nie określono inaczej, domyślna wartość to Visibility.PRIVATE.
PRIVATE	Wyświetlaj to powiadomienie na wszystkich ekranach blokady, ale ukrywaj informacje poufne lub prywatne na bezpiecznych ekranach.
PUBLIC	Pokazuj to powiadomienie w całości na wszystkich ekranach blokady.
SECRET	Nie pokazuj żadnej części tego powiadomienia na bezpiecznym ekranie blokady.

Ustawienia oświetlenia

Ustawienia dotyczące sterowania diodą LED powiadomień.

Zapis JSON
{ "color": { object (Color) }, "light_on_duration": string, "light_off_duration": string }

Pola
color	object (Color) Wymagane. Ustaw color diody LED za pomocą parametru google.type.Color.
light_on_duration	string (Duration format) Wymagane. Oprócz wartości light_off_duration określ szybkość migania diod LED. Rozdzielczość zdefiniowana przez proto.Duration Czas trwania w sekundach składający się z maksymalnie 9 cyfr po przecinku, kończący się cyfrą „s”. Przykład: "3.5s".
light_off_duration	string (Duration format) Wymagane. Oprócz wartości light_on_duration określ szybkość migania diod LED. Rozdzielczość zdefiniowana przez proto.Duration Czas trwania w sekundach składający się z maksymalnie 9 cyfr po przecinku, kończący się cyfrą „s”. Przykład: "3.5s".

Kolor

Reprezentuje kolor w przestrzeni kolorów RGBA. Ta reprezentacja ma na celu uproszczenie procesu konwersji i zmiany kolorów w różnych językach, a nie ich kompaktowości. Na przykład pola tej reprezentacji można wprost przekazać do konstruktora java.awt.Color w Javie; można go również łatwo dostarczyć do metody +colorWithRed:green:blue:alpha UIColor w systemie iOS. Przy niewielkim nakładzie pracy można go łatwo sformatować pod postacią ciągu CSS rgba() w JavaScripcie.

Na tej stronie referencyjnej nie ma informacji o bezwzględnej przestrzeni kolorów, która powinna być wykorzystywana do interpretacji wartości RGB, np. sRGB, Adobe RGB, DCI-P3 i BT.2020. Domyślnie aplikacje powinny przyjąć przestrzeń kolorów sRGB.

Gdy należy ustalić równość kolorów, implementacje (o ile nie udokumentowano inaczej) traktują 2 kolory jako równe, jeśli wszystkie ich wartości czerwonego, zielonego, niebieskiego i alfa różnią się o maksymalnie 1e-5.

Przykład (Java):

 import com.google.type.Color;

 // ...
 public static java.awt.Color fromProto(Color protocolor) {
   float alpha = protocolor.hasAlpha()
       ? protocolor.getAlpha().getValue()
       : 1.0;

   return new java.awt.Color(
       protocolor.getRed(),
       protocolor.getGreen(),
       protocolor.getBlue(),
       alpha);
 }

 public static Color toProto(java.awt.Color color) {
   float red = (float) color.getRed();
   float green = (float) color.getGreen();
   float blue = (float) color.getBlue();
   float denominator = 255.0;
   Color.Builder resultBuilder =
       Color
           .newBuilder()
           .setRed(red / denominator)
           .setGreen(green / denominator)
           .setBlue(blue / denominator);
   int alpha = color.getAlpha();
   if (alpha != 255) {
     result.setAlpha(
         FloatValue
             .newBuilder()
             .setValue(((float) alpha) / denominator)
             .build());
   }
   return resultBuilder.build();
 }
 // ...

Przykład (iOS / Obj-C):

 // ...
 static UIColor* fromProto(Color* protocolor) {
    float red = [protocolor red];
    float green = [protocolor green];
    float blue = [protocolor blue];
    FloatValue* alpha_wrapper = [protocolor alpha];
    float alpha = 1.0;
    if (alpha_wrapper != nil) {
      alpha = [alpha_wrapper value];
    }
    return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
 }

 static Color* toProto(UIColor* color) {
     CGFloat red, green, blue, alpha;
     if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
       return nil;
     }
     Color* result = [[Color alloc] init];
     [result setRed:red];
     [result setGreen:green];
     [result setBlue:blue];
     if (alpha <= 0.9999) {
       [result setAlpha:floatWrapperWithValue(alpha)];
     }
     [result autorelease];
     return result;
}
// ...

Przykład (JavaScript):

// ...

var protoToCssColor = function(rgb_color) {
   var redFrac = rgb_color.red || 0.0;
   var greenFrac = rgb_color.green || 0.0;
   var blueFrac = rgb_color.blue || 0.0;
   var red = Math.floor(redFrac * 255);
   var green = Math.floor(greenFrac * 255);
   var blue = Math.floor(blueFrac * 255);

   if (!('alpha' in rgb_color)) {
      return rgbToCssColor(red, green, blue);
   }

   var alphaFrac = rgb_color.alpha.value || 0.0;
   var rgbParams = [red, green, blue].join(',');
   return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
};

var rgbToCssColor = function(red, green, blue) {
  var rgbNumber = new Number((red << 16) | (green << 8) | blue);
  var hexString = rgbNumber.toString(16);
  var missingZeros = 6 - hexString.length;
  var resultBuilder = ['#'];
  for (var i = 0; i < missingZeros; i++) {
     resultBuilder.push('0');
  }
  resultBuilder.push(hexString);
  return resultBuilder.join('');
};

// ...

Zapis JSON
{ "red": number, "green": number, "blue": number, "alpha": number }

Pola
red	number Ilość czerwonego koloru jako wartość z przedziału [0, 1].
green	number Ilość zielonego koloru jako wartość przedziału [0, 1].
blue	number Ilość niebieskiego koloru jako wartość z przedziału [0, 1].
alpha	number Część tego koloru, która powinna zostać zastosowana do piksela. Oznacza to, że końcowy kolor w pikselach jest określony za pomocą tego równania: pixel color = alpha * (this color) + (1.0 - alpha) * (background color) Oznacza to, że wartość 1,0 odpowiada jednolitym kolorowi, a wartość 0,0 – kolorowi całkowicie przezroczystemu. Wykorzystuje komunikat opakowany, a nie prosty zmiennoprzecinkowy element skalarny, dzięki czemu można odróżnić wartość domyślną od nieskonfigurowanej wartości. Jeśli ten obiekt koloru zostanie pominięty, będzie on renderowany jako jednolity kolor (jak gdyby wartość alfa miała jednoznacznie przypisaną wartość 1,0).

Serwer proxy

Ustawienie pozwalające określić, kiedy powiadomienie może być wysyłane przez serwer proxy.

Wartości w polu enum
PROXY_UNSPECIFIED	Jeśli nie określono inaczej, domyślna wartość to Proxy.IF_PRIORITY_LOWERED.
ALLOW	Spróbuj przesłać to powiadomienie przez serwer proxy.
DENY	Nie przesyłaj tego powiadomienia do serwera proxy.
IF_PRIORITY_LOWERED	Przekieruj to powiadomienie przez serwer proxy tylko wtedy, gdy jego wartość AndroidMessagePriority na urządzeniu została obniżona z HIGH na NORMAL.

Opcje AndroidFcm

Opcje funkcji dostępnych w pakiecie SDK FCM na Androida.

Zapis JSON
{ "analytics_label": string }

Pola
analytics_label	string Etykieta powiązana z danymi analitycznymi wiadomości.

Konfiguracja Webpush

opcji protokołu Webpush.

Zapis JSON
{ "headers": { string: string, ... }, "data": { string: string, ... }, "notification": { object }, "fcm_options": { object (WebpushFcmOptions) } }

Pola
headers	map (key: string, value: string) Nagłówki HTTP zdefiniowane w protokole webpush. Informacje o obsługiwanych nagłówkach znajdziesz w artykule o protokole Webpush, np. „TTL”: „15”. Obiekt zawierający listę par "key": value. Przykład: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
data	map (key: string, value: string) Dowolny ładunek klucz/wartość. Jeśli jest podany, zastąpi wartość google.firebase.fcm.v1.Message.data. Obiekt zawierający listę par "key": value. Przykład: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
notification	object (Struct format) Opcje powiadomień internetowych jako obiekt JSON. Obsługuje właściwości instancji Notification zdefiniowane w interfejsie Web Notification API. Jeśli występuje, „title” i „body” zastępują te wartości: google.firebase.fcm.v1.Notification.title i google.firebase.fcm.v1.Notification.body.
fcm_options	object (WebpushFcmOptions) Opcje funkcji zapewnianych przez pakiet SDK FCM na potrzeby witryn.

Opcje WebpushFcmOptions

Opcje funkcji zapewnianych przez pakiet SDK FCM na potrzeby witryn.

Zapis JSON
{ "link": string, "analytics_label": string }

Pola
link	string Link, który ma się otworzyć, gdy użytkownik kliknie powiadomienie. W przypadku wszystkich wartości adresów URL wymagany jest protokół HTTPS.
analytics_label	string Etykieta powiązana z danymi analitycznymi wiadomości.

Konfiguracja Apns

Opcje specyficzne dla usługi Apple Push Notification.

Zapis JSON
{ "headers": { string: string, ... }, "payload": { object }, "fcm_options": { object (ApnsFcmOptions) } }

Pola
headers	map (key: string, value: string) Nagłówki żądań HTTP zdefiniowane w usłudze Apple Push Notification. Informacje o obsługiwanych nagłówkach (np. apns-expiration i apns-priority) znajdziesz w artykule Nagłówki żądań APN. Backend ustawia domyślną wartość dla pola apns-expiration na 30 dni i wartość domyślną dla parametru apns-priority na 10, jeśli nie zostanie ustawiona bezpośrednio. Obiekt zawierający listę par "key": value. Przykład: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
payload	object (Struct format) Ładunek APNs w postaci obiektu JSON, który obejmuje zarówno słownik aps, jak i ładunek niestandardowy. Patrz dokumentacja klucza ładunku. Jeśli występuje, zastępuje reguły google.firebase.fcm.v1.Notification.title i google.firebase.fcm.v1.Notification.body.
fcm_options	object (ApnsFcmOptions) Opcje funkcji dostępnych w pakiecie SDK FCM na iOS.

Opcje ApnsFcm

Opcje funkcji dostępnych w pakiecie SDK FCM na iOS.

Zapis JSON
{ "analytics_label": string, "image": string }

Pola
analytics_label	string Etykieta powiązana z danymi analitycznymi wiadomości.
image	string Zawiera adres URL obrazu, który będzie wyświetlany w powiadomieniu. Jeśli jest podany, zastąpi wartość google.firebase.fcm.v1.Notification.image.

Opcje FcmOptions

Opcje dostępne w pakietach SDK FCM niezależnie od platformy.

Zapis JSON
{ "analytics_label": string }

Pola
analytics_label	string Etykieta powiązana z danymi analitycznymi wiadomości.

Metody
send	Wyślij wiadomość do określonego celu (tokena rejestracji, tematu lub warunku).