인스턴스 API v4
인스턴스 API v4를 통해 레벨플레이 광고 네트워크 인스턴스를 프로그래밍 방식으로 검색, 생성, 업데이트 또는 삭제하여 앱 Mediation 인스턴스를 관리할 수 있습니다.
읽는 시간 10분최근 업데이트: 9시간 전
인스턴스 API 사용하여 레벨플레이 대시보드에서 인스턴스를 관리합니다. 이 API 버전은 다음을 지원합니다.
- CRUD 지원
- 광고 네트워크의 애플리케이션 레벨 구성 변경
- 워터폴 그룹에서 인스턴스 추가 또는 제거(활성 AB 테스트 애플리케이션 지원)
요청은 호출 1개 애플리케이션 제한됩니다.
속도 제한
API 요청이 30분 동안 4000개를 초과하면 429 HTTP 상태 코드를 반환합니다.
인증 유형
GET
설명
모든 애플리케이션 인스턴스, 입찰 및 비입찰 목록을 가져옵니다.
메서드
요청 파라미터
Name | Type | 설명 | 예시 |
|---|---|---|---|
| appKey | 문자열 | 애플리케이션 키(플랫폼에서 확인 가능) | 142401ac1 |
요청 예시 URL
응답 파라미터
Name | 설명 | 예시 |
|---|---|---|
| instanceId | 고유 인스턴스 ID | 1072562 |
| instanceName | 인스턴스 이름 | Rewarded50 |
| adUnit | 인스턴스 광고 유닛 유형(보상형 비디오, 인터스티셜 광고 또는 배너 | 배너 |
| adFormat | 보상형 광고, 인터스티셜 광고, 배너 광고 또는 네이티브 광고 | 인터스티셜 광고 |
| networkName | 인스턴스 속한 광고 네트워크 | adColony |
| appConfig1 / appConfig2 | ||
| instanceConfig1 / instanceConfig2 | 각 구성 필드 대해 전송되어야 합니다. | |
| isBidder | 입찰자 인스턴스 인스턴스(true 또는 false) | true |
| 그룹 | 레벨플레이 그룹 API 전송되는 그룹 ID 배열 | 2515, 6226 |
| isLive | 인스턴스 상태는 활성 상태일 수도 있고 비활성 상태일 수도 있습니다. | ‘false' |
| 속도 | 인스턴스 레벨 속도(정의된 경우) | 15 |
응답 예시
[ { "instanceId": 1072562, "instanceName": "", "adUnit": "rewardedVideo", "adFormat": "rewarded", "networkName": "unityAds", "appConfig1": "qtr", "instanceConfig1": "trb", "isBidder": true, "groups": [101663], "isLive": true }, { "instanceId": 1014428, "instanceName": "기본값", "adUnit": "interstitial", "adFormat": "interstitial", "networkName": "unityAds", "appConfig1": "qertb", "instanceConfig1": "qtrb", "isBidder": false, "groups": [101664], "isLive": true, "rate": 25 }, { "instanceId": 1845809, "instanceName": "기본값", "adUnit": "rewardedVideo", "adFormat": "rewarded", "networkName": "adManager", "appConfig1": "bqw", "instanceConfig1": "qqr", "isBidder": false, "groups": [101663 ], "isLive": true, "rate": 4 }]
생성
이 API 사용하여 Mediation 기반 광고 소스의 인스턴스를 생성합니다. 이 API 사용하면 단일 API 호출 여러 인스턴스를 생성할 수 있습니다. API 사용하여 인스턴스를 생성할 때는 플랫폼이 허용하는 인스턴스 수로 제한됩니다.
"groups" 파라미터 사용하여 인스턴스 포함/제외할 각 워터폴 그룹을 결정합니다.
- 'status' 파라미터 세트 없이 생성된 인스턴스는 자동으로 'active'로 설정됩니다.
- 스토어에 라이브 상태가 아닌 앱 대해 생성된 인스턴스는 자동으로 ‘비활성화’로 설정됩니다.
- 동일한 광고 네트워크가 있는 인스턴스의 경우 애플리케이션 설정 값이 동일해야 합니다.
- 커스텀 네트워크 인스턴스 생성에는 'networkKey' 파라미터 필요합니다. 네트워크 기술 자료에서 확인할 수 있습니다.
메서드
요청 파라미터
Name | Type | 설명 | 예시 |
|---|---|---|---|
| appKey | 문자열 | 애플리케이션 키(플랫폼에서 확인 가능) | 142401ac1 |
요청 예시 URL
지원 파라미터
Name | Type | 설명 | 필수 | 예시 |
|---|---|---|---|---|
| instanceName | 문자열 | 새로 생성된 인스턴스 이름 | ✓ - 입찰하지 않는 인스턴스의 경우 | highestBidderinstance |
| networkName | 문자열 | ✓ | adColony | |
| adFormat | 문자열 | 보상형 광고, 인터스티셜 광고, 배너 광고 또는 네이티브 광고 | ✓ | 인터스티셜 광고 |
| isBidder | 부울 | 인스턴스 입찰자 인스턴스 여부를 나타냅니다. | ✓ | true/false |
| appConfig1 | 문자열 | x | ‘123' / ‘abc' | |
| appConfig2 | 문자열 | x | ‘123' / ‘abc' | |
| instanceConfig1 | 문자열 | x | ‘123' / ‘abc' | |
| instanceConfig2 | 문자열 | x | ‘123' / ‘abc' | |
| 그룹 | 수 배열 | 전송되지 않은 경우 ‘모든 그룹’으로 간주합니다. A/B 테스트 중에 있는 경우 ‘A’ 및 ‘B’ 그룹 모두에 groupIds를 전송하는 것이 좋습니다. | x | 12525 |
| isLive | 부울 | 인스턴스 활성화하거나 비활성화합니다. 전송되지 않은 경우 가 액티브로 간주됩니다. | x | true/false |
| 속도 | 숫자 | 0.01-3000 사이 | x | 5 |
요청 예시
[ { "instanceName": "newInstance", "networkName": "unityAds", "adUnit": "rewardedVideo", "isBidder": true, "appConfig1": "414n", "instanceConfig1": "aaa1", "instanceConfig2": "aaa1", "groups": [12345], "isLive": true }, { "instanceName": "newInstance_2", "networkName": "unityAds", "adFormat": "rewarded", "isBidder": false, "appConfig1": "414n", "instanceConfig1": "bbb1", "groups": [12345], "isLive": true, "rate": 5 }]
업데이트
이 API 사용하여 인스턴스를 업데이트합니다. 단일 API 호출 여러 인스턴스를 업데이트할 수 있습니다.
인스턴스 레벨 속도를 제거하려면 속도 파라미터 'null' 값으로 추가합니다.
메서드
요청 파라미터
Name | Type | 설명 | 예시 |
|---|---|---|---|
| appKey | 문자열 | 애플리케이션 키(플랫폼에서 확인 가능) | 142401ac1 |
요청 예시 URL
지원 파라미터
Name | Type | 설명 | 필수 | 예시 |
|---|---|---|---|---|
| instanceId | 숫자 | GET 요청에서 전송된 인스턴스 ID | ✓ | |
| instanceName | 문자열 | 새로 생성된 인스턴스 이름 | x | highestBidderinstance |
| appConfig1 | 문자열 | x | ‘123' / ‘abc' | |
| appConfig2 | 문자열 | x | ‘123' / ‘abc' | |
| instanceConfig1 | 문자열 | x | ‘123' / ‘abc' | |
| instanceConfig2 | 문자열 | x | ‘123' / ‘abc' | |
| 그룹 | 수 배열 | 전송되지 않은 경우, ‘모든 그룹’으로 간주됩니다. | x | 12525 |
| isLive | 부울 | 활성 상태 또는 비활성 상태. 전송되지 않은 경우 가 액티브로 간주됩니다. | x | true |
| 속도 | 숫자 | 0.01-3000 사이 | x | 100 |
요청 예시
[ { "instanceId": 122, "instanceName": "newInstance", "appConfig1": "414n", "instanceConfig1": "aaa1", "instanceConfig2": "aaa1", "groups": [1], "isLive": true, "rate": 2 }]
삭제
이 API 사용하여 인스턴스 삭제합니다.
- 기본 인스턴스는 삭제할 수 없습니다.
- 삭제된 인스턴스는 복원할 수 없습니다.
메서드
요청된 파라미터
Name | Type | 설명 | 예시 |
|---|---|---|---|
| appKey | 문자열 | 애플리케이션 키(플랫폼에서 확인 가능) | 142401ac1 |
요청 예시 URL
지원 파라미터
Name | Type | 설명 | 필수 | 예시 |
|---|---|---|---|---|
| id | 배열 개수 | GET 요청에서 전송된 인스턴스 ID | ✓ | 1458, 5769 |
요청 바디 예시
{ "ids": [1458, 5769]}
Success
성공적인 응답은 HTTP 코드 200으로 전송됩니다.
오류
요청에 전송된 인스턴스 중 하나가 실패하면 HTTP 코드 400과 함께 오류 배열 전송되며, 전체 요청이 거부됩니다.
각 오류는 다음에 오류 메시지 표시됩니다.
예시
{ "errorsArray": [ { "code": ERR-402, "errorMessage": "인스턴스 이름은 동일한 광고 형식과 네트워크에 대해 고유해야 합니다." "params": { "instanceName": "abc" } } ], "code": 400}
API v3(이전 버전)
인스턴스 API v3는 라이브 A/B 테스트 중에 앱 지원하지 않습니다.
인스턴스 가져오기
설명
이 API 사용하여 애플리케이션 모든 인스턴스 목록을 가져옵니다. 응답에는 애플리케이션 목록 API의 모든 정보와 인스턴스 이름, 인스턴스 ID, 상태 및 해당하는 경우의 가격이 포함됩니다. 가격은 Ironsource 네트워크 인스턴스에만 적용됩니다.
인증 유형
메서드
GET platform.ironsrc.com/partners/publisher/instances/v3?
필수 파라미터
Name | Type | 설명 |
|---|---|---|
| appKey | 문자열 | 애플리케이션 키(플랫폼에서 확인 가능) |
요청 예시 URL
응답 파라미터
Name | 설명 |
|---|---|
| appKey | 애플리케이션 키(플랫폼에서 확인 가능) |
| appName | 애플리케이션 이름 |
| appStatus | 애플리케이션 상태 |
| platform | 플랫폼은 iOS 또는 Android입니다. |
| bundleId | 네이티브 앱 스토어 번들 ID |
| creationDate | 앱이 Ironsource 플랫폼에 추가된 날짜 |
| id | 인스턴스 생성 시 Ironsource 플랫폼에서 생성한 고유 인스턴스 ID |
| 공급자 인스턴스 레벨 구성* | |
| name | 인스턴스 이름 |
| status | 인스턴스 상태가 활성 상태일 수도 있고 비활성 상태일 수도 있습니다. |
| 속도 | 인스턴스 레벨 속도(정의된 경우) |
| 가격 | Ironsource 네트워크용 플랫폼에서 설정된 가격 |
| abversion | A/B 테스트 버전(선택값: "A", "B", "N/A") |
JSON 예제 응답
{ "appKey": "aa2209b1d", "appName": "내 테스트 앱", "appStatus": "active", "platform": "Android", "bundleId": "com.test.app", "creationDate": "N/A", "adUnits": { "rewardedVideo": { "activeNetworks": [ "ironSource", "AdColony" ], "activeBidderNetworks": [ "" ], "networkInstances": { "ironSource": [ { "id": 0, "name": "기본값", "status": "active", "pricing": [ { "eCPM": "10.5", "Countries": [ "FR", "UK" ] } ], "abVersion": "N/A" } ], "AdColony": [ { "id": 0, "zoneId": "zone_ID_US_High", "name": "US_high", "status": "active", "rate": 87, "abVersion": "N/A" }, { "id": 2851429, "zoneId": "zone_ID_US_Low", "name": "US_Low", "status": "active", "rate": 12, "abVersion": "N/A" } ] }, "networkBidderInstances": [] }, "offerWall": { "activeNetworks": [ "ironSource" ] }, "interstitial": { "activeNetworks": [], "activeBidderNetworks": [], "networkInstances": { "ironSource": [ { "id": 0, "name": "기본값", "status": "inactive", "pricing": [ { "eCPM": "8.5", "Countries": [ "FR", "UK" ] } ], "abVersion": "N/A" } ] }, "networkBidderInstances": [] }, "banner": { "activeNetworks": [], "networkInstances": { "ironSource": [ { "id": 0, "name": "기본값", "status": "inactive", "abVersion": "N/A" } ] } } }}
인스턴스 생성
이 API 사용하여 Ironsource 네트워크와 미디에이션된 광고 소스 모두에 대한 인스턴스를 생성합니다. 이 API 사용하면 단일 API 호출 여러 인스턴스를 생성할 수 있습니다.
- 'status' 파라미터 세트 없이 생성된 인스턴스는 자동으로 'active'로 설정됩니다.
- 스토어에 라이브 상태가 아닌 앱 대해 생성된 인스턴스는 자동으로 '비활성화'로 설정됩니다.
- Mediation 사용자용 - 새로 생성된 각 인스턴스는 앱의 모든 Mediation 그룹에 포함됩니다.
- 각 앱은 광고 유닛당 최대 10개의 인스턴스로 제한됩니다. 이 제한을 확장하려면 지원 팀에 문의하거나 세일즈 담당자에게 문의하십시오.
- 입찰자 네트워크를 구축하려면 지원 팀에 문의하거나 세일즈 담당자에게 문의하십시오.
CPM 가격
일반
- CPM 가격 책정을 사용하면 레벨플레이 네트워크에서 예상되는 CPM 속도를 제어하고 유연하게 정의할 수 있습니다. 더 읽어보기 여기.
- CPM 가격은 특정 계정에서만 사용할 수 있습니다. CPM 가격을 활성화하려면 지원 팀에 문의하거나 세일즈 담당자에게 문의하십시오.
- 가격이 책정된 인스턴스를 사용하는 베스트 프랙티스는 베스트 프랙티스 문서를 참조하십시오.
참고
- 인스턴스에 대한 전역 가격을 설정하려면 인스턴스의 국가 필드에 별표 캐릭터 ‘*’를 입력합니다.
- 가격 책정 없이 생성된 인스턴스와 가격 책정이 정의되지 않은 국가는 최적화된 가격 책정을 사용하도록 설정됩니다.
- 국가는 ISO 3166-1 알파-2에 따라 국가 코드 2자로 정의됩니다.
인증 유형
메서드
POST platform.ironsrc.com/partners/ 퍼블리셔/instances/v3?
필수 파라미터
Name | Type | 설명 |
|---|---|---|
| appKey | 문자열 | 애플리케이션 키(플랫폼에서 확인 가능) |
| 공급자 | 문자열 배열 | |
| adUnit | 문자열 배열 | "rewardedVideo", "interstitial", "banner" |
| instanceName | 문자열 | 새로 생성된 인스턴스 이름 |
| 공급자 인스턴스 레벨 구성* | 문자열 |
선택적 파라미터
Name | Type | 설명 |
|---|---|---|
| status | 문자열 | 인스턴스 상태는 '활성' 또는 '비활성'일 수 있습니다. |
| 가격 | 문자열 배열 | Ironsource 네트워크에서 제공할 eCPM을 결정합니다. |
| 속도 | 더블 | 인스턴스 레벨 속도(정의된 경우) |
| 공급자 앱 레벨 설정* | 문자열 |
요청 예제 URL
https://platform.ironsrc.com/partners/publisher/instances/v3요청 예시 바디
{ "appKey": "d11a21a5", "configurations": { "ironSource": { "interstitial": [ { "instanceName": "low_interstitial", "status": "active", "pricing": [ { "country": [ "FR", "DE" ], "eCPM": 3 } ], "pricingType": "eCPM" }, { "instanceName": "high_interstitial", "status": "active", "pricing": [ { "country": [ "IL", "US" ], "eCPM": 20개 } ] } ] }, "adColony": { "rewardedVideo": [ { "instanceName": "adcolony_rv", "status": "active", "zoneId": 102030, "rate": 10 } ] } }}
JSON 예제 응답
{ "rewardedVideo": { "AdColony": [ { "id": 6701121, "zoneId": "102030", "name": "adcolony_rv", "status": "active", "rate": 10, "abVersion": "N/A" } ] }, "interstitial": { "ironSource": [ { "id": 0, "name": "기본값", "status": "active", "abVersion": "N/A" }, { "id": 6701117, "name": "low_interstitial", "status": "active", "abVersion": "N/A", "pricing": [ { "eCPM": 3, "Countries": [ "FR", "DE" ] } ] }, { "id": 6701119, "name": "high_interstitial", "status": "active", "abVersion": "N/A", "pricing": [ { "eCPM": 20, "Countries": [ "IL", "US" ] } ] } ], "ironSourceBidding": [ { "id": 2948695, "name": "", "status": "inactive", "abVersion": "N/A" } ] }}
인스턴스 업데이트
이 API 사용하여 아이언소스 네트워크 및 Mediation 광고 소스의 인스턴스 이름, 상태 및 가격을 업데이트합니다. 가격은 아이언소스 네트워크에서만 사용할 수 있습니다. 단일 API 호출 여러 인스턴스를 업데이트할 수 있습니다.
- 최대 업데이트 콜 수는 일별로 6개로 제한됩니다.
- 기본 인스턴스가 아닌 인스턴스를 활성화 먼저 기본 인스턴스인스턴스 ID=0)를 활성화 합니다.
- 인스턴스 가격 책정을 업데이트하면 동일한 인스턴스 대한 모든 가격 책정 값이 대체됩니다.
- 입찰자 네트워크를 업데이트하려면 지원 팀에 문의하거나 세일즈 담당자에게 도달률을 지정하십시오.
- 인스턴스 레벨 속도를 제거하려면 비어 있는 문자열 값(예: "")을 사용하여 속도 파라미터 추가합니다.
인증 유형
메서드
PUT platform.ironsrc.com/partners/ 퍼블리셔/instances/v3?
필수 파라미터
Name | Type | 설명 |
|---|---|---|
| appKey | 문자열 | 애플리케이션 키(플랫폼에서 확인 가능) |
| 공급자 | 문자열 배열 | |
| adUnit | 문자열 배열 | "rewardedVideo", "interstitial", "banner" |
| instanceId | 문자열 | 인스턴스 생성 시 Ironsource 플랫폼에서 생성한 ID |
선택적 파라미터
Name | Type | 설명 |
|---|---|---|
| name | 문자열 | 인스턴스 이름 |
| 가격 | 문자열 | Ironsource 네트워크에서 제공할 eCPM을 결정합니다. |
| status | 문자열 | 인스턴스 상태는 '활성' 또는 '비활성'일 수 있습니다. |
| 속도 | 더블 | 인스턴스 레벨 속도(정의된 경우) |
| 공급자 인스턴스 레벨 구성* | 문자열 | |
| 공급자 앱 레벨 설정* | 문자열 |
요청 예제 URL
요청 바디 예시
{ "appKey": "6bc83099", "configurations": { "ironSourceBidding": { "rewardedVideo": [ { "instanceId": 327, "status": "inactive" } ] } }}
JSON 응답 예시
{ "rewardedVideo": { "ironSource": [ { "id": 0, "name": "기본값", "status": "inactive", "abVersion": "N/A" } ], "AdColony": [ { "id": 0, "name": "default", "status": "active", "abVersion": "N/A" }, { "id": 326, "name": "lw", "status": "inactive", "rate":"2", "abVersion": "N/A" } ], "ironSourceBidding": [ { "id": 327, "name": "-", "status": "inactive", "abVersion": "N/A" } ] }, "interstitial": { "ironSource": [ { "id": 0, "name": "기본값", "status": "active", "abVersion": "N/A" } ] }, "banner": { "ironSource": [ { "id": 0, "name": "기본값", "status": "inactive", "abVersion": "N/A" } ] }}
인스턴스 삭제
설명
이 API 사용하여 인스턴스 삭제합니다.
일반 참고 사항:
- 호출 하나의 인스턴스 삭제할 수 있습니다.
- 기본 인스턴스 삭제할 수 없습니다.
- 삭제된 인스턴스 복원할 수 없습니다.
- 응답에는 삭제된 인스턴스를 제외한 앱의 모든 인스턴스가 포함됩니다.
인증 유형
메서드
삭제 platform.ironsrc.com/partners/ 퍼블리셔/instances/v3?
필수 파라미터
Name | Type | 설명 |
|---|---|---|
| appKey | 문자열 | 애플리케이션 키(플랫폼에서 확인 가능) |
| instanceId | 문자열 | 인스턴스 생성 시 Ironsource 플랫폼에서 생성한 ID |
요청 예제 URL
JSON 응답 예시
{ "rewardedVideo": { "ironSource": [ { "id": 0, "name": "기본값", "status": "active" }, { "id": 45678, "name": "thirdRVInstance", "status": "inactive" } ] }, "interstitial": { "ironSource": [ { "id": 0, "name": "기본값", "status": "active" }, { "id": 23456, "name": "secondISInstance", "status": "active", "pricing": [ { "eCPM": "0.01", "Countries": [ "FR", "UK" ] } ] } ] }, "banner": { "ironSource": [ { "id": 0, "name": "기본값", "status": "inactive" } ] }}