Method: exchanges.orders.products.patch

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

Yêu cầu HTTP

PATCH https://dv360seller.googleapis.com/v1beta1/{product.name=exchanges/*/orders/*/products/*}

URL sử dụng cú pháp Chuyển mã gRPC.

Tham số đường dẫn

Thông số
product.name

string

Tên tài nguyên 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.

Nội dung yêu cầu

Nội dung yêu cầu chứa dữ liệu với cấu trúc sau:

Biểu diễn dưới dạng JSON 
{
  "product": {
    "name": string,
    "displayName": string,
    "externalDealId": string,
    "transactionType": enum (TransactionType),
    "pricingType": enum (PricingType),
    "updateTime": string,
    "startTime": string,
    "endTime": string,
    "rateDetails": {
      "rateType": enum (RateType),
      "rate": {
        object (Money)
      },
      "unitsPurchasedCount": string
    },
    "creativeConfig": [
      {
        "creativeType": enum (CreativeType),
        "dimensionCreativeConfig": {
          object (DimensionCreativeConfig)
        },
        "durationCreativeConfig": {
          object (DurationCreativeConfig)
        }
      }
    ],
    "makegood": boolean,
    "makegoodDetails": {
      "originalExternalDealId": string,
      "reason": string
    },
    "creativeSource": enum (CreativeSource),
    "mediumType": enum (MediumType),
    "audienceTargetingConfig": {
      "audienceType": enum (AudienceType)
    },
    "targetingCriteria": {
      "selectedTargetingOptions": [
        {
          object (SelectedTargetingOption)
        }
      ]
    },
    "forecastResult": {
      "forecasts": [
        {
          object (Forecast)
        }
      ]
    },
    "errorDetails": {
      "message": string,
      "instantDealErrorStatus": enum (InstantDealErrorStatus)
    },
    "frequencyCap": {
      "timeUnit": enum (TimeUnit),
      "maxImpressions": string
    },
    "program": string,
    "buyerCustomParameters": {
      string: string,
      ...
    },
    "etag": string
  },
  "updateMask": string
}
Trường
product.displayName

string

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

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

string

Mã nhận dạng bên ngoài. Đây là mã giao dịch trên hệ thống trao đổi. Tối đa 100 ký tự. Các ký tự được phép 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 cho tất cả sản phẩm. Bắt buộc.
product.transactionType

enum (TransactionType)

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

enum (PricingType)

Loại giá cho sản phẩm. Bắt buộc.
product.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".
product.startTime

string (Timestamp format)

Thời điểm 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 trong tương lai. 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".
product.endTime

string (Timestamp format)

Thời điểm sản phẩm này không còn hoạt động. 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".
product.rateDetails

object (RateDetails)

Chi tiết về giá. Bắt buộc.
product.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 đặt trước.
product.makegood
(deprecated)

boolean

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

object (MakegoodDetails)

Thông tin chi tiết về quảng cáo đền bù cho một sản phẩm. Bắt buộc khi sản phẩm là quảng cáo đền bù.
product.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. Không thể thay đổi sau khi tạo sản phẩm.
product.mediumType

enum (MediumType)

Loại phương tiện cho một sản phẩm. Giá trị mặc định là DIGITAL nếu không được chỉ định để tương thích ngược. Không thể thay đổi sau khi tạo sản phẩm.
product.audienceTargetingConfig

object (AudienceTargetingConfig)

Không bắt buộc. Cấu hình nhắm mục tiêu theo đối tượng được áp dụng ở cấp giao dịch trên sàn giao dịch.
product.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 Kịch bản giao dịch tức thì.
product.forecastResult

object (ForecastResult)

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

object (ErrorDetails)

Bạn phải nêu rõ thông tin chi tiết về lỗi khi không thể cập nhật một số trường sản phẩm. Bắt buộc khi không thể cung cấp kết quả dự đoán 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 Kịch bản giao dịch tức thì.
product.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 Kịch bản giao dịch tức thì.
product.program

string

Chỉ có đầu ra. Chương trình mà người mua đã tạo giao dịch tức thì. Để trống cho quy trình thông thường của sàn giao dịch. Chỉ áp dụng cho các Kịch bản giao dịch tức thì.
product.buyerCustomParameters

map (key: string, value: string)

Chỉ có đầu ra. Các tham số khoá/giá trị tuỳ chỉnh do người mua đặt trên yêu cầu giao dịch tức thì. Chỉ áp dụng cho các Kịch bản giao dịch tức thì.

Một đối tượng chứa danh sách các cặp "key": value. Ví dụ: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
product.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 trường này cho một bản cập nhật nếu trường etag không trống. Chỉ áp dụng cho các Kịch bản giao dịch tức thì.
updateMask

string (FieldMask format)

Mặt nạ để kiểm soát những trường cần cập nhật. Bắt buộc.

Đây là danh sách tên đầy đủ của các trường, được phân tách bằng dấu phẩy. Ví dụ: "user.displayName,photo"

Nội dung phản hồi

Nếu thành công, nội dung phản hồi sẽ chứa một thực thể của Product.

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

  • https://www.googleapis.com/auth/doubleclickbidmanager

Để biết thêm thông tin, hãy xem OAuth 2.0 Overview.