2013年10月14日月曜日

Using Amazon SNS Mobile Push APIs 日本語訳

日本語訳したドキュメント


Amazon Simple Notification Service
Developer Guide (API Version 2010-03-31)

http://docs.aws.amazon.com/sns/latest/dg/mobile-push-api.html

Using Amazon SNS Mobile Push APIs

Amazon SNS モバイルPush APIを使うためには、APNsやGCMなどのPush通知サービスの事前準備を行っておく必要があります。詳細情報についてはPrerequisitesのページを参照。
Amazon SNSのAPIを使ってモバイル機器へとPush通知を送るためには、最初にCreatePlatformApplicationアクションを実行しておく必要があります。CreatePlatoformApplictionアクションはPlatformApplitionArmを返すので、これを使ってCreatePlatformEndpointアクションを実行し、最終的に通知実行に必要なEndpointArnを取得できます。

EndpointArnの用途は

  • PublishアクションにEndpointArnを指定して通知メッセージを送信する
  • SubscribeアクションにEndpointArnを指定してトピックにEndpointを紐付ける

以下はAmazon SNSのモバイルPush APIについてのAPI一覧とその解説です。
APIDescription
CreatePlatformApplicationAPNsやGCMのようなPush通知サービスをサポートするplatform applicationオブジェクトを作成し、モバイル機器を登録できるようにします。
APIの戻り値としてはPlatformApplicationArnがあり、これはCreatePlatformEndpointアクションで利用されます。 詳細はAmazon SNS  APIリファレンスの、CreatePlotformApplicationの項目を参照。
SetPlatformApplicationAttributesplatform applicationオブジェクトに各属性値をセットします。
詳細はAmazon SNS APIリファレンスのSetPlatformApplicationAttributesの項目を参照。
GetPlatformApplicationAttributesplatform applicationオブジェクトの属性値を取得します。詳細はAmazon SNS APIリファレンスのGetPlatformApplicationAttributesの項目を参照。
ListPlatformApplicationsAmazonSNSがサポートしているPush通知サービスに関して、AWSアカウントで作成済みのplatform applicationオブジェクトの一覧を取得します。詳細はAmazon SNS APIリファレンスのListPlatformApplicationsの項目を参照。
DeletePlatformApplicationplatform applicationオブジェクトを削除します。 詳細はAmazon SNS APIリファレンスのDeletePlatformApplicationの項目を参照。
CreatePlatformEndpointAmazonSNSがサポートしているPush通知サービスに関して、モバイル機器用のエンドポイントを作成します。CreatePlatformEndpointアクションには、CreatePlatformApplicationアクションが返すPlatformApplicationArnを入力します。このアクションが返すEndpointArnは、Publishアクションで通知メッセージをモバイル機器へ送信する際に使われます。詳細はAmazon SNS APIリファレンスのCreatePlatformEndpointの項目を参照。

SetEndpointAttributesエンドポイントへモバイル機器やアプリに関する属性をセットします。詳細はAmazon SNS APIリファレンスのSetEndpointAttributesの項目を参照。
GetEndpointAttributesエンドポイントに紐づく情報を取得します。詳細はAmazon SNS APIリファレンスのGetEndpointAttributesの項目を参照。
ListEndpointsByPlatformApplicationAmazonSNSがサポートしているPush通知サービスに関して、エンドポイントをリストとして取得します。詳細はAmazon SNS APIリファレンスのListEndointsByPlatformApplicationの項目を参照。
DeleteEndpointAmazonSNSがサポートしているPush通知サービスに関して、エンドポイントを削除します。詳細はAmazon SNS APIリファレンスのDeleteEndpointの項目を参照。

まとめ

  • 通知を送るにはEndpointArnを指定する
    • もしくはエンドポイントとトピックを紐付けておく
  • EndpointArnを作成するには事前にPlatformApplicationArnを作っておく
    • PlatformAPplicationArnは各通知サービスごとに作成する
      • ADM、APNs本番、APNs砂場、GCM
  • 作成したエンドポイントには端末やアプリの情報を紐付けておくことができる
  • エンドポイントは削除できる(ただし、EndpointArnの指定が必要)
  • platform applicationを削除した際に、紐づくエンドポイントも連動して削除されるかは不明

0 件のコメント:

コメントを投稿