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)

เอาต์พุตเท่านั้น รหัสที่ไม่ซ้ำกันของแคมเปญ กำหนดโดยระบบ
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 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

ประเภทเป้าหมายแคมเปญที่เป็นไปได้

Enum
CAMPAIGN_GOAL_TYPE_UNSPECIFIED ไม่ได้ระบุหรือไม่รู้จักมูลค่าเป้าหมายในเวอร์ชันนี้
CAMPAIGN_GOAL_TYPE_APP_INSTALL กระตุ้นยอดติดตั้งแอปหรือการมีส่วนร่วม
CAMPAIGN_GOAL_TYPE_BRAND_AWARENESS เพิ่มการรับรู้ถึงแบรนด์หรือผลิตภัณฑ์
CAMPAIGN_GOAL_TYPE_OFFLINE_ACTION กระตุ้นยอดขายออฟไลน์หรือในร้านค้า
CAMPAIGN_GOAL_TYPE_ONLINE_ACTION กระตุ้นการเข้าชมหรือการดำเนินการทางออนไลน์

CampaignFlight

การตั้งค่าที่ติดตามการใช้จ่ายตามแผนที่วางไว้และระยะเวลาของแคมเปญ

การแสดง JSON 
{
  "plannedSpendAmountMicros": string,
  "plannedDates": {
    object (DateRange)
  }
}
ช่อง
plannedSpendAmountMicros

string (int64 format)

จำนวนเงินที่แคมเปญคาดว่าจะใช้จ่ายสำหรับ plannedDates ที่ระบุ ตัวเลือกนี้ไม่จำกัดการแสดงโฆษณา แต่จะใช้เพื่อติดตามการใช้จ่ายใน UI ของ 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)

รหัสที่ไม่ซ้ำกันของงบประมาณแคมเปญ กำหนดโดยระบบ อย่าตั้งค่าสำหรับงบประมาณใหม่

ต้องระบุเมื่ออัปเดตหรือเพิ่มงบประมาณลงใน campaignBudgets มิเช่นนั้น ระบบจะสร้างและกําหนดรหัสใหม่ให้
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

เปลี่ยนแปลงไม่ได้ รหัสที่ระบุงบประมาณนี้ไปยังแหล่งที่มาภายนอก

หากตั้งค่าช่องนี้และตั้งค่าระดับรายละเอียดใบแจ้งหนี้ของโปรไฟล์การเรียกเก็บเงินที่เกี่ยวข้องเป็น "PO ระดับงบประมาณ" การแสดงผลทั้งหมดที่แสดงตามงบประมาณนี้จะรวมรหัสนี้ไว้ในใบแจ้งหนี้

ต้องไม่ซ้ำกันในแคมเปญ
invoiceGroupingId

string

เปลี่ยนแปลงไม่ได้ รหัสที่ใช้จัดกลุ่มงบประมาณเพื่อรวมใบแจ้งหนี้เดียวกัน

หากตั้งค่าช่องนี้และตั้งค่าระดับใบแจ้งหนี้ของโปรไฟล์การเรียกเก็บเงินที่เกี่ยวข้องเป็น "รหัสการจัดกลุ่มใบแจ้งหนี้ตามงบประมาณ" ระบบจะจัดกลุ่ม externalBudgetId ทั้งหมดที่ใช้ invoiceGroupingId เดียวกันไว้ในใบแจ้งหนี้เดียวกัน
prismaConfig

object (PrismaConfig)

ข้อมูลเมตาเพิ่มเติมสำหรับใช้โดยเครื่องมือ Mediaocean Prisma

ต้องระบุสำหรับงบประมาณ Mediaocean

ใช้ได้กับผู้ลงโฆษณา prismaEnabled เท่านั้น

ExternalBudgetSource

แหล่งที่มาภายนอกสำหรับกลุ่มงบประมาณแคมเปญ

Enum
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)

ต้องระบุ รหัสลูกค้า ผลิตภัณฑ์ และการคาดการณ์ที่เกี่ยวข้องจากเครื่องมือ Prisma ของ Mediaocean
supplier

string

ต้องระบุ ผู้จัดสรรงบประมาณนี้ (DSP, เว็บไซต์ ฯลฯ)

PrismaType

ประเภทที่เป็นไปได้สำหรับงบประมาณ Prisma

Enum
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

 อัปเดตแคมเปญที่มีอยู่