그룹 API v4
그룹 API v4를 사용하여 그룹을 생성, 업데이트, 가져오기 및 삭제하여 사용자 세그먼트를 구성하고 관리할 수 있습니다.
읽는 시간 6분최근 업데이트: 10시간 전
중요
API 버전 3 이하에서는 2025년 3월부터 사용 중단 예정 중단됩니다. 방해를 방지하기 위해 최신 버전으로 업데이트합니다.
이 API 사용하여 레벨플레이 대시보드에서 Mediation 그룹을 관리합니다. 이 API 다음을 지원합니다.
- Mediation 그룹 설정 관리
- Mediation 그룹별 워터폴 관리
요청은 호출 1개 애플리케이션 제한됩니다.
속도 제한
API 요청이 30분 동안 4000개를 초과하면 429 HTTP 상태 코드를 반환합니다.
인증 유형
GET
설명
애플리케이션 그룹 목록을 가져옵니다.
메서드
요청 파라미터
Name | Type | 설명 | 예시 |
|---|---|---|---|
| appKey | 문자열 | 애플리케이션 키(플랫폼에서 확인 가능) | 142401ac1 |
요청 예시 URL
응답 파라미터
Name | 설명 | 예시 |
|---|---|---|
| groupId | 그룹 생성 시 레벨플레이 플랫폼에서 생성한 고유 그룹 ID | 2432228 |
| groupName | 그룹 이름 | 영어 |
| mediationAdUnitId | 그룹이 속한 광고 유닛의 ID | fgx25t56dq201bd2 |
| mediationAdUnitName | 그룹이 속한 광고 유닛의 이름 | interstitial-1 |
| adFormat | 보상형 광고, 인터스티셜 광고, 배너 광고 또는 네이티브 광고 | 인터스티셜 광고 |
| abTest | 관련된 그룹 테스트 | A |
| 포지션 | 리스트에서 그룹의 위치 | 1 |
| floorPrice | 노출당 최소 단가(CPM) | 1.3 |
| countries | 그룹에 속한 국가 코드 목록 | US, GB |
| 세그먼트 | 그룹에 속하는 세그먼트 이름 목록 | 30세 미만, femaleOnly |
| 인스턴스 | 그룹에 속한 인스턴스 목록 | |
| 이것들은 ‘instances’ 배열의 다음 인스턴스 필드입니다. | ||
| id | 레벨플레이 인스턴스 API 전송되는 인스턴스 ID | 128395 |
| name | 인스턴스 이름 | Rewarded50 |
| networkName | 인스턴스 속한 광고 네트워크 | unityAds |
| isBidder | 입찰자 인스턴스의 경우 true, 그렇지 않으면 false | False |
| groupRate | 워터폴의 인스턴스 우선 순위를 지정하는 데 사용. 0.01-3000 범위여야 합니다. Mediation management 를 참조하십시오. | 11.9 |
| countriesRate | 그룹 레벨 속도와 다른 국가의 속도 목록 | |
| 다음은 ‘countryRate’ 배열의 countryRate 필드입니다. | ||
| countryCode | 국가 코드는 ISO 3166-1 알파-2에 해당 2자리 국가 코드로 정의됩니다. | GB |
| 속도 | 워터폴의 인스턴스 우선 순위를 지정하고 보고에 사용됩니다. 0.01-3000 범위여야 합니다. Mediation management 를 참조하십시오. | 9 |
응답 예시
[ { "groupId": 12673, "groupName": "newGroup", "mediationAdUnitId": "fgx25t56dq201bd2", "mediationAdUnitName": "interstitial-1", "adFormat": "interstitial", "abTest": "A", "countries": ["FR","US"], "position": 1, "segments": [], "floorPrice": 0.3, "instances": [ { "id": 3681, "name": "", "networkName": "ironSource", "isBidder": true }, { "id": 2, "name": "기본값", "isBidder": false, "networkName": "unityAds", "groupRate": 5, "countriesRate": [ { "countryCode": "FR", "rate": 1 } ] } ] }]
생성
이 API 사용하여 Mediation 그룹을 생성합니다. 이 API 사용하면 단일 API 호출 여러 그룹을 생성할 수 있습니다. ‘instances’ 파라미터 사용하여 그룹에 포함/제외할 각 인스턴스 결정합니다. 인스턴스 ID 값은 Instances API를 사용하여 도달할 수 있습니다.
- 이 API 사용하면 단일 API 호출 여러 그룹을 생성할 수 있습니다.
- 이 API 대한 Get 호출 사용하여 그룹 ID 값에 도달할 수 있습니다.
- 인스턴스 ID 값은 Instances API를 사용하여 도달할 수 있습니다.
메서드
요청 파라미터
Name | Type | 설명 | 예시 |
|---|---|---|---|
| appKey | 문자열 | 애플리케이션 키(플랫폼에서 확인 가능) | 142401ac1 |
요청 예시 URL
지원 파라미터
Name | Type | 설명 | 필수 | 예시 |
|---|---|---|---|---|
| groupName | 문자열 | 새로 생성된 그룹의 이름 Length는 범위가 1~32여야 합니다. | ✓ | 계층 1 |
| adFormat | 문자열 | 보상형 광고, 인터스티셜 광고, 배너, 네이티브 | ✓ | 인터스티셜 광고 |
| mediationAdUnitId | 문자열 | 그룹이 속한 광고 유닛의 ID. 광고 형식에 여러 광고 유닛이 있는 경우 필수입니다. | x | fgx25t56dq201bd2 |
| 포지션 | 숫자 | 그룹 목록의 그룹 포지션 목록의 1~최대 그룹 사이여야 합니다(allCountries 그룹 제외). | ✓ | 2 |
| abTest | 문자열 | 관련된 AB 테스트 그룹입니다. "A", "B" | x | B |
| floorPrice | 숫자 | CPM으로 표시되는 노출당 최소 단가 | x | 15 |
| countries | 문자열 배열 | 국가 코드 배열으로, 두 글자 국가 코드로 정의됩니다. ISO 3166-1 알파-2. 지정되어 있지 않으면 기본값에 allCountries가 포함됩니다. | x | US, GB |
| 세그먼트 | 문자열 배열 | 세그먼트 이름 배열 | x | 30세 미만, femaleOnly |
| 인스턴스 | 배열 | 업데이트할 인스턴스 리스트입니다. 지정되어 있지 않으면 기본값에는 광고 형식으로 설정된 모든 인스턴스가 포함됩니다. | x | |
| 이것들은 ‘instances’ 배열의 다음 인스턴스 필드입니다. | ||||
| id | 숫자 | 레벨플레이 인스턴스 API 전송되는 인스턴스 ID | ✓ | 124526 |
| groupRate | 숫자 | 워터폴의 인스턴스 우선 순위를 지정하는 데 사용. 0.01-3000 범위여야 합니다. Mediation management 를 참조하십시오. | x | 0.6 |
| countriesRate | 배열 | 업데이트할 국가 수익 목록 | x | |
| 다음은 ‘countryRate’ 배열의 countryRate 필드입니다. | ||||
| countryCode | 문자열 | 국가 코드입니다. 이 코드는 ISO 3166-1 알파-2에 해당 2자리 국가 코드로 정의됩니다. | ✓ | AU |
| 속도 | 숫자 | 워터폴의 인스턴스 우선 순위를 지정하는 데만 사용됩니다. 0.01-3000 범위여야 합니다. Mediation management 를 참조하십시오. | ✓ | 2.4 |
요청 예시
[ { "groupName": "새 그룹", "adFormat": "rewarded", "mediationAdUnitId": "fgx25t56dq201bd2", "countries": ["FR","US"], "position": 1, "segments": ["nonPaying"], "abTest": "B", "floorPrice": 0.3, "instances": [ { "id": 7983541, "groupRate": 2, "countriesRate": [ { "countryCode": "FR", "rate": 1 } ] }, { "id": 4896357 }, { "id": 62624583, "countriesRate": [ { "countryCode": "US", "rate": 5.3 } ] } ] }]
업데이트
이 API 사용하여 Mediation 그룹 설정 설정 및 워터폴을 업데이트합니다.
- 단일 API 호출 여러 그룹을 업데이트할 수 있습니다.
- groupRate/countryRate를 제거하려면 필드 파라미터를 null 값으로 추가합니다.
- 배열 필드 업데이트하려면 모든 값(새 값과 기존 값)을 포함합니다.
메서드
요청 파라미터
Name | Type | 설명 | 예시 |
|---|---|---|---|
| appKey | 문자열 | 애플리케이션 키(플랫폼에서 확인 가능) | 142401ac1 |
요청 예시 URL
지원 파라미터
Name | Type | 설명 | 필수 | 예시 |
|---|---|---|---|---|
| groupId | 숫자 | GET 요청에서 전송된 그룹 ID | ✓ | 12673 |
| groupName | 문자열 | 새로 생성된 그룹의 이름 Length는 범위가 1~32여야 합니다. | x | 영어 |
| 포지션 | 숫자 | 그룹 목록의 그룹 포지션 목록의 1~최대 그룹 사이여야 합니다(allCountries 그룹 제외). | x | 2 |
| floorPrice | 숫자 | 노출당 최소 단가(CPM) | x | 15 |
| countries | 문자열 배열 | 국가 코드 배열으로, 2자리 국가 코드로 정의됩니다. ISO 3166-1 알파-2에 따라. 지정되어 있지 않으면 기본값에 allCountries가 포함됩니다. | x | US, GB |
| 세그먼트 | 문자열 배열 | 세그먼트 이름 배열 | x | 30세 미만, femaleOnly |
| 인스턴스 | 배열 | 업데이트할 인스턴스 리스트입니다. 지정되어 있지 않으면 기본값에는 광고 형식으로 설정된 모든 인스턴스가 포함됩니다. | x | |
| 이것들은 ‘instances’ 배열의 다음 인스턴스 필드입니다. | ||||
| id | 숫자 | 레벨플레이 인스턴스 API 전송되는 인스턴스 ID | ✓ | 123658 |
| groupRate | 숫자 | 워터폴의 인스턴스 우선 순위를 지정하는 데만 사용됩니다. 0.01-3000 범위여야 합니다. Mediation management 를 참조하십시오. | x | 0.6 |
| countriesRate | 배열 | 업데이트할 countryRate 목록 | x | |
| 다음은 ‘countryRate’ 배열의 countryRate 필드입니다. | ||||
| countryCode | 문자열 | 국가 코드는 ISO 3166-1 알파-2에 해당 2자리 국가 코드로 정의됩니다. | ✓ | AU |
| 속도 | 숫자 | 워터폴의 인스턴스 우선 순위를 지정하는 데만 사용됩니다. 0.01-3000 범위여야 합니다. Mediation management 를 참조하십시오. | ✓ | 2.5 |
요청 예시
[ { "groupId": 123, "groupName": "새 그룹", "countries": ["FR","US"], "position": 1, "segments": [], "floorPrice": 0.3, "instances": [ { "id": 1, "groupRate": null, "countriesRate": [ { "countryCode": "FR", "rate": 1 } ] }, { "id": 2, "countriesRate": [ { "countryCode": "FR", "rate": 1.4 } ] } ] }]
Success
성공적인 응답은 HTTP 코드 200으로 전송됩니다.
삭제
이 API 사용하여 인스턴스 삭제합니다.
- AllCountries 그룹은 삭제할 수 없습니다.
- 삭제된 그룹은 복원할 수 없습니다.
메서드
요청 파라미터
Name | Type | 설명 | 예시 |
|---|---|---|---|
| appKey | 문자열 | 애플리케이션 키(플랫폼에서 확인 가능) | 142401ac1 |
요청 예시 URL
지원 파라미터
Name | Type | 설명 | 필수 | 예시 |
|---|---|---|---|---|
| id | 배열 개수 | GET 요청에서 전송된 그룹 ID | ✓ | 12473, 47238 |
요청 바디 예시
{ "ids": [1458, 5769]}
Success
성공적인 응답은 HTTP 코드 200으로 전송됩니다.
오류
요청에 전송된 그룹 중 하나가 실패하면 HTTP 코드 400과 함께 오류 배열 전송되며, 전체 요청이 거부됩니다.
각 오류는 다음에 오류 메시지 표시됩니다.
예시
{ "errorsArray": [ { "code": ERR-208, "errorMessage": "필수 그룹 이름 값", "params": { "[0].groupName": "" } }, { "code": ERR-311, "errorMessage": "그룹 위치 값이 유효하지 않음", "params": { "[0].position": "" } } ], "code": 400}