登録者情報更新 API

概要

登録ユーザーの情報を更新します。

URL

https://${hostname}/mapi/3.1/user/${device_type}/update/

URLパラメータ

キー名 必須 タイプ 説明
device_type o 文字列 以下のいずれかを指定
android, iphone

メソッド

POST

結果タイプ

単数を返却する

リクエストパラメータ

キー名 必須 タイプ 説明
target_id o 配列 更新対象ユーザーの絞り込み
do o 配列 更新操作オブジェクトの配列

更新操作オブジェクト

更新操作は、1つのキーを持つオブジェクトの配列として表します。 更新操作名ごとに更新操作内容のフォーマットは規定されます。

doの中に記載された更新操作オブジェクトは、指定された順に実行されます。 全ての操作が成功するか、もしくは、失敗します。

{"更新操作名": "更新操作内容"}

利用可能な更新操作名

名前 説明
segment.clear 属性値を削除します。
segment.set 単一選択属性の属性値をセットします。
segment.add 複数選択属性の属性値を追加します。
segment.remove 複数選択属性の属性値を削除します。

更新操作内容のフォーマット (segment.clear)

1つの属性キーIDを、数値で指定します。

以下の例では、属性キーID 100 の設定が解除されます。

{"do": [{"segment.clear": 100}]}

更新操作内容のフォーマット (segment.set)

1つの属性キーIDと、属性値IDを指定します。 この操作を複数選択属性に対して行うとエラーとなります。

以下の例では、属性キーID 100 の設定が、101 に変更されます。

{"do": [{"segment.set": {"100": 101}}]}

更新操作内容のフォーマット (segment.add)

1つの属性キーIDと、属性値IDを指定します。 この操作を単数選択属性に対して行うとエラーとなります。

以下の例では、属性キーID 300 の設定に、301 が追加されます。 既に301が追加されているユーザーには、何も起こりません。

{"do": [{"segment.add": {"300": 301}}]}

更新操作内容のフォーマット (segment.remove)

1つの属性キーIDと、属性値IDを指定します。 この操作を単数選択属性に対して行うとエラーとなります。

以下の例では、属性キーID 300 の設定から、301 が削除されます。 もともと301が追加されていないユーザーには、何も起こりません。

{"do": [{"segment.remove": {"300": 301}}]}

target_id による絞り込み

操作対象のユーザーをpopinfo_idの配列として指定します。

上限は、100件です。

popinfo_idを取得するために、事前に「登録者情報一覧取得 API」をご利用 ください。

レスポンスパラメータ

キー名 タイプ 説明
target_id 配列 操作対象となったユーザーのpopinfo_id を配列で返却します。
(例えば無効なpopinfo_idが指定された 場合、そのpopinfo_idは含まれません)
実際に変化が起きたユーザーではありません。
(男性 → 男性 など変化が無い ユーザーも含まれます)

リクエストのサンプル

次の例では、popinfo_idが、AAAA, BBBB のユーザーに対して 複数選択の属性キー 100 に属する、性値ID 123を削除し、 124と125を追加します。

{
  "do": [
    {
      "segment.remove": {
        "100": 123
      }
    }, 
    {
      "segment.add": {
        "100": 124
      }
    }, 
    {
      "segment.add": {
        "100": 125
      }
    }
  ], 
  "target_id": [
    "AAAA", 
    "BBBB"
  ]
}
レスポンスのサンプル
{
  "status": "OK", 
  "result": {
    "target_id": [
      "AAAA", 
      "BBBB"
    ]
  }
}