IM-Notice Mobile設定¶
概要¶
モバイル通知機能に関する設定です。
モジュール モバイル通知機能 フォーマットファイル(xsd) WEB-INF/schema/im-notice-mobile-config.xsd 設定場所 WEB-INF/conf/im-notice-mobile-config.xml <?xml version="1.0" encoding="UTF-8"?> <im-notice-mobile-config xmlns="http://www.intra-mart.jp/notice/mobile/config/im-notice-mobile-config" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.intra-mart.jp/notice/mobile/config/im-notice-mobile-config ../schema/im-notice-mobile-config.xsd"> <proxy enable="false"> <host></host> <port xsi:nil="true"></port> <username></username> <password></password> <workstation></workstation> <domain></domain> </proxy> <asns name="asns-apns"> <endpoint>sns.ap-northeast-1.amazonaws.com</endpoint> <platform-application-arn></platform-application-arn> <access-key></access-key> <secret-key></secret-key> </asns> <asns name="asns-gcm"> <endpoint>sns.ap-northeast-1.amazonaws.com</endpoint> <platform-application-arn></platform-application-arn> <access-key></access-key> <secret-key></secret-key> <gcma-project-number></gcma-project-number> </asns> <asns name="asns-baidu"> <endpoint>sns.ap-northeast-1.amazonaws.com</endpoint> <platform-application-arn></platform-application-arn> <access-key></access-key> <secret-key></secret-key> <baidu-api-key></baidu-api-key> </asns> <gcma name="gcma"> <url>https://android.googleapis.com/gcm/send</url> <api-key></api-key> <project-number></project-number> </gcma> <push type="android" engine="gcma" /> <push type="ios" engine="asns-apns" /> <max-push-subject-length>30</max-push-subject-length> <max-push-body-length>70</max-push-body-length> </im-notice-mobile-config>
リファレンス¶
プロキシの設定¶
タグ名 proxy Amazon SNSやGoogle Cloud Messaging for Androidへ接続するためのプロキシを設定します。【設定項目】
<im-notice-mobile-config> <proxy enable="false"> ・・・・・ </proxy> </im-notice-mobile-config>
必須項目 ○ 複数設定 × 設定値・設定する内容 プロキシを使用する際に必要な設定をしてください。 単位・型 なし 省略時のデフォルト値 なし 親タグ im-notice-mobile-config 【属性】
属性名 説明 必須 デフォルト値 enable プロキシを使用する場合、trueを設定してください。プロキシを使用しない場合、falseを設定してください。○ false
ホストの設定¶
タグ名 host プロキシサーバのIPアドレスを設定します。【設定項目】
<proxy enable="true"> <host>XXX.XXX.XXX.XXX</host> </proxy>
必須項目 × 複数設定 × 設定値・設定する内容 なし 単位・型 文字列 省略時のデフォルト値 なし 親タグ proxy
ポート番号の設定¶
タグ名 port プロキシサーバのポート番号を設定します。【設定項目】
<proxy enable="true"> <port>XXXX</port> </proxy>
必須項目 × 複数設定 × 設定値・設定する内容 なし 単位・型 数値(0-) 省略時のデフォルト値 なし 親タグ proxy 【属性】
属性名 説明 必須 デフォルト値 xsi:nil ポート番号を指定する場合、この属性を削除してください。ポート番号を指定しない場合、trueを設定してください。× true
ユーザ名の設定¶
タグ名 username プロキシ使用時にユーザ認証が必要な場合、ユーザ名を設定します。【設定項目】
<proxy enable="true"> <username>XXXXXXXX</username> </proxy>
必須項目 × 複数設定 × 設定値・設定する内容 なし 単位・型 文字列 省略時のデフォルト値 なし 親タグ proxy
パスワードの設定¶
タグ名 password プロキシ使用時にユーザ認証が必要な場合、パスワードを設定します。【設定項目】
<proxy enable="true"> <password>XXXXXXXX</password> </proxy>
必須項目 × 複数設定 × 設定値・設定する内容 なし 単位・型 文字列 省略時のデフォルト値 なし 親タグ proxy
ワークステーションの設定¶
タグ名 workstation NTLM認証を行っている場合、ワークステーションを設定します。【設定項目】
<proxy enable="true"> <workstation>XXXXXXXX</workstation> </proxy>
必須項目 × 複数設定 × 設定値・設定する内容 なし 単位・型 文字列 省略時のデフォルト値 なし 親タグ proxy
ドメインの設定¶
タグ名 domain NTLM認証を行っている場合、ドメインを設定します。【設定項目】
<proxy enable="true"> <domain>XXXXXXXX</domain> </proxy>
必須項目 × 複数設定 × 設定値・設定する内容 なし 単位・型 文字列 省略時のデフォルト値 なし 親タグ proxy
Amazon SNSの設定¶
タグ名 asns Amazon SNSを使用するための項目値を設定します。【設定項目】
<im-notice-mobile-config> <asns name="asns-apns"> ・・・・・ </asns> </im-notice-mobile-config>
必須項目 ○ 複数設定 ○ 設定値・設定する内容 Amazon SNSを使用するために必要な設定をしてください。 単位・型 なし 省略時のデフォルト値 なし 親タグ im-notice-mobile-config 【属性】
属性名 説明 必須 デフォルト値 name 任意の名前を設定してください。pushタグのengine要素で通知方法を設定する際に使用します。○ asns-apns,asns-gcm
エンドポイントの設定¶
タグ名 endpoint エンドポイントを設定します。【設定項目】
<im-notice-mobile-config> <asns name="asns-apns"> <endpoint>sns.ap-northeast-1.amazonaws.com</endpoint> </asns> </im-notice-mobile-config>
必須項目 × 複数設定 × 設定値・設定する内容 使用するリージョンに対応するAmazon SNSサービスアクセスポイントを設定してください。各リージョンのエンドポイントは AWS documentation - Regions and Endpoints で確認できます。単位・型 文字列 省略時のデフォルト値 空文字 親タグ asns
Amazon リソースネームの設定¶
タグ名 platform-application-arn Amazonリソースネームを設定します。【設定項目】
<im-notice-mobile-config> <asns name="asns-apns"> <platform-application-arn>arn:aws:sns:ap-northeast-1:XXXXXXXXXXXX:app/APNS/IM-Notice_APNS</platform-application-arn> </asns> </im-notice-mobile-config>
必須項目 × 複数設定 × 設定値・設定する内容 Amazon SNSで作成したアプリケーションのApplication ARNを設定してください。 単位・型 文字列 省略時のデフォルト値 空文字 親タグ asns
アクセスキーの設定¶
タグ名 access-key アクセスキーを設定します。【設定項目】
<im-notice-mobile-config> <asns name="asns-apns"> <access-key>XXXXXXXXXXXXXXXXXXXX</access-key> </asns> </im-notice-mobile-config>
必須項目 × 複数設定 × 設定値・設定する内容 AWSで作成したアクセスキーを設定してください。 単位・型 文字列 省略時のデフォルト値 空文字 親タグ asns
シークレットキーの設定¶
タグ名 secret-key シークレットキーを設定します。【設定項目】
<im-notice-mobile-config> <asns name="asns-apns"> <secret-key>XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX</secret-key> </asns> </im-notice-mobile-config>
必須項目 × 複数設定 × 設定値・設定する内容 AWSで作成したシークレットキーを設定してください。 単位・型 文字列 省略時のデフォルト値 空文字 親タグ asns
Google Cloud Messaging for Androidのプロジェクト番号の設定¶
タグ名 gcma-project-number Google Cloud Messaging for Androidのプロジェクト番号を設定します。【設定項目】
<im-notice-mobile-config> <asns name="asns-gcm"> <gcma-project-number>XXXXXXXXXXXX</gcma-project-number> </asns> </im-notice-mobile-config>
必須項目 通知手段にAmazon SNS+Google Cloud Messaging for Androidを利用する場合に必須 複数設定 × 設定値・設定する内容 Google Cloud Messaging for Androidで作成したプロジェクトのプロジェクト番号を設定してください。 単位・型 文字列 省略時のデフォルト値 なし 親タグ asns
Baidu APIキーの設定¶
タグ名 baidu-api-key Baidu APIキーを設定します。【設定項目】
<im-notice-mobile-config> <asns name="asns-baidu"> <baidu-api-key>XXXXXXXXXXXX</baidu-api-key> </asns> </im-notice-mobile-config>
必須項目 通知手段にAmazon SNS+Baiduを利用する場合に必須 複数設定 × 設定値・設定する内容 BaiduクラウドプロジェクトのAPIキーを設定してください。 単位・型 文字列 省略時のデフォルト値 なし 親タグ asns
Google Cloud Messaging for Androidの設定¶
タグ名 gcma Google Cloud Messaging for Androidを使用するための設定をします。【設定項目】
<im-notice-mobile-config> <gcma name="gcma"> ・・・・・ </gcma> </im-notice-mobile-config>
必須項目 ○ 複数設定 ○ 設定値・設定する内容 Google Cloud Messaging for Androidを使用するために必要な設定をしてください。 単位・型 なし 省略時のデフォルト値 なし 親タグ im-notice-mobile-config 【属性】
属性名 説明 必須 デフォルト値 name 任意の名前を設定してください。pushタグのengine要素で通知方法を設定する際に使用します。○ gcma
URLの設定¶
タグ名 url Google Cloud Messaging for AndroidのURLを設定します。【設定項目】
<im-notice-mobile-config> <gcma name="gcma"> <url>https://android.googleapis.com/gcm/send</url> </gcma> </im-notice-mobile-config>
必須項目 × 複数設定 × 設定値・設定する内容 「https://developers.google.com/cloud-messaging/http-server-ref」を設定してください。 単位・型 文字列 省略時のデフォルト値 空文字 親タグ gcma
APIキーの設定¶
タグ名 api-key APIキーを設定します。【設定項目】
<im-notice-mobile-config> <gcma name="gcma"> <api-key>XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX</api-key> </gcma> </im-notice-mobile-config>
必須項目 × 複数設定 × 設定値・設定する内容 Google Cloud Messaging for Androidで作成したアプリケーションのAPIキーを設定してください。 単位・型 文字列 省略時のデフォルト値 空文字 親タグ gcma
プロジェクト番号の設定¶
タグ名 project-number プロジェクト番号を設定します。【設定項目】
<im-notice-mobile-config> <gcma name="gcma"> <project-number>XXXXXXXXXXXX</project-number> </gcma> </im-notice-mobile-config>
必須項目 × 複数設定 × 設定値・設定する内容 GCMAで作成したプロジェクトのプロジェクト番号を設定してください。 単位・型 文字列 省略時のデフォルト値 空文字 親タグ gcma
通知方法の設定¶
タグ名 push 各通知先へ通知を行う際に使用するサービスを設定します。【設定項目】
<im-notice-mobile-config> <push type="android" engine="gcma" /> <push type="ios" engine="asns-apns" /> </im-notice-mobile-config>
必須項目 ○ 複数設定 ○ 設定値・設定する内容 なし 単位・型 識別子 省略時のデフォルト値 なし 親タグ im-notice-mobile-config 【属性】
属性名 説明 必須 デフォルト値 type 通知先(android/ios)を設定してください。 × android,ios engine 各通知先への通知方法(asnsタグまたはgcmaタグのname属性に設定した名前)を設定してください。 ○ gcma,asns-apns
通知タイトルの最長文字数の設定¶
タグ名 max-push-subject-length Push通知受信時に表示するタイトルの最大文字数を設定します。【設定項目】
<im-notice-mobile-config> <max-push-subject-length>30</max-push-subject-length> </im-notice-mobile-config>
必須項目 × 複数設定 × 設定値・設定する内容 Push通知受信時に表示するタイトルの最大文字数を設定してください。 単位・型 数値(0-) 省略時のデフォルト値 空文字 親タグ im-notice-mobile-config
通知内容の最長文字数の設定¶
タグ名 max-push-body-length Push通知受信時に表示する本文の最長文字数を設定します。【設定項目】
<im-notice-mobile-config> <max-push-body-length>70</max-push-body-length> </im-notice-mobile-config>
必須項目 × 複数設定 × 設定値・設定する内容 Push通知受信時に表示する本文の最長文字数を設定してください。 単位・型 数値(0-) 省略時のデフォルト値 空文字 親タグ im-notice-mobile-config