コンテンツにスキップ

新しいユーザーエイリアスを作成する

post

/users/alias/new

このエンドポイントを使用して、既存の識別済みユーザーに新しいユーザーエイリアスを追加するか、新しい未識別ユーザーを作成します。

1回のリクエストで最大50個のユーザーエイリアスを指定できます。

既存のユーザーにユーザーエイリアスを追加するには、新しいユーザーエイリアスオブジェクトにexternal_idを含める必要があります。オブジェクトにexternal_idが含まれていても、そのexternal_idを持つユーザーが存在しない場合、エイリアスはどのユーザーにも追加されません。external_idが含まれていない場合でもユーザーは作成されますが、後で識別する必要があります。識別は「Identifying Users」とusers/identifyエンドポイントを使用して行えます。

エイリアスのみの新規ユーザーを作成するには、新しいユーザーエイリアスオブジェクトからexternal_idを省略する必要があります。ユーザーが作成されたら、/users/trackエンドポイントを使用してエイリアスのみのユーザーに属性、イベント、購入を関連付け、/users/identifyエンドポイントを使用してexternal_idでユーザーを識別します。

/campaigns/trigger/sendエンドポイントを使用すると、user_aliasを指定してAPIトリガーキャンペーンをユーザーに送信できます。

alias_labelとalias_nameが既に存在する場合

alias_labelとalias_nameの組み合わせは、ユーザー群全体で一意である必要があります。詳細については、ユーザーエイリアスを参照してください。

alias_labelとalias_nameのペアが既にいずれかのユーザー(リクエスト対象と同じユーザーか別のユーザーかを問わず)に存在する状態でリクエストを送信した場合でも、エンドポイントは成功レスポンスを返します(例:"aliases_processed": 1、"message": "success")。この場合、リクエスト内のユーザーに新しいエイリアスは追加されません。alias_labelとalias_nameのペアが既に使用されているため、リクエストによる変更は一切行われず、該当ユーザーにエイリアスが追加されなかったように見えることがあります。

Endpoint reference

This reference is generated from the OpenAPI specification for this endpoint. To run the endpoint, copy the generated cURL example and send it from your terminal or Postman. You can also download the raw OpenAPI spec for this page at /docs/ja/assets/api/openapi/users_alias_new.yaml. Use this spec to validate that your requests include the correct parameters, fields, and structure before you send them. To learn how, see Use OpenAPI schemas for request validation.

New Stuff!