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)

僅供輸出。廣告活動所屬的廣告客戶專屬編號。
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」的時間戳記格式，解析度為奈秒，且最多 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) 設定。
PERFORMANCE_GOAL_TYPE_CPC 成效目標可透過單次點擊出價 (CPC) 設定。
PERFORMANCE_GOAL_TYPE_CPA 成效目標設為以單次操作出價 (CPA) 計費。
PERFORMANCE_GOAL_TYPE_CTR 成效目標是以點閱率 (點閱率) 百分比來設定。
PERFORMANCE_GOAL_TYPE_VIEWABILITY 成效目標的設定依據為可視度百分比。
PERFORMANCE_GOAL_TYPE_CPIAVC 成效目標可設為「單次有聲可視完整播放的曝光出價」。
PERFORMANCE_GOAL_TYPE_CPE 成效目標是設為單次參與出價。
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 使用者介面中追蹤支出。

金額以微量為單位。必須大於或等於 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

 更新現有的廣告活動。