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_CPV เป้าหมายด้านประสิทธิภาพจะกำหนดเป็น CPV (ต้นทุนต่อการดู)
PERFORMANCE_GOAL_TYPE_CLICK_CVR เป้าหมายด้านประสิทธิภาพจะตั้งเป็นเปอร์เซ็นต์อัตรา Conversion การคลิก (Conversion ต่อคลิก)
PERFORMANCE_GOAL_TYPE_IMPRESSION_CVR เป้าหมายด้านประสิทธิภาพจะตั้งค่าเป็นเปอร์เซ็นต์อัตรา Conversion ของการแสดงผล (Conversion ต่อการแสดงผล)
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 ที่ระบุ ซึ่งจะไม่จํากัดการแสดงโฆษณา แต่จะใช้ในการติดตามการใช้จ่ายใน 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

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

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

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

การแสดง JSON 
{
  "prismaClientCode": string,
  "prismaProductCode": string,
  "prismaEstimateCode": string
}
ช่อง
prismaClientCode

string

โค้ดไคลเอ็นต์ Prisma
prismaProductCode

string

รหัสผลิตภัณฑ์ Prisma
prismaEstimateCode

string

โค้ดการคาดการณ์ Prisma

เมธอด

create

 สร้างแคมเปญใหม่

delete

 ลบแคมเปญอย่างถาวร

get

 รับแคมเปญ

list

 แสดงรายการแคมเปญของผู้ลงโฆษณา

listAssignedTargetingOptions

 แสดงรายการตัวเลือกการกำหนดเป้าหมายที่กําหนดของแคมเปญในประเภทการกําหนดเป้าหมายต่างๆ

patch

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