开发者控制台

A3L Messaging示例应用

A3L Messaging示例应用

本页向您介绍使用A3L Messaging SDK构建的示例应用。该应用用于演示如何集成A3L Messaging。无需编写任何代码即可运行此应用,但必须提供相应的配置。可以在启用Google Play的设备和Fire OS设备上安装该应用。可以从该应用向安装了应用的设备发送推送通知。要发送推送通知,应用需要服务器端凭证。

下载示例应用项目

下载示例A3L Messaging应用以开始。该文件包含一个Android项目,可用于配置和构建示例应用。

构建项目时,如果遇到“SDK location not found”(未找到SDK位置)错误,请在项目根目录下的local.properties文件中添加一行,以包含您的Android SDK位置。

例如:

  • 在Windows上,添加以下行:sdk.dir=C:\\Users\\<username>\\AppData\\Local\\Android\\sdk
  • 在Mac上,添加以下行:sdk.dir=/Users/<username>/Library/Android/sdk

<username>替换为您的用户名。

示例应用集成

示例应用既需要设备端凭证,又需要服务器端凭证。设备端凭证存在于应用中,并且是云消息传递正常工作所必需的。通常,应在安全的服务器环境中使用服务器端凭证。但出于演示目的,此应用在应用本身中使用服务器端凭证。在实际项目中,不要在应用中使用服务器端凭证,因为这样会不安全。

必须填充四个配置文件,才能运行示例应用。

文件名称 位置 配置类型 消息传递类型
api_key.txt
要获取此项,请参阅设备端配置中的步骤1。
app/src/main/assets/ 设备端 ADM
adm_server_configuration.json
要获取此项,请参阅服务器端配置中的步骤1。
app/src/main/assets/ 服务器端 ADM
google-services.json
要获取此项,请参阅设备端配置中的步骤2。
app/ 设备端 FCM
fcm_server_configuration.json
要获取此项,请参阅服务器端配置中的步骤2。
app/src/main/assets/ 服务器端 FCM

示例应用的集成指南分为两部分:设备端配置和服务器端配置。

设备端配置

首先,获取Amazon Device Messaging (ADM)和Firebase Cloud Messaging (FCM)二者的设备端配置。

生成凭证时,可能需要提供应用的程序包名称。示例应用的程序包名称为com.example.SampleA3LMessagingApp

  1. 对于ADM,请转到开发者控制台获取您的凭证。然后在项目中添加API密钥。请务必在开发者控制台中您应用的应用服务部分下附加安全配置文件,从而为应用启用设备消息传递。

  2. 对于FCM,创建Firebase项目,然后在Firebase中注册您的应用。获得google-services.json配置文件,并在项目中添加该文件

服务器端配置

接下来,获取ADM和FCM的服务器端配置。

  1. 对于ADM,在位于assets文件夹下的adm_server_configuration.json中,添加客户端ID和客户端密钥。下面是ADM服务器配置JSON的示例。

     {
         "client_id": "客户端ID",
         "client_secret": "客户端密钥"
     }
    
  2. 对于FCM,创建Google服务账户密钥,并按照说明以JSON文件形式下载密钥。还可以使用现有的服务账户密钥。复制下载的JSON的内容并将其粘贴到fcm_server_configuration.json(位于assets文件夹下)。下面是FCM服务器配置JSON的示例。

     {
         "type": "服务账户",
         "project_id": "项目ID",
         "private_key_id": "密钥ID",
         "private_key": "-----开始私钥-----\n私钥\n-----结束私钥-----\n",
         "client_email": "服务账户电子邮件",
         "client_id": “客户端ID",
         "auth_uri": "https://accounts.google.com/o/oauth2/auth",
         "token_uri": "https://accounts.google.com/o/oauth2/token",
         "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
         "client_x509_cert_url": "https://www.googleapis.com/robot/v1/metadata/x509/服务账户电子邮件"
     }
    

示例应用测试

  1. 配置完所有四个配置文件后,构建应用。
  2. 在启用Google Play服务的Android设备或Fire OS设备上安装该应用。
  3. 打开应用。应该会看到一个带有调试占位符文本和SEND PUSH NOTIFICATION(发送推送通知)按钮的欢迎页面。
  4. 单击SEND PUSH NOTIFICATION。应该会出现一条toast消息,指示您检查通知托盘。应该还会看到一条调试语句,其中包含在占位符文本之前所在位置的设备ID。
  5. 检查设备的通知托盘,确保消息成功递送。
    来自示例应用的推送通知消息
    一条成功递送的通知