Skip to content

カタログセレクションを作成する

post

/catalogs/{catalog_name}/selections

このエンドポイントを使用して、カタログにセレクションを作成します。

前提条件

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

レート制限

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

パスパラメーター

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

リクエストパラメーター

パラメーター 必須 データタイプ 説明
selection 必須 オブジェクト セレクション条件を含むオブジェクト。オブジェクトとそのフィールドの詳細については、カタログセレクションオブジェクトを参照してください。

セレクションオブジェクトのパラメーター

パラメーター 必須 データタイプ 説明
name 必須 文字列 カタログセレクションの名前。
description オプション 文字列 カタログセレクションの説明。
external_id 必須 文字列 セレクションの一意の識別子。
source オプション 文字列 カタログデータのソース。Shopifyカタログの場合は "Shopify" を使用します。有効な値は "Shopify" と "Braze" です。
filters オプション 配列 カタログアイテムに適用するフィルターオブジェクトの配列。リクエストごとに最大4つのフィルターを指定できます。フィルターが指定されていない場合、カタログ内のすべてのアイテムが含まれます。
results_limit オプション 整数 返す結果の最大数。1から50までの数値を指定する必要があります。
sort_field オプション 文字列 結果をソートするフィールド。sort_orderと組み合わせて使用する必要があります。sort_fieldとsort_orderの両方が指定されていない場合、結果はランダムな順序で返されます。
sort_order オプション 文字列 結果のソート順。有効な値は "asc"（昇順）または "desc"（降順）です。sort_fieldと組み合わせて使用する必要があります。sort_fieldとsort_orderの両方が指定されていない場合、結果はランダムな順序で返されます。

リクエスト例

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

curl --location --request POST 'https://rest.iad-03.braze.com/catalogs/restaurants/selections' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY' \
--data-raw '{
  "selection": {
    "name": "favorite-restaurants",
    "description": "Favorite restaurants in NYC",
    "external_id": "favorite-nyc-restaurants",
    "filters": [
      {
        "field": "City",
        "operator": "equals",
        "value": "NYC"
      },
      {
        "field": "Rating",
        "operator": "greater than",
        "value": 7
      }
    ],
    "results_limit": 10,
    "sort_field": "Rating",
    "sort_order": "desc"
  }
}'

フィルター演算子

フィールドタイプ サポートされている演算子
string equals, does not equal
number equals, does not equal, greater than, less than
boolean is
time before, after
array includes value, does not include value

応答

このエンドポイントには、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"
}

トラブルシューティング

次のテーブルに、返される可能性のあるエラーと、関連するトラブルシューティングステップを示します。

エラー トラブルシューティング
catalog-not-found カタログ名が有効であることを確認してください。
company-size-limit-already-reached カタログのストレージサイズの上限に達しています。
selection-limit-reached カタログのセレクション数が上限に達しています。
invalid-selection セレクションが有効であることを確認してください。
too-many-filters セレクションのフィルター数が多すぎないか確認してください。
selection-name-already-exists セレクション名がカタログ内にすでに存在していないか確認してください。
selection-has-invalid-filter セレクションフィルターが有効かどうか確認してください。
selection-invalid-results-limit セレクションの結果制限が有効かどうか確認してください。
invalid-sorting セレクションのソートが有効かどうか確認してください。
invalid-sort-field セレクションのソートフィールドが有効かどうか確認してください。
invalid-sort-order セレクションのソート順が有効かどうか確認してください。
selection-contains-too-many-arrays セレクションに array 型のフィールドが複数含まれていないか確認してください。サポートされているのは1つのみです。
New Stuff!