Experiment Management APIのデプロイメントエンドポイント

名前	概要
List deployments	実験やフラグを割り当てることができるデプロイメントをリストアップします。
Create deployment	デプロイメントを作成します。
Edit deployment	デプロイメントを編集します。

EUデータレジデンシー

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

List deployments

bash

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

実験やフラグを割り当てることができるデプロイメントのリストを取得します。

クエリパラメータ

名前	概要
`limit`	オプションです。タイプ：`number`。返されるデプロイメントの最大数。上限は1000です。
`cursor`	オプションです。タイプ：`number`。結果の「ページ」を開始するためのオフセットです。

レスポンス

リクエストが成功すると、200 OKレスポンスが返され、レスポンス本文にはデプロイメントのJSONエンコードリストが含まれます。

リクエスト

curl

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

レスポンス

json

    {
        "deployments": [
            {
                "id": <id>,
                "projectId": <projectId>,
                "label": "deployment-1",
                "key": <key>,
                "deleted": true
            },
            {
                "id": <id>,
                "projectId": <projectId>,
                "label": "deployment-2",
                "key": <key>,
                "deleted": false
            }
        ]
    }

Create deployment

bash

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

実験やフラグを割り当てることができるデプロイメントを作成します。

クエリパラメータ

名前	概要
`projectId`	必須です。タイプ：`string`。プロジェクトのID。
`label`	必須です。タイプ：`string`。デプロイメントのラベル。英数字および/または`_`、`-`文字を含む必要があります。
`type`	必須です。タイプ：`string`。デプロイメントのタイプ。 `client`または`server`のいずれかである必要があります。

リクエスト

json

{
  "projectId": "<projectId>",
  "label": "hello-world",
  "type": "client"
}

レスポンス

リクエストが成功すると、200 OKレスポンスとデプロイメントのidが返されます。

リクエスト

curl

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

json

    {
        "id": <id>
    }

Edit deployment

bash

PATCH https://experiment.amplitude.com/api/1/deployments/<id>

実験やフラグを割り当てることができるデプロイメントを編集します。

クエリパラメータ

名前	概要
`label`	オプションです。タイプ：`string`。デプロイメントのラベル。英数字および/または`_`、`-`文字を含む必要があります。
`archive`	オプションです。タイプ：`boolean`。デプロイメントをソフトデリートするか復元します。

リクエスト

json

{
  "label": "updated-label"
}

レスポンス

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

リクエスト

curl

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

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