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 กระตุ้นการเข้าชมหรือการดำเนินการทางออนไลน์

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

ประเภทเป้าหมายด้านประสิทธิภาพที่เป็นไปได้

Enum
PERFORMANCE_GOAL_TYPE_UNSPECIFIED ไม่ได้ระบุประเภทเป้าหมายประสิทธิภาพหรือไม่รู้จักในเวอร์ชันนี้
PERFORMANCE_GOAL_TYPE_CPM ระบบตั้งเป้าหมายประสิทธิภาพเป็น CPM (ต้นทุนต่อการแสดงผลพันครั้ง)
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_CLICK_CVR มีการตั้งเป้าหมายด้านประสิทธิภาพไว้ในอัตรา Conversion การคลิก (Conversion ต่อคลิก)
PERFORMANCE_GOAL_TYPE_IMPRESSION_CVR มีการตั้งเป้าหมายด้านประสิทธิภาพในอัตรา Conversion การแสดงผล (Conversion ต่อการแสดงผล)
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 ที่กำหนด การดำเนินการนี้จะไม่จำกัดการแสดงโฆษณา แต่จะใช้สำหรับการติดตามการใช้จ่ายใน 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)

ต้องระบุ โค้ดเกี่ยวกับลูกค้า ผลิตภัณฑ์ และค่าประมาณที่เกี่ยวข้องจากเครื่องมือ Mediaocean Prisma
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

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