REST Resource: advertisers.insertionOrders

리소스: InsertionOrder

단일 게재 신청서

JSON 표현 
{
  "name": string,
  "advertiserId": string,
  "campaignId": string,
  "insertionOrderId": string,
  "displayName": string,
  "insertionOrderType": enum (InsertionOrderType),
  "entityStatus": enum (EntityStatus),
  "updateTime": string,
  "partnerCosts": [
    {
      object (PartnerCost)
    }
  ],
  "pacing": {
    object (Pacing)
  },
  "frequencyCap": {
    object (FrequencyCap)
  },
  "integrationDetails": {
    object (IntegrationDetails)
  },
  "performanceGoal": {
    object (PerformanceGoal)
  },
  "budget": {
    object (InsertionOrderBudget)
  },
  "bidStrategy": {
    object (BiddingStrategy)
  },
  "reservationType": enum (ReservationType),
  "billableOutcome": enum (BillableOutcome)
}
필드
name

string

출력 전용입니다. 게재 신청서의 리소스 이름입니다.
advertiserId

string (int64 format)

출력 전용입니다. 게재 신청서가 속한 광고주의 고유 ID입니다.
campaignId

string (int64 format)

필수 항목입니다. 변경할 수 없습니다. 게재 신청서가 속한 캠페인의 고유 ID입니다.
insertionOrderId

string (int64 format)

출력 전용입니다. 게재 신청서의 고유 ID입니다. 시스템에서 할당합니다.
displayName

string

필수 항목입니다. 게재 신청서의 표시 이름입니다.

최대 240바이트의 UTF-8로 인코딩되어야 합니다.
insertionOrderType

enum (InsertionOrderType)

게재 신청서의 유형입니다.

생성 시 이 필드를 지정하지 않으면 기본값은 RTB입니다.
entityStatus

enum (EntityStatus)

필수 항목입니다. 게재 신청서가 인벤토리에 예산을 지출하고 입찰할 수 있는지 여부를 제어합니다.

  • insertionOrders.create 메서드의 경우 ENTITY_STATUS_DRAFT만 허용됩니다. 게재 신청서를 활성화하려면 insertionOrders.patch 메서드를 사용하고 생성 후 상태를 ENTITY_STATUS_ACTIVE로 업데이트합니다.
  • 게재 신청서는 다른 상태에서 ENTITY_STATUS_DRAFT 상태로 다시 변경할 수 없습니다.
  • 상위 캠페인이 활성 상태가 아니면 게재 신청서를 ENTITY_STATUS_ACTIVE로 설정할 수 없습니다.
updateTime

string (Timestamp format)

출력 전용입니다. 게재 신청서가 마지막으로 업데이트된 시점의 타임스탬프입니다. 시스템에서 할당합니다.

RFC3339 UTC 'Zulu' 형식의 타임스탬프입니다(나노초 단위, 소수점 이하 9자리). 예를 들면 "2014-10-02T15:01:23Z" 및 "2014-10-02T15:01:23.045123456Z"입니다.
partnerCosts[]

object (PartnerCost)

게재 신청서와 관련된 파트너 비용입니다.

insertionOrders.create 메서드에 없거나 비어 있는 경우 새로 만든 게재 신청서가 파트너 설정에서 파트너 비용을 상속합니다.
pacing

object (Pacing)

필수 항목입니다. 게재 신청서의 예산 지출 속도 설정입니다.
frequencyCap

object (FrequencyCap)

필수 항목입니다. 게재 신청서의 최대 게재빈도 설정입니다.
integrationDetails

object (IntegrationDetails)

게재 신청서의 추가 통합 세부정보입니다.
performanceGoal

object (PerformanceGoal)

필수 항목입니다. 게재 신청서의 실적 목표입니다.
budget

object (InsertionOrderBudget)

필수 항목입니다. 게재 신청서의 예산 할당 설정입니다.
bidStrategy

object (BiddingStrategy)

게재 신청서의 입찰 전략입니다. 기본적으로 fixedBid가 설정되어 있습니다.
reservationType

enum (ReservationType)

출력 전용입니다. 게재 신청서의 예약 유형입니다.
billableOutcome

enum (BillableOutcome)

변경할 수 없습니다. 게재 신청서의 청구 가능 결과입니다.

결과 기반 구매는 지원 중단되었습니다. 유효한 값은 BILLABLE_OUTCOME_PAY_PER_IMPRESSION뿐입니다.

InsertionOrderType

게재 신청서의 가능한 유형입니다.

게재 신청서의 유형에 따라 광고 형식 또는 타겟팅 옵션과 같은 적용 가능한 설정과 옵션이 달라집니다.

열거형
INSERTION_ORDER_TYPE_UNSPECIFIED 게재 신청서 유형이 지정되지 않았거나 알 수 없습니다.
RTB 실시간 입찰.
OVER_THE_TOP 오버더톱

InsertionOrderBudget

게재 신청서 예산을 할당하는 방법을 제어하는 설정입니다.

JSON 표현 
{
  "budgetUnit": enum (BudgetUnit),
  "automationType": enum (InsertionOrderAutomationType),
  "budgetSegments": [
    {
      object (InsertionOrderBudgetSegment)
    }
  ]
}
필드
budgetUnit

enum (BudgetUnit)

필수 항목입니다. 변경할 수 없습니다. 예산 단위는 예산이 통화 기반인지 노출 기반인지를 지정합니다.
automationType

enum (InsertionOrderAutomationType)

게재 신청서의 입찰가 및 예산을 관리하는 데 사용되는 자동화 유형입니다.

생성 시 이 필드를 지정하지 않으면 기본값은 INSERTION_ORDER_AUTOMATION_TYPE_NONE입니다.
budgetSegments[]

object (InsertionOrderBudgetSegment)

필수 항목입니다. 예산 세그먼트 목록입니다. 예산 세그먼트를 사용하여 게재 신청서가 실행되는 특정 기간에 대한 특정 예산을 지정합니다.

InsertionOrderAutomationType

게재 신청서 입찰가 및 예산을 자동화하는 데 가능한 옵션입니다.

열거형
INSERTION_ORDER_AUTOMATION_TYPE_UNSPECIFIED 이 버전에서 게재 신청 자동화 옵션이 지정되지 않았거나 알 수 없습니다.
INSERTION_ORDER_AUTOMATION_TYPE_BUDGET 자동 예산 할당 시스템이 소유 광고 항목으로 예산을 자동으로 전환하여 performanceGoal로 정의된 실적을 최적화하도록 허용합니다. 입찰가 설정에 자동화 기능이 없습니다.
INSERTION_ORDER_AUTOMATION_TYPE_NONE 게재 신청서 수준에서는 입찰 또는 예산을 자동화하지 않습니다. 입찰가 및 예산은 광고 항목 수준에서 수동으로 구성해야 합니다.
INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET 시스템이 입찰가를 자동으로 조정하고 소유 광고 항목으로 예산을 전환하여 performanceGoal로 정의된 실적을 최적화하도록 허용합니다.

InsertionOrderBudgetSegment

단일 예산 세그먼트의 예산을 관리하는 설정입니다.

JSON 표현 
{
  "budgetAmountMicros": string,
  "description": string,
  "dateRange": {
    object (DateRange)
  },
  "campaignBudgetId": string
}
필드
budgetAmountMicros

string (int64 format)

필수 항목입니다. 게재 신청서에서 지정된 dateRange에 지출할 예산 금액입니다. 금액은 마이크로 단위입니다. 0보다 커야 합니다. 예를 들어 500000000은 통화의 표준 단위 500개를 나타냅니다.
description

string

예산 세그먼트 설명입니다. 각 예산 세그먼트의 구매주문서 정보를 입력하고 인보이스에 해당 정보를 인쇄하는 데 사용할 수 있습니다.

UTF-8로 인코딩되어야 합니다.
dateRange

object (DateRange)

필수 항목입니다. 예산 세그먼트의 시작일 및 종료일 설정입니다. 상위 광고주의 시간대를 기준으로 확인됩니다.

  • 새 예산 세그먼트를 만들 때는 startDate와 endDate가 모두 미래여야 합니다.
  • 이전에 startDate이 있었던 기존 예산 세그먼트에는 변경 가능한 endDate와 변경할 수 없는 startDate가 있습니다.
  • endDate는 2037년 이전의 startDate 이상이어야 합니다.
campaignBudgetId

string (int64 format)

이 게재 신청서 예산 세그먼트가 속한 캠페인 예산의 budgetId입니다.

BillableOutcome

게재 신청서에 대해 청구 가능한 결과입니다.

열거형
BILLABLE_OUTCOME_UNSPECIFIED 지정되지 않은 청구 가능 결과입니다.
BILLABLE_OUTCOME_PAY_PER_IMPRESSION 노출당 지불
BILLABLE_OUTCOME_PAY_PER_CLICK

클릭당 비용
BILLABLE_OUTCOME_PAY_PER_VIEWABLE_IMPRESSION

Active View당 비용을 지불합니다.

메서드

create

 새 게재 신청서를 만듭니다.

delete

 게재 신청서를 삭제합니다.

get

 게재 신청서를 가져옵니다.

list

 광고주의 게재 신청서를 나열합니다.

listAssignedTargetingOptions

 타겟팅 유형 전반에 걸쳐 게재 신청서에 할당된 타겟팅 옵션을 나열합니다.

patch

 기존 게재 신청서를 업데이트합니다.