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)
  },
  "kpi": {
    object (Kpi)
  },
  "budget": {
    object (InsertionOrderBudget)
  },
  "bidStrategy": {
    object (BiddingStrategy)
  },
  "reservationType": enum (ReservationType),
  "optimizationObjective": enum (OptimizationObjective)
}
필드
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)

출력 전용입니다. 삽입 주문이 마지막으로 업데이트된 타임스탬프입니다. 시스템에서 할당합니다.

생성된 출력은 항상 Z-정규화되고 소수점 이하 0, 3, 6 또는 9자리인 RFC 3339를 사용합니다. 'Z' 이외의 오프셋도 허용됩니다. 예를 들면 "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" 또는 "2014-10-02T15:01:23+05:30"입니다.
partnerCosts[]

object (PartnerCost)

선택사항입니다. 삽입 주문과 관련된 파트너 비용입니다.

insertionOrders.create 메서드에 없거나 비어 있으면 새로 생성된 삽입 주문이 파트너 설정에서 파트너 비용을 상속합니다.
pacing

object (Pacing)

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

pacingType PACING_TYPE_ASAP은 pacingPeriod PACING_PERIOD_FLIGHT과 호환되지 않습니다.
frequencyCap

object (FrequencyCap)

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

object (IntegrationDetails)

선택사항입니다. 게재 신청서의 추가 통합 세부정보입니다.
kpi

object (Kpi)

필수입니다. 게재 신청서의 핵심성과지표 (KPI)입니다.

Display & Video 360 인터페이스에서는 '목표'로 표시됩니다.
budget

object (InsertionOrderBudget)

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

object (BiddingStrategy)

선택사항입니다. 게재 신청서의 입찰 전략입니다. 기본적으로 fixedBid가 설정됩니다.
reservationType

enum (ReservationType)

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

enum (OptimizationObjective)

필수입니다. 게재 신청서의 최적화 목표입니다.

InsertionOrderType

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

삽입 주문 유형에 따라 광고 형식이나 타겟팅 옵션 등 적용 가능한 설정과 옵션이 달라집니다.

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

KPI

게재 신청서의 핵심성과지표(KPI)를 제어하는 설정입니다.

JSON 표현 
{
  "kpiType": enum (KpiType),
  "kpiAlgorithmId": string,

  // Union field kpi_value can be only one of the following:
  "kpiAmountMicros": string,
  "kpiPercentageMicros": string,
  "kpiString": string
  // End of list of possible types for union field kpi_value.
}
필드
kpiType

enum (KpiType)

필수입니다. KPI 유형입니다.
kpiAlgorithmId

string (int64 format)

선택사항입니다. KPI_CUSTOM_IMPRESSION_VALUE_OVER_COST와 연결된 맞춤 입찰 알고리즘 ID입니다. 적절한 KPI를 선택하지 않으면 이 필드는 무시됩니다.
통합 필드 kpi_value. 필수입니다. KPI 값입니다. 관련 필드는 kpi_type에 해당합니다. kpi_value은 다음 중 하나일 수 있습니다.
kpiAmountMicros

string (int64 format)

목표 금액입니다(광고주 통화의 마이크로 단위).

kpiType이 다음 중 하나인 경우에 적용됩니다.

  • KPI_TYPE_CPM
  • KPI_TYPE_CPC
  • KPI_TYPE_CPA
  • KPI_TYPE_CPIAVC
  • KPI_TYPE_VCPM

예: 1500000은 통화의 표준 단위 1.5를 나타냅니다.
kpiPercentageMicros

string (int64 format)

목표 비율의 10진수 표현(마이크로 단위)입니다.

kpiType이 다음 중 하나인 경우에 적용됩니다.

  • KPI_TYPE_CTR
  • KPI_TYPE_VIEWABILITY
  • KPI_TYPE_CLICK_CVR
  • KPI_TYPE_IMPRESSION_CVR
  • KPI_TYPE_VTR
  • KPI_TYPE_AUDIO_COMPLETION_RATE
  • KPI_TYPE_VIDEO_COMPLETION_RATE

예: 70000은 7% (십진수 0.07)을 나타냅니다.
kpiString

string

KPI 문자열입니다. 비어 있을 수 있습니다. 길이가 100자(영문 기준) 이하인 UTF-8로 인코딩되어야 합니다.

kpiType이 KPI_TYPE_OTHER인 경우에 적용됩니다.

KpiType

가능한 핵심성과지표 (KPI) 유형입니다.

열거형
KPI_TYPE_UNSPECIFIED 이 버전에서 KPI 유형이 지정되지 않았거나 알 수 없습니다.
KPI_TYPE_CPM KPI는 CPM (1,000회 노출당 비용)입니다.
KPI_TYPE_CPC KPI는 CPC (클릭당비용)입니다.
KPI_TYPE_CPA KPI는 CPA (액션당비용)입니다.
KPI_TYPE_CTR KPI는 CTR (클릭률) 비율입니다.
KPI_TYPE_VIEWABILITY KPI는 조회 가능 비율입니다.
KPI_TYPE_CPIAVC KPI는 CPIAVC (완료 지점에서의 청취 및 조회 가능 노출당 비용)입니다.
KPI_TYPE_CPE KPI는 CPE (참여당비용)입니다.
KPI_TYPE_CPV KPI는 CPV (조회당비용)로 설정됩니다.
KPI_TYPE_CLICK_CVR KPI는 클릭 전환율 (클릭당 전환수) 백분율입니다.
KPI_TYPE_IMPRESSION_CVR KPI는 노출수 전환율 (노출당 전환수) 백분율입니다.
KPI_TYPE_VCPM KPI는 vCPM (조회 가능 1,000회 노출당비용)입니다.
KPI_TYPE_VTR KPI는 YouTube 조회율 (노출당 YouTube 조회수) 비율입니다.
KPI_TYPE_AUDIO_COMPLETION_RATE KPI는 오디오 완료율 (노출당 오디오 듣기 완료) 비율입니다.
KPI_TYPE_VIDEO_COMPLETION_RATE KPI는 동영상 완료율 (노출당 완료된 동영상 조회수) 비율입니다.
KPI_TYPE_CPCL KPI는 CPCL (완료한 오디오 청취당 비용)로 설정됩니다.
KPI_TYPE_CPCV KPI는 CPCV (완료한 동영상 조회수당 비용)로 설정됩니다.
KPI_TYPE_TOS10 KPI는 화면에 10초 이상 표시된 시간의 비율 (측정 가능하고 건너뛸 수 없는 노출 중 화면에 10초 이상 표시된 노출의 비율)로 설정됩니다.
KPI_TYPE_MAXIMIZE_PACING KPI는 전체 예산 지출을 우선하면서 브랜드 영향을 극대화하도록 설정됩니다.
KPI_TYPE_CUSTOM_IMPRESSION_VALUE_OVER_COST KPI는 비용으로 나눈 맞춤 노출 가치로 설정됩니다.
KPI_TYPE_OTHER KPI가 다른 값입니다.

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 자동 예산 할당 시스템에서 소유 광고 항목으로 예산을 자동으로 이동하여 kpi로 정의된 실적을 최적화하도록 허용합니다. 입찰가 설정에 자동화가 없습니다.
INSERTION_ORDER_AUTOMATION_TYPE_NONE 게재 신청서 수준에서 입찰 또는 예산이 자동화되지 않습니다. 입찰가와 예산은 광고 항목 수준에서 수동으로 구성해야 합니다.
INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET 시스템에서 입찰가를 자동으로 조정하고 예산을 소유 광고 항목으로 이동하여 kpi로 정의된 실적을 최적화하도록 허용합니다.

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입니다.

OptimizationObjective

가능한 최적화 목표 유형입니다.

열거형
OPTIMIZATION_OBJECTIVE_UNSPECIFIED 이 버전에서 유형 값이 지정되지 않았거나 알 수 없습니다.
CONVERSION 판매 및 전환을 늘리는 노출에 우선순위를 지정합니다.
CLICK 웹사이트 트래픽, 앱, 앱 스토어를 늘리는 노출에 우선순위를 지정합니다.
BRAND_AWARENESS 특정 품질의 노출수에 우선순위를 지정합니다.
CUSTOM 목표는 할당된 맞춤 입찰 알고리즘에 의해 정의됩니다.
NO_OBJECTIVE 목표가 정의되지 않았습니다. KPI 또는 입찰 전략을 사용할 수 있습니다.

메서드

create

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

delete

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

get

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

list

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

listAssignedTargetingOptions

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

patch

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