실험 실험 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
변형당 최대 2,000개의 포함을 가질 수 있습니다. 이 제한을 초과하면 Amplitude는 400오류를 반환합니다.
플래그 변형에 포함(사용자 또는 장치)을 추가합니다.
경로 변수
| 이름 | 설명 |
|---|---|
id | 필수입니다. 유형: string. 플래그의 ID입니다. Amplitude 앱에서 플래그의 URL에서 ID를 찾으십시오. |
variantKey | 필수입니다. 유형: string. 변형의 키입니다. |
요청 본문
| 이름 | 설명 |
|---|---|
inclusions | 필수입니다. 유형: object. 사용자 또는 장치 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. 사용자의 인덱스입니다. 0부터 시작하는 인덱스입니다. 변형 포함 내용 가져오기에서 사용자 인덱스 기반 배열을 가져옵니다. |
응답
성공적인 요청은 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의 문자열 배열을 포함합니다. |
응답
성공적인 요청은 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>"}'
이 내용이 도움이 되었나요?