Skip to content

カタログフィールドの作成

post

/catalogs/{catalog_name}/fields

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

前提条件

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

レート制限

このエンドポイントには、APIレート制限に記載されているように、すべての非同期カタログフィールドおよびセレクションエンドポイント間で1分あたり50リクエストの共有レート制限があります。

パスパラメーター

パラメーター 必須 データタイプ 説明
catalog_name 必須 文字列 カタログ名。

リクエストパラメーター

パラメーター 必須 データタイプ 説明
fields 必須 配列 フィールドオブジェクトを含む配列。フィールドオブジェクトには、新しいフィールドの名前とタイプが含まれている必要があります。

リクエスト例

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

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"
    },
    {
      "name": "Location",
      "type": "geo"
    }
  ]
}'

応答

このエンドポイントには、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を超えるフィールドを持つことはできません。
New Stuff!