243 lines
7.4 KiB
Python
243 lines
7.4 KiB
Python
"""Server Side FCM sample.
|
|
Firebase Cloud Messaging (FCM) can be used to send messages to clients on iOS,
|
|
Android and Web.
|
|
This sample uses FCM to send two types of messages to clients that are subscribed
|
|
to the `news` topic. One type of message is a simple notification message (display message).
|
|
The other is a notification message (display notification) with platform specific
|
|
customizations. For example, a badge is added to messages that are sent to iOS devices.
|
|
"""
|
|
|
|
import argparse
|
|
import json
|
|
import requests
|
|
import datetime
|
|
|
|
from google.oauth2 import service_account
|
|
from firebase_admin import messaging
|
|
|
|
PROJECT_ID = 'aitrainer-af0ec'
|
|
BASE_URL = 'https://fcm.googleapis.com'
|
|
FCM_ENDPOINT = 'v1/projects/' + PROJECT_ID + '/messages:send'
|
|
FCM_URL = BASE_URL + '/' + FCM_ENDPOINT
|
|
SCOPES = ['https://www.googleapis.com/auth/firebase.messaging']
|
|
|
|
# [START retrieve_access_token]
|
|
def _get_access_token():
|
|
"""Retrieve a valid access token that can be used to authorize requests.
|
|
:return: Access token.
|
|
"""
|
|
credentials = credentials = service_account.Credentials.from_service_account_file(
|
|
"asset/aitrainer-firebase-adminsdk.json",
|
|
scopes=['email'],
|
|
)
|
|
access_token_info = credentials.get_access_token()
|
|
return access_token_info.access_token
|
|
# [END retrieve_access_token]
|
|
|
|
def _send_fcm_message(fcm_message):
|
|
"""Send HTTP request to FCM with given message.
|
|
Args:
|
|
fcm_message: JSON object that will make up the body of the request.
|
|
"""
|
|
# [START use_access_token]
|
|
headers = {
|
|
'Authorization': 'Bearer ' + _get_access_token(),
|
|
'Content-Type': 'application/json; UTF-8',
|
|
}
|
|
# [END use_access_token]
|
|
resp = requests.post(FCM_URL, data=json.dumps(fcm_message), headers=headers)
|
|
|
|
if resp.status_code == 200:
|
|
print('Message sent to Firebase for delivery, response:')
|
|
print(resp.text)
|
|
else:
|
|
print('Unable to send message to Firebase')
|
|
print(resp.text)
|
|
|
|
def _build_common_message():
|
|
"""Construct common notifiation message.
|
|
Construct a JSON object that will be used to define the
|
|
common parts of a notification message that will be sent
|
|
to any app instance subscribed to the news topic.
|
|
"""
|
|
return {
|
|
'message': {
|
|
'topic': 'news',
|
|
'notification': {
|
|
'title': 'FCM Notification',
|
|
'body': 'Notification from FCM'
|
|
}
|
|
}
|
|
}
|
|
|
|
def _build_override_message():
|
|
"""Construct common notification message with overrides.
|
|
Constructs a JSON object that will be used to customize
|
|
the messages that are sent to iOS and Android devices.
|
|
"""
|
|
fcm_message = _build_common_message()
|
|
|
|
apns_override = {
|
|
'payload': {
|
|
'aps': {
|
|
'badge': 1
|
|
}
|
|
},
|
|
'headers': {
|
|
'apns-priority': '10'
|
|
}
|
|
}
|
|
|
|
android_override = {
|
|
'notification': {
|
|
'click_action': 'android.intent.action.MAIN'
|
|
}
|
|
}
|
|
|
|
fcm_message['message']['android'] = android_override
|
|
fcm_message['message']['apns'] = apns_override
|
|
|
|
return fcm_message
|
|
|
|
def send_to_token():
|
|
# [START send_to_token]
|
|
# This registration token comes from the client FCM SDKs.
|
|
registration_token = 'fFjCZmrHREpRvxZMIKhNSI:APA91bH7cfctHFHbKxtQ5XGRlL26jgLLzo3a1x4hlPfZYi9WxrauMkdIBmqnIQnyD8Jc3xEs0gAsgNYNMLDEgdrHV3bbH4gvFHYUrYzOHZFr-2aVCsYF9otT8_fmAV380egGf5HiCIYd'
|
|
|
|
# See documentation on defining a message payload.
|
|
message = messaging.Message(
|
|
data={
|
|
'score': '850',
|
|
'time': '2:45',
|
|
},
|
|
token=registration_token,
|
|
)
|
|
|
|
# Send a message to the device corresponding to the provided
|
|
# registration token.
|
|
response = messaging.send(message)
|
|
# Response is a message ID string.
|
|
print('Successfully sent message:', response)
|
|
# [END send_to_token]
|
|
|
|
def send_to_topic():
|
|
# [START send_to_topic]
|
|
# The topic name can be optionally prefixed with "/topics/".
|
|
topic = 'highScores'
|
|
|
|
# See documentation on defining a message payload.
|
|
message = messaging.Message(
|
|
data={
|
|
'score': '850',
|
|
'time': '2:45',
|
|
},
|
|
topic=topic,
|
|
)
|
|
|
|
# Send a message to the devices subscribed to the provided topic.
|
|
response = messaging.send(message)
|
|
# Response is a message ID string.
|
|
print('Successfully sent message:', response)
|
|
# [END send_to_topic]
|
|
|
|
|
|
def send_to_condition():
|
|
# [START send_to_condition]
|
|
# Define a condition which will send to devices which are subscribed
|
|
# to either the Google stock or the tech industry topics.
|
|
condition = "'stock-GOOG' in topics || 'industry-tech' in topics"
|
|
|
|
# See documentation on defining a message payload.
|
|
message = messaging.Message(
|
|
notification=messaging.Notification(
|
|
title='$GOOG up 1.43% on the day',
|
|
body='$GOOG gained 11.80 points to close at 835.67, up 1.43% on the day.',
|
|
),
|
|
condition=condition,
|
|
)
|
|
|
|
# Send a message to devices subscribed to the combination of topics
|
|
# specified by the provided condition.
|
|
response = messaging.send(message)
|
|
# Response is a message ID string.
|
|
print('Successfully sent message:', response)
|
|
# [END send_to_condition]
|
|
|
|
|
|
def send_dry_run():
|
|
message = messaging.Message(
|
|
data={
|
|
'score': '850',
|
|
'time': '2:45',
|
|
},
|
|
token='token',
|
|
)
|
|
|
|
# [START send_dry_run]
|
|
# Send a message in the dry run mode.
|
|
response = messaging.send(message, dry_run=True)
|
|
# Response is a message ID string.
|
|
print('Dry run successful:', response)
|
|
# [END send_dry_run]
|
|
|
|
|
|
def android_message():
|
|
# [START android_message]
|
|
message = messaging.Message(
|
|
android=messaging.AndroidConfig(
|
|
ttl=datetime.timedelta(seconds=3600),
|
|
priority='normal',
|
|
notification=messaging.AndroidNotification(
|
|
title='$GOOG up 1.43% on the day',
|
|
body='$GOOG gained 11.80 points to close at 835.67, up 1.43% on the day.',
|
|
icon='stock_ticker_update',
|
|
color='#f45342'
|
|
),
|
|
),
|
|
topic='industry-tech',
|
|
)
|
|
# [END android_message]
|
|
return message
|
|
|
|
|
|
def apns_message():
|
|
# [START apns_message]
|
|
message = messaging.Message(
|
|
apns=messaging.APNSConfig(
|
|
headers={'apns-priority': '10'},
|
|
payload=messaging.APNSPayload(
|
|
aps=messaging.Aps(
|
|
alert=messaging.ApsAlert(
|
|
title='$GOOG up 1.43% on the day',
|
|
body='$GOOG gained 11.80 points to close at 835.67, up 1.43% on the day.',
|
|
),
|
|
badge=42,
|
|
),
|
|
),
|
|
),
|
|
topic='industry-tech',
|
|
)
|
|
# [END apns_message]
|
|
return message
|
|
|
|
def main():
|
|
parser = argparse.ArgumentParser()
|
|
parser.add_argument('--message')
|
|
args = parser.parse_args()
|
|
if args.message and args.message == 'common-message':
|
|
common_message = _build_common_message()
|
|
print('FCM request body for message using common notification object:')
|
|
print(json.dumps(common_message, indent=2))
|
|
_send_fcm_message(common_message)
|
|
elif args.message and args.message == 'override-message':
|
|
override_message = _build_override_message()
|
|
print('FCM request body for override message:')
|
|
print(json.dumps(override_message, indent=2))
|
|
_send_fcm_message(override_message)
|
|
else:
|
|
print('''Invalid command. Please use one of the following commands:
|
|
python messaging.py --message=common-message
|
|
python messaging.py --message=override-message''')
|
|
|
|
if __name__ == '__main__':
|
|
main() |