REST Resource: advertisers.campaigns

리소스: 캠페인

단일 캠페인

JSON 표현 
{
  "name": string,
  "advertiserId": string,
  "campaignId": string,
  "displayName": string,
  "entityStatus": enum (EntityStatus),
  "updateTime": string,
  "campaignGoal": {
    object (CampaignGoal)
  },
  "campaignFlight": {
    object (CampaignFlight)
  },
  "frequencyCap": {
    object (FrequencyCap)
  },
  "campaignBudgets": [
    {
      object (CampaignBudget)
    }
  ]
}
필드
name

string

출력 전용입니다. 캠페인의 리소스 이름입니다.
advertiserId

string (int64 format)

출력 전용입니다. 캠페인이 속한 광고주의 고유 ID입니다.
campaignId

string (int64 format)

출력 전용입니다. 캠페인의 고유 ID입니다. 시스템에서 할당합니다.
displayName

string

필수 항목입니다. 캠페인의 표시 이름입니다.

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

enum (EntityStatus)

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

  • 허용되는 값은 ENTITY_STATUS_ACTIVE, ENTITY_STATUS_ARCHIVED, ENTITY_STATUS_PAUSED입니다.
  • campaigns.create 메서드의 경우 ENTITY_STATUS_ARCHIVED는 허용되지 않습니다.
updateTime

string (Timestamp format)

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

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

object (CampaignGoal)

필수 항목입니다. 캠페인의 목표입니다.
campaignFlight

object (CampaignFlight)

필수 항목입니다. 계획된 캠페인 지출 및 기간
frequencyCap

object (FrequencyCap)

필수 항목입니다. 캠페인의 최대 게재빈도 설정입니다.
campaignBudgets[]

object (CampaignBudget)

이 캠페인에 사용할 수 있는 예산 목록입니다.

이 필드를 설정하지 않으면 캠페인에서 무제한 예산이 사용됩니다.

CampaignGoal

캠페인의 목표를 제어하는 설정입니다.

JSON 표현 
{
  "campaignGoalType": enum (CampaignGoalType),
  "performanceGoal": {
    object (PerformanceGoal)
  }
}
필드
campaignGoalType

enum (CampaignGoalType)

필수 항목입니다. 캠페인 목표의 유형입니다.
performanceGoal

object (PerformanceGoal)

필수 항목입니다. 캠페인의 실적 목표입니다.

사용 가능한 performanceGoalType 값은 다음과 같습니다.

  • PERFORMANCE_GOAL_TYPE_CPM
  • PERFORMANCE_GOAL_TYPE_CPC
  • PERFORMANCE_GOAL_TYPE_CPA
  • PERFORMANCE_GOAL_TYPE_CPIAVC
  • PERFORMANCE_GOAL_TYPE_CTR
  • PERFORMANCE_GOAL_TYPE_VIEWABILITY
  • PERFORMANCE_GOAL_TYPE_OTHER

CampaignGoalType

가능한 캠페인 목표 유형

열거형
CAMPAIGN_GOAL_TYPE_UNSPECIFIED 이 버전에서 목표 값이 지정되지 않았거나 알 수 없습니다.
CAMPAIGN_GOAL_TYPE_APP_INSTALL 앱 설치 또는 참여 유도
CAMPAIGN_GOAL_TYPE_BRAND_AWARENESS 브랜드 또는 제품의 인지도 제고
CAMPAIGN_GOAL_TYPE_OFFLINE_ACTION 오프라인 또는 매장 내 판매 유도
CAMPAIGN_GOAL_TYPE_ONLINE_ACTION 온라인 액션 또는 방문 유도

PerformanceGoal

캠페인의 실적 목표를 관리하는 설정입니다.

JSON 표현 
{
  "performanceGoalType": enum (PerformanceGoalType),

  // Union field performance_goal_value can be only one of the following:
  "performanceGoalAmountMicros": string,
  "performanceGoalPercentageMicros": string,
  "performanceGoalString": string
  // End of list of possible types for union field performance_goal_value.
}
필드
performanceGoalType

enum (PerformanceGoalType)

필수 항목입니다. 실적 목표의 유형입니다.
통합 필드 performance_goal_value. 필수 항목입니다. 지정된 performance_goal_type에 해당하는 실적 목표 값입니다. performance_goal_value은 다음 중 하나일 수 있습니다.
performanceGoalAmountMicros

string (int64 format)

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

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

  • PERFORMANCE_GOAL_TYPE_CPM
  • PERFORMANCE_GOAL_TYPE_CPC
  • PERFORMANCE_GOAL_TYPE_CPA
  • PERFORMANCE_GOAL_TYPE_CPIAVC
  • PERFORMANCE_GOAL_TYPE_VCPM

예를 들어 1500000은 해당 통화의 표준 단위 1.5를 나타냅니다.
performanceGoalPercentageMicros

string (int64 format)

목표 비율을 마이크로 단위로 소수점 표기한 값입니다.

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

  • PERFORMANCE_GOAL_TYPE_CTR
  • PERFORMANCE_GOAL_TYPE_VIEWABILITY
  • PERFORMANCE_GOAL_TYPE_CLICK_CVR
  • PERFORMANCE_GOAL_TYPE_IMPRESSION_CVR
  • PERFORMANCE_GOAL_TYPE_VTR
  • PERFORMANCE_GOAL_TYPE_AUDIO_COMPLETION_RATE
  • PERFORMANCE_GOAL_TYPE_VIDEO_COMPLETION_RATE

예를 들어 70000은 7%(소수점 0.07)을 나타냅니다.
performanceGoalString

string

핵심성과지표 (KPI) 문자열로, 비어 있을 수 있습니다. UTF-8로 인코딩되어야 하며 길이는 100자(영문 기준) 이하여야 합니다.

performanceGoalType가 PERFORMANCE_GOAL_TYPE_OTHER로 설정된 경우에 적용됩니다.

PerformanceGoalType

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

열거형
PERFORMANCE_GOAL_TYPE_UNSPECIFIED 이 버전에서 실적 목표 유형이 지정되지 않았거나 알 수 없습니다.
PERFORMANCE_GOAL_TYPE_CPM 실적 목표는 CPM(1,000회 노출당비용)으로 설정됩니다.
PERFORMANCE_GOAL_TYPE_CPC 실적 목표는 CPC(클릭당비용)로 설정됩니다.
PERFORMANCE_GOAL_TYPE_CPA 실적 목표는 CPA(액션당비용)로 설정됩니다.
PERFORMANCE_GOAL_TYPE_CTR 실적 목표는 CTR (클릭률) 백분율로 설정됩니다.
PERFORMANCE_GOAL_TYPE_VIEWABILITY 실적 목표는 조회가능성 백분율로 설정됩니다.
PERFORMANCE_GOAL_TYPE_CPIAVC 실적 목표는 CPIAVC (완료 시 청취 및 조회 가능 노출당 비용)로 설정됩니다.
PERFORMANCE_GOAL_TYPE_CPE 실적 목표는 CPE(참여당비용)로 설정됩니다.
PERFORMANCE_GOAL_TYPE_CPV 실적 목표는 CPV (조회당비용)로 설정됩니다.
PERFORMANCE_GOAL_TYPE_CLICK_CVR 실적 목표는 클릭 전환율 (클릭당 전환수) 비율로 설정됩니다.
PERFORMANCE_GOAL_TYPE_IMPRESSION_CVR 실적 목표는 노출 전환율(노출당 전환수) 백분율로 설정됩니다.
PERFORMANCE_GOAL_TYPE_VCPM 실적 목표는 VCPM (조회 가능 1,000회 노출당비용)으로 설정됩니다.
PERFORMANCE_GOAL_TYPE_VTR 실적 목표는 YouTube 조회율(노출당 YouTube 조회수) 백분율로 설정됩니다.
PERFORMANCE_GOAL_TYPE_AUDIO_COMPLETION_RATE 실적 목표는 오디오 완료율(노출당 오디오 듣기 완료) 백분율로 설정됩니다.
PERFORMANCE_GOAL_TYPE_VIDEO_COMPLETION_RATE 실적 목표는 동영상 완료율 (노출당 완료 동영상 조회수) 비율로 설정됩니다.
PERFORMANCE_GOAL_TYPE_OTHER 실적 목표가 기타로 설정됩니다.

CampaignFlight

캠페인의 계획된 지출 및 기간을 추적하는 설정입니다.

JSON 표현 
{
  "plannedSpendAmountMicros": string,
  "plannedDates": {
    object (DateRange)
  }
}
필드
plannedSpendAmountMicros

string (int64 format)

캠페인에서 지출할 것으로 예상되는 plannedDates입니다. 이렇게 해도 게재가 제한되지는 않지만 DV360 UI에서 지출을 추적하는 데 사용됩니다.

금액은 마이크로 단위입니다. 0보다 크거나 같아야 합니다. 예를 들어 500000000은 500개의 통화 표준 단위를 나타냅니다.
plannedDates

object (DateRange)

필수 항목입니다. 캠페인이 실행될 것으로 예상되는 날짜입니다. 상위 광고주의 시간대를 기준으로 확인됩니다.

  • 여기에 지정한 날짜는 게재에 영향을 주지 않습니다. 알림 및 경고를 생성하는 데 사용됩니다. 예를 들어 하위 게재 신청서의 게재 날짜가 이 날짜 범위를 벗어나면 사용자 인터페이스에 경고가 표시됩니다.
  • startDate은 필수이며 현재 날짜 또는 이후의 날짜여야 합니다.
  • endDate는 선택사항입니다. 지정된 경우 startDate 이상이어야 합니다.
  • 지정된 날짜는 2037년 이전이어야 합니다.

CampaignBudget

캠페인 예산을 할당하는 방식을 관리하는 설정입니다.

JSON 표현 
{
  "budgetId": string,
  "displayName": string,
  "budgetUnit": enum (BudgetUnit),
  "budgetAmountMicros": string,
  "dateRange": {
    object (DateRange)
  },
  "externalBudgetSource": enum (ExternalBudgetSource),
  "externalBudgetId": string,
  "invoiceGroupingId": string,
  "prismaConfig": {
    object (PrismaConfig)
  }
}
필드
budgetId

string (int64 format)

캠페인 예산의 고유 ID입니다. 시스템에서 할당합니다. 새 예산에는 설정하지 마세요.

campaignBudgets에 예산을 업데이트하거나 추가할 때 포함해야 합니다. 그렇지 않으면 새 ID가 생성되어 할당됩니다.
displayName

string

필수 항목입니다. 예산의 표시 이름입니다.

UTF-8로 인코딩되어야 하며 최대 크기는 240바이트여야 합니다.
budgetUnit

enum (BudgetUnit)

필수 항목입니다. 변경할 수 없습니다. 예산을 통화로 측정할지 노출수로 측정할지 지정합니다.
budgetAmountMicros

string (int64 format)

필수 항목입니다. 연결된 게재 신청서 세그먼트에서 예산을 책정할 수 있는 총 금액입니다.

금액은 마이크로 단위입니다. 0보다 커야 합니다. 예를 들어 500000000은 통화의 표준 단위 500개를 나타냅니다.
dateRange

object (DateRange)

필수 항목입니다. 캠페인 예산의 기간입니다. 연결된 예산 세그먼트의 기간이 다를 수 있습니다. 상위 광고주의 시간대를 기준으로 확인됩니다.

startDate 및 endDate는 모두 2037년 이전이어야 합니다.
externalBudgetSource

enum (ExternalBudgetSource)

필수 항목입니다. 예산의 외부 소스입니다.
externalBudgetId

string

변경할 수 없습니다. 외부 소스에 이 예산을 식별하는 ID입니다.

이 필드가 설정되어 있고 해당 결제 프로필의 인보이스 세부정보 수준이 '예산 수준 PO'로 설정된 경우 이 예산에 대해 게재된 모든 노출에는 인보이스에 이 ID가 포함됩니다.

캠페인 내에서 고유해야 합니다.
invoiceGroupingId

string

변경할 수 없습니다. 동일한 인보이스에 포함될 예산을 그룹화하는 데 사용되는 ID입니다.

이 필드가 설정되어 있고 해당 결제 프로필의 인보이스 수준이 '예산 인보이스 그룹 ID'로 설정된 경우 동일한 invoiceGroupingId를 공유하는 모든 externalBudgetId가 동일한 인보이스에 그룹화됩니다.
prismaConfig

object (PrismaConfig)

Mediaocean Prisma 도구에서 사용할 추가 메타데이터입니다.

Mediaocean 예산에 필요합니다.

prismaEnabled 광고주에게만 적용됩니다.

ExternalBudgetSource

캠페인 예산 세그먼트의 외부 소스입니다.

열거형
EXTERNAL_BUDGET_SOURCE_UNSPECIFIED 이 버전에서 외부 예산 소스 값이 지정되지 않았거나 알 수 없습니다.
EXTERNAL_BUDGET_SOURCE_NONE 예산에 외부 소스가 없습니다.
EXTERNAL_BUDGET_SOURCE_MEDIA_OCEAN 예산 소스는 Mediaocean입니다.

PrismaConfig

Mediaocean Prisma 도구 전용 설정입니다.

JSON 표현 
{
  "prismaType": enum (PrismaType),
  "prismaCpeCode": {
    object (PrismaCpeCode)
  },
  "supplier": string
}
필드
prismaType

enum (PrismaType)

필수 항목입니다. Prisma 유형입니다.
prismaCpeCode

object (PrismaCpeCode)

필수 항목입니다. Mediaocean Prisma 도구의 관련 고객, 제품, 견적 코드
supplier

string

필수 항목입니다. 이 예산을 할당한 항목(DSP, 사이트 등)입니다.

PrismaType

Prisma 예산의 가능한 유형입니다.

열거형
PRISMA_TYPE_UNSPECIFIED 이 버전에서 유형이 지정되지 않았거나 알 수 없습니다.
PRISMA_TYPE_DISPLAY 디스플레이 유형입니다.
PRISMA_TYPE_VIDEO 동영상 유형입니다.
PRISMA_TYPE_AUDIO 오디오 유형입니다.
PRISMA_TYPE_SOCIAL 소셜 유형
PRISMA_TYPE_FEE 수수료 유형입니다.

PrismaCpeCode

Google 결제 센터는 이 코드의 구성요소 필드에서 검색과 필터링을 지원합니다.

JSON 표현 
{
  "prismaClientCode": string,
  "prismaProductCode": string,
  "prismaEstimateCode": string
}
필드
prismaClientCode

string

Prisma 클라이언트 코드입니다.
prismaProductCode

string

Prisma 제품 코드입니다.
prismaEstimateCode

string

Prisma 견적 코드입니다.

메서드

create

 새 캠페인을 만듭니다.

delete

 캠페인을 영구적으로 삭제합니다.

get

 캠페인을 가져옵니다.

list

 광고주의 캠페인을 표시합니다.

listAssignedTargetingOptions

 여러 타겟팅 유형에 걸쳐 캠페인에 할당된 타겟팅 옵션을 나열합니다.

patch

 기존 캠페인을 업데이트합니다.