テイラードオーディエンスユーザー（廃止）

注: このページのエンドポイントは廃止されています。v8では引き続き利用できますが、v9では利用できません。

POST accounts/:account_id/tailored_audiences/:tailored_audience_id/users¶

このエンドポイントを使用すると、パートナーは特定のtailored_audience_idのユーザーを追加、更新、削除できます。このエンドポイントは、ユーザーごとに複数のユーザーIDタイプも受け入れます。

partner_user_idを除く、リクエストのusersフィールドで提供されるすべてのデータは、SHA256を使用してハッシュ化し、正規化する必要があります。

バッチリクエスト

• このエンドポイントの現在の最大バッチサイズは、2500です。バッチサイズは、リクエストあたりの操作数（Update/Delete）によって決まります。たとえば、1つの配列に2,500を超える操作オブジェクト（{"operation_type": "Update/Delete", [..] }）があると、エラーになります。
• このエンドポイントが受け入れることができるリクエストPOSTボディの最大サイズは5,000,000バイトです。
• このエンドポイントのレート制限は、1分あたり1,500です
• すべてのパラメーターはリクエストボディで送信され、application/jsonのContent-Typeが必須です。
• バッチリクエストはグループ単位で失敗または成功となります。エラーの場合も、成功の場合も、API応答には、最初のリクエストの項目の順序が保持されます。

バッチ応答

広告APIから返される応答には、success_countとtotal_countの2つのフィールドがあります。これらの値は常に等しくなる必要があります。これらは、バックエンドで処理されたリクエスト内のレコード数のカウントです。リクエストボディで送信されたレコード数がsuccess_countとtotal_countに等しくない場合は、エラー状態として処理し、再試行が必要になります。

バッチエラー

• リクエストレベルのエラー（最大バッチサイズの超過など）は、errorsオブジェクトの応答に表示されます。
• 項目レベルのエラー（必須パラメーターの不足など）は、operation_errorsオブジェクトの応答に表示されます。
• operation_errorsのエラーのインデックスは、入力項目のインデックスと、それに対応するエラーメッセージを示します

リソースURL¶

https://ads-api.x.com/8/accounts/:account_id/tailored_audiences/:tailored_audience_id/users

パラメーター¶

usersオブジェクトにマルチキーのアプローチを使用する場合の、このオブジェクトの各要素は以下のとおりです。

リクエストの例¶

POST https://ads-api.x.com/8/accounts/18ce54d4x5t/tailored_audiences/1nmth/users

[
  {
    "operation_type": "Update",
    "params": {
      "effective_at": "2018-05-15T00:00:00Z",
      "expires_at": "2019-01-01T07:00:00Z",
      "users": [
        {
          "email": [
            "4798b8bbdcf6f2a52e527f46a3d7a7c9aefb541afda03af79c74809ecc6376f3"
          ],
          "handle": [
            "7352f353c460e74c7ae226952d04f8aa307b12329c5512ec8cb6f1a0f8f9b2cb",
            "49e0be2aeccfb51a8dee4c945c8a70a9ac500cf6f5cb08112575f74db9b1470d"
          ]
        },
        {
          "email": [
            "5bf13d5ad4200407c5bc8b9bb578e425d05ef936fd488e3799a9d0806669223c"
          ],
          "twitter_id": [
            "34d56c7159a7eea941f359653029410f813f65a1d2d13ecc5ccbdd5a8cb755cf",
            "00e7b76c9739dec57f4c4a20ec021a20ffcf26bd00f519b17ea00f0ed6048f85"
          ]
        }
      ]
    }
  },
  {
    "operation_type": "Delete",
    "params": {
      "effective_at": "2018-05-15T00:00:00Z",
      "expires_at": "2019-01-01T07:00:00Z",
      "users": [
        {
          "device_id": [
            "8d969eef6ecad3c29a3a629280e686cf0c3f5d5a86aff3ca12020c923adc6c92"
          ],
          "email": [
            "4798b8bbdcf6f2a52e527f46a3d7a7c9aefb541afda03af79c74809ecc6376f3"
          ],
          "handle": [
            "461222f5dd690a20651c3d19848015cb0369db3f8e937571ffb775de70750847"
          ],
          "twitter_id": [
            "c623c7e163984493b46c547088542e95d0aaa529bc52bbecce3ff91eb6b7843b"
          ]
        },
        {
          "email": [
            "5bf13d5ad4200407c5bc8b9bb578e425d05ef936fd488e3799a9d0806669223c"
          ],
          "twitter_id": [
            "858cdc7f313f84a3f3c48e9a6323307c1ef1bb7439b8e3623e140454b0fd8fa5",
            "bb074e154657b91d99bd1bb3757409149670e8ae7a0fe9136fae29a26a7881c8"
          ]
        }
      ]
    }
  }
]

応答の例¶

{
  "request": {
    "params": {
      "account_id": "18ce54d4x5t",
      "tailored_audience_id": "1nmth"
    }
  },
  "data": {
    "success_count": 4,
    "total_count": 4
  }
}