ユーザー属性の照会

開発者が指定したユーザーIDまたは匿名ユーザーIDのユーザー属性値を一括照会することができます。1回の照会で最大100個のユーザーIDまたは匿名ユーザーIDをサポートします。

リクエストメソッド

GET

エンドポイント

https://api-${endpoint}.gptbots.ai/v2/user-property/query

認証

認証方法の説明についてはAPI Overviewをご参照ください。

リクエスト

リクエスト例

curl -X GET 'https://api-${endpoint}.gptbots.ai/v2/user-property/query' \ -H 'Authorization: Bearer ${token}' \ -d '{ "user_ids": [ "example_user_id_1", "example_user_id_2" ], "anonymous_ids": [ "example_anonymous_id_1", "example_anonymous_id_2" ] }'

                      
                      curl -X GET 'https://api-${endpoint}.gptbots.ai/v2/user-property/query'  \
-H 'Authorization: Bearer ${token}' \
-d '{
      "user_ids": [
        "example_user_id_1",
        "example_user_id_2"
      ],
      "anonymous_ids": [
        "example_anonymous_id_1",
        "example_anonymous_id_2"
      ]
}'

このコードブロックをポップアップで表示

リクエストヘッダー

フィールド	型	説明
Authorization	Bearer ${token}	Authorization: Bearer ${token}による呼び出し認証を使用します。APIキーページでトークンとして使用するキーを取得してください。

リクエストボディ

パラメータ	型	説明	必須
user_ids	string	属性を照会するユーザーID	必須、anonymous_idsとどちらか一方
anonymouse_ids	string	属性を照会する匿名ユーザーID	必須、user_idsとどちらか一方

user_idとanonymouse_idはどちらか一方を指定する必要があります。両方指定された場合は、user_idが優先されます。

レスポンス

レスポンス例

{ { "user_id": "example_user_id_1", "property_values": [ { "property_name": "example_property_name", "value": "example_value" }, { "property_name": "example_property_name", "value": "example_value" } ] }, { "anonymous_id": "example_anonymous_id_2", "property_values": [ { "property_name": "example_property_name", "value": "example_value" }, { "property_name": "example_property_name", "value": "example_value" } ] } }

                      
                      {
  {
    "user_id": "example_user_id_1",
    "property_values": [
      {
        "property_name": "example_property_name",
        "value": "example_value"
      },
      {
        "property_name": "example_property_name",
        "value": "example_value"
      }
    ]
  },
  {
    "anonymous_id": "example_anonymous_id_2",
    "property_values": [
      {
        "property_name": "example_property_name",
        "value": "example_value"
      },
      {
        "property_name": "example_property_name",
        "value": "example_value"
      }
    ]
  }
}

このコードブロックをポップアップで表示

成功レスポンス

パラメータ	型	説明
user_id	string	照会対象のユーザーID
anonymous_id	string	照会対象の匿名ユーザーID
property_values	list	ユーザー属性と属性値のリスト
property_name	string	ユーザー属性名
value	object	ユーザー属性値

エラーレスポンス

パラメータ	型	説明
code	int	エラーコード
message	string	エラーメッセージ

ステータスコード

コード	説明
200	成功
400	パラメータエラー
401	認証エラー
403	権限エラー
500	サーバーエラー
503	ユーザーIDが存在しません
504	匿名ユーザーIDが存在しません