カスタム属性をエクスポートする
get
/custom_attributes
アプリに記録されたカスタム属性のリストをエクスポートするには、このエンドポイントを使用する。属性は50のグループに分けられ、アルファベット順にソートされて返される。
前提条件
このエンドポイントを使用するには、API キーとcustom_attributes.getの権限が必要です。
レート制限
2021年9月16日以降に Braze にオンボーディングした顧客の場合、このエンドポイントには、1時間あたり1,000リクエストの共有レート制限が適用されます。このレート制限は、API レート制限に記載されているように、/events、/events/list、および /purchases/product_list エンドポイントと共有されます。
クエリーパラメーター
このエンドポイントへの各コールにより、50の属性が返されます。50を超える属性については、次のレスポンス例に示すように、Link ヘッダーを使用して次のページのデータを取得します。
| パラメータ | required | データ型 | 説明 |
|---|---|---|---|
cursor |
オプション | 文字列 | カスタム属性のページネーションを決定する。 |
例のリクエスト
カーソルなし
1
2
3
curl --location --request GET 'https://rest.iad-01.braze.com/custom_attributes' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'
カーソル付き
1
2
3
curl --location --request GET 'https://rest.iad-03.braze.com/custom_attributes?cursor=c2tpcDow' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'
応答
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY
{
"message": (required, string) the status of the export, returns 'success' when completed without errors,
"attributes" : [
{
"array_length": 100, (number) the maximum array length, or null if not applicable,
"data_type": "Number", (string) the data type,
"description": "The attribute description", (string) the attribute description,
"name": "The attribute name", (string) the attribute name,
"status": "Active", (string) the attribute status,
"tag_names": ["Tag One", "Tag Two"] (array) the tag names associated with the attribute formatted as strings,
},
...
]
}
致命的なエラーの応答コード
リクエストが致命的なエラーに遭遇した場合に返されるステータスコードと関連するエラーメッセージについては、致命的なエラーを参照してください。
tip:
CSV および API のエクスポートに関するヘルプについては、「エクスポートのトラブルシューティング」を参照してください。
GitHub でこのページを編集
「このページはどの程度役に立ちましたか?」
New Stuff!