クライアント API - Mobile Platform as a Service - Alibaba Cloud ドキュメントセンター

メッセージプッシュサービスには、次のクライアント API が含まれます。

呼び出し方法	API	説明
RPC 呼び出し	バインド	ユーザー ID とデバイス ID（Ad トークン）をバインドします。
	バインド解除	ユーザー ID とデバイス ID（Ad トークン）のバインドを解除します。
	サードパーティチャンネルデバイスをレポートする	サードパーティチャンネルのデバイス ID（Ad トークン）をバインドします。

mPaaS の中間レイヤーにある MPPush クラスは、ユーザーのバインド、バインド解除、およびサードパーティチャンネルデバイス情報のレポート用のインターフェイスを含む、MPS のすべての API をカプセル化します。 API 呼び出しは、モバイルゲートウェイ SDK を介して実装されます。

バインド

メソッド定義
このメソッドは、ユーザー ID とデバイス ID をバインドするために使用されます。バインドが完了すると、ユーザーディメンションでメッセージをプッシュできます。
説明
このインターフェイスは、子スレッドで呼び出す必要があります。
```
    public static ResultPbPB bind(Context ctx, String userId, String token)
```
このメソッドは、ユーザー ID とデバイス ID をバインドするために使用されます。ユーザー ID とデバイス ID がバインドされると、MPS はユーザーディメンションからメッセージをプッシュします。

リクエストパラメータ

パラメータ	タイプ	説明
ctx	Context	空ではない Context である必要があります。
userId	String	ユーザーの一意の識別子。ユーザー ID は、必ずしも業務システムの実際の識別子であるとは限りませんが、ユーザー ID とユーザーの間には 1 対 1 のマッピングが必要です。
token	String	プッシュゲートウェイによって配布されるデバイストークン。

レスポンスパラメータ

パラメータ	説明
success	インターフェイス呼び出しが成功したかどうか。 true: 成功 false: 失敗
code	操作結果コード。一般的な操作コードと対応する説明については、次の結果コード表を参照してください。
name	結果コードの名前
message	結果コードに対応する説明

結果コード

コード	名前	メッセージ	説明
3012	NEED_USERID	need userid	クライアントがインターフェイスを呼び出すときに、パラメータ `userId` が空です。
3001	NEED_DELIVERYTOKEN	need token	クライアントがインターフェイスを呼び出すときに、パラメータ `token` が空です。

コードサンプル

  private void doSimpleBind() {
      final ResultPbPB resultPbPB = MPPush.bind(getApplicationContext(), mUserId, PushMsgService.mAdToken);
      handlePbPBResult("Bind users", resultPbPB);
  }

バインド解除

メソッド定義
このメソッドは、ユーザー ID とデバイス ID のバインドを解除するために使用されます。
説明
このインターフェイスは、子スレッドで呼び出す必要があります。
```
  public static ResultPbPB unbind(Context ctx, String userId, String token)
```

リクエストパラメータ

パラメータ	タイプ	説明
ctx	Context	空ではない Context である必要があります。
userId	String	ユーザーの一意の識別子。ユーザー ID は、必ずしも業務システムの実際の識別子であるとは限りませんが、ユーザー ID とユーザーの間には 1 対 1 のマッピングが必要です。
token	String	プッシュゲートウェイによって配布されるデバイストークン。

レスポンスパラメータ
バインド API のレスポンスパラメータを参照してください。

コードサンプル

    private void doSimpleUnBind() {
        final ResultPbPB resultPbPB = MPPush.unbind(getApplicationContext()
                , mUserId, PushMsgService.mAdToken);
        handlePbPBResult("Unbind users", resultPbPB);
    }

サードパーティチャンネルデバイスをレポートする

メソッド定義
このメソッドは、サードパーティチャンネルのデバイス ID と Ad トークンをバインドするために使用されます。つまり、サードパーティチャンネルのデバイス識別子と mPaaS デバイス識別子（MPS ゲートウェイによって発行された Ad トークン）がモバイルプッシュコアにレポートされ、モバイルプッシュコアはこれら 2 つの識別子をバインドします。このプロセスが完了すると、サードパーティチャンネルを使用してメッセージをプッシュできます。
説明
このメソッドは、フレームワークによって 1 回呼び出されます。SDK の呼び出し失敗を回避するために、手動で再度呼び出すことをお勧めします。
```
public static ResultPbPB report(Context context, String deliveryToken, int thirdChannel, String thirdChannelDeviceToken)
```

リクエストパラメータ

パラメータ	タイプ	説明
ctx	Context	空ではない Context である必要があります。
deliveryToken	String	MPS ゲートウェイによって発行されたデバイス ID（Ad トークン）。
thirdChannel	int	サードパーティチャンネル。有効な値は次のとおりです。 2: Apple 4: Xiaomi 5: Huawei 6: FCM 7: OPPO 8: vivo
thirdChannelDeviceToken	String	サードパーティチャンネルに接続されているデバイスの ID。

レスポンスパラメータ
バインド API のレスポンスパラメータを参照してください。

コードサンプル

    private void doSimpleUploadToken() {
        final ResultPbPB resultPbPB = MPPush.report(getApplicationContext(), PushMsgService.mAdToken
                , PushOsType.HUAWEI.value(), PushMsgService.mThirdToken);
        handlePbPBResult("report 3rd-party device ID", resultPbPB);

トラブルシューティング

リソースの RPC リクエストを開始するプロセスで例外が発生した場合は、セキュリティガードの結果コードを参照してください。