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
    },
    "etag": string
  },
  "updateMask": string
}
ช่อง
product.displayName

string

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

ต้องเข้ารหัส UTF-8 และมีขนาดสูงสุด 240 ไบต์ ต้องระบุ

product.externalDealId

string

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

product.transactionType

enum (TransactionType)

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

product.pricingType

enum (PricingType)

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

product.updateTime
(deprecated)

string (Timestamp format)

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

ใช้ RFC 3339 ซึ่งเอาต์พุตที่สร้างขึ้นจะเป็นรูปแบบ Z-normalized เสมอ และใช้ตัวเลขทศนิยม 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-normalized เสมอ และใช้ตัวเลขทศนิยม 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)

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

ใช้ RFC 3339 ซึ่งเอาต์พุตที่สร้างขึ้นจะเป็นรูปแบบ Z-normalized เสมอ และใช้ตัวเลขทศนิยม 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)

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

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.etag

string

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

updateMask

string (FieldMask format)

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

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

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

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

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

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

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

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