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á 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 đơ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 trên 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, ENTITY_STATUS_ARCHIVED không được phép.
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.

Dấu thời gian ở định dạng "Zulu" RFC3339 UTC, có độ phân giải nano giây và tối đa 9 chữ số thập phân. Ví dụ: "2014-10-02T15:01:23Z" và "2014-10-02T15:01:23.045123456Z".
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 theo kế hoạch 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, chiến dịch sẽ sử dụng ngân sách không giới hạn.

CampaignGoal

Các 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ủa chiến dịch có thể có.

Enum
CAMPAIGN_GOAL_TYPE_UNSPECIFIED Giá trị mục tiêu chưa đượ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 lượt cài đặt ứng dụng hoặc lượt tương tác.
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

Các 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),

  // 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.
}
Trường
performanceGoalType

enum (PerformanceGoalType)

Bắt buộc. Loại mục tiêu hiệu suất.
Trường hợp hợp nhất performance_goal_value. 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. performance_goal_value chỉ có thể là một trong những giá trị sau:
performanceGoalAmountMicros

string (int64 format)

Số tiền mục tiêu, tính bằng phần triệu đơ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 thể hiện 1,5 đơn vị tiền tệ tiêu chuẩn.
performanceGoalPercentageMicros

string (int64 format)

Giá trị thập phân của tỷ lệ phần trăm mục tiêu tính bằng 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 thể hiện 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.

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 chưa đượ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 về 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 ở tỷ lệ phần trăm khả năng xem.
PERFORMANCE_GOAL_TYPE_CPIAVC Mục tiêu hiệu suất được đặt thành CPIAVC (chi phí mỗi lượt hiển thị có thể nghe và có thể xem đến hết).
PERFORMANCE_GOAL_TYPE_CPE Mục tiêu về 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 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ệ chuyển đổi trên lượt hiển thị (số lượt chuyển đổi trên mỗi lượt hiển thị) theo tỷ lệ phần trăm.
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ệ phần trăm số lượt 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ệ phần trăm tỷ lệ xem hết phần âm thanh (số lượt nghe hết phần âm thanh trên mỗi lượt hiển thị).
PERFORMANCE_GOAL_TYPE_VIDEO_COMPLETION_RATE Mục tiêu về hiệu suất được đặt theo tỷ lệ phần trăm 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

Các chế độ cài đặt theo dõi mức chi tiêu và thời lượng đã lên kế hoạch của 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 một plannedDates nhất định. Việc 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 trình bày dưới dạng phần triệu. Phải lớn hơn hoặc bằng 0. Ví dụ: 500000000 thể hiện 500 đơn vị tiêu chuẩn của đơn vị tiền tệ.
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 mã này dùng để tạo cảnh báo và nhắc nhở. Ví dụ: nếu ngày bay của bất kỳ đơn đặt hàng chèn con nào nằm ngoài phạm vi ngày này, thì giao diện người dùng sẽ hiển thị cảnh báo.
  • startDate là bắt buộc và phải là ngày hiện tại trở đi.
  • endDate là không bắt buộc. Nếu được chỉ định, phiên bản phải là startDate trở lên.
  • Mọi ngày được chỉ định phải trước năm 2037.

CampaignBudget

Các 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. Khô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 vào campaignBudgets. Nếu không, hệ thống sẽ tạo và chỉ định một mã nhận dạng mới.
displayName

string

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

Phải được mã hoá 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 thứ tự chèn được liên kết có thể lập ngân sách.

Số tiền được trình bày dưới dạng phần triệu. 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 của ngân sách chiến dịch. Các phân khúc ngân sách được liên kết có thể có phạm vi ngày khác nhau. 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 bên ngoài của ngân sách.
externalBudgetId

string

Không thể thay đổi. Mã nhận dạng giúp xác định 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 hoá đơn của hồ sơ thanh toán tương ứng thành "Số đơ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 theo ngân sách", thì tất cả externalBudgetId có cùng invoiceGroupingId sẽ được nhóm trong 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 prismaEnabled nhà quảng cáo.

ExternalBudgetSource

Nguồn bên ngoài cho một phân khúc ngân sách của 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

Các 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, sản phẩm và ước tính có liên quan từ công cụ Mediaocean Prisma.
supplier

string

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

PrismaType

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

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

Google Payments Center hỗ trợ tìm kiếm và lọc trên 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ã ứng dụ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

 Xóa vĩnh viễn chiến dịch.

get

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

list

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

listAssignedTargetingOptions

 Liệt kê các tùy chọn nhắm mục tiêu được chỉ định của một chiến dịch trên các loại nhắm mục tiêu.

patch

 Cập nhật chiến dịch hiện tại.