REST Resource: advertisers.campaigns

Tài nguyên: Chiến dịch

Một chiến dịch.

Biểu diễn dưới dạng 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)
    }
  ]
}
Trường
name

string

Chỉ có đầu ra. Tên tài nguyên của chiến dịch.
advertiserId

string (int64 format)

Chỉ có đầu ra. Mã nhận dạng duy nhất của nhà quảng cáo sở hữu chiến dịch.
campaignId

string (int64 format)

Chỉ có đầu ra. Mã nhận dạng duy nhất của chiến dịch. Do hệ thống chỉ định.
displayName

string

Bắt buộc. Tên hiển thị của chiến dịch.

Phải được mã hoá theo UTF-8 với kích thước tối đa là 240 byte.
entityStatus

enum (EntityStatus)

Bắt buộc. Kiểm soát việc các đơn đặt hàng quảng cáo trong chiến dịch này có thể chi tiêu ngân sách và đặt giá thầu cho khoảng không quảng cáo hay không.

  • Các giá trị được chấp nhận là ENTITY_STATUS_ACTIVE, ENTITY_STATUS_ARCHIVED và ENTITY_STATUS_PAUSED.
  • Đối với phương thức campaigns.create, bạn không được phép sử dụng ENTITY_STATUS_ARCHIVED.
updateTime

string (Timestamp format)

Chỉ có đầu ra. Dấu thời gian khi chiến dịch được cập nhật lần gần đây nhất. Do hệ thống chỉ định.

Hãy dùng RFC 3339, trong đó dữ liệu đầu ra được tạo sẽ luôn được chuẩn hoá theo múi giờ và sử dụng 0, 3, 6 hoặc 9 chữ số thập phân. Các khoảng lệch khác ngoài "Z" cũng được chấp nhận. Ví dụ: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" hoặc "2014-10-02T15:01:23+05:30".
campaignGoal

object (CampaignGoal)

Bắt buộc. Mục tiêu của chiến dịch.
campaignFlight

object (CampaignFlight)

Bắt buộc. Mức chi tiêu dự kiến và thời lượng của chiến dịch.
frequencyCap

object (FrequencyCap)

Bắt buộc. Chế độ cài đặt giới hạn tần suất của chiến dịch.
campaignBudgets[]

object (CampaignBudget)

Danh sách ngân sách có sẵn cho chiến dịch này.

Nếu bạn không đặt trường này, thì chiến dịch sẽ sử dụng ngân sách không giới hạn.

CampaignGoal

Chế độ cài đặt kiểm soát mục tiêu của chiến dịch.

Biểu diễn dưới dạng JSON 
{
  "campaignGoalType": enum (CampaignGoalType),
  "performanceGoal": {
    object (PerformanceGoal)
  }
}
Trường
campaignGoalType

enum (CampaignGoalType)

Bắt buộc. Loại mục tiêu của chiến dịch.
performanceGoal

object (PerformanceGoal)

Bắt buộc. Mục tiêu hiệu suất của chiến dịch.

Các giá trị được chấp nhận cho performanceGoalType là:

  • 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

Các loại mục tiêu có thể có của chiến dịch.

Enum
CAMPAIGN_GOAL_TYPE_UNSPECIFIED Giá trị mục tiêu không được chỉ định hoặc không xác định trong phiên bản này.
CAMPAIGN_GOAL_TYPE_APP_INSTALL Thúc đẩy tương tác hoặc lượt cài đặt ứng dụng.
CAMPAIGN_GOAL_TYPE_BRAND_AWARENESS Nâng cao mức độ nhận biết về một thương hiệu hoặc sản phẩm.
CAMPAIGN_GOAL_TYPE_OFFLINE_ACTION Thúc đẩy doanh số bán hàng tại cửa hàng hoặc ngoại tuyến.
CAMPAIGN_GOAL_TYPE_ONLINE_ACTION Thúc đẩy lượt truy cập hoặc hành động trực tuyến.

PerformanceGoal

Chế độ cài đặt kiểm soát mục tiêu hiệu suất của chiến dịch.

Biểu diễn dưới dạng JSON 
{
  "performanceGoalType": enum (PerformanceGoalType),

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "performanceGoalAmountMicros": string,
  "performanceGoalPercentageMicros": string,
  "performanceGoalString": string
  // End of mutually exclusive fields.
}
Trường
performanceGoalType

enum (PerformanceGoalType)

Bắt buộc. Loại mục tiêu hiệu suất.
Bắt buộc. Giá trị mục tiêu hiệu suất tương ứng với một performance_goal_type nhất định. Sau đây là danh sách các trường loại trừ lẫn nhau. Tối đa một trong các trường sẽ được đặt trong phản hồi:
performanceGoalAmountMicros

string (int64 format)

Số tiền mục tiêu, tính bằng đơn vị micro theo đơn vị tiền tệ của nhà quảng cáo.

Áp dụng khi performanceGoalType là một trong những giá trị sau:

  • PERFORMANCE_GOAL_TYPE_CPM
  • PERFORMANCE_GOAL_TYPE_CPC
  • PERFORMANCE_GOAL_TYPE_CPA
  • PERFORMANCE_GOAL_TYPE_CPIAVC
  • PERFORMANCE_GOAL_TYPE_VCPM

Ví dụ: 1500000 tương ứng với 1,5 đơn vị tiền tệ chuẩn.
performanceGoalPercentageMicros

string (int64 format)

Biểu thị thập phân của tỷ lệ phần trăm mục tiêu theo phần triệu.

Áp dụng khi performanceGoalType là một trong những giá trị sau:

  • 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

Ví dụ: 70000 đại diện cho 7% (số thập phân 0, 07).
performanceGoalString

string

Chuỗi chỉ báo hiệu suất chính (KPI), có thể để trống. Phải được mã hoá UTF-8 với độ dài không quá 100 ký tự.

Áp dụng khi performanceGoalType được đặt thành PERFORMANCE_GOAL_TYPE_OTHER.
Kết thúc các trường loại trừ lẫn nhau.

PerformanceGoalType

Các loại mục tiêu hiệu suất có thể có.

Enum
PERFORMANCE_GOAL_TYPE_UNSPECIFIED Loại mục tiêu hiệu suất không được chỉ định hoặc không xác định được trong phiên bản này.
PERFORMANCE_GOAL_TYPE_CPM Mục tiêu hiệu suất được đặt theo CPM (chi phí mỗi nghìn lượt hiển thị).
PERFORMANCE_GOAL_TYPE_CPC Mục tiêu hiệu suất được đặt theo CPC (chi phí mỗi lượt nhấp).
PERFORMANCE_GOAL_TYPE_CPA Mục tiêu hiệu suất được đặt theo CPA (chi phí mỗi hành động).
PERFORMANCE_GOAL_TYPE_CTR Mục tiêu hiệu suất được đặt theo tỷ lệ phần trăm CTR (tỷ lệ nhấp).
PERFORMANCE_GOAL_TYPE_VIEWABILITY Mục tiêu hiệu suất được đặt theo Tỷ lệ phần trăm khả năng xem.
PERFORMANCE_GOAL_TYPE_CPIAVC Mục tiêu hiệu suất được đặt là CPIAVC (chi phí mỗi lượt hiển thị có thể nghe và xem khi hoàn thành).
PERFORMANCE_GOAL_TYPE_CPE Mục tiêu hiệu suất được đặt theo CPE (chi phí mỗi lượt tương tác).
PERFORMANCE_GOAL_TYPE_CPV Mục tiêu hiệu suất được đặt theo CPV (chi phí mỗi lượt xem).
PERFORMANCE_GOAL_TYPE_CLICK_CVR Mục tiêu hiệu suất được đặt theo tỷ lệ phần trăm của tỷ lệ chuyển đổi từ lượt nhấp (số lượt chuyển đổi trên mỗi lượt nhấp).
PERFORMANCE_GOAL_TYPE_IMPRESSION_CVR Mục tiêu hiệu suất được đặt theo tỷ lệ phần trăm tỷ lệ chuyển đổi từ lượt hiển thị (số lượt chuyển đổi trên mỗi lượt hiển thị).
PERFORMANCE_GOAL_TYPE_VCPM Mục tiêu hiệu suất được đặt theo vCPM (chi phí mỗi nghìn lượt hiển thị có thể xem).
PERFORMANCE_GOAL_TYPE_VTR Mục tiêu hiệu suất được đặt theo tỷ lệ xem trên YouTube (số lượt xem trên YouTube trên mỗi lượt hiển thị).
PERFORMANCE_GOAL_TYPE_AUDIO_COMPLETION_RATE Mục tiêu hiệu suất được đặt theo tỷ lệ hoàn thành âm thanh (số lượt nghe hết âm thanh trên mỗi lượt hiển thị).
PERFORMANCE_GOAL_TYPE_VIDEO_COMPLETION_RATE Mục tiêu hiệu suất được đặt theo tỷ lệ xem hết video (số lượt xem hết video trên mỗi lượt hiển thị).
PERFORMANCE_GOAL_TYPE_OTHER Mục tiêu hiệu suất được đặt thành Khác.

CampaignFlight

Chế độ cài đặt theo dõi mức chi tiêu và thời lượng dự kiến của một chiến dịch.

Biểu diễn dưới dạng JSON 
{
  "plannedSpendAmountMicros": string,
  "plannedDates": {
    object (DateRange)
  }
}
Trường
plannedSpendAmountMicros

string (int64 format)

Số tiền mà chiến dịch dự kiến sẽ chi tiêu cho plannedDates nhất định. Điều này sẽ không giới hạn việc phân phát, nhưng sẽ được dùng để theo dõi mức chi tiêu trong giao diện người dùng DV360.

Số tiền được tính theo đơn vị micro. Phải lớn hơn hoặc bằng 0. Ví dụ: 500000000 đại diện cho 500 đơn vị tiền tệ tiêu chuẩn.
plannedDates

object (DateRange)

Bắt buộc. Ngày dự kiến chạy chiến dịch. Các giá trị này được phân giải theo múi giờ của nhà quảng cáo mẹ.

  • Ngày được chỉ định ở đây sẽ không ảnh hưởng đến việc phân phát. Các dữ liệu này được dùng để tạo cảnh báo. Ví dụ: nếu ngày bắt đầu và ngày kết thúc của bất kỳ đơn đặt hàng quảng cáo con nào nằm ngoài phạm vi của những ngày này, thì giao diện người dùng sẽ hiển thị cảnh báo.
  • Bạn phải nhập startDate và ngày này phải là ngày hiện tại hoặc muộn hơn.
  • endDate là không bắt buộc. Nếu được chỉ định, thì phiên bản này phải là startDate trở lên.
  • Mọi ngày được chỉ định đều phải trước năm 2037.

CampaignBudget

Chế độ cài đặt kiểm soát cách phân bổ ngân sách chiến dịch.

Biểu diễn dưới dạng JSON 
{
  "budgetId": string,
  "displayName": string,
  "budgetUnit": enum (BudgetUnit),
  "budgetAmountMicros": string,
  "dateRange": {
    object (DateRange)
  },
  "externalBudgetSource": enum (ExternalBudgetSource),
  "externalBudgetId": string,
  "invoiceGroupingId": string,
  "prismaConfig": {
    object (PrismaConfig)
  }
}
Trường
budgetId

string (int64 format)

Mã nhận dạng duy nhất của ngân sách chiến dịch. Do hệ thống chỉ định. Đừng đặt cho ngân sách mới.

Phải được đưa vào khi cập nhật hoặc thêm ngân sách quảng cáo vào campaignBudgets. Nếu không, một mã nhận dạng mới sẽ được tạo và chỉ định.
displayName

string

Bắt buộc. Tên hiển thị của ngân sách.

Phải được mã hoá theo UTF-8 với kích thước tối đa là 240 byte.
budgetUnit

enum (BudgetUnit)

Bắt buộc. Không thể thay đổi. Chỉ định xem ngân sách được đo lường bằng đơn vị tiền tệ hay số lượt hiển thị.
budgetAmountMicros

string (int64 format)

Bắt buộc. Tổng số tiền mà các phân đoạn đơn đặt hàng quảng cáo được liên kết có thể lập ngân sách.

Số tiền được tính theo đơn vị micro. Phải lớn hơn 0. Ví dụ: 500000000 đại diện cho 500 đơn vị tiền tệ tiêu chuẩn.
dateRange

object (DateRange)

Bắt buộc. Phạm vi ngày cho ngân sách chiến dịch. Các phân đoạn ngân sách được liên kết có thể có phạm vi ngày khác. Các giá trị này được phân giải theo múi giờ của nhà quảng cáo mẹ.

Cả startDate và endDate đều phải trước năm 2037.
externalBudgetSource

enum (ExternalBudgetSource)

Bắt buộc. Nguồn ngân sách bên ngoài.
externalBudgetId

string

Không thể thay đổi. Mã nhận dạng ngân sách này cho nguồn bên ngoài.

Nếu bạn đặt trường này và đặt cấp độ chi tiết của hoá đơn trong hồ sơ thanh toán tương ứng thành "Đơn đặt hàng cấp ngân sách", thì tất cả lượt hiển thị được phân phát theo ngân sách này sẽ bao gồm mã nhận dạng này trên hoá đơn.

Phải là duy nhất trong chiến dịch.
invoiceGroupingId

string

Không thể thay đổi. Mã nhận dạng dùng để nhóm các ngân sách sẽ được đưa vào cùng một hoá đơn.

Nếu bạn đặt trường này và đặt cấp hoá đơn của hồ sơ thanh toán tương ứng thành "Mã nhóm hoá đơn ngân sách", thì tất cả externalBudgetId có cùng invoiceGroupingId sẽ được nhóm vào cùng một hoá đơn.
prismaConfig

object (PrismaConfig)

Siêu dữ liệu bổ sung để công cụ Mediaocean Prisma sử dụng.

Bắt buộc đối với ngân sách Mediaocean.

Chỉ áp dụng cho nhà quảng cáo prismaEnabled.

ExternalBudgetSource

Nguồn bên ngoài cho một phân đoạn ngân sách chiến dịch.

Enum
EXTERNAL_BUDGET_SOURCE_UNSPECIFIED Giá trị nguồn ngân sách bên ngoài không được chỉ định hoặc không xác định trong phiên bản này.
EXTERNAL_BUDGET_SOURCE_NONE Ngân sách không có nguồn bên ngoài.
EXTERNAL_BUDGET_SOURCE_MEDIA_OCEAN Nguồn ngân sách là Mediaocean.

PrismaConfig

Chế độ cài đặt dành riêng cho công cụ Mediaocean Prisma.

Biểu diễn dưới dạng JSON 
{
  "prismaType": enum (PrismaType),
  "prismaCpeCode": {
    object (PrismaCpeCode)
  },
  "supplier": string
}
Trường
prismaType

enum (PrismaType)

Bắt buộc. Loại Prisma.
prismaCpeCode

object (PrismaCpeCode)

Bắt buộc. Mã khách hàng, mã sản phẩm và mã ước tính có liên quan trong công cụ Mediaocean Prisma.
supplier

string

Bắt buộc. Thực thể được phân bổ ngân sách này (DSP, trang web, v.v.).

PrismaType

Các loại ngân sách có thể có của Prisma.

Enum
PRISMA_TYPE_UNSPECIFIED Loại không được chỉ định hoặc không xác định trong phiên bản này.
PRISMA_TYPE_DISPLAY Loại màn hình.
PRISMA_TYPE_VIDEO Loại video.
PRISMA_TYPE_AUDIO Loại âm thanh.
PRISMA_TYPE_SOCIAL Loại mạng xã hội.
PRISMA_TYPE_FEE Loại phí.

PrismaCpeCode

Trung tâm thanh toán của Google hỗ trợ tìm kiếm và lọc theo các trường thành phần của mã này.

Biểu diễn dưới dạng JSON 
{
  "prismaClientCode": string,
  "prismaProductCode": string,
  "prismaEstimateCode": string
}
Trường
prismaClientCode

string

Mã khách hàng Prisma.
prismaProductCode

string

Mã sản phẩm Prisma.
prismaEstimateCode

string

Mã ước tính Prisma.

Phương thức

create

 Tạo chiến dịch mới.

delete

 Xoá vĩnh viễn một chiến dịch.

get

 Lấy một chiến dịch.

list

 Liệt kê các chiến dịch của một nhà quảng cáo.

patch

 Cập nhật chiến dịch hiện có.