하우스 캠페인 수정

PUT

/api/core/organization/{organizationId}/house-campaign/{campaignId}

const url = 'https://www.easterad.com/api/core/organization/example/house-campaign/example';
const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"budget":1,"name":"example","endAt":"example","targeting":{"platforms":["APP_PLATFORM_ANDROID"],"devices":["DEVICE_TYPE_MOBILE_TABLET"],"tags":["example"],"locations":["example"],"languages":["example"],"inventoryTargets":[{"organizationId":"example"}]},"btags":["example"]}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request PUT \
  --url https://www.easterad.com/api/core/organization/example/house-campaign/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "budget": 1, "name": "example", "endAt": "example", "targeting": { "platforms": [ "APP_PLATFORM_ANDROID" ], "devices": [ "DEVICE_TYPE_MOBILE_TABLET" ], "tags": [ "example" ], "locations": [ "example" ], "languages": [ "example" ], "inventoryTargets": [ { "organizationId": "example" } ] }, "btags": [ "example" ] }'

Authorizations

bearerAuth

Parameters

Path Parameters

organizationId

required

string

campaignId

required

string

Request Body^required

application/json

object

budget

number

>= 1

name

required

string

>= 1 characters <= 40 characters

endAt

string

/^[0-9]{4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12][0-9]|3[01])T(?:[01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](?:\.[0-9]{1,9})?(?:Z|[+-](?:[01][0-9]|2[0-3]):[0-5][0-9])$/

targeting

required

object

platforms

required

Array

devices

required

Array

tags

required

Array<string>

locations

required

Array<string>

languages

required

Array<string>

inventoryTargets

required

Array

Any of:

object
object

object

organizationId

required

string

/^[0-9a-fA-F]{24}$/

btags

required

Array<string>

Responses

200

성공

application/json

object

campaign

required

object

advertiser

required

string

_id

required

string

status

required

Any of:

string

Allowed value: CAMPAIGN_STATUS_PENDING

budgetRemain

required

number

name

required

string

>= 1 characters <= 40 characters

startAt

required

string

/^[0-9]{4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12][0-9]|3[01])T(?:[01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](?:\.[0-9]{1,9})?(?:Z|[+-](?:[01][0-9]|2[0-3]):[0-5][0-9])$/

endAt

string

/^[0-9]{4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12][0-9]|3[01])T(?:[01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](?:\.[0-9]{1,9})?(?:Z|[+-](?:[01][0-9]|2[0-3]):[0-5][0-9])$/

cur

required

Any of:

string
string

string

Allowed value: CURRENCY_KRW

budget

required

number

targeting

required

object

platforms

required

Array

devices

required

Array

tags

required

Array<string>

locations

required

Array<string>

languages

required

Array<string>

inventoryTargets

required

Array

Any of:

object
object

object

organizationId

required

string

/^[0-9a-fA-F]{24}$/

btags

required

Array<string>

ads

required

Array<object>

object

_id

required

string

cur

required

Any of:

string
string

string

Allowed value: CURRENCY_KRW

name

required

string

>= 1 characters <= 40 characters

categories

required

Array<string>

cpm

number

productType

required

Any of:

string

Allowed value: AD_PRODUCT_TYPE_INTRINSIC

creatives

required

Array

>= 1 items

Any of:

object
object

object

_id

required

string

image

required

object

width

required

number

>= 1

height

required

number

>= 1

mime

required

string

>= 1 characters <= 20 characters

aspectRatio

required

number

> 0

url

required

string

/^https?://(?:[^\s/:?#]+|\[[0-9A-Fa-f:.]+\])(?::\d{1,5})?(?:[/?#][^\s]*)?$/

destinationUrl

string

/^https?://(?:[^\s/:?#]+|\[[0-9A-Fa-f:.]+\])(?::\d{1,5})?(?:[/?#][^\s]*)?$/

promotedAppId

string

/^[0-9a-fA-F]{24}$/

createdAt

required

string

/^[0-9]{4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12][0-9]|3[01])T(?:[01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](?:\.[0-9]{1,9})?(?:Z|[+-](?:[01][0-9]|2[0-3]):[0-5][0-9])$/

updatedAt

required

string

/^[0-9]{4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12][0-9]|3[01])T(?:[01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](?:\.[0-9]{1,9})?(?:Z|[+-](?:[01][0-9]|2[0-3]):[0-5][0-9])$/

servingEligibility

required

object

status

required

Any of:

string

Allowed value: HOUSE_CAMPAIGN_SERVING_ELIGIBILITY_STATUS_ELIGIBLE

issues

required

Array<object>

object

reason

required

Any of:

string
string

string

Allowed value: HOUSE_CAMPAIGN_SERVING_ISSUE_REASON_APP_OWNERSHIP_MISMATCH

inventoryTarget

required

Any of:

object
object

object

organizationId

required

string

/^[0-9a-fA-F]{24}$/

productType

Any of:

string

Allowed value: AD_PRODUCT_TYPE_INTRINSIC

crossPromotionId

string

/^[0-9a-fA-F]{24}$/

promotedAppId

string

/^[0-9a-fA-F]{24}$/

Example

{
  "campaign": {
    "status": "CAMPAIGN_STATUS_PENDING",
    "cur": "CURRENCY_KRW",
    "targeting": {
      "platforms": [
        "APP_PLATFORM_ANDROID"
      ],
      "devices": [
        "DEVICE_TYPE_MOBILE_TABLET"
      ]
    },
    "ads": [
      {
        "cur": "CURRENCY_KRW",
        "productType": "AD_PRODUCT_TYPE_INTRINSIC"
      }
    ]
  },
  "servingEligibility": {
    "status": "HOUSE_CAMPAIGN_SERVING_ELIGIBILITY_STATUS_ELIGIBLE",
    "issues": [
      {
        "reason": "HOUSE_CAMPAIGN_SERVING_ISSUE_REASON_APP_OWNERSHIP_MISMATCH",
        "productType": "AD_PRODUCT_TYPE_INTRINSIC"
      }
    ]
  }
}

default

오류 — 공통 오류 응답. 인증 단계 오류 코드는 문서의 “인증” 페이지를 참조.

application/json

object

statusCode

required

number

code

required

string

message

required

string

reason

선택 상세 사유. 예: CREATIVE_NOT_READY

string

assetId

Example^generated

{
  "statusCode": 1,
  "code": "example",
  "message": "example",
  "reason": "example",
  "assetId": "example"
}

하우스 캠페인 수정

Authorizations

Parameters

Path Parameters

Request Bodyrequired

Responses

200

Example

default

Examplegenerated

Request Body^required

Example^generated