Releases API
地域
ベースURLは、プロジェクトのデータのレジデンシーによって異なります。このページ内のすべての例では、プロジェクトがAmplitudeのEUデータセンターを利用している場合を除き、デフォルトのベースURLを使用してください。EUデータセンターを利用している場合は、この表に記載されているEU用のベースURLを使用してください。
リクエストはhttps://amplitude.com(デフォルト)またはhttps://analytics.eu.amplitude.com(EU)に送信されます。https://analytics.amplitude.comのホスト名はアナリティクスウェブアプリ(ブラウザーUI)です。RESTリクエストにはanalytics.amplitude.comではなく、この表に記載されているホストを使用してください。
| データのレジデンシー | ベースURL |
|---|---|
| デフォルト | https://amplitude.com |
| 欧州連合 | https://analytics.eu.amplitude.com |
リリースを作成する
POST https://amplitude.com/api/2/release
リリースのパラメータをJSONペイロードまたはクエリパラメータとして送信します。
POST /api/2/release?version=2.2&release_start=2022-01-01 00:00:00&release_end=2022-01-01 00:00:00&title=New Feature&description=Releasing the new paid feature. &platforms=iOS&created_by=&chart_visibility=true HTTP/1.1
Host: amplitude.com
Authorization: Basic {api-key}:{secret-key}
リリースパラメータ
| 名前 | 概要 |
|---|---|
version | 必須です。 このリリースに対応するプロダクトのバージョン。 |
release_start | 必須です。 このリリースの開始時刻に対応するタイムスタンプ(UTC)。 この形式である必要があります:yyyy-MM-dd HH:mm:ss。 |
release_end | オプションです。このリリースの終了時刻に対応するタイムスタンプ(UTC)。この形式である必要があります:yyyy-MM-dd HH:mm:ss。 |
title | 必須です。 リリースの名前です。 |
description | オプションです。リリースの説明です。 |
platforms | オプションです。このリリースに対応するプラットフォームの一覧です。 |
created_by | オプションです。リリースを作成しているユーザーの名前(文字列形式)。 |
chart_visibility | オプションです。デフォルトはtrueです。 trueの場合、リリースが注釈としてチャートに表示されます。 |
レスポンス
リクエストが成功すると、リリースの情報を含むJSONレスポンスが返されます。
json
{
"success": true,
"release": {
"id": "xbcehyc",
"app_id": 50000,
"org_id": 10001,
"version": "3.5",
"release_start": "2022-01-01 00:00:00",
"release_end": "2022-01-01 00:00:00",
"type": "integration",
"title": "Big new feature for iOS",
"description": "Releasing the new paid feature. ",
"platforms": ["iOS"],
"chart_visibility": true,
"params": {
"created": 1646324226364,
"created_by": "A User",
"last_modified": 1646324226364,
"last_modified_by": "A User"
}
}
}
ステータスコード
| コード | メッセージ |
|---|---|
| 200 | 成功 |
| 400 | 無効なリクエストです。 詳細についてはメッセージを確認してください。 |
これは役に立ちましたか?