Method: exchanges.orders.products.patch

محصولی را به‌روز می‌کند.

درخواست HTTP

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

نشانی وب از نحو تراتبدیل 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 کدبندی شده باشد و حداکثر اندازه آن ۲۴۰ بایت باشد. الزامی.
product.externalDealId

string

شناسه خارجی. این شناسه معامله در سیستم مبادله است. حداکثر ۱۰۰ نویسه. نویسه‌های مجاز عبارتند از الفباعددی، زیرخط، خط تیره، و نقطه. باید در همه محصولات منحصربه‌فرد باشد. الزامی.
product.transactionType

enum (TransactionType)

نوع تراکنش محصول. الزامی.
product.pricingType

enum (PricingType)

نوع قیمت‌گذاری برای محصول. الزامی.
product.updateTime
(deprecated)

string (Timestamp format)

مُهر زمان آخرین به‌روزرسانی محصول.

از RFC 3339 استفاده می‌کند، که در آن خروجی تولیدشده همیشه Z-نرمال‌شده است و از ۰، ۳، ۶، یا ۹ رقم اعشاری استفاده می‌کند. انحراف‌های غیراز «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 باشد. زمان شروع نمی‌تواند بیشتر از ۱ سال در آینده باشد. الزامی.

از RFC 3339 استفاده می‌کند، که در آن خروجی تولیدشده همیشه Z-نرمال‌شده است و از ۰، ۳، ۶، یا ۹ رقم اعشاری استفاده می‌کند. انحراف‌های غیراز «Z» نیز پذیرفته می‌شود. مثال‌ها: "2014-10-02T15:01:23Z"، "2014-10-02T15:01:23.045123456Z"، یا "2014-10-02T15:01:23+05:30".
product.endTime

string (Timestamp format)

زمانی که این محصول غیرفعال می‌شود. نمی‌تواند بعداز سال ۲۰۳۶ باشد. الزامی.

از RFC 3339 استفاده می‌کند، که در آن خروجی تولیدشده همیشه Z-نرمال‌شده است و از ۰، ۳، ۶، یا ۹ رقم اعشاری استفاده می‌کند. انحراف‌های غیراز «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)

اختیاری. پیکربندی هدف‌یابی مخاطب در سطح معامله در صرافی اعمال شد.
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 خالی نباشد. فقط برای «سناریوهای معامله فوری» قابل‌اعمال است.
updateMask

string (FieldMask format)

ماسک برای کنترل اینکه کدام فیلدها به‌روزرسانی شوند. الزامی.

این فهرست جداشده با کاما از نام‌های کاملاً واجدشرایط فیلدها است. مثال: "user.displayName,photo".

بدنه پاسخ

اگر موفقیت‌آمیز باشد، بدنه پاسخ حاوی نمونه‌ای از Product است.

دامنه‌های مجوز

به محدوده OAuth زیر نیاز دارد:

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

برای اطلاعات بیشتر، به OAuth 2.0 Overview مراجعه کنید.