Mobile Platform as a Service:サーバー API

メーカーチャネルの特別なパラメーター制限は次のとおりです。

MPS は以下のサーバーサイド API を提供します。これらについては、以下の表で説明します。

SDK の準備

MPS は、Java、Python、Node.js、PHP の 4 つのプログラミング言語をサポートしています。上記の API をメッセージプッシュのために呼び出す前に、プログラミング言語ごとに異なる準備をする必要があります。

次の例では、さまざまなプログラミング言語の SDK を実装する前に必要な準備について説明します。

Java

上記の 4 つの API をメッセージプッシュのために呼び出す前に、Maven 構成を導入します。次の依存関係をメインの pom ファイルにインポートします。

<dependency>
  <groupId>com.aliyun</groupId>
  <artifactId>aliyun-java-sdk-mpaas</artifactId>
  <version>3.0.10</version>
</dependency>

<dependency>
<groupId>com.aliyun</groupId>
  <artifactId>aliyun-java-sdk-core</artifactId>
  <optional>true</optional>
  <version>[4.3.2,5.0.0)</version>
</dependency>

Python

次のコマンドを実行して、関連する依存関係を追加します。

## Aliyun SDK
pip install aliyun-python-sdk-core
## mPaaSs SDK 
pip install aliyun-python-sdk-mpaas

Node.js

次のコマンドを実行して、関連する依存関係を追加します。

npm i @alicloud/mpaas20190821

PHP

次のコマンドを実行して、関連する依存関係を追加します。

composer require alibabacloud/sdk

メッセージプッシュ - シンプルプッシュ

1 つのターゲット ID に 1 つのメッセージをプッシュします。この API を呼び出す前に、必要な依存関係を導入する必要があります。詳細については、「SDK の準備」をご参照ください。

リクエストパラメーター

StrategyContent フィールド

JSON 値は String に変換されて渡されます。

レスポンスパラメーター

コード例

AccessKey に AliyunMPAASFullAccess 権限があることを確認してください。詳細については、「RAM ユーザーのアプリケーションレベルアクセス制御」をご参照ください。

Java サンプルコード

次のサンプルコードの AccessKey ID と AccessKey シークレットの取得方法については、こちらをクリックしてください。

 DefaultProfile.addEndpoint("cn-hongkong", "mpaas", "mpaas.cn-hongkong.aliyuncs.com");
        // DefaultAcsClient インスタンスを作成し、初期化します
        DefaultProfile profile = DefaultProfile.getProfile(
            "cn-hangzhou",          // リージョン ID
            "******",      // RAM アカウントの AccessKey ID
            "*****"); // RAM アカウントの AccessKey シークレット

        IAcsClient client = new DefaultAcsClient(profile);
        // API リクエストを作成し、パラメーターを設定します
        PushSimpleRequest request = new PushSimpleRequest();
        request.setAppId("ONEX570DA89211721");
        request.setWorkspaceId("test");
        request.setTaskName("テストタスク");
        request.setTitle("テスト");
        request.setContent("テスト");
        request.setDeliveryType(3L);
        Map<String,String> extendedParam = new HashMap<String, String>();
        extendedParam.put("key1","value1");
        request.setExtendedParams(JSON.toJSONString(extendedParam));
        request.setExpiredSeconds(300L);

        request.setPushStyle(2);
        String imageUrls = "{\"defaultUrl\":\"https://pre-mpaas.oss-cn-hangzhou.aliyuncs.com/tmp/test.png\",\"oppoUrl\":\"https://pre-mpaas.oss-cn-hangzhou.aliyuncs.com/tmp/test.png\",\"miuiUrl\":\"https://pre-mpaas.oss-cn-hangzhou.aliyuncs.com/tmp/test.png\",\"fcmUrl\":\"https://pre-mpaas.oss-cn-hangzhou.aliyuncs.com/tmp/test.png\",\"iosUrl\":\"https://pre-mpaas.oss-cn-hangzhou.aliyuncs.com/tmp/test.png\"}";
        String iconUrls = "{\"defaultUrl\":\"https://pre-mpaas.oss-cn-hangzhou.aliyuncs.com/tmp/test.png\",\"hmsUrl\":\"https://pre-mpaas.oss-cn-hangzhou.aliyuncs.com/tmp/test.png\",\"oppoUrl\":\"https://pre-mpaas.oss-cn-hangzhou.aliyuncs.com/tmp/test.png\",\"miuiUrl\":\"https://pre-mpaas.oss-cn-hangzhou.aliyuncs.com/tmp/test.png\"}";
        request.setImageUrls(imageUrls);
        request.setIconUrls(iconUrls);

        request.setStrategyType(2);
        request.setStrategyContent("{\"fixedTime\":1630303126000,\"startTime\":1625673600000,\"endTime\":1630303126000,\"circleType\":1,\"circleValue\":[1, 7],\"time\":\"13:45:11\"}");

        Map<String,String> target = new HashMap<String, String>();
        String msgKey = String.valueOf(System.currentTimeMillis());
        target.put("user1024",msgKey);
        request.setTargetMsgkey(JSON.toJSONString(target));
        // リクエストを開始し、レスポンスまたは例外を処理します
        PushSimpleResponse response;
        try {
            response = client.getAcsResponse(request);
            System.out.println(response.getResultCode());
            System.out.println(response.getResultMessage());
        } catch (ClientException e) {
            e.printStackTrace();
        }

Python サンプルコード

from aliyunsdkcore.client import AcsClient
from aliyunsdkmpaas.request.v20190821 import PushSimpleRequest
import json

# AcsClient インスタンスを初期化します
client = AcsClient(
  "***",
  "***",
  "cn-hongkong"
);

# リクエストを初期化し、パラメーターを設定します
request = PushSimpleRequest.PushSimpleRequest()
request.set_endpoint("mpaas.cn-hongkong.aliyuncs.com")
request.set_AppId("ONEX570DA89211721")
request.set_WorkspaceId("test")
request.set_Title( "Python テスト")
request.set_Content( "テスト 2")
request.set_DeliveryType(3)
request.set_TaskName("Python テンプレートプッシュのテストタスク")
request.set_ExpiredSeconds(600)
target = {"user1024":str(time.time())}
request.set_TargetMsgkey(json.dumps(target))

# レスポンスを出力します
response = client.do_action_with_exception(request)
print response

Node.js サンプルコード

const sdk = require('@alicloud/mpaas20190821');

const { default: Client, PushSimpleRequest } = sdk;
// クライアントを作成します
const client = new Client({
  accessKeyId: '****',
  accessKeySecret: '*****',
  endpoint: 'mpaas.cn-hongkong.aliyuncs.com',
  apiVersion: '2019-08-21'
});
// リクエストを初期化します。
  const request = new PushSimpleRequest();
  request.appId = "ONEX570DA89211721";
  request.workspaceId = "test";
  request.title = "Node テスト";
  request.content = "テスト";
  request.deliveryType = 3;
  request.taskName = "Node テストタスク";
  request.expiredSeconds=600;
  const extendedParam = {
    test: 'カスタム拡張パラメーター'
  };
  request.extendedParams = JSON.stringify(extendedParam);
// 値はビジネスメッセージの ID です。ID が一意であることを確認してください。
  const target = {
    "userid1024": String(new Date().valueOf())
  };
  request.targetMsgkey = JSON.stringify(target);

// API 操作を呼び出します。
try {
  client.pushSimple(request).then(res => {
    console.log('SUCCESS', res);
  }).catch(e => {
    console.log('FAIL', e);
  });
} catch(e) {
  console.log('ERROR', e);
}

PHP サンプルコード

<?php

use AlibabaCloud\Client\AlibabaCloud;
use AlibabaCloud\MPaaS\MPaaS;
AlibabaCloud::accessKeyClient('accessKeyId', 'accessKeySecret')
    ->regionId('cn-hongkong')
    ->asDefaultClient();

class Demo {
    public function run() {
        try {
               $this->simplePush();
        } catch (\Exception $e) {
        }
    }


    public function simplePush() {
        $request = MPaaS::v20190821()->pushSimple();
        $result = $request->withAppId("ONEX570DA89211721")
            ->withWorkspaceId("test")
            ->withTitle("PHP テスト")
            ->withContent("テスト 3")
            ->withDeliveryType(3)
            ->withTaskName("PHP テストタスク")
            ->withExpiredSeconds(600)
            ->withTargetMsgkey(
                json_encode(["userid1024" => "".time() ]
            ))
            // エンドポイント
            ->host("mpaas.cn-hongkong.aliyuncs.com")
            // デバッグモードを有効にするかどうかを指定します
            ->debug(true)
            ->request();
    }
}

メッセージプッシュ - テンプレートプッシュ

テンプレートプッシュとは、1 つのメッセージを 1 つのターゲット ID にプッシュすることです。メッセージはテンプレートに基づいて作成されます。複数の ID が同じテンプレートを共有できます。

インターフェースを呼び出す前に、次の操作を完了していることを確認してください。

• MPS コンソールでテンプレートを作成していること。詳細については、「テンプレートの作成」をご参照ください。

• 必要な依存関係を導入していること。詳細については、「SDK の準備」をご参照ください。

リクエストパラメーター

StrategyContent フィールド

JSON 値は String に変換されて渡されます。

レスポンスパラメーター

コード例

AccessKey に AliyunMPAASFullAccess 権限があることを確認してください。詳細については、「RAM ユーザーのアプリケーションレベルアクセス制御」をご参照ください。

Java サンプルコード

次のサンプルコードの AccessKey ID と AccessKey シークレットの取得方法については、こちらをクリックしてください。

 DefaultProfile.addEndpoint("cn-hongkong", "mpaas", "mpaas.cn-hongkong.aliyuncs.com");
        // DefaultAcsClient インスタンスを作成し、初期化します。
        DefaultProfile profile = DefaultProfile.getProfile(
            "cn-hangzhou",          // リージョン ID
            "******",      // RAM アカウントの AccessKey ID
            "******"); // RAM アカウントの AccessKey シークレット

        IAcsClient client = new DefaultAcsClient(profile);
        // API リクエストを作成し、パラメーターを設定します
        PushTemplateRequest request = new PushTemplateRequest();
        request.setAppId("ONEX570DA89211721");
        request.setWorkspaceId("test");
        request.setTemplateName("testTemplate");
        // #name# さん、#money# 円獲得おめでとうございます。
        Map<String,String> templatekv = new HashMap<String, String>();
        templatekv.put("name"," Bob");
        templatekv.put("money","200");
        request.setTemplateKeyValue(JSON.toJSONString(templatekv));
        request.setExpiredSeconds(600L);
        request.setTaskName("templateTest");
        request.setDeliveryType(3L);
        Map<String,String> target = new HashMap<String, String>();
        String msgKey = String.valueOf(System.currentTimeMillis());
        target.put("userid1024",msgKey);
        request.setTargetMsgkey(JSON.toJSONString(target));

        request.setStrategyType(2);
        request.setStrategyContent("{\"fixedTime\":1630303126000,\"startTime\":1625673600000,\"endTime\":1630303126000,\"circleType\":1,\"circleValue\":[1, 7],\"time\":\"13:45:11\"}");

        PushTemplateResponse response;
        try {
            response = client.getAcsResponse(request);

            System.out.println(response.getResultCode());
            System.out.println(response.getResultMessage());
        } catch (ClientException e) {
            e.printStackTrace();
        }

Python サンプルコード

from aliyunsdkcore.client import AcsClient
from aliyunsdkmpaas.request.v20190821 import PushTemplateRequest
import json
import time

# AcsClient インスタンスを初期化します
client = AcsClient(
  "AccessKey ID",
  "AccessKey Secret",
  "cn-hongkong"
);

# リクエストを初期化し、パラメーターを設定します
request = PushTemplateRequest.PushTemplateRequest()
request.set_endpoint("mpaas.cn-hongkong.aliyuncs.com")
request.set_AppId("ONEX570DA89211721")
request.set_WorkspaceId("test")
request.set_TemplateName("template1024")
templatekv = {"name":"Bob","money":"200"}
request.set_TemplateKeyValue(json.dumps(templatekv))
request.set_DeliveryType(3)
request.set_TaskName("Python テンプレートプッシュのテストタスク")
request.set_ExpiredSeconds(600)
target = {"userid1024":str(time.time())}
request.set_TargetMsgkey(json.dumps(target))

# レスポンスを出力します
response = client.do_action_with_exception(request)
print response

Node.js サンプルコード

const sdk = require('@alicloud/mpaas20190821');

const { default: Client, PushTemplateRequest } = sdk;
// クライアントを作成します。
const client = new Client({
  accessKeyId: 'accessKeyId',
  accessKeySecret: 'accessKeySecret',
  endpoint: 'mpaas.cn-hongkong.aliyuncs.com',
  apiVersion: '2019-08-21'
});
// リクエストを初期化します。
  const request = new PushTemplateRequest();
  request.appId = "ONEX570DA89211721";
  request.workspaceId = "test";
  request.templateName= "template1024";
  const templatekv = {
    name: 'Bob',
    money:'300'
  };
  request.templateKeyValue = JSON.stringify(templatekv);
  request.deliveryType = 3;
  request.taskName = "Node テストタスク";
  request.expiredSeconds=600;
  const extendedParam = {
    test: 'カスタム拡張パラメーター'
  };
  request.extendedParams = JSON.stringify(extendedParam);
  const target = {
    "userid1024": String(new Date().valueOf())
  };
  request.targetMsgkey = JSON.stringify(target);

// API 操作を呼び出します。
try {
  client.pushTemplate(request).then(res => {
    console.log('SUCCESS', res);
  }).catch(e => {
    console.log('FAIL', e);
  });
} catch(e) {
  console.log('ERROR', e);
}

PHP サンプルコード

<?php

use AlibabaCloud\Client\AlibabaCloud;
use AlibabaCloud\MPaaS\MPaaS;
AlibabaCloud::accessKeyClient('accessKeyId', 'accessKeySecret')
    ->regionId('cn-hongkong')
    ->asDefaultClient();

class Demo {
    public function run() {
        try {
              $this->templatePush();
        } catch (\Exception $e) {
        }
    }

    public function templatePush() {
        $request = MPaaS::v20190821()->pushTemplate();
        $result = $request->host("mpaas.cn-hongkong.aliyuncs.com")
            // デバッグモードを有効にするかどうかを指定します。
            ->debug(true)
            ->withAppId("ONEX570DA89211721")
            ->withWorkspaceId("test")
            ->withTemplateName("template1024")
            ->withTemplateKeyValue(json_encode(["name" => "Bob", "money" => "200"]))
            ->withDeliveryType(3)
            ->withTaskName("PHP テストタスク")
            ->withExpiredSeconds(600)
            ->withTargetMsgkey(
                json_encode(["userid1024" => "".time() ])
            )
            ->request();
    }
}

メッセージプッシュ - マルチプッシュ

この API を呼び出すと、異なるターゲット ID に異なるメッセージをプッシュできます。この API を使用すると、テンプレートのプレースホルダーを置き換えることによって、ターゲット ID ごとにパーソナライズされたメッセージを作成できます。テンプレートプッシュとは異なり、マルチプッシュでは、異なるターゲット ID に異なるコンテンツのメッセージを送信できます。

インターフェースを呼び出す前に、次の操作を完了していることを確認してください。

• MPS コンソールでプレースホルダーを含むテンプレートを作成していること。そうでない場合、パーソナライズされたメッセージプッシュ、つまり異なるターゲット ID に異なるメッセージをプッシュすることはできません。詳細については、「テンプレートの作成」をご参照ください。

• 必要な依存関係を導入していること。詳細については、「SDK の準備」をご参照ください。

リクエストパラメーター

targetMsgs オブジェクト

StrategyContent フィールド

JSON 値は String に変換されて渡されます。

レスポンスパラメーター

コード例

AccessKey に AliyunMPAASFullAccess 権限があることを確認してください。詳細については、「RAM ユーザーのアプリケーションレベルアクセス制御」をご参照ください。

Java サンプルコード

次のサンプルコードの AccessKey ID と AccessKey シークレットの取得方法については、こちらをクリックしてください。

 DefaultProfile.addEndpoint("cn-hongkong", "mpaas", "mpaas.cn-hongkong.aliyuncs.com");
        // DefaultAcsClient インスタンスを作成し、初期化します
        DefaultProfile profile = DefaultProfile.getProfile(
            "cn-hangzhou",          // リージョン ID
            "******",      // RAM アカウントの AccessKey ID
            "******"); // RAM アカウントの AccessKey シークレット

        IAcsClient client = new DefaultAcsClient(profile);
        // API リクエストを作成し、パラメーターを設定します
        PushMultipleRequest request = new PushMultipleRequest();
        request.setAppId("ONEX570DA89211721");
        request.setWorkspaceId("test");
        request.setDeliveryType(3L);
        request.setTaskName("multipleTest");
        request.setTemplateName("testTemplate");
        // #name# さん、#money# 円獲得おめでとうございます。
        List<PushMultipleRequest.TargetMsg> targetMsgs = new ArrayList<PushMultipleRequest.TargetMsg>();
        PushMultipleRequest.TargetMsg targetMsg = new PushMultipleRequest.TargetMsg();
        targetMsg.setTarget("userid1024");
        targetMsg.setMsgKey(String.valueOf(System.currentTimeMillis()));
        Map<String, String> templatekv = new HashMap<String, String>();
        templatekv.put("name", "Bob");
        templatekv.put("money", "200");
        targetMsg.setTemplateKeyValue(JSON.toJSONString(templatekv));
        // TargetMsg オブジェクトの数は最大 100 にすることができます
        targetMsgs.add(targetMsg);
        request.setTargetMsgs(targetMsgs);
        request.setExpiredSeconds(600L);

        request.setStrategyType(2);
        request.setStrategyContent("{\"fixedTime\":1630303126000,\"startTime\":1625673600000,\"endTime\":1630303126000,\"circleType\":1,\"circleValue\":[1, 7],\"time\":\"13:45:11\"}");

        PushMultipleResponse response;
        try {
            response = client.getAcsResponse(request);
            System.out.println(response.getResultCode());
            System.out.println(response.getResultMessage());
            System.out.println(response.getPushResult().getData());  // プッシュタスク ID またはスケジュールされたプッシュタスク ID
        } catch (ClientException e) {
            e.printStackTrace();
        }

Python サンプルコード

# -*- coding: utf8 -*-
from aliyunsdkcore.client import AcsClient
from aliyunsdkmpaas.request.v20190821 import PushMultipleRequest
import json
import time

# AcsClient インスタンスを初期化します
client = AcsClient(
  "AccessKey ID",
  "AccessKey Secret",
  "cn-hongkong"
);

# リクエストを初期化し、パラメーターを設定します
request = PushMultipleRequest.PushMultipleRequest()
request.set_endpoint("mpaas.cn-hongkong.aliyuncs.com")
request.set_AppId("ONEX570DA89211721")
request.set_WorkspaceId("test")
request.set_TemplateName("template1024")
request.set_DeliveryType(3)
request.set_TaskName("Python テンプレートプッシュのテストタスク")
request.set_ExpiredSeconds(600)
msgkey = str(time.time())
targets = [
  {
    "Target": "user1024",
    "MsgKey": msgkey,
    "TemplateKeyValue": {
      "name": "Bob",
      "money": "200"
    }
  }
]
request.set_TargetMsgs(targets)
# レスポンスを出力します
response = client.do_action_with_exception(request)
print response

Node.js サンプルコード

const sdk = require('@alicloud/mpaas20190821');

const { default: Client, PushMultipleRequest,PushMultipleRequestTargetMsg } = sdk;
// クライアントを作成します
const client = new Client({
  accessKeyId: 'accessKeyId',
  accessKeySecret: 'AccessKey Secret',
  endpoint: 'mpaas.cn-hongkong.aliyuncs.com',
  apiVersion: '2019-08-21'
});
// リクエストを初期化します
  const request = new PushMultipleRequest();
  request.appId = "ONEX570DA89211721";
  request.workspaceId = "test";
  request.templateName= "template1024";
  const templatekv = {
    name: 'Bob',
    money:'300'
  };
  //request.templateKeyValue = JSON.stringify(templatekv);

  request.deliveryType = 3;
  request.taskName = "Node テストタスク";
  request.expiredSeconds=600;
  const extendedParam = {
    test: 'カスタム拡張パラメーター'
  };
  request.extendedParams = JSON.stringify(extendedParam);

  const targetMsgkey = new PushMultipleRequestTargetMsg();
  targetMsgkey.target = "userid1024";
  targetMsgkey.msgKey = String(new Date().valueOf());
  targetMsgkey.templateKeyValue = JSON.stringify(templatekv);;
  request.targetMsg = [targetMsgkey];

// API 操作を呼び出します。
try {
  client.pushMultiple(request).then(res => {
    console.log('SUCCESS', res);
  }).catch(e => {
    console.log('FAIL', e);
  });
} catch(e) {
  console.log('ERROR', e);
}

PHP サンプルコード

<?php

use AlibabaCloud\Client\AlibabaCloud;
use AlibabaCloud\MPaaS\MPaaS;
AlibabaCloud::accessKeyClient('accessKeyId', 'accessKeySecret')
    ->regionId('cn-hongkong')
    ->asDefaultClient();

class Demo {
    public function run() {
        try {
              $this->multiPush();
        } catch (\Exception $e) {
        }
    }


   public function multiPush() {
        $request = MPaaS::v20190821()->pushMultiple();
        $result = $request->host("mpaas.cn-hongkong.aliyuncs.com")
            // デバッグモードを有効にするかどうかを指定します
            ->debug(true)
            ->withAppId("ONEX570DA89211721")
            ->withWorkspaceId("test")
            ->withTemplateName("template1024")
            ->withDeliveryType(3)
            ->withTaskName("PHP マルチプッシュのテストタスク")
            ->withExpiredSeconds(600)
            ->withTargetMsg(
                [
                    [
                        "Target" => "userid1024",
                        "MsgKey" => "" . time(),
                        "TemplateKeyValue" => json_encode([
                            "name" => "Bob",
                            "money" => "200",
                        ])
                    ]
                ]
            )
            ->request();
    }
}

メッセージプッシュ - ブロードキャストプッシュ

このインターフェースを呼び出すと、すべてのデバイスに同じメッセージをプッシュできます。メッセージはテンプレートに基づいて作成されます。

インターフェースを呼び出す前に、次の操作を完了していることを確認してください。

• MPS コンソールでプレースホルダーを含むテンプレートを作成していること。そうでない場合、パーソナライズされたメッセージプッシュ、つまり異なるターゲット ID に異なるメッセージをプッシュすることはできません。詳細については、「テンプレートの作成」をご参照ください。

• 必要な依存関係を導入していること。詳細については、「SDK の準備」をご参照ください。

リクエストパラメーター

StrategyContent フィールド

JSON 値は String に変換されて渡されます。

レスポンスパラメーター

コード例

AccessKey に AliyunMPAASFullAccess 権限があることを確認してください。詳細については、「RAM ユーザーのアプリケーションレベルアクセス制御」をご参照ください。

Java サンプルコード

次のサンプルコードの AccessKey ID と AccessKey シークレットの取得方法については、こちらをクリックしてください。

DefaultProfile.addEndpoint("cn-hongkong", "mpaas", "mpaas.cn-hongkong.aliyuncs.com");
        // DefaultAcsClient インスタンスを作成し、初期化します
        DefaultProfile profile = DefaultProfile.getProfile(
            "cn-hangzhou",          // リージョン ID
            "******",      // RAM アカウントの AccessKey ID
            "******"); // RAM アカウントの AccessKey Secret

        IAcsClient client = new DefaultAcsClient(profile);

        PushBroadcastRequest request = new PushBroadcastRequest();
        request.setAppId("ONEX570DA89211720");
        request.setWorkspaceId("test");
        request.setDeliveryType(2L);
        request.setMsgkey(String.valueOf(System.currentTimeMillis()));
        request.setExpiredSeconds(600L);
        request.setTaskName("broadcastTest ");
        request.setTemplateName("broadcastTemplate ");
        // これはお知らせです：#content#。
        Map<String, String> templatekv = new HashMap<String, String>();
        templatekv.put("content", "お知らせの内容");
        request.setTemplateKeyValue(JSON.toJSONString(templatekv));

        request.setStrategyType(2);
        request.setStrategyContent("{\"fixedTime\":1630303126000,\"startTime\":1625673600000,\"endTime\":1630303126000,\"circleType\":1,\"circleValue\":[1, 7],\"time\":\"13:45:11\"}");    

        PushBroadcastResponse response;
        try {
            response = client.getAcsResponse(request);
            System.out.println(response.getResultCode());
            System.out.println(response.getResultMessage());
            System.out.println(response.getPushResult().getData());  // プッシュタスク ID またはスケジュールされたタスク ID
        } catch (ClientException e) {
            e.printStackTrace();
        }

Python サンプルコード

# -*- coding: utf8 -*-

from aliyunsdkcore.client import AcsClient
from aliyunsdkmpaas.request.v20190821 import PushBroadcastRequest
import json
import time

# AcsClient インスタンスを初期化します
client = AcsClient(
  "AccessKey ID",
  "AccessKey Secret",
  "cn-hongkong"
);

# リクエストを初期化し、パラメーターを設定します
request = PushBroadcastRequest.PushBroadcastRequest()
request.set_endpoint("mpaas.cn-hongkong.aliyuncs.com")
request.set_AppId("ONEX570DA89211720")
request.set_WorkspaceId("test")
request.set_TemplateName("broadcastTemplate")
templatekv = {"content":"これはお知らせです"}
request.set_TemplateKeyValue(json.dumps(templatekv))
request.set_DeliveryType(1)
request.set_TaskName("Python ブロードキャストプッシュのテストタスク")
request.set_ExpiredSeconds(600)
request.set_Msgkey(str(time.time()))

# レスポンスを出力します
response = client.do_action_with_exception(request)
print response

Node.js サンプルコード

const sdk = require('@alicloud/mpaas20190821');

const { default: Client, PushBroadcastRequest } = sdk;
// クライアントを作成します。
const client = new Client({
  accessKeyId: 'accessKeyId',
  accessKeySecret: 'AccessKey Secret',
  endpoint: 'mpaas.cn-hongkong.aliyuncs.com',
  apiVersion: '2019-08-21'
});
// リクエストを初期化します。

  const request = new PushBroadcastRequest();
  request.appId = "ONEX570DA89211720";
  request.workspaceId = "test";
  request.templateName= "broadcastTemplate";
  const templatekv = {
    content: 'これはお知らせです',
  };
  request.templateKeyValue = JSON.stringify(templatekv);
  request.deliveryType = 1;
  request.taskName = "Node テストタスク";
  request.expiredSeconds=600;
  const extendedParam = {
    test: 'カスタム拡張パラメーター'
  };
  request.extendedParams = JSON.stringify(extendedParam);

  request.msgkey = String(new Date().valueOf())

// API 操作を呼び出します。
try {
  client.pushBroadcast(request).then(res => {
    console.log('SUCCESS', res);
  }).catch(e => {
    console.log('FAIL', e);
  });
} catch(e) {
  console.log('ERROR', e);
}

PHP サンプルコード

<?php

use AlibabaCloud\Client\AlibabaCloud;
use AlibabaCloud\MPaaS\MPaaS;
AlibabaCloud::accessKeyClient('accessKeyId', 'accessKeySecret')
    ->regionId('cn-hongkong')
    ->asDefaultClient();

class Demo {
    public function run() {
        try {
               $this->broadcastPush();
        } catch (\Exception $e) {
        }
    }


   public function broadcastPush(){
        $request = MPaaS::v20190821()->pushBroadcast();
        $result = $request->host("mpaas.cn-hongkong.aliyuncs.com")
            // デバッグモードを有効にするかどうかを指定します。
            ->debug(true)
            ->withAppId("ONEX570DA89211720")
            ->withWorkspaceId("test")
            ->withTemplateName("broadcastTemplate")
            ->withTemplateKeyValue(
                json_encode(["content" => "これはお知らせです"])
            )
            ->withDeliveryType(1)
            ->withTaskName("PHP ブロードキャストプッシュのテストタスク")
            ->withExpiredSeconds(600)
            ->withMsgkey("". time())
            ->request();
    }
}

メッセージの取り消し

シンプルプッシュまたはテンプレートプッシュでプッシュされたメッセージは、メッセージ ID で取り消すことができます。マルチプッシュまたはブロードキャストプッシュでプッシュされたメッセージは、タスク ID で取り消すことができます。過去 7 日間にプッシュされたメッセージのみを取り消すことができます。

メッセージ ID による取り消し

シンプルプッシュモードまたはテンプレートプッシュモードでプッシュされたメッセージを取り消します。

リクエストパラメーター

レスポンスパラメーター

サンプルコード

DefaultProfile.addEndpoint("cn-hongkong", "mpaas", "mpaas.cn-hongkong.aliyuncs.com");
        // DefaultAcsClient インスタンスを作成し、初期化します
        DefaultProfile profile = DefaultProfile.getProfile(
            "cn-hangzhou",          // リージョン ID
            "******",      // RAM アカウントの AccessKey ID
            "******"); // RAM アカウントの AccessKey Secret

        IAcsClient client = new DefaultAcsClient(profile);        

        RevokePushMessageRequest request = new RevokePushMessageRequest();
        request.setAppId("ONEX570DA89211720");
        request.setWorkspaceId("test");
        request.setMessageId("console_1624516744112");  // 業務システム内のメッセージ ID
        request.setTargetId("mpaas_push_demo");         // ターゲット ID

        RevokePushMessageResponse response;
        try {
            response = client.getAcsResponse(request);
            System.out.println(response.getResultCode());
            System.out.println(response.getResultMessage());
        } catch (ClientException e) {
            e.printStackTrace();
        }

タスク ID による取り消し

マルチプッシュモードまたはブロードキャストプッシュモードでプッシュされたメッセージを取り消します。

リクエストパラメーター

レスポンスパラメーター

サンプルコード

DefaultProfile.addEndpoint("cn-hongkong", "mpaas", "mpaas.cn-hongkong.aliyuncs.com");
        // DefaultAcsClient インスタンスを作成し、初期化します
        DefaultProfile profile = DefaultProfile.getProfile(
            "cn-hangzhou",          // リージョン ID
            "******",      // RAM アカウントの AccessKey ID
            "******"); // RAM アカウントの AccessKey Secret

        IAcsClient client = new DefaultAcsClient(profile);

        RevokePushTaskRequest request = new RevokePushTaskRequest();
        request.setAppId("ONEX570DA89211720");
        request.setWorkspaceId("test");
        request.setTaskId("20842863");     // プッシュタスク ID

        RevokePushTaskResponse response;
        try {
            response = client.getAcsResponse(request);
            System.out.println(response.getResultCode());
            System.out.println(response.getResultMessage());
        } catch (ClientException e) {
            e.printStackTrace();
        }

メッセージプッシュの分析

統計データのクエリ

プッシュされたメッセージ、正常にプッシュされたメッセージ、メッセージの到着、開封されたメッセージ、無視されたメッセージなどのメッセージプッシュ統計データをクエリします。

リクエストパラメーター

レスポンスパラメーター

サンプルコード

DefaultProfile.addEndpoint("cn-hongkong", "mpaas", "mpaas.cn-hongkong.aliyuncs.com");
        // DefaultAcsClient インスタンスを作成し、初期化します
        DefaultProfile profile = DefaultProfile.getProfile(
            "cn-hangzhou",          // リージョン ID
            "******",      // RAM アカウントの AccessKey ID
            "******"); // RAM アカウントの AccessKey Secret
        IAcsClient client = new DefaultAcsClient(profile);
        QueryPushAnalysisCoreIndexRequest request = new QueryPushAnalysisCoreIndexRequest();
        request.setAppId("ONEX570DA89211720");
        request.setWorkspaceId("test");
        request.setStartTime(Long.valueOf("1617206400000"));
        request.setEndTime(Long.valueOf("1624982400000"));
        request.setPlatform("ANDROID");
        request.setChannel("ANDROID");
        request.setType("SIMPLE");
        request.setTaskId("20842863");

        QueryPushAnalysisCoreIndexResponse response;
        try {
            response = client.getAcsResponse(request);
            System.out.println(response.getResultCode());
            System.out.println(response.getResultMessage());
        } catch (ClientException e) {
            e.printStackTrace();
        }

プッシュタスクのクエリ

MPS コンソールで作成された、または API の呼び出しによってトリガーされたマルチ/ブロードキャストプッシュタスクをクエリします。

リクエストパラメーター

レスポンスパラメーター

サンプルコード

DefaultProfile.addEndpoint("cn-hongkong", "mpaas", "mpaas.cn-hongkong.aliyuncs.com");
        // DefaultAcsClient インスタンスを作成し、初期化します
        DefaultProfile profile = DefaultProfile.getProfile(
            "cn-hangzhou",          // リージョン ID
            "******",      // RAM アカウントの AccessKey ID
            "******"); // RAM アカウントの AccessKey Secret
        IAcsClient client = new DefaultAcsClient(profile);

        QueryPushAnalysisTaskListRequest request = new QueryPushAnalysisTaskListRequest();
        request.setAppId("ONEX570DA89211721");
        request.setWorkspaceId("default");
        request.setStartTime(Long.valueOf("1617206400000"));
        request.setTaskId("20845212");
        request.setTaskName("Tesk task");
        request.setPageNumber(1);
        request.setPageSize(10);

        QueryPushAnalysisTaskListResponse response;
        try {
            response = client.getAcsResponse(request);
            System.out.println(response.getResultCode());
            System.out.println(response.getResultMessage());
        } catch (ClientException e) {
            e.printStackTrace();
        }

プッシュタスク詳細のクエリ

MPS コンソールで作成された、または API の呼び出しによってトリガーされたマルチ/ブロードキャストプッシュタスクの詳細をクエリします。

リクエストパラメーター

レスポンスパラメーター

サンプルコード

DefaultProfile.addEndpoint("cn-hongkong", "mpaas", "mpaas.cn-hongkong.aliyuncs.com");
        // DefaultAcsClient インスタンスを作成し、初期化します
        DefaultProfile profile = DefaultProfile.getProfile(
            "cn-hangzhou",          // リージョン ID
            "******",      // RAM アカウントの AccessKey ID
            "******"); // RAM アカウントの AccessKey Secret
        IAcsClient client = new DefaultAcsClient(profile);

        QueryPushAnalysisTaskDetailRequest request = new QueryPushAnalysisTaskDetailRequest();
        request.setAppId("ONEXPREF4F5C52081557");
        request.setWorkspaceId("default");
        request.setTaskId("20845212");

        QueryPushAnalysisTaskDetailResponse response;
        try {
            response = client.getAcsResponse(request);
            System.out.println(response.getResultCode());
            System.out.println(response.getResultMessage());
        } catch (ClientException e) {
            e.printStackTrace();
        }

スケジュールされたプッシュタスクの管理

スケジュールされたプッシュタスクのクエリ

作成されたスケジュールされたプッシュタスク（タイミングプッシュタスクとサイクリックプッシュタスクを含む）をクエリします。

リクエストパラメーター

レスポンスパラメーター

サンプルコード

DefaultProfile.addEndpoint("cn-hongkong", "mpaas", "mpaas.cn-hongkong.aliyuncs.com");
        // DefaultAcsClient インスタンスを作成し、初期化します
        DefaultProfile profile = DefaultProfile.getProfile(
            "cn-hangzhou",          // リージョン ID
            "******",      // RAM アカウントの AccessKey ID
            "******"); // RAM アカウントの AccessKey Secret
        IAcsClient client = new DefaultAcsClient(profile);

        QueryPushSchedulerListRequest request = new QueryPushSchedulerListRequest();
        request.setAppId("ONEXPREF4F5C52081557");
        request.setWorkspaceId("default");
        request.setStartTime(Long.valueOf("1625068800000"));
        request.setEndTime(Long.valueOf("1630425600000"));
        request.setType(0);
        request.setUniqueId("49ec0ed5a2a642bcbe139a2d7a419d6d");
        request.setPageNumber(1);
        request.setPageSize(10);

        QueryPushSchedulerListResponse response;
        try {
            response = client.getAcsResponse(request);
            System.out.println(response.getResultCode());
            System.out.println(response.getResultMessage());
        } catch (ClientException e) {
            e.printStackTrace();
        }

スケジュールされたプッシュタスクのキャンセル

プッシュされていないスケジュールされたプッシュタスク（サイクリックプッシュタスクを含む）をキャンセルします。タスクを一括でキャンセルできます。

リクエストパラメーター

レスポンスパラメーター

サンプルコード

DefaultProfile.addEndpoint("cn-hongkong", "mpaas", "mpaas.cn-hongkong.aliyuncs.com");
        // DefaultAcsClient インスタンスを作成し、初期化します
        DefaultProfile profile = DefaultProfile.getProfile(
            "cn-hangzhou",          // リージョン ID
            "******",      // RAM アカウントの AccessKey ID
            "******"); // RAM アカウントの AccessKey Secret
        IAcsClient client = new DefaultAcsClient(profile);

CancelPushSchedulerRequest request = new CancelPushSchedulerRequest();
        request.setAppId("ONEXPREF4F5C52081557");
        request.setWorkspaceId("default");
        request.setUniqueIds("49ec0ed5a2a642bcbe139a2d7a419d6d, 49ec0ed5a2a642bcbe139a2d7a419d6c");

        CancelPushSchedulerResponse response;
        try {
            response = client.getAcsResponse(request);
            System.out.println(response.getResultCode());
            System.out.println(response.getResultMessage());
        } catch (ClientException e) {
            e.printStackTrace();
        }

拡張パラメーター

拡張パラメーターは、メッセージ本文とともにクライアントに渡されます。これらのパラメーターを定義または処理できます。

拡張パラメーターには、次の 3 つのタイプがあります。

• システム拡張パラメーター

  これらの拡張パラメーターはシステムによって使用されています。これらのパラメーターの値を変更しないでください。システム拡張パラメーターには、notifyType、action、silent、pushType、templateCode、channel、taskId が含まれます。

• 特定の意味を持つシステム拡張パラメーター

  このタイプの拡張パラメーターはシステムによって使用されています。各パラメーターには特定の意味があります。これらの拡張パラメーターの値を設定できます。次の表に、特定の意味を持つ拡張パラメーターを示します。

  キー	説明
  sound	メッセージのカスタム着信音。このパラメーターの値は着信音のパスです。このパラメーターは、Xiaomi スマートフォンと iPhone にのみ適用されます。
  badge	アプリアイコンのバッジ。その値は特定の数字です。この拡張パラメーターは、メッセージ本文とともにクライアントに渡されます。 Android デバイスの場合、バッジロジックを自分で実装する必要があります。 iOS デバイスの場合、システムは自動的にバッジロジックを実装します。メッセージがターゲットの携帯電話にプッシュされると、値で指定した番号がアプリアイコンのバッジに表示されます。
  mutable-content	Apple Push Notification service（APNs）のカスタムプッシュ ID。このパラメーターを含むプッシュ通知は、iOS 10 UNNotificationServiceExtension をサポートしていることを示します。このパラメーターを含まないプッシュ通知は、一般的なプッシュを示します。値を 1 に設定します。
  badge_add_num	Huawei プッシュチャネルに追加されたプッシュバッジの数。
  badge_class	Huawei プッシュチャネルのデスクトップアイコンに対応するアクティビティクラス
  big_text	大きなテキストスタイル。このパラメーターは固定値「1」です。その他の値は無効です。このパラメーターは、Xiaomi デバイスと Huawei デバイスにのみ有効です。

• ユーザー定義の拡張パラメーター

  上記のシステム拡張パラメーター以外のすべてのパラメーターは、ユーザー定義の拡張パラメーターです。ユーザー定義の拡張パラメーターは、メッセージ本文とともにクライアントに渡されます。これらのパラメーターを定義および処理できます。

結果コード