Method: exchanges.orders.products.patch

อัปเดตผลิตภัณฑ์

คำขอ HTTP

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

URL ใช้ไวยากรณ์การแปลงรหัส gRPC

พารามิเตอร์เส้นทาง

พารามิเตอร์
product.name

string

ชื่อทรัพยากรแบบสัมพัทธ์สำหรับผลิตภัณฑ์ สร้างโดยเซิร์ฟเวอร์ ตัวอย่าง: "exchanges/1234/orders/5678/products/abc" เอาต์พุตเท่านั้น

เนื้อความของคำขอ

เนื้อหาของคำขอมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้

การแสดง 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
}
ช่อง
product.displayName

string

ชื่อที่แสดงของผลิตภัณฑ์

ต้องเข้ารหัส UTF-8 โดยมีขนาดสูงสุด 240 ไบต์ ต้องระบุ
product.externalDealId

string

รหัสภายนอก นี่คือรหัสดีลในระบบ Exchange สูงสุด 100 อักขระ อักขระที่อนุญาตคือตัวอักษรและตัวเลขคละกัน ขีดล่าง ขีดกลาง และจุด ต้องไม่ซ้ำกันในผลิตภัณฑ์ทั้งหมด ต้องระบุ
product.transactionType

enum (TransactionType)

ประเภทธุรกรรมของผลิตภัณฑ์ ต้องระบุ
product.pricingType

enum (PricingType)

ประเภทการกำหนดราคาสำหรับผลิตภัณฑ์ ต้องระบุ
product.updateTime
(deprecated)

string (Timestamp format)

การประทับเวลาที่อัปเดตผลิตภัณฑ์ครั้งล่าสุด

ใช้ RFC 3339 โดยเอาต์พุตที่สร้างขึ้นจะได้รับการแปลงเป็นรูปแบบ Z เสมอ และใช้ตัวเลขเศษส่วน 0, 3, 6 หรือ 9 หลัก นอกจากนี้ ระบบยังยอมรับออฟเซ็ตอื่นๆ นอกเหนือจาก "Z" ด้วย เช่น "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" หรือ "2014-10-02T15:01:23+05:30"
product.startTime

string (Timestamp format)

เวลาที่ผลิตภัณฑ์นี้เริ่มทำงาน ต้องอยู่ก่อน endTime เวลาเริ่มต้นต้องไม่เกิน 1 ปีนับจากนี้ ต้องระบุ

ใช้ RFC 3339 โดยเอาต์พุตที่สร้างขึ้นจะได้รับการแปลงเป็นรูปแบบ Z เสมอ และใช้ตัวเลขเศษส่วน 0, 3, 6 หรือ 9 หลัก นอกจากนี้ ระบบยังยอมรับออฟเซ็ตอื่นๆ นอกเหนือจาก "Z" ด้วย เช่น "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" หรือ "2014-10-02T15:01:23+05:30"
product.endTime

string (Timestamp format)

เวลาที่ผลิตภัณฑ์นี้จะไม่มีการใช้งาน ต้องไม่เกินปี 2579 ต้องระบุ

ใช้ RFC 3339 โดยเอาต์พุตที่สร้างขึ้นจะได้รับการแปลงเป็นรูปแบบ Z เสมอ และใช้ตัวเลขเศษส่วน 0, 3, 6 หรือ 9 หลัก นอกจากนี้ ระบบยังยอมรับออฟเซ็ตอื่นๆ นอกเหนือจาก "Z" ด้วย เช่น "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" หรือ "2014-10-02T15:01:23+05:30"
product.rateDetails

object (RateDetails)

รายละเอียดราคา ต้องระบุ
product.creativeConfig[]

object (CreativeConfig)

ข้อกำหนดด้านครีเอทีฟโฆษณาสำหรับผลิตภัณฑ์ ต้องระบุสำหรับผลิตภัณฑ์ประเภทธุรกรรมที่จองไว้
product.makegood
(deprecated)

boolean

ระบุว่าผลิตภัณฑ์เป็นผลิตภัณฑ์ชดเชยหรือไม่
product.makegoodDetails
(deprecated)

object (MakegoodDetails)

รายละเอียดค่าชดเชยสำหรับผลิตภัณฑ์ ต้องระบุเมื่อผลิตภัณฑ์เป็น Makegood
product.creativeSource

enum (CreativeSource)

แหล่งที่มาของครีเอทีฟโฆษณาสำหรับผลิตภัณฑ์ ไม่บังคับ ค่าเริ่มต้นคือ CREATIVE_SOURCE_ADVERTISER เปลี่ยนไม่ได้หลังจากสร้างผลิตภัณฑ์แล้ว
product.mediumType

enum (MediumType)

ประเภทสื่อสำหรับผลิตภัณฑ์ ค่าเริ่มต้นจะเป็น DIGITAL หากไม่ได้ระบุไว้เพื่อความเข้ากันได้แบบย้อนหลัง ทั้งนี้ คุณจะเปลี่ยนแปลงข้อมูลนี้หลังจากที่สร้างผลิตภัณฑ์แล้วไม่ได้
product.audienceTargetingConfig

object (AudienceTargetingConfig)

ไม่บังคับ การกำหนดค่าการกำหนดกลุ่มเป้าหมายที่ใช้ในระดับดีลใน Exchange
product.targetingCriteria

object (TargetingCriteria)

เอาต์พุตเท่านั้น ข้อมูลอ้างอิงเกณฑ์การกำหนดเป้าหมายผลิตภัณฑ์ ใช้ได้กับสถานการณ์ดีลแบบทันทีเท่านั้น
product.forecastResult

object (ForecastResult)

ผลการคาดการณ์ผลิตภัณฑ์ ต้องระบุเมื่อเกณฑ์การกำหนดเป้าหมายไม่ว่างเปล่าและไม่มีการคาดการณ์ ใช้ได้กับสถานการณ์ดีลแบบทันทีเท่านั้น
product.errorDetails

object (ErrorDetails)

ต้องระบุรายละเอียดข้อผิดพลาดเมื่ออัปเดตช่องสินค้าที่เฉพาะเจาะจงไม่ได้ ต้องระบุเมื่อไม่สามารถแสดงผลการคาดการณ์ได้เนื่องจากเกณฑ์การกำหนดเป้าหมาย หรือไม่สามารถอัปเดตผลิตภัณฑ์ได้ ใช้ได้กับสถานการณ์ดีลแบบทันทีเท่านั้น
product.frequencyCap

object (FrequencyCap)

เอาต์พุตเท่านั้น ความถี่สูงสุดที่ผู้ซื้อเลือก ใช้ได้กับสถานการณ์ดีลแบบทันทีเท่านั้น
product.program

string

เอาต์พุตเท่านั้น โปรแกรมที่ผู้ซื้อใช้สร้างดีลแบบทันที เว้นว่างไว้สำหรับขั้นตอนการแลกเปลี่ยนปกติ ใช้ได้กับสถานการณ์ดีลแบบทันทีเท่านั้น
product.buyerCustomParameters

map (key: string, value: string)

เอาต์พุตเท่านั้น พารามิเตอร์คีย์/ค่าที่กำหนดเองซึ่งผู้ซื้อตั้งค่าไว้ในคำขอดีลแบบทันที ใช้ได้กับสถานการณ์ดีลแบบทันทีเท่านั้น

ออบเจ็กต์ที่มีรายการคู่ "key": value เช่น { "name": "wrench", "mass": "1.3kg", "count": "3" }
product.etag

string

ETag ที่ต้องระบุเมื่ออัปเดตผลิตภัณฑ์ คุณต้องระบุสำหรับการอัปเดตก็ต่อเมื่อช่อง etag ไม่ว่างเปล่า ใช้ได้กับสถานการณ์ดีลแบบทันทีเท่านั้น
updateMask

string (FieldMask format)

มาสก์เพื่อควบคุมช่องที่จะอัปเดต ต้องระบุ

ซึ่งเป็นรายการชื่อฟิลด์ที่สมบูรณ์ในตัวเองและคั่นด้วยคอมมา ตัวอย่าง: "user.displayName,photo"

เนื้อหาการตอบกลับ

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีอินสแตนซ์ Product

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

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

ดูข้อมูลเพิ่มเติมได้ที่ OAuth 2.0 Overview