# 플레이스먼트 API

> 플레이스먼트 API 사용하여 광고 플레이스먼트를 생성, 검색, 업데이트 또는 삭제하여 AIR 앱 내의 플레이스먼트 구성을 관리할 수 있습니다.

이 API 사용하여 레벨플레이 계정의 광고 유닛 레벨에서 플레이스먼트를 관리할 수 있습니다. 이 API 활성화하다, 사용 가능하다 다음을 수행할 수 있습니다.

* 플레이스먼트 목록 전체 세부 정보 확인
* 새 플레이스먼트를 생성하고 플레이스먼트 광고 게재 설정을 정의합니다.
* 기존 플레이스먼트 업데이트
* 삭제(아카이브) 배치

자세한 내용은 [배치](/grow/levelplay/platform/settings/placements.md)를 참고하십시오.

> **Note:**
>
> [Bearer API 인증](/grow/levelplay/platform/api/authentication.md)을 사용하여 각 API 요청을 인증해야 합니다.

## 메서드 가져오기##get-method

### 설명##description

플레이스먼트 설정 정보 제공

### 요청##request

#### URL 요청 예시##request-url-example

\[[https://platform.ironsrc.com/partners/publisher/placements/v1/?appKey=\\](https://platform.ironsrc.com/partners/publisher/placements/v1/?appKey=\\)[REPLACE](https://platform.ironsrc.com/partners/publisher/placements/v1/?appKey=\\\[REPLACE)]

#### 요청 파라미터##request-parameters

| **Key** | **Type** | **설명**        | **값** | **필수** |
| ------- | -------- | ------------- | ----- | ------ |
| appKey  | 문자열      | 애플리케이션 고유 식별자 |       | v      |

### 응답##response

#### 응답 파라미터##response-parameters

| **Key**          | **Type** | **설명**                                 | **필수**         |
| ---------------- | -------- | -------------------------------------- | -------------- |
| adUnit           | 문자열      | ad-unit name: rewarded동영상 인터스티셜 광고 배너  | v              |
| name             | 문자열      | 플레이스먼트 고유 이름                           | v              |
| id               | 정수       | 플레이스먼트 고유 식별자                          | v              |
| adDelivery       | 정수       | 플레이스먼트 광고 전달이 켜져 있는 경우 1, 그렇지 않으면 0    | v              |
| itemName         | 문자열      | 보상 이름(최대 30자)                          | v(보상형 비디오만 해당) |
| rewardAmount     | 정수       | 단일 광고 뷰의 아이템 수(최대 20000000)            | v(보상형 비디오만 해당) |
| capping.enabled  | 정수       | 1을 활성화하다, 사용 가능하다, 그렇지 않으면 0           |                |
| capping.limit    | 정수       | 한도 간격당 게재되는 최대 광고 수(최대 1,000)          |                |
| capping.interval | 문자열      | 한도 간격: d - 일 h - 시간                    |                |
| pacing.enabled   | 정수       | 1은 pacinhg를 활성화하다, 사용 가능하다, 그렇지 않으면 0은 |                |
| pacing.minutes   | float    | 광고 게재 간 최소 간격(단위: 분) (최대 1000)         |                |

#### 응답 바디 예시##response-body-example

```jsonp
[
    {
        "name": "Home_Screen",
        "id": 12,
        "adUnit": "rewardedVideo",
        "itemName": "코인",
        "rewardAmount": 3,
        "adDelivery": 1,
        "capping": {
            "enabled": 1,
            "cappingLimit": 3,
            "cappingInterval": "h"
        },
        "pacing": {
            "enabled": 1,
            "pacingMinutes": 12.5
        },
        "abVersion": "A"
    }
]
```

## 포스트 메서드##post-method

이 메서드를 사용하여 애플리케이션 계정에 새로운 플레이스먼트를 생성합니다(제한 및 속도 설정 포함).

플레이스먼트는 광고 유닛 유형별로 생성되며, 각 플레이스먼트는 광고 유닛당 1개만 추가할 수 있습니다. 다음 광고 유닛에서 API 지원 생성:

보상형 동영상

* 인터스티셜 광고

* Banner

* 플레이스먼트 이름은 광고 유닛 유형별로 고유해야 합니다.

* 단일 POST 호출 멀티 플레이스먼트 생성이 지원됩니다.

* 그에 대한 응답으로 placementId를 받게 됩니다. 이 파라미터 Ironsource 플랫폼에 표시되지 않습니다. PUT 및 DELETE 메서드에 이 파라미터 사용해야 합니다.

### 요청##request

#### 요청 바디 파라미터##request-body-parameters

| **Key**                            | **Type** | **설명**                                     | **필수**         |
| ---------------------------------- | -------- | ------------------------------------------ | -------------- |
| appKey                             | 문자열      | 의 플레이스먼트를 생성하기 위한 애플리케이션 키                 | v              |
| 플레이스먼트                             | 배열       | 생성할 플레이스먼트 목록                              | v              |
| **다음은 ‘placements’ 배열의 배치 필드입니다.** |          |                                            |                |
| adUnit                             | 문자열      | ad-unit name: rewarded동영상 인터스티셜 광고 배너      | v              |
| name                               | 문자열      | 플레이스먼트 고유 이름                               | v              |
| adDelivery                         | bolean   | 플레이스먼트 광고 전달이 켜져 있는 경우 1, 그렇지 않으면 0(기본값 1) |                |
| itemName                           | 문자열      | 보상 이름(최대 30자)                              | v(보상형 비디오만 해당) |
| rewardAmount                       | 정수       | 단일 광고 뷰의 아이템 수(최대 20000000)                | v(보상형 비디오만 해당) |
| capping.enabled                    | 정수       | 1을 활성화하다, 사용 가능하다, 그렇지 않으면 0               |                |
| capping.limit                      | 정수       | 한도 간격당 게재되는 최대 광고 수(최대 1,000)              |                |
| capping.interval                   | 문자열      | 한도 간격: d - 일 h - 시간                        |                |
| pacing.enabled                     | 정수       | 1은 pacinhg를 활성화하다, 사용 가능하다, 그렇지 않으면 0은     |                |
| pacing.minutes                     | float    | 광고 게재 간 최소 간격(단위: 분) (최대 1000)             |                |

#### 요청 바디 예시##request-body-example

```json
{
  "appKey": "28cd2e39",
  "placements": [
    {
      "adUnit": "rewardedVideo", // rewardedVideo / interstitial / banner
      "name": "Main_Menu", // 고유 플레이스먼트 이름
      "itemName": "코인", // 보상형 광고 항목 이름
      "rewardAmount": 25, // 광고 조회당 제공할 보상 금액
      "capping": {
        	"enabled": 1, // 1 - 제한을 활성화하다, 사용 가능하다, 그렇지 않으면 0 (기본값: 1)
		"cappingLimit": 3, // cappingInterval당 광고 수 제한
		"cappingInterval": "h" // interval type. "h"-hours, "d"-days (default: “d”)
      }
    },
    {
      "adUnit": "banner",
      "name": "Custom_Pause",
      "pacing": {
      	"enabled": 0, // 1 - 활성화하다, 사용 가능하다 0(기본값: 1)
	  	"pacingMinutes": 3, // 분 단위의 페이싱 간격
      }
    }
  ]
}

```

### 응답##response

성공적인 응답에는 새로 생성된 플레이스먼트 식별자 포함됩니다. 이 파라미터 Ironsource 플랫폼에 표시되지 않으며 GET 메서드를 사용하여 가져올 수 있습니다. 플레이스먼트를 수정/삭제할 때 ID를 사용해야 합니다.

#### 응답 파라미터##response-parameters

| **Key** | **Type** | **설명**         | **값**               | **필수** |
| ------- | -------- | -------------- | ------------------- | ------ |
| appKey  | 문자열      | 애플리케이션 고유 식별자  |                     | v      |
| adUnit  | 문자열      | 광고 유닛 이름       | 보상형 비디오 인터스티셜 광고 배너 | v      |
| name    | 문자열      | 플레이스먼트의 이름입니다. | 최대 30자              | v      |
| id      | 문자열      | 플레이스먼트 ID      |                     |        |

#### 응답 바디 예시##response-body-example

```json
{
    "appKey": "28cd2e39",
    "placements": [
        {
            "adUnit": "rewardedVideo",
            "id": 2, // 플레이스먼트의 고유 ID
            "name": "Main_Menu"
        },
        {
            "adUnit": "banner",
            "id": 4,
            "name": "Custom_Pause"
        }
    ]
}
```

## put 메서드##put-method

애플리케이션의 제한 및 속도를 비롯한 기존 플레이스먼트 업데이트 API 다음 광고 유닛을 지원합니다.

* 보상형 동영상
* 인터스티셜 광고
* Banner

기본 플레이스먼트 광고 게재는 꺼질 수 없습니다.

캡핑/패싱을 활성화하다, 사용 가능하다 금액 필드 제공해야 합니다.

### 요청##request

#### URL 요청 예시##request-url-example

`https://dev-php-ssp5.supersonicads.com/partners/publisher/placements/v1?appKey=132deb27d`

#### 요청 바디 파라미터##request-body-parameters

| **Key**                           | **Type** | **설명**                                 | **필수** |
| --------------------------------- | -------- | -------------------------------------- | ------ |
| appKey                            | 문자열      | 의 플레이스먼트를 업데이트하기 위한 애플리케이션 키           | v      |
| 플레이스먼트                            | 배열       | 업데이트할 플레이스먼트 목록                        | v      |
| 다음은 ‘placements’ 배열 플레이스먼트 필드입니다. |          |                                        |        |
| adUnit                            | 문자열      | ad-unit name: rewarded동영상 인터스티셜 광고 배너  | v      |
| id                                | 정수       | 플레이스먼트 고유 ID                           | v      |
| adDelivery                        | 정수       | 플레이스먼트 광고 전달이 켜져 있는 경우 1, 그렇지 않으면 0    |        |
| itemName                          | 문자열      | 보상 이름(최대 30자)                          |        |
| rewardAmount                      | 정수       | 단일 광고 뷰의 아이템 수(최대 20000000)            |        |
| capping.enabled                   | 정수       | 1을 활성화하다, 사용 가능하다, 그렇지 않으면 0           |        |
| capping.limit                     | 정수       | 한도 간격당 게재되는 최대 광고 수(최대 1,000)          |        |
| capping.interval                  | 문자열      | 한도 간격: d - 일 h - 시간                    |        |
| pacing.enabled                    | 정수       | 1은 pacinhg를 활성화하다, 사용 가능하다, 그렇지 않으면 0은 |        |
| pacing.minutes                    | float    | 광고 게재 간 최소 간격(단위: 분) (최대 1000)         |        |

#### 요청 바디 예시##request-body-example

```json
{
    "appKey": "28cd2e39",
    "placements": [
        {
            "adUnit": "rewardedVideo", // rewardedVideo / interstitial / banner
            "id": 1, // 고유 플레이스먼트 ID
            "rewardAmount": 25, // 제공할 보상 금액 변경
            "adDelivery": 1, // 광고 전송 토글, 1 - 활성화, 그렇지 않으면 0
            "capping": {
                "cappingInterval": "h" // 한도 간격을 시간으로 업데이트
            }
        },
        {
            "adUnit": "interstitial",
            "id": 3,
            "pacing": {
                "enabled": 1, // 1 - 활성화하다, 사용 가능하다, 그렇지 않으면 0
                "pacingMinutes": 15, // 분 단위의 페이싱 간격
            }
        }
    ]
}
```

### 응답##response

업데이트가 성공하면 HTTP 코드 "200"이 메시지 "true"로 응답됩니다.

## 메서드 삭제##delete-method

API는 다음 광고 유닛을 지원합니다.

* 보상형 동영상
* 인터스티셜 광고
* Banner

> **Note:**
>
> 기본 플레이스먼트를 아카이브할 수 없습니다.

### 요청##request

#### 요청 바디 파라미터##request-body-parameters

| **Key** | **Type** | **설명**                                | **필수** |
| ------- | -------- | ------------------------------------- | ------ |
| appKey  | 문자열      | 의 플레이스먼트를 아카이브 애플리케이션 키               | v      |
| adUnit  | 문자열      | ad-unit name: rewarded동영상 인터스티셜 광고 배너 | v      |
| id      | 정수       | 플레이스먼트 고유 ID                          | v      |

#### 요청 바디 예시##request-body-example

```json
{
    "appKey": "28cd2e39",
    "adUnit": "rewardedVideo", // rewardedVideo / interstitial / banner
    "id": 1 // 고유 플레이스먼트 ID
}
```

### 응답##response

업데이트가 성공하면 HTTP 코드 "200"이 메시지 "true"로 응답됩니다.
