Skip to content

カタログ・フィールドを作成する

post

/catalogs/{catalog_name}/fields

このエンドポイントを使用して、カタログに複数のフィールドを作成する。

前提条件

このエンドポイントを使用するには、catalogs.create_fields 権限を持つ API キーが必要です。

レート制限

This endpoint has a shared rate limit of 50 requests per minute between all asynchronous catalog fields and selections endpoints, as documented in API rate limits.

パスパラメーター

パラメーター required データ型 説明
catalog_name 必須 string カタログ名。

リクエストパラメーター

パラメーター required データ型 説明
fields required 配列 フィールドオブジェクトを含む配列。フィールドオブジェクトは、新しいフィールドの名前とタイプを含んでいなければなりません。

リクエスト例

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

curl --location --request POST 'https://rest.iad-03.braze.com/catalogs/restaurants/fields' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY' \
--data-raw '{
  "fields": [
    {
      "name": "Name",
      "type": "string"
    },
    {
      "name": "Ratings",
      "type": "number"
    },
    {
      "name": "Loyalty_Program",
      "type": "boolean"
    },
    {
      "name": "Created_At",
      "type": "time"
    }
  ]
}'

応答

このエンドポイントには、202、400、404 という3つのステータスコード応答があります。

成功応答の例

ステータスコード 202 は、次の応答本文を返す可能性があります。

1
2
3

{
  "message": "success"
}

エラー応答例

ステータスコード 400 は、次の応答本文を返す可能性があります。遭遇する可能性のあるエラーの詳細については、「トラブルシューティング」を参照のこと。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

{
  "errors": [
    {
      "id": "catalog-not-found",
      "message": "Could not find catalog",
      "parameters": [
        "catalog_name"
      ],
      "parameter_values": [
        "restaurants"
      ]
    }
  ],
  "message": "Invalid Request"
}

トラブルシューティング

以下の表は、返される可能性のあるエラーと、それに関連するトラブルシューティングの手順を示したものである。

エラー トラブルシューティング
arbitrary-error 任意のエラーが発生した。もう一度試すか、サポートに連絡する。
catalog-not-found カタログ名が有効であることを確認する。
company-size-limit-already-reached カタログのストレージサイズの上限に達しています。
request-includes-too-many-fields 各リクエストは最大50の新規フィールドをサポートできる。
catalog-exceeds-fields-limit カタログは500以上のフィールドを持つことはできない。
  GitHub でこのページを編集
「このページはどの程度役に立ちましたか?」
New Stuff!