Experiment Management APIのホールドアウトグループエンドポイント

名前	概要
List	ホールドアウトグループとその設定の詳細をリスト表示します。
詳細を取得する	ホールドアウトグループの設定の詳細を取得します。
Edit	ホールドアウトグループを編集します。
Create	新しいホールドアウトグループを作成します。

EUデータレジデンシー

このページの例では、デフォルトのベースURLhttps://experiment.amplitude.comを使用しています。プロジェクトでAmplitudeのEUデータセンターを使用している場合は、代わりにhttps://experiment.eu.amplitude.comを使用してください。詳細については、地域を参照してください。

List

bash

GET https://experiment.amplitude.com/api/1/holdouts

ホールドアウトグループのリストとその設定の詳細を取得します。

クエリパラメータ

名前	タイプ	必須	概要
`limit`	整数です。	いいえ	返すホールドアウトグループの最大数。上限は1000です。
`cursor`	文字列	いいえ	結果ページの開始位置となるオフセットです。

レスポンス

リクエストが成功すると、200 OKレスポンスと、レスポンス本文にJSONとしてエンコードされたホールドアウトグループのリストが返されます。

curl --request GET \
--url 'https://experiment.amplitude.com/api/1/holdout?limit=1000' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <management-api-key>'

詳細を取得する

bash

GET https://experiment.amplitude.com/api/1/holdouts/<id>

ホールドアウトグループの設定の詳細を取得します。

パス変数

名前	タイプ	必須	概要
`id`	文字列	はい	ホールドアウトグループのID。

レスポンス

リクエストが成功すると、200 OKレスポンスとホールドアウトグループの詳細を含むJSONオブジェクトが返されます。

curl --request GET \
    --url 'https://experiment.amplitude.com/api/1/holdouts/<id>' \
    --header 'Accept: application/json' \
    --header 'Authorization: Bearer <management-api-key>'

Edit

bash

PATCH https://experiment.amplitude.com/api/1/holdouts/{id}

ホールドアウトグループを編集します。

パス変数

名前	概要
`id`	必須です。文字列です。ホールドアウトグループのID。

リクエスト本文

名前	タイプ	必須	概要
`name`	文字列	いいえ	ホールドアウトグループ名。
`description`	文字列	いいえ	ホールドアウトグループの説明。
`experiments`	数値配列	いいえ	このホールドアウトグループに含める実験IDのリスト。実験の評価モードは、ホールドアウトグループの評価モードと互換性がある必要があります。
`individualInclusion`	文字列配列	いいえ	このホールドアウトグループに含めるユーザーIDまたはデバイスIDのリスト。含まれているユーザーが実験を経験することはありません。
`individualExclusion`	文字列配列	いいえ	このホールドアウトグループから除外するユーザーIDまたはデバイスIDのリスト。除外されたユーザーは実験を体験できます。
`archive`	ブール値	いいえ	ホールドアウトグループをアーカイブします。このプロパティを設定すると、ホールドアウトグループが削除済みとしてマークされ、すべての子実験の親依存関係から削除されます。

リクエスト例

json

{
  "name": "updated name",
  "description": "updated description",
  "experiments": [123],
  "individualInclusion": ["x@amplitude.com"]
}

レスポンス

リクエストに成功すると、200 OKレスポンスが返されます。

リクエスト

curl

curl --request PATCH \
    --url 'https://experiment.amplitude.com/api/1/holdouts/<id>' \
    --header 'Content-Type: application/json' \
    --header 'Accept: application/json' \
    --header 'Authorization: Bearer <management-api-key>' \
    --data '{"name": "updated name"}'

Create

bash

POST https://experiment.amplitude.com/api/1/holdouts

新しいホールドアウトグループを作成します。

リクエスト本文

名前	タイプ	必須	概要
`projectId`	番号	はい	ホールドアウトグループのプロジェクトID。
`name`	文字列	はい	ホールドアウトグループ名。
`key`	文字列	いいえ	ホールドアウトグループのキー。一意である必要があります。指定されていない場合、Amplitudeはランダムなキーを生成します。
`description`	文字列	いいえ	ホールドアウトグループの説明。
`holdoutPercentage`	番号	はい	ホールドアウト率。 1〜99の整数です（この値を含む）。
`evaluationMode`	文字列	いいえ	評価モード。オプションは`local`および`remote`です。デフォルトは`remote`です。
`bucketingKey`	文字列	いいえ	バケットキー。デフォルトは`amplitude_id`です。
`experiments`	数値配列	いいえ	このホールドアウトグループに含める実験IDのリスト。実験の評価モードは、ホールドアウトグループの評価モードと互換性がある必要があります。
`individualInclusion`	文字列配列	いいえ	このホールドアウトグループに含めるユーザーIDまたはデバイスIDのリスト。含まれているユーザーが実験を経験することはありません。
`individualExclusion`	文字列配列	いいえ	このホールドアウトグループから除外するユーザーIDまたはデバイスIDのリスト。除外されたユーザーは実験を体験できます。

リクエスト例

json

{
    "projectId": <projectId>,
    "name": "Example Holdout",
  	"key": "example-holdout",
    "holdoutPercentage": 5,
    "evaluationMode": "local",
    "bucketingKey": "device_id",
    "experiments": [21197],
    "individualInclusion": ["x@amplitude.com"],
    "individualExclusion": ["y@amplitude.com"],
}

レスポンス

リクエストが成功すると、200 OKレスポンスとホールドアウトグループのIDとURLを含むJSONオブジェクトが返されます。

curl --request POST \
    --url 'https://experiment.amplitude.com/api/1/holdouts' \
    --header 'Content-Type: application/json' \
    --header 'Accept: application/json' \
    --header 'Authorization: Bearer <management-api-key>' \
    --data '{"projectId":"<projectId>","name":"Example Holdout","holdoutPercentage":5}'

これは役に立ちましたか？