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

post

/catalogs/{catalog_name}/selections

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

important:

このエンドポイントは現在早期アクセス中である。この早期アクセスへ参加することに興味がある場合は、カスタマーサクセスマネージャーにお問い合わせください。

前提条件

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

レート制限

パスパラメーター

パラメータ必須データ型説明

catalog_name 必須文字列カタログ名。

リクエストパラメーター

パラメータ必須データ型説明

selection 必須オブジェクト選択基準を含むオブジェクト。選択オブジェクトには、name、description、filters、results_limit、sort_field、sort_order が含まれる場合があります。

リクエスト例

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",
    "filters": [
      {
        "field": "City",
        "operator": "equals",
        "value": "NYC"
      },
      {
        "field": "Rating",
        "operator": "greater than",
        "value": 7
      }
    ]
  }
}'

フィルター演算子

フィールドタイプ対応オペレーター

string equals, does not equal

number equalsdoes not equal,greater than 、 less than

boolean is

time before, after

array includes value, does not include value

応答

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

成功応答の例

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

{
  "message": "success"
}

エラー応答例

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

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