REST Resource: exchanges.orders.products

Tài nguyên: Sản phẩm

Sản phẩm

Biểu diễn dưới dạng JSON 
{
  "name": string,
  "displayName": string,
  "externalDealId": string,
  "transactionType": enum (TransactionType),
  "pricingType": enum (PricingType),
  "updateTime": string,
  "startTime": string,
  "endTime": string,
  "rateDetails": {
    object (RateDetails)
  },
  "creativeConfig": [
    {
      object (CreativeConfig)
    }
  ],
  "makegood": boolean,
  "makegoodDetails": {
    object (MakegoodDetails)
  },
  "creativeSource": enum (CreativeSource),
  "mediumType": enum (MediumType),
  "audienceTargetingConfig": {
    object (AudienceTargetingConfig)
  },
  "targetingCriteria": {
    object (TargetingCriteria)
  },
  "forecastResult": {
    object (ForecastResult)
  },
  "errorDetails": {
    object (ErrorDetails)
  },
  "frequencyCap": {
    object (FrequencyCap)
  },
  "etag": string
}
Trường
name

string

Tên tuyến đường tương đối của sản phẩm. Do máy chủ tạo. Ví dụ: "exchanges/1234/orders/5678/products/abc". Chỉ có đầu ra.
displayName

string

Tên hiển thị của sản phẩm.

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

string

Mã nhận dạng bên ngoài. Đây là mã giao dịch trên hệ thống sàn giao dịch. Tối đa 100 ký tự. Các ký tự hợp lệ là chữ và số, dấu gạch dưới, dấu gạch ngang và dấu chấm. Phải là duy nhất trên tất cả các sản phẩm. Bắt buộc.
transactionType

enum (TransactionType)

Loại giao dịch sản phẩm. Bắt buộc.
pricingType

enum (PricingType)

Loại định giá cho sản phẩm. Bắt buộc.
updateTime
(deprecated)

string (Timestamp format)

Dấu thời gian khi sản phẩm được cập nhật lần gần đây nhất.

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".
startTime

string (Timestamp format)

Thời gian sản phẩm này bắt đầu hoạt động. Phải sớm hơn endTime. Thời gian bắt đầu không được quá 1 năm nữa. Bắt buộc.

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".
endTime

string (Timestamp format)

Thời gian sản phẩm này chuyển sang trạng thái không hoạt động. Hiện tại, ngày này không được muộn hơn năm 2036. Bắt buộc.

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".
rateDetails

object (RateDetails)

Thông tin chi tiết về giá. Bắt buộc.
creativeConfig[]

object (CreativeConfig)

Yêu cầu về mẫu quảng cáo cho một sản phẩm. Bắt buộc đối với sản phẩm có loại giao dịch được đặt trước.
makegood
(deprecated)

boolean

Cho biết liệu một sản phẩm có phải là sản phẩm bù đắp hay không.
makegoodDetails
(deprecated)

object (MakegoodDetails)

Thông tin chi tiết về quảng cáo thay thế cho một sản phẩm. Bắt buộc khi sản phẩm là sản phẩm thay thế.
creativeSource

enum (CreativeSource)

Nguồn mẫu quảng cáo cho một sản phẩm. Không bắt buộc, mặc định là CREATIVE_SOURCE_ADVERTISER. Bạn không thể thay đổi thông tin này sau khi tạo sản phẩm.
mediumType

enum (MediumType)

Loại phương tiện truyền thông của một sản phẩm. Mặc định là DIGITAL nếu không được chỉ định để tương thích ngược. Bạn không thể thay đổi thông tin này sau khi tạo sản phẩm.
audienceTargetingConfig

object (AudienceTargetingConfig)

Không bắt buộc. Cấu hình nhắm mục tiêu theo đối tượng đã chọn được áp dụng ở cấp thoả thuận trên Sàn giao dịch.
targetingCriteria

object (TargetingCriteria)

Chỉ có đầu ra. Tài liệu tham khảo về tiêu chí nhắm mục tiêu sản phẩm. Chỉ áp dụng cho các trường hợp có ưu đãi tức thì.
forecastResult

object (ForecastResult)

Kết quả dự đoán về sản phẩm. Bắt buộc khi tiêu chí nhắm mục tiêu không trống và không có thông tin dự đoán. Chỉ áp dụng cho các trường hợp có ưu đãi tức thì.
errorDetails

object (ErrorDetails)

Bạn phải chỉ định thông tin chi tiết về lỗi khi không thể cập nhật các trường cụ thể của sản phẩm. Bắt buộc khi không thể cung cấp kết quả dự báo do tiêu chí nhắm mục tiêu hoặc không thể cập nhật sản phẩm. Chỉ áp dụng cho các trường hợp có ưu đãi tức thì.
frequencyCap

object (FrequencyCap)

Chỉ có đầu ra. Giới hạn tần suất do người mua chọn. Chỉ áp dụng cho các trường hợp có ưu đãi tức thì.
etag

string

Một etag cần được chỉ định khi cập nhật sản phẩm. Bạn chỉ cần chỉ định cho bản cập nhật nếu trường etag không trống. Chỉ áp dụng cho các trường hợp có ưu đãi tức thì.

CreativeConfig

Cấu hình yêu cầu về mẫu quảng cáo cho một sản phẩm.

Biểu diễn dưới dạng JSON 
{
  "creativeType": enum (CreativeType),
  "dimensionCreativeConfig": {
    object (DimensionCreativeConfig)
  },
  "durationCreativeConfig": {
    object (DurationCreativeConfig)
  }
}
Trường
creativeType

enum (CreativeType)

Loại mẫu quảng cáo. Bắt buộc.
dimensionCreativeConfig

object (DimensionCreativeConfig)

Cấu hình cho mẫu quảng cáo hiển thị.

Trường này không được hỗ trợ cho mẫu quảng cáo gốc (CREATIVE_TYPE_NATIVE).
durationCreativeConfig

object (DurationCreativeConfig)

Cấu hình cho mẫu quảng cáo dạng video.

CreativeType

Các loại mẫu quảng cáo có thể có.

Enum
CREATIVE_TYPE_UNSPECIFIED Chưa xác định loại mẫu quảng cáo. Giá trị đầu vào không hợp lệ.
CREATIVE_TYPE_DISPLAY Loại mẫu quảng cáo hiển thị.
CREATIVE_TYPE_VIDEO Loại mẫu quảng cáo dạng video.
CREATIVE_TYPE_AUDIO Loại mẫu quảng cáo dạng âm thanh.
CREATIVE_TYPE_NATIVE Loại mẫu quảng cáo gốc.

DimensionCreativeConfig

Kích thước mẫu quảng cáo hiển thị tính bằng pixel.

Biểu diễn dưới dạng JSON 
{
  "width": integer,
  "height": integer
}
Trường
width

integer

Chiều rộng của mẫu quảng cáo hiển thị. Bắt buộc.
height

integer

Chiều cao của mẫu quảng cáo hiển thị. Bắt buộc.

DurationCreativeConfig

Cấu hình cho mẫu quảng cáo theo thời lượng.

Biểu diễn dưới dạng JSON 
{
  "duration": string,
  "durationMatchType": enum (DurationMatchType),
  "skippableMatchType": enum (SkippableMatchType)
}
Trường
duration

string (Duration format)

Thời lượng của quảng cáo dạng video tính bằng giây. Bắt buộc

Thời lượng tính bằng giây, có tối đa 9 chữ số thập phân, kết thúc bằng "s". Ví dụ: "3.5s".
durationMatchType

enum (DurationMatchType)

Tiêu chí so khớp thời lượng.
skippableMatchType

enum (SkippableMatchType)

Loại có thể bỏ qua của mẫu quảng cáo dạng video.

DurationMatchType

Các định dạng có thể có cho tiêu chí so khớp thời lượng.

Enum
DURATION_MATCH_TYPE_UNSPECIFIED Tiêu chí so khớp thời lượng không được chỉ định hoặc không xác định trong phiên bản này. Giá trị đầu vào không hợp lệ.
DURATION_MATCH_TYPE_EQUAL_TO Thời lượng của mẫu quảng cáo phải giống với thời lượng bắt buộc.
DURATION_MATCH_TYPE_LESS_THAN_OR_EQUAL_TO Thời lượng của mẫu quảng cáo phải bằng hoặc ít hơn thời lượng bắt buộc.

SkippableMatchType

Các định dạng có thể sử dụng cho một sản phẩm.

Enum
SKIPPABLE_MATCH_TYPE_UNSPECIFIED Loại có thể bỏ qua chưa được chỉ định hoặc không xác định trong phiên bản này. Giá trị đầu vào không hợp lệ.
SKIPPABLE_MATCH_TYPE_SKIPPABLE Mẫu quảng cáo cần có thể bỏ qua.
SKIPPABLE_MATCH_TYPE_NOT_SKIPPABLE Mẫu quảng cáo không được phép bỏ qua.
SKIPPABLE_MATCH_TYPE_ANY Mẫu quảng cáo có thể bỏ qua hoặc không thể bỏ qua.

MakegoodDetails

Cấu hình cho thông tin chi tiết về quảng cáo thay thế.

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

string

Mã giao dịch bên ngoài ban đầu yêu cầu quảng cáo đền bù. Tối đa 100 ký tự. Các ký tự hợp lệ là chữ và số, dấu gạch dưới, dấu gạch ngang và dấu chấm. Bắt buộc.
reason

string

Lý do tạo quảng cáo đền bù do người bán tạo. Tối đa 250 ký tự. Bắt buộc.

CreativeSource

Nguồn mẫu quảng cáo; nơi mẫu quảng cáo sẽ được phân phát.

Enum
CREATIVE_SOURCE_UNSPECIFIED Nguồn của mẫu quảng cáo không được chỉ định hoặc không xác định trong phiên bản này. Giá trị đầu vào không hợp lệ.
CREATIVE_SOURCE_ADVERTISER DV360 sẽ phân phát mẫu quảng cáo.
CREATIVE_SOURCE_PUBLISHER Nhà xuất bản sẽ phân phát mẫu quảng cáo. Hiện tại, chúng tôi không hỗ trợ mẫu quảng cáo do nhà xuất bản lưu trữ; mọi yêu cầu cố gắng đặt nguồn mẫu quảng cáo thành CREATIVE_SOURCE_PUBLISHER sẽ không thành công.

AudienceTargetingConfig

Cấu hình để nhắm mục tiêu theo đối tượng.

Biểu diễn dưới dạng JSON 
{
  "audienceType": enum (AudienceType)
}
Trường
audienceType

enum (AudienceType)

Loại đối tượng. Bắt buộc.

AudienceType

Loại đối tượng.

Enum
AUDIENCE_TYPE_UNSPECIFIED Loại đối tượng không xác định. Không hợp lệ đối với thông tin đầu vào.
AUDIENCE_TYPE_COMMERCE Loại đối tượng thương mại.

TargetingCriteria

Đã chỉ định tiêu chí nhắm mục tiêu.

Biểu diễn dưới dạng JSON 
{
  "selectedTargetingOptions": [
    {
      object (SelectedTargetingOption)
    }
  ]
}
Trường
selectedTargetingOptions[]

object (SelectedTargetingOption)

Các lựa chọn đã chọn.

SelectedTargetingOption

Lựa chọn nhắm mục tiêu đã chọn cho một loại tiêu chí nhắm mục tiêu.

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

  // Union field value can be only one of the following:
  "audienceSelection": {
    object (AudienceSelection)
  },
  "targetingSelection": {
    object (TargetingSelection)
  }
  // End of list of possible types for union field value.
}
Trường
type

enum (TargetingType)

Loại tiêu chí nhắm mục tiêu được liên kết với các lựa chọn đã chọn.
Trường nhóm value. Bạn chỉ có thể thêm một loại lựa chọn. Lựa chọn đã chọn phải tương ứng với TargetingType đã chọn cho trường "type". value chỉ có thể là một trong những trạng thái sau:
audienceSelection

object (AudienceSelection)

Đối tượng đã chọn.
targetingSelection

object (TargetingSelection)

Tập hợp chung gồm các mã lựa chọn đã chọn.

TargetingType

Các loại tiêu chí nhắm mục tiêu.

Enum
TARGETING_TYPE_UNSPECIFIED Loại nhắm mục tiêu chưa được chỉ định, không hợp lệ cho dữ liệu đầu vào.
TARGETING_TYPE_AUDIENCE Đối tượng thuộc loại nhắm mục tiêu.
TARGETING_TYPE_COUNTRY Quốc gia theo loại tiêu chí nhắm mục tiêu.
TARGETING_TYPE_DMA Loại tiêu chí nhắm mục tiêu dma.
TARGETING_TYPE_PROGRAMMER Loại nhắm mục tiêu của nhà lập trình.
TARGETING_TYPE_BRAND Loại nhắm mục tiêu theo thương hiệu.
TARGETING_TYPE_CONTENT_GENRE Thể loại nội dung của loại tiêu chí nhắm mục tiêu.
TARGETING_TYPE_DEVICE Thiết bị loại tiêu chí nhắm mục tiêu.
TARGETING_TYPE_OPERATING_SYSTEM Hệ điều hành loại tiêu chí nhắm mục tiêu.
TARGETING_TYPE_RATING Mức độ phù hợp của loại tiêu chí nhắm mục tiêu.
TARGETING_TYPE_ENVIRONMENT Môi trường loại tiêu chí nhắm mục tiêu.
TARGETING_TYPE_LANGUAGE Ngôn ngữ loại tiêu chí nhắm mục tiêu.
TARGETING_TYPE_GEO Loại tiêu chí nhắm mục tiêu theo địa lý.
TARGETING_TYPE_AGE Độ tuổi loại nhắm mục tiêu.
TARGETING_TYPE_GENDER Giới tính của loại nhắm mục tiêu.
TARGETING_TYPE_CONTEXTUAL_SEGMENT Loại tiêu chí nhắm mục tiêu theo phân khúc ngữ cảnh.
TARGETING_TYPE_REQUEST_FORMAT Định dạng yêu cầu loại nhắm mục tiêu.
TARGETING_TYPE_PUBLISHER Nhà xuất bản loại tiêu chí nhắm mục tiêu.
TARGETING_TYPE_INVENTORY_SIZE Kích thước loại nhắm mục tiêu.
TARGETING_TYPE_NETWORK Mạng loại nhắm mục tiêu.
TARGETING_TYPE_PLATFORM Nền tảng loại nhắm mục tiêu.
TARGETING_TYPE_VIDEO_DELIVERY_TYPE Loại nhắm mục tiêu theo loại phân phối video.
TARGETING_TYPE_VIDEO_MINIMUM_PLAYER_SIZE Kích thước tối thiểu của trình phát video thuộc loại nhắm mục tiêu.

AudienceSelection

Các lựa chọn nhắm mục tiêu theo đối tượng đã chọn.

Biểu diễn dưới dạng JSON 
{
  "includedOrGroups": [
    {
      object (OrGroup)
    }
  ],
  "excludedOptionIds": [
    string
  ]
}
Trường
includedOrGroups[]

object (OrGroup)

Các lựa chọn được đưa vào được kết hợp với AND, mỗi lựa chọn được đưa vào có thể là một lựa chọn riêng lẻ hoặc một nhóm lựa chọn được kết hợp với OR.
excludedOptionIds[]

string (int64 format)

Các lựa chọn bị loại trừ được kết hợp với OR.

OrGroup

Một nhóm các lựa chọn được chọn kết hợp bằng OR.

Biểu diễn dưới dạng JSON 
{
  "optionIds": [
    string
  ]
}
Trường
optionIds[]

string (int64 format)

Mã lựa chọn đã chọn.

TargetingSelection

Một tập hợp gồm một hoặc nhiều mã lựa chọn đã chọn, áp dụng cho hầu hết các loại nhắm mục tiêu.

Biểu diễn dưới dạng JSON 
{
  "optionIds": [
    string
  ]
}
Trường
optionIds[]

string (int64 format)

Mã lựa chọn đã chọn.

ForecastResult

Đã chỉ định kết quả dự đoán.

Biểu diễn dưới dạng JSON 
{
  "forecasts": [
    {
      object (Forecast)
    }
  ]
}
Trường
forecasts[]

object (Forecast)

Dự báo. "forecastCategory" phải là giá trị riêng biệt cho từng phần tử được chỉ định.

Dự báo

Thông tin dự báo về danh mục dự báo được chỉ định.

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

  // Union field forecast_data can be only one of the following:
  "number": string,
  "percentage": integer,
  "cpmPrice": {
    object (Money)
  },
  "cpmRange": {
    object (CpmRange)
  },
  "forecastBreakdownData": {
    object (ForecastBreakdownData)
  }
  // End of list of possible types for union field forecast_data.
}
Trường
forecastCategory

enum (ForecastCategory)

Danh mục dự báo được chỉ định mà số liệu thống kê dự báo đại diện.
Trường nhóm forecast_data. Bạn chỉ có thể thêm một loại dữ liệu thống kê. Dữ liệu được điền sẵn phải tương ứng với trường "forecastCategory". forecast_data chỉ có thể là một trong những trạng thái sau:
number

string (int64 format)

Dữ liệu số.
percentage

integer

Dữ liệu phần trăm.
cpmPrice

object (Money)

Dữ liệu về giá CPM.
cpmRange

object (CpmRange)

Dữ liệu về phạm vi giá CPM.
forecastBreakdownData

object (ForecastBreakdownData)

Dữ liệu bảng chi tiết thông tin dự báo.

ForecastCategory

Danh mục dự đoán.

Enum
FORECAST_CATEGORY_UNSPECIFIED Danh mục chưa xác định. Không hợp lệ đối với thông tin đầu vào.
FORECAST_CATEGORY_TOTAL_OPPORTUNITIES Tổng số cơ hội. Dữ liệu số.
FORECAST_CATEGORY_TOTAL_AUDIENCE Tổng số khán giả. Dữ liệu số.
FORECAST_CATEGORY_DIGITAL_TRP Điểm xếp hạng mục tiêu kỹ thuật số. Dữ liệu phần trăm.
FORECAST_CATEGORY_SUGGESTED_CPM Giá CPM đề xuất. Phạm vi CPM hoặc dữ liệu về giá CPM.
FORECAST_CATEGORY_UNIQUE_REACH Dự báo phạm vi tiếp cận riêng biệt. Dữ liệu số.
FORECAST_CATEGORY_FORECAST_BREAKDOWN Bảng chi tiết thông tin dự báo. Dữ liệu bảng chi tiết thông tin dự báo.

CpmRange

Phạm vi CPM chứa CPM tối thiểu và tối đa.

Biểu diễn dưới dạng JSON 
{
  "minCpm": {
    object (Money)
  },
  "maxCpm": {
    object (Money)
  }
}
Trường
minCpm

object (Money)

Giới hạn dưới của phạm vi CPM.
maxCpm

object (Money)

Giới hạn trên của phạm vi CPM.

ForecastBreakdownData

Dữ liệu bảng chi tiết thông tin dự báo chứa danh sách bảng chi tiết thông tin dự báo.

Biểu diễn dưới dạng JSON 
{
  "forecastBreakdowns": [
    {
      object (ForecastBreakdown)
    }
  ]
}
Trường
forecastBreakdowns[]

object (ForecastBreakdown)

Danh sách thông tin dự báo chi tiết.

ForecastBreakdown

Bảng phân tích dự báo của lựa chọn nhắm mục tiêu đã chọn.

Biểu diễn dưới dạng JSON 
{
  "selectedTargetingOption": {
    object (SelectedTargetingOption)
  },

  // Union field breakdown_data can be only one of the following:
  "impressions": string
  // End of list of possible types for union field breakdown_data.
}
Trường
selectedTargetingOption

object (SelectedTargetingOption)

Lựa chọn nhắm mục tiêu đã chọn cho một loại tiêu chí nhắm mục tiêu.
Trường nhóm breakdown_data. Bạn chỉ có thể thêm một loại dữ liệu phân tích. breakdown_data chỉ có thể là một trong những trạng thái sau:
impressions

string (int64 format)

Số lượt hiển thị dự kiến.

ErrorDetails

Thông tin chi tiết về lỗi được chỉ định khi bản cập nhật có lỗi.

Biểu diễn dưới dạng JSON 
{
  "message": string,
  "instantDealErrorStatus": enum (InstantDealErrorStatus)
}
Trường
message

string

Thông báo được chỉ định khi bản cập nhật có lỗi.
instantDealErrorStatus

enum (InstantDealErrorStatus)

Trạng thái lỗi được chỉ định khi bản cập nhật có lỗi đối với ưu đãi tức thì.

InstantDealErrorStatus

Trạng thái lỗi được chỉ định khi có lỗi xảy ra trong quá trình cập nhật thoả thuận tức thì.

Enum
INSTANT_DEAL_ERROR_STATUS_UNSPECIFIED Trạng thái lỗi không xác định.
INSTANT_DEAL_ERROR_STATUS_INVENTORY_UNAVAILABLE Trạng thái lỗi cho biết kho hàng không có sẵn.
INSTANT_DEAL_ERROR_STATUS_FORECAST_UNAVAILABLE Trạng thái lỗi cho biết không có thông tin dự báo.
INSTANT_DEAL_ERROR_STATUS_INVALID_INPUT Trạng thái lỗi cho biết có các trường đầu vào không hợp lệ.

FrequencyCap

Số lần một người dùng có thể nhìn thấy cùng một quảng cáo trong một khoảng thời gian nhất định

Biểu diễn dưới dạng JSON 
{
  "timeUnit": enum (TimeUnit),
  "maxImpressions": string
}
Trường
timeUnit

enum (TimeUnit)

Đơn vị thời gian mà giới hạn tần suất sẽ được áp dụng.
maxImpressions

string (int64 format)

Số lần tối đa mà một người dùng có thể nhìn thấy cùng một quảng cáo trong khoảng thời gian này.

TimeUnit

Đơn vị thời gian mà giới hạn tần suất sẽ được áp dụng.

Enum
TIME_UNIT_UNSPECIFIED Đơn vị thời gian không xác định.
TIME_UNIT_LIFETIME Giới hạn tần suất sẽ được áp dụng trong toàn bộ thời gian tồn tại.
TIME_UNIT_MONTHS Giới hạn tần suất sẽ được áp dụng trong một số tháng.
TIME_UNIT_WEEKS Giới hạn tần suất sẽ được áp dụng trong một số tuần.
TIME_UNIT_DAYS Giới hạn tần suất sẽ được áp dụng cho một số ngày.

Phương thức

create

 Tạo một sản phẩm.

get

 Nhận sản phẩm.

list

 Liệt kê sản phẩm.

patch

 Cập nhật một sản phẩm.