実験管理APIフラグエンドポイント
| 名前 | 概要 |
|---|---|
| リスト | 設定の詳細を含むフラグの一覧。 |
| 詳細を取得する | フラグの設定の詳細を取得します。 |
| バージョンを一覧表示 | フラグのすべてのバージョンをリストアップします。 |
| バージョン詳細の取得 | フラグの特定のバージョンを取得します。 |
| バリアントを一覧表示 | フラグのすべてのバリアントをリストアップします。 |
| バリアントの詳細を取得する | フラグの特定のバリアントを取得します。 |
| バリアントのインクルージョンを取得する | バリアントのすべてのインクルージョン(ユーザー)を取得します。 |
| バリアントコホートの包含情報の取得 | あるバリアントのすべてのコホート包含情報を取得します。 |
| バリアントを作成する | フラグの新しいバリアントを作成します。 |
| バリアントを編集 | フラグのバリアントを編集します。 |
| バリアントを削除 | フラグからバリアントを削除します。 |
| ユーザーをバリアントに追加する | フラグのバリアントにユーザーを追加します。 |
| バリアントにコホートを追加する | フラグのバリアントにコホートを追加します。 |
| バリアントからユーザーを削除する | フラグのバリアントからユーザーを削除します。 |
| バリアントからすべてのユーザーを削除する | フラグのバリアントからすべてのユーザーを削除します。 |
| バリアントからユーザーを一括削除する | 実験のバリアントからユーザーを一括削除します。 |
| バリアントからコホートを一括削除 | フラグのバリアントからコホートを一括削除します。 |
| デプロイメントを一覧表示する | フラグのすべてのデプロイメントを一覧表示します。 |
| デプロイメントを作成する | フラグのデプロイメントを追加します。 |
| デプロイメントを削除する | フラグからデプロイメントを削除します。 |
| 編集 | フラグを編集します。 |
| 作成 | 新しいフラグを作成します。 |
EU データレジデンシー
このページの例では、デフォルトのベース URL https://experiment.amplitude.comを使用しています。プロジェクトで Amplitude の EU データセンターを使用している場合は、代わりに https://experiment.eu.amplitude.com を使用してください。詳細については、「地域」を参照してください。
リスト
GET https://experiment.amplitude.com/api/1/flags
設定の詳細を含むフラグのリストを取得します。 結果は、作成日時の新しい順に表示されます。
クエリパラメータ
| 名前 | 概要 |
|---|---|
key | フラグキーがこの値と一致するフラグをフィルタリングします。 |
projectId | このプロジェクトに属するフラグをフィルタリングします。 |
limit | 返されるフラグの最大数。 上限は1000です。 |
cursor | 結果ページの開始位置となるオフセットです。 |
includeArchived | アーカイブ済みのフラグを含めるようにフィルタリングします。 デフォルトはfalseです。 |
レスポンス
リクエストが成功すると、200 OKレスポンスコードと、レスポンスボディ内のJSONエンコードされたフラグのリストが返されます。createdAtとlastModifiedAtは、ISO 8601形式のUTCです。
curl --request GET \
--url 'https://experiment.amplitude.com/api/1/flags?limit=1000' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <management-api-key>'
詳細を取得する
GET https://experiment.amplitude.com/api/1/flags/<id>
フラグの設定の詳細を取得します。
パス変数
| 名前 | 概要 |
|---|---|
id | 必須です。 タイプ: string. フラグの ID。 AmplitudeアプリでフラグのURLからIDを見つけます。 |
レスポンス
リクエストが成功すると、200 OK レスポンスと、フラグの詳細を含む JSON オブジェクトが返されます。
curl --request GET \
--url 'https://experiment.amplitude.com/api/1/flags/<id>' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <management-api-key>'
バージョンを一覧表示
GET https://experiment.amplitude.com/api/1/flags/{id}/versions
フラグのすべてのバージョンのリストを取得します。
パス変数
| 名前 | 概要 |
|---|---|
id | 必須です。 タイプ: string. フラグの ID。 AmplitudeアプリでフラグのURLからIDを見つけます。 |
レスポンス
リクエストが成功すると、200 OK レスポンスが返され、レスポンス本文にフラグのバージョンが JSON オブジェクトの配列として含まれます。バージョンは降順でソートされます。
curl --request GET \
--url 'https://experiment.amplitude.com/api/1/flags/<id>/versions' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <management-api-key>'
バージョン詳細の取得
GET https://experiment.amplitude.com/api/1/flags/{id}/versions/{versionId}
フラグの特定のバージョンの詳細を取得します。
パス変数
| 名前 | 概要 |
|---|---|
id | 必須です。 タイプ: string. フラグの ID。 AmplitudeアプリでフラグのURLからIDを見つけます。 |
versionId | 必須です。 タイプ: string. バージョンのID。 |
レスポンス
リクエストが成功すると、200 OK応答とバージョンの詳細を含むJSONオブジェクトが返されます。
curl --request GET \
--url 'https://experiment.amplitude.com/api/1/flags/<id>/versions/<versionId>' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <management-api-key>'
バリアントを一覧表示
GET https://experiment.amplitude.com/api/1/flags/{id}/variants
フラグのすべてのバリアントのリストを取得します。
パス変数
| 名前 | 概要 |
|---|---|
id | 必須です。 タイプ: string. フラグの ID。 AmplitudeアプリでフラグのURLからIDを見つけます。 |
レスポンス
成功したリクエストは、200 OKレスポンスとバリアントをJSONオブジェクトの配列としてレスポンスボディに返します。
curl --request GET \
--url 'https://experiment.amplitude.com/api/1/flags/<id>/variants' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <management-api-key>'
バリアントの詳細を取得する
GET https://experiment.amplitude.com/api/1/flags/{id}/variants/{variantKey}
フラグの特定のバリアントの詳細を取得します。
パス変数
| 名前 | 概要 |
|---|---|
id | 必須です。 タイプ: string. フラグの ID。 AmplitudeアプリでフラグのURLからIDを見つけます。 |
variantKey | 必須です。 タイプ: string. バリアントのキーです。 |
レスポンス
リクエストが成功すると、200 OKレスポンスとフラグバリアントの詳細を含むJSONオブジェクトが返されます。
curl --request GET \
--url 'https://experiment.amplitude.com/api/1/flags/<id>/variants/<variantKey>' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <management-api-key>'
バリアントのインクルージョンを取得する
GET https://experiment.amplitude.com/api/1/flags/{id}/variants/{variantKey}/users
フラグの特定のバリアントに対するインクルージョンのリストを取得します。
パス変数
| 名前 | 概要 |
|---|---|
id | 必須です。 タイプ: string. フラグの ID。 AmplitudeアプリでフラグのURLからIDを見つけます。 |
variantKey | 必須です。 タイプ: string. バリアントのキーです。 |
レスポンス
リクエストが成功すると、200 OKレスポンスとバリアントのインクルージョンがJSONオブジェクトの配列として返されます。
curl --request GET \
--url 'https://experiment.amplitude.com/api/1/flags/<id>/variants/<variantKey>/users' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <management-api-key>'
バリアントコホートの包含情報の取得
GET https://experiment.amplitude.com/api/1/flags/{id}/variants/{variantKey}/cohorts
フラグの特定のバリアントに対するコホートインクルージョンのリストを取得します。
パス変数
| 名前 | 概要 |
|---|---|
id | 必須です。 タイプ: string. フラグの ID。 AmplitudeアプリでフラグのURLからIDを見つけます。 |
variantKey | 必須です。 タイプ: string. バリアントのキーです。 |
レスポンス
リクエストが成功すると、200 OK応答と、バリアントが所属するコホートがコホート ID の配列として返されます。
curl --request GET \
--url 'https://experiment.amplitude.com/api/1/flags/<id>/variants/<variantKey>/cohorts' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <management-api-key>'
バリアントを作成する
POST https://experiment.amplitude.com/api/1/flags/{id}/variants
フラグの新しいバリアントを作成する
パス変数
| 名前 | 概要 |
|---|---|
id | 必須です。 タイプ: string. フラグの ID。 AmplitudeアプリでフラグのURLからIDを見つけます。 |
リクエスト本文
| 名前 | 概要 |
|---|---|
key | 必須です。 タイプ: string. バリアントキー。 には、文字、数字、アンダースコア (_) 、およびハイフン (-) のみを使用できます。 |
description | オプションです。タイプ: string. バリアントの説明です。 |
name | オプションです。タイプ: string. バリアントの名前。 |
payload | オプションです。タイプ: JSON. オプションのペイロード。 値は、オブジェクト、文字列、数値などの有効な JSON 要素である必要があります。 |
rolloutWeight | オプションです。タイプ: number. 対象外のユーザーに対するロールアウトのウェイト。 |
リクエスト例
{
"key": "new-variant-key",
"description": "optional description for variant",
"name": "optional name for variant",
"payload": { "variant-payload": "example payload" },
"rolloutWeight": 0
}
レスポンス
成功したリクエストは200 OK応答とOKテキストを返します。
リクエスト
curl --request POST \
--url 'https://experiment.amplitude.com/api/1/flags/<id>/variants' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <management-api-key>' \
--data '{"key":"<key>","name":"<name>","description":"<description>","payload":"<payload>","rolloutWeight":<rolloutWeight>}'
バリアントを編集
POST https://experiment.amplitude.com/api/1/flags/<id>/variants/<variantKey>
フラグのバリアントを編集します。
パス変数
| 名前 | 概要 |
|---|---|
id | 必須です。 タイプ: string. フラグの ID。 AmplitudeアプリでフラグのURLからIDを見つけます。 |
variantKey | 必須です。 タイプ: string. バリアントのキーです。 |
リクエスト例
{
"key": "updated-variant-key",
"description": "updated optional description for variant",
"name": "optional name for variant",
"payload": { "variant-payload": "example payload" },
"rolloutWeight": 0
}
リクエスト本文
| 名前 | 概要 |
|---|---|
key | オプションです。タイプ: string. バリアントキー。 使用できるのは、文字、数字、アンダースコア (_)、およびハイフン (-) のみです。 |
description | オプションです。タイプ: string. バリアントの説明です。 |
name | オプションです。タイプ: string. バリアントの名前。 |
payload | オプションです。タイプ: JSON. オプションのペイロード。 値は、オブジェクト、文字列、数値などの有効なJSON要素である必要があります。この値は、バリアントペイロードの既存の値に置き換えられます。 |
rolloutWeight | オプションです。タイプ: number. 対象外のユーザーに対するロールアウトのウェイト。 |
レスポンス
成功したリクエストは200 OK応答とOKテキストを返します。
リクエスト
curl --request PATCH \
--url 'https://experiment.amplitude.com/api/1/flags/<id>/variants/<variantKey>' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <management-api-key>' \
--data '{"key":"<key>","name":"<name>","description":"<description>","payload":"<payload>","rolloutWeight":<rolloutWeight>}'
バリアントを削除
DELETE https://experiment.amplitude.com/api/1/flags/{id}/variants/{variantKey}
フラグからバリアントを削除します。
パス変数
| 名前 | 概要 |
|---|---|
id | 必須です。 タイプ: string. フラグの ID。 AmplitudeアプリでフラグのURLからIDを見つけます。 |
variantKey | 必須です。 タイプ: string. バリアントのキーです。 |
レスポンス
成功したリクエストは200 OK応答とOKテキストを返します。
リクエスト
curl --request DELETE \
--url 'https://experiment.amplitude.com/api/1/flags/<id>/variants/<variantKey>' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <management-api-key>'
ユーザーをバリアントに追加する
POST https://experiment.amplitude.com/api/1/flags/{id}/variants/{variantKey}/users
1 つのバリアントにつき最大 2,000 個のインクルージョンを含めることができます。 この制限を超えると、Amplitudeは400エラーを返します。
フラグのバリアントにインクルージョン(ユーザーまたはデバイス)を追加します。
パス変数
| 名前 | 概要 |
|---|---|
id | 必須です。 タイプ: string. フラグの ID。 AmplitudeアプリでフラグのURLからIDを見つけます。 |
variantKey | 必須です。 タイプ: string. バリアントのキーです。 |
リクエスト本文
| 名前 | 概要 |
|---|---|
inclusions | 必須です。 タイプ: object. ユーザーIDまたはデバイスIDの文字列配列を格納します。 |
リクエスト例
{
"inclusions": [
"<user1>@<your-company-email>, <user2>@<your-company-email>, <userId>"
]
}
レスポンス
成功したリクエストは200 OK応答とOKテキストを返します。
リクエスト
curl --request POST \
--url 'https://experiment.amplitude.com/api/1/flags/<id>/variants/<variantKey>/users' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <management-api-key>' \
--data '{"inclusions":<["id1", "id2", "id3"]>}'
バリアントにコホートを追加する
POST https://experiment.amplitude.com/api/1/flags/{id}/variants/{variantKey}/cohorts
フラグのバリアントにコホートインクルージョンを追加します。
パス変数
| 名前 | 概要 |
|---|---|
id | 必須です。 タイプ: string. フラグの ID。 AmplitudeアプリでフラグのURLからIDを見つけます。 |
variantKey | 必須です。 タイプ: string. バリアントのキーです。 |
リクエスト本文
| 名前 | 概要 |
|---|---|
inclusions | 必須です。 タイプ: array. 追加するコホート ID の配列です。 |
リクエスト例
{
"inclusions": ["cohort-id-1", "cohort-id-2"]
}
レスポンス
成功したリクエストは200 OK応答とOKテキストを返します。
リクエスト
curl --request POST \
--url 'https://experiment.amplitude.com/api/1/flags/<id>/variants/<variantKey>/cohorts' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <management-api-key>' \
--data '{"inclusions":["cohort-id-1", "cohort-id-2"]}'
バリアントからユーザーを削除する
DELETE https://experiment.amplitude.com/api/1/flags/{id}/variants/{variantKey}/users/{userIndex}
フラグのバリアントからインクルージョン(ユーザーまたはデバイス)を削除します。
パス変数
| 名前 | 概要 |
|---|---|
id | 必須です。 タイプ: string. フラグの ID。 AmplitudeアプリでフラグのURLからIDを見つけます。 |
variantKey | 必須です。 タイプ: string. バリアントのキーです。 |
userIndex | 必須です。 タイプ: string. ユーザーのインデックス。 ゼロから始まるインデックスです。バリアントのインクルージョンの取得から、ユーザーのインデックスベースの配列を取得します |
レスポンス
成功したリクエストは200 OK応答とOKテキストを返します。
リクエスト
curl --request DELETE \
--url 'https://experiment.amplitude.com/api/1/flags/<id>/variants/<variantKey>/users/<userIndex>' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <management-api-key>'
バリアントからすべてのユーザーを削除する
DELETE https://experiment.amplitude.com/api/1/flags/{id}/variants/{variantKey}/users
フラグのバリアントからすべてのインクルージョン(ユーザーまたはデバイス)を削除します。
パス変数
| 名前 | 概要 |
|---|---|
id | 必須です。 タイプ: string. フラグの ID。 AmplitudeアプリでフラグのURLからIDを見つけます。 |
variantKey | 必須です。 タイプ: string. バリアントのキーです。 |
レスポンス
成功したリクエストは200 OK応答とOKテキストを返します。
リクエスト
curl --request DELETE \
--url 'https://experiment.amplitude.com/api/1/flags/<id>/variants/<variantKey>/users' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <management-api-key>'
バリアントからユーザーを一括削除する
DELETE https://experiment.amplitude.com/api/1/flags/{id}/variants/{variantKey}/bulk-delete-users
フラグのバリアントからユーザーまたはデバイスを一括削除します。 各リクエストにつき100件に制限されています。
パス変数
| 名前 | 概要 |
|---|---|
id | 必須です。 タイプ: string. フラグの ID。 AmplitudeアプリでフラグのURLからIDを見つけます。 |
variantKey | 必須です。 タイプ: string. バリアントのキーです。 |
リクエスト本文
| 名前 | 概要 |
|---|---|
users | 必須です。 タイプ: object. ユーザーIDまたはデバイスIDの文字列配列を格納します。 |
レスポンス
成功したリクエストは200 OK応答とOKテキストを返します。
リクエスト
curl --request DELETE \
--url 'https://experiment.amplitude.com/api/1/flags/<id>/variants/<variantKey>/bulk-delete-users' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <management-api-key>' \
--data '{"users":<["id1", "id2", "id3"]>}'
バリアントからコホートを一括削除
DELETE https://experiment.amplitude.com/api/1/flags/{id}/variants/{variantKey}/bulk-delete-cohorts
フラグのバリアントからコホートを一括削除します。 各リクエストにつき100件に制限されています。
パス変数
| 名前 | 概要 |
|---|---|
id | 必須です。 タイプ: string. フラグの ID。 AmplitudeアプリでフラグのURLからIDを見つけます。 |
variantKey | 必須です。 タイプ: string. バリアントのキーです。 |
リクエスト本文
| 名前 | 概要 |
|---|---|
users | 必須です。 タイプ: array. 削除するコホート ID の配列です。 |
レスポンス
成功したリクエストは200 OK応答とOKテキストを返します。
リクエスト
curl --request DELETE \
--url 'https://experiment.amplitude.com/api/1/flags/<id>/variants/<variantKey>/bulk-delete-cohorts' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <management-api-key>' \
--data '{"users":["cohort-id-1", "cohort-id-2"]}'
デプロイメントを一覧表示する
GET https://experiment.amplitude.com/api/1/flags/{id}/deployments
フラグのすべてのデプロイメントを一覧表示します。
パス変数
| 名前 | 概要 |
|---|---|
id | 必須です。 タイプ: string. フラグの ID。 AmplitudeアプリでフラグのURLからIDを見つけます。 |
レスポンス
リクエストが成功すると、200 OKレスポンスと、フラグのデプロイメントの詳細を含むJSONオブジェクトの配列が返されます。
curl --request GET \
--url 'https://experiment.amplitude.com/api/1/flags/<id>/deployments' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <management-api-key>'
デプロイメントを作成する
POST https://experiment.amplitude.com/api/1/flags/{id}/deployments
フラグのデプロイメントを追加します。
パス変数
| 名前 | 概要 |
|---|---|
id | 必須です。 タイプ: string. オブジェクトの ID。 |
リクエスト本文
| 名前 | 概要 |
|---|---|
deployments | 必須です。 タイプ: string array. デプロイメントIDの文字列配列を含みます。 |
リクエスト例
{
"deployments": [<deploymentId>]
}
レスポンス
成功したリクエストは200 OK応答とOKテキストを返します。
リクエスト
curl --request POST \
--url 'https://experiment.amplitude.com/api/1/flags/<id>/deployments' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <management-api-key>'
--data '{"deployments":[<deploymentId>]}'
デプロイメントを削除する
DELETE https://experiment.amplitude.com/api/1/flags/{id}/deployments/{deploymentId}
フラグからデプロイメントを削除します。
パス変数
| 名前 | 概要 |
|---|---|
id | 必須です。 タイプ: string. フラグの ID。 AmplitudeアプリでフラグのURLからIDを見つけます。 |
deploymentID | 必須です。 タイプ: string. デプロイメントの ID。 |
レスポンス
成功したリクエストは200 OK応答とOKテキストを返します。
リクエスト
curl --request DELETE \
--url 'https://experiment.amplitude.com/api/1/flags/<id>/deployments/<deploymentId>' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <management-api-key>'
編集
PATCH https://experiment.amplitude.com/api/1/flags/{id}
フラグを編集します。
パス変数
| 名前 | 概要 |
|---|---|
id | 必須です。 タイプ: string. フラグの ID。 AmplitudeアプリでフラグのURLからIDを見つけます。 |
リクエスト本文
| 名前 | 概要 |
|---|---|
name | オプションです。タイプ: string. 名前 |
description | オプションです。タイプ: string. 説明。 |
bucketingKey | オプションです。タイプ: string. ユーザーをバケットに分類するためのユーザープロパティ。 |
bucketingSalt | オプションです。タイプ: string. バケット割り当て用ソルト。 |
bucketingUnit | オプションです。タイプ: string. アカウント アドオンのグループ タイプで表されるバケッティング単位。グループレベルのバケット設定と分析に使用されます。 |
evaluationMode | オプションです。タイプ: string. フラグの評価モードは、localまたはremoteのいずれかです。 |
rolloutPercentage | オプションです。タイプ: number. 対象外ユーザーに対するロールアウト率。 範囲は0〜100です。 |
targetSegments | オプションです。タイプ: object array. 詳細については、targetSegments表を参照してください。 targetSegmentsオブジェクト配列を指定すると、既存のターゲットセグメントが置き換えられます。このオプションはコホートをサポートしていません。 |
enabled | オプションです。タイプ: boolean. フラグを有効化または無効化するためのプロパティです。 |
archive | オプションです。タイプ: boolean. フラグをアーカイブまたはアーカイブ解除するためのプロパティです。 |
tags | オプションです。タイプ: string array. フラグのタグのリストです。 タグの追加と削除は同じ操作で行われます。 既存のタグに新しいタグを追加するには、まずすべてのフラグタグのリストを取得します。 |
リクエスト例
{
"name": "updated name",
"description": "updated description",
"bucketingKey": "amplitude_id",
"bucketingSalt": "<bucketingSalt>",
"bucketingUnit": "org id",
"evaluationMode": "remote",
"rolloutPercentage": 0,
"enabled": false,
"tags": ["prod", "staging"]
}
レスポンス
成功したリクエストは200 OK応答を返します。
レスポンス
curl --request PATCH \
--url 'https://experiment.amplitude.com/api/1/flags/<id>' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <management-api-key>' \
--data '{"enabled":<enabled>,"rolloutPercentage":<rolloutPercentage>}'
作成
POST https://experiment.amplitude.com/api/1/flags
新しいフラグを作成します。
リクエスト本文
| 名前 | 概要 |
|---|---|
projectId | 必須です。 タイプ: string. プロジェクトのID。 |
key | 必須です。 タイプ: string. フラグキーです。 |
name | オプションです。タイプ: string. フラグの名前。 |
description | オプションです。タイプ: string. フラグの説明です。 |
variants | オプションです。タイプ: object array. variantsの配列 |
bucketingKey | オプションです。タイプ: string. ユーザーをバケットに分類するためのユーザープロパティ。 |
rolloutWeights | オプションです。タイプ: object. 対象外のユーザー向けのロールアウトウェイト。 オブジェクトは、バリアントキーから整数としてのロールアウトウェイトへのマッピングである必要があります。たとえば、{ "control": 1, "treatment": 1 }です。 |
targetSegments | オプションです。タイプ: object array. 詳細については、targetSegments表を参照してください。 |
deployments | オプションです。タイプ: string array. フラグを割り当てるべきデプロイメントの配列。 |
evaluationMode | オプションです。タイプ: string. 実験評価モード。オプションには remote または local があります。 |
variants
variantsフィールドにはこれらのオブジェクトが含まれています。
| 名前 | 概要 |
|---|---|
key | 必須です。 タイプ: string. バリアントのキー(値とも呼ばれます)。 使用できるのは、文字、数字、アンダースコア (_)、およびハイフン (-) のみです。 |
payload | オプションです。タイプ: JSON. オプションのペイロード。 値は、オブジェクト、文字列、数値などの有効な JSON 要素である必要があります。 |
name | オプションです。タイプ: string. バリアント名。 |
description | オプションです。タイプ: string. バリアントの説明。 |
targetSegments
targetSegmentsフィールドにはこれらのオブジェクトが含まれています。
| 名前 | 概要 |
|---|---|
name | 必須です。 タイプ: string. セグメント名。 |
conditions | 必須です。 タイプ: object array. conditionsの配列 |
percentage | 必須です。 タイプ: number. 条件に一致するユーザーに対する割り当て率。 |
rolloutWeights | 必須です。 タイプ: object. バリアントキーからロールアウトウェイトまでのマップ。 たとえば、{ "control": 1, "treatment": 1 }です。 |
conditions
conditionsフィールドにはこれらのオブジェクトが含まれています。
| 名前 | 概要 |
|---|---|
type | 必須です。 タイプ: string. 値を持つ必要があります:property |
prop | 必須です。 タイプ: string. 条件で使用するプロパティです。 カスタムプロパティと自由形式プロパティの接頭辞: gp: |
op | 必須です。 タイプ: string. この条件で使用する演算です。 |
values | 必須です。 タイプ: string array. 演算で使用する値です。 |
op
プロパティ値に対する操作を表す文字列値です。 可能な値は次のとおりです:
isis notcontainsdoes not containlessless or equalgreatergreater or equalset isset is notset containsset does not containglob matchglob does not matchversion less thanversion less than or equal toversion greater thanversion greater than or equal to
リクエスト例
{
"projectId": "<projectId>",
"name": "Analyze button clicks",
"key": "analyze-button-clicks",
"description": "analyze button clicks on the main page",
"variants": [
{
"key": "on"
}
],
"rolloutWeights": { "on": 1 },
"targetSegments": [
{
"name": "Segment 1",
"conditions": [
{
"prop": "country",
"op": "is",
"type": "property",
"values": ["United States"]
}
],
"percentage": 0,
"bucketingKey": "amplitude_id",
"rolloutWeights": {
"on": 1
}
}
],
"deployments": ["<deploymentId>"],
"evaluationMode": "remote"
}
レスポンス
成功したリクエストは、200 OKレスポンスとフラグのIDとURLを含むJSONオブジェクトを返します。
curl --request POST \
--url 'https://experiment.amplitude.com/api/1/flags' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <management-api-key>' \
--data '{"projectId":"<projectId>","key":"<key>"}'
これは役に立ちましたか?