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

必要欄位。廣告活動的顯示名稱。

必須採用 UTF-8 編碼，且大小上限為 240 個位元組。
entityStatus

enum (EntityStatus)

必要欄位。控制這個廣告活動下廣告訂單是否可以支出預算，以及對廣告空間出價。

  • 可接受的值為 ENTITY_STATUS_ACTIVE、ENTITY_STATUS_ARCHIVED 和 ENTITY_STATUS_PAUSED。
  • 對於 campaigns.create 方法，不允許 ENTITY_STATUS_ARCHIVED。
updateTime

string (Timestamp format)

僅供輸出。上次更新廣告活動的時間戳記。由系統指派。

RFC3339 世界標準時間「Zulu」格式的時間戳記，精確度達奈秒單位，最多九個小數位數。例如 "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) 為單位。
PERFORMANCE_GOAL_TYPE_CPC 成效目標以單次點擊出價 (CPC) 為單位。
PERFORMANCE_GOAL_TYPE_CPA 成效目標會以單次動作出價 (CPA) 的形式設定。
PERFORMANCE_GOAL_TYPE_CTR 成效目標是以點閱率百分比設定。
PERFORMANCE_GOAL_TYPE_VIEWABILITY 成效目標以可視度百分比設定。
PERFORMANCE_GOAL_TYPE_CPIAVC 成效目標設為 CPIAVC (單次有聲可見完整播放的曝光出價)。
PERFORMANCE_GOAL_TYPE_CPE 成效目標是設為單次參與出價。
PERFORMANCE_GOAL_TYPE_CPV 成效目標以單次收視出價 (CPV) 為單位。
PERFORMANCE_GOAL_TYPE_CLICK_CVR 成效目標以點擊轉換率 (單次點擊轉換次數) 百分比設定。
PERFORMANCE_GOAL_TYPE_IMPRESSION_CVR 成效目標以曝光轉換率 (單次曝光轉換次數) 百分比設定。
PERFORMANCE_GOAL_TYPE_VCPM 成效目標是設為千次可視曝光出價 (vCPM)。
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 可讓外部來源辨識此預算。

如果您設定這個欄位，且相應帳單資料的月結單詳細資料層級設為「預算層級訂購單」，則根據這個預算放送的所有曝光，都會在月結單中納入這個 ID。

在廣告活動中不得重複。
invoiceGroupingId

string

不可變動。用於分類預算，以納入同一張月結單的預算。

如果設定了這個欄位，且對應帳單資料的月結單層級設為「預算月結單分組 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

必要欄位。分配此預算的實體 (需求端平台、網站等)。

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

 更新現有的廣告活動。