モバイルアプリの連絡先情報管理API
プッシュ通知用デバイスの登録ID (pushRegistrationId) は、特定のエンドユーザーに連絡を取る方法の1つです。各ユーザーはそれぞれ、プッシュ通知を受け取るデバイスを1つ以上持つことができます。それに対し、プッシュ通知用デバイスは常に、1台につき、1人のユーザーに属します。各デバイスに付与されるpushRegistrationIDは、各ユーザーを識別可能にする一意の識別子です。
プッシュ通知用デバイスのデータは、主にAndroid (opens in a new tab)、iOS (opens in a new tab)、Cordova (opens in a new tab)、およびReact Native (opens in a new tab)のMobile SDKによって管理されます。一部のデバイスデータ (アプリケーションのバージョンやデバイスのモデルなど) は、SDKによって自動的に収集されます。このようなデータは、以下のモデルでは読み取り専用としてマークされています。
また、プライマリーフラグや追加データ属性など、SDKとHTTP APIの両方を通じて管理できる種類のデータもあります。
モバイルアプリの連絡先情報管理 APIを使用すると、次のことができます：
- プッシュ通知用デバイスの登録
- プッシュ通知用デバイスの登録情報の更新
- パーソナライズ化
- 非パーソナライズ化
APPLICATION CODEは、AppCodeヘッダーを介してHTTPリクエストごとに提供する必要があります。特定のアプリケーションコードを探したい時は、モバイルアプリケーションプロファイルの作成 セクションにご参照ください。
モデル
本文パラメーター
| Parameter name | Type | Description |
|---|---|---|
| registrationId | 文字列 (読み取り専用) | 特定のプッシュ通知用デバイスの登録情報を識別する登録IDです。 |
| applicationId | 文字列 (読み取り専用) | プッシュ通知のアプリケーション構成の内部識別子です。 |
| isPrimary | ブール値 | ユーザーが複数のデバイスの中でこのデバイスをプライマリーデバイスとして使用する場合、 trueに設定します。 |
| systemData | システムデータのことです。 | プッシュ通知固有の属性については、[System data (システムデータ)]のセクションをご参照ください。 |
| additionalData | カスタム属性の一覧です。 | デバイスに設定可能なカスタム属性については、[Additional data (追加データ)]のセクションをご参照ください。 |
システムデータ
| Parameter name | Type | Description |
|---|---|---|
| registrationEnabled | ブール値 | デバイスの登録が有効であることを示します。 |
| notificationsEnabled | ブール値 (読み取り専用) | デバイスで通知を有効にする場合、 trueに設定します。 |
| sdkVersion | 文字列 (読み取り専用) | デバイスに実装されているSDKのバージョンです。 |
| appVersion | 文字列 (読み取り専用) | SDKが埋め込まれているアプリケーションのバージョンです。 |
| os | 文字列 (読み取り専用) | オペレーティングシステムは、 Androidまたは iOSに対応しています。 |
| osVersion | 文字列 (読み取り専用) | オペレーティングシステムのバージョンです。 |
| deviceManufacturer | 文字列 (読み取り専用) | SDKによって検出されたデバイスのメーカー (製造元) です。 |
| deviceModel | 文字列 (読み取り専用) | デバイスのモデル (型式) です。 |
| deviceSecure | ブール値 (読み取り専用) | デバイスに何らかのセキュリティ用画面ロックが設定されている場合は、 trueに設定します。 |
| osLanguage | 文字列 (読み取り専用) | デバイスで使用する言語を識別します。 |
| deviceTimezoneOffset | 文字列 (読み取り専用) | デバイスの現在のタイムゾーンを協定世界時 (UTC) との差 (オフセット) で識別します。 |
| deviceName | 文字列 (読み取り専用) | ユーザーによって構成されたデバイスの名前です。 |
追加データ
追加データは、デバイスに割り当てられた一連のカスタム値を指定します。
属性フィールド | Type | 説明 | 制限 |
|---|---|---|---|
| 名前 | 文字列 | 属性の名前 | 最大256文字 |
| 値 | 文字列、数値、ブール値、日付 | 属性の値 | 数値の最大値は 9223372036854775807 です。文字列の最大値は 4096 文字です。日付は YYYY-MM-DD です。 |
プッシュ通知用デバイスの登録
プラットフォームからデバイスデータを取得するには、 プッシュ通知デバイスの登録 (opens in a new tab)方法について記述しているセクションをご参照ください。
プッシュ通知用デバイスの登録情報の更新
プラットフォーム上のデバイスデータを更新するには、プッシュ通知デバイスの登録情報の更新 (opens in a new tab)方法について記述しているセクションをご参照ください。
パーソナライズ化
各ユーザーは、電話番号、メールアドレス または外部ID を持つことができます。これらのフィールドは、NTT CPaaSのプラットフォームでは各ユーザーを識別する一意のIDとして使われ、パーソンプロファイルにに基づいて、プッシュ通知用デバイスの登録情報 をパーソナライズ (opens in a new tab)できるようにします。NTT CPaaSのプラットフォームには、こうしたパラメーターに基づいてデータをグループ化する機能があります。この機能により、同じ電話番号および／またはメールアドレスでパーソナライズされたデバイスはすべて、その電話番号および／またはメールアドレスを持つ1人のユーザーに紐づけられます。
以下のクエリパラメーターがサポートされています：
クエリパラメーター
| Query parameter | Type | Description |
|---|---|---|
| forceDepersonalize | ブール値 | 以前にパーソナライズ化した登録情報を常時リセットしたい場合は、このパラメーターをtrue に設定します。なお、既にパーソナライズしている登録情報に対するパーソナライズ化の試みがいつあったかを知りたい場合は、このパラメーターを使用しないでください。 |
本文パラメーター
| Body parameter | Type | Description |
|---|---|---|
| identity | externalId (外部ID)、phoneNumber (電話番号)および／またはemail (メールアドレス)を含むオブジェクトのことです。 | このオブジェクトの一意の識別子は、プッシュ通知登録をパーソナライズ化する際に使用されます。重要：null、NullまたはNULLは、 externalIdの文字列値としてサポートされておらず、JSON null と見なされます。 |
| attributes | firstName (ファーストネーム)、 gender (性別)、 customAttributes (カスタム属性)、 tags (タグ) といったパーソン関連のフィールドを0個以上含むオブジェクトのことです。 | このオブジェクトで指定されたデータは、パーソナライズ化属性の追加対象パーソンに適用されます。 |
非パーソナライズ化
デバイスを非パーソナライズ化 (opens in a new tab)して現在のパーソンプロファイルから切り離すようにすると、それ以降、いずれかのパーソン属性のターゲットにされても、送信したメッセージがそのデバイスに届かないようにすることができます。