コンソールへ移動

firebase_admin.messaging module

Firebase Cloud Messaging module.

Exceptions

exception firebase_admin.messaging.QuotaExceededError(message, cause=None, http_response=None)

Bases: firebase_admin.exceptions.ResourceExhaustedError

Sending limit exceeded for the message target.

exception firebase_admin.messaging.SenderIdMismatchError(message, cause=None, http_response=None)

Bases: firebase_admin.exceptions.PermissionDeniedError

The authenticated sender ID is different from the sender ID for the registration token.

exception firebase_admin.messaging.ThirdPartyAuthError(message, cause=None, http_response=None)

Bases: firebase_admin.exceptions.UnauthenticatedError

APNs certificate or web push auth key was invalid or missing.

exception firebase_admin.messaging.UnregisteredError(message, cause=None, http_response=None)

Bases: firebase_admin.exceptions.NotFoundError

App instance was unregistered from FCM.

This usually means that the token used is no longer valid and a new one must be used.

Classes

class firebase_admin.messaging.AndroidConfig(collapse_key=None, priority=None, ttl=None, restricted_package_name=None, data=None, notification=None, fcm_options=None)

Bases: object

Android-specific options that can be included in a message.

Parameters:
  • collapse_key – Collapse key string for the message (optional). This is an identifier for a group of messages that can be collapsed, so that only the last message is sent when delivery can be resumed. A maximum of 4 different collapse keys may be active at a given time.
  • priority – Priority of the message (optional). Must be one of high or normal.
  • ttl – The time-to-live duration of the message (optional). This can be specified as a numeric seconds value or a datetime.timedelta instance.
  • restricted_package_name – The package name of the application where the registration tokens must match in order to receive the message (optional).
  • data – A dictionary of data fields (optional). All keys and values in the dictionary must be strings. When specified, overrides any data fields set via Message.data.
  • notification – A messaging.AndroidNotification to be included in the message (optional).
  • fcm_options – A messaging.AndroidFCMOptions to be included in the message (optional).
class firebase_admin.messaging.AndroidFCMOptions(analytics_label=None)

Bases: object

Options for features provided by the FCM SDK for Android.

Parameters:analytics_label – contains additional options for features provided by the FCM Android SDK (optional).
class firebase_admin.messaging.AndroidNotification(title=None, body=None, icon=None, color=None, sound=None, tag=None, click_action=None, body_loc_key=None, body_loc_args=None, title_loc_key=None, title_loc_args=None, channel_id=None)

Bases: object

Android-specific notification parameters.

Parameters:
  • title – Title of the notification (optional). If specified, overrides the title set via messaging.Notification.
  • body – Body of the notification (optional). If specified, overrides the body set via messaging.Notification.
  • icon – Icon of the notification (optional).
  • color – Color of the notification icon expressed in #rrggbb form (optional).
  • sound – Sound to be played when the device receives the notification (optional). This is usually the file name of the sound resource.
  • tag – Tag of the notification (optional). This is an identifier used to replace existing notifications in the notification drawer. If not specified, each request creates a new notification.
  • click_action – The action associated with a user click on the notification (optional). If specified, an activity with a matching intent filter is launched when a user clicks on the notification.
  • body_loc_key – Key of the body string in the app’s string resources to use to localize the body text (optional).
  • body_loc_args – A list of resource keys that will be used in place of the format specifiers in body_loc_key (optional).
  • title_loc_key – Key of the title string in the app’s string resources to use to localize the title text (optional).
  • title_loc_args – A list of resource keys that will be used in place of the format specifiers in title_loc_key (optional).
  • channel_id – channel_id of the notification (optional).
class firebase_admin.messaging.APNSConfig(headers=None, payload=None, fcm_options=None)

Bases: object

APNS-specific options that can be included in a message.

Refer to APNS Documentation for more information.

Parameters:
  • headers – A dictionary of headers (optional).
  • payload – A messaging.APNSPayload to be included in the message (optional).
  • fcm_options – A messaging.APNSFCMOptions instance to be included in the message (optional).
class firebase_admin.messaging.APNSFCMOptions(analytics_label=None)

Bases: object

Options for features provided by the FCM SDK for iOS.

Parameters:analytics_label – contains additional options for features provided by the FCM iOS SDK (optional).
class firebase_admin.messaging.APNSPayload(aps, **kwargs)

Bases: object

Payload of an APNS message.

Parameters:
  • aps – A messaging.Aps instance to be included in the payload.
  • kwargs – Arbitrary keyword arguments to be included as custom fields in the payload (optional).
class firebase_admin.messaging.Aps(alert=None, badge=None, sound=None, content_available=None, category=None, thread_id=None, mutable_content=None, custom_data=None)

Bases: object

Aps dictionary to be included in an APNS payload.

Parameters:
  • alert – A string or a messaging.ApsAlert instance (optional).
  • badge – A number representing the badge to be displayed with the message (optional).
  • sound – Name of the sound file to be played with the message or a messaging.CriticalSound instance (optional).
  • content_available – A boolean indicating whether to configure a background update notification (optional).
  • category – String identifier representing the message type (optional).
  • thread_id – An app-specific string identifier for grouping messages (optional).
  • mutable_content – A boolean indicating whether to support mutating notifications at the client using app extensions (optional).
  • custom_data – A dict of custom key-value pairs to be included in the Aps dictionary (optional).
class firebase_admin.messaging.ApsAlert(title=None, subtitle=None, body=None, loc_key=None, loc_args=None, title_loc_key=None, title_loc_args=None, action_loc_key=None, launch_image=None, custom_data=None)

Bases: object

An alert that can be included in messaging.Aps.

Parameters:
  • title – Title of the alert (optional). If specified, overrides the title set via messaging.Notification.
  • subtitle – Subtitle of the alert (optional).
  • body – Body of the alert (optional). If specified, overrides the body set via messaging.Notification.
  • loc_key – Key of the body string in the app’s string resources to use to localize the body text (optional).
  • loc_args – A list of resource keys that will be used in place of the format specifiers in loc_key (optional).
  • title_loc_key – Key of the title string in the app’s string resources to use to localize the title text (optional).
  • title_loc_args – A list of resource keys that will be used in place of the format specifiers in title_loc_key (optional).
  • action_loc_key – Key of the text in the app’s string resources to use to localize the action button text (optional).
  • launch_image – Image for the notification action (optional).
  • custom_data – A dict of custom key-value pairs to be included in the ApsAlert dictionary (optional)
class firebase_admin.messaging.BatchResponse(responses)

Bases: object

The response received from a batch request to the FCM API.

failure_count
responses

A list of messaging.SendResponse objects (possibly empty).

success_count
class firebase_admin.messaging.CriticalSound(name, critical=None, volume=None)

Bases: object

Critical alert sound configuration that can be included in messaging.Aps.

Parameters:
  • name – The name of a sound file in your app’s main bundle or in the Library/Sounds folder of your app’s container directory. Specify the string default to play the system sound.
  • critical – Set to True to set the critical alert flag on the sound configuration (optional).
  • volume – The volume for the critical alert’s sound. Must be a value between 0.0 (silent) and 1.0 (full volume) (optional).
class firebase_admin.messaging.ErrorInfo(index, reason)

Bases: object

An error encountered when performing a topic management operation.

index

Index of the registration token to which this error is related to.

reason

String describing the nature of the error.

class firebase_admin.messaging.FCMOptions(analytics_label=None)

Bases: object

Options for features provided by SDK.

Parameters:analytics_label – contains additional options to use across all platforms (optional).
class firebase_admin.messaging.Message(data=None, notification=None, android=None, webpush=None, apns=None, fcm_options=None, token=None, topic=None, condition=None)

Bases: object

A message that can be sent via Firebase Cloud Messaging.

Contains payload information as well as recipient information. In particular, the message must contain exactly one of token, topic or condition fields.

Parameters:
  • data – A dictionary of data fields (optional). All keys and values in the dictionary must be strings.
  • notification – An instance of messaging.Notification (optional).
  • android – An instance of messaging.AndroidConfig (optional).
  • webpush – An instance of messaging.WebpushConfig (optional).
  • apns – An instance of messaging.ApnsConfig (optional).
  • fcm_options – An instance of messaging.FCMOptions (optional).
  • token – The registration token of the device to which the message should be sent (optional).
  • topic – Name of the FCM topic to which the message should be sent (optional). Topic name may contain the /topics/ prefix.
  • condition – The FCM condition to which the message should be sent (optional).
class firebase_admin.messaging.MulticastMessage(tokens, data=None, notification=None, android=None, webpush=None, apns=None, fcm_options=None)

Bases: object

A message that can be sent to multiple tokens via Firebase Cloud Messaging.

Parameters:
  • tokens – A list of registration tokens of targeted devices.
  • data – A dictionary of data fields (optional). All keys and values in the dictionary must be strings.
  • notification – An instance of messaging.Notification (optional).
  • android – An instance of messaging.AndroidConfig (optional).
  • webpush – An instance of messaging.WebpushConfig (optional).
  • apns – An instance of messaging.ApnsConfig (optional).
  • fcm_options – An instance of messaging.FCMOptions (optional).
class firebase_admin.messaging.Notification(title=None, body=None)

Bases: object

A notification that can be included in a message.

Parameters:
  • title – Title of the notification (optional).
  • body – Body of the notification (optional).
class firebase_admin.messaging.SendResponse(resp, exception)

Bases: object