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 ويستخدم 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. لا يمكن أن يكون وقت البدء بعد أكثر من عام واحد في المستقبل. مطلوب.

يستخدم معيار 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)

الوقت الذي يصبح فيه هذا المنتج غير نشط لا يمكن حاليًا أن يكون التاريخ بعد عام 2036. مطلوب.

يستخدم معيار 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)

تفاصيل التعويض عن منتج معيّن مطلوبة عندما يكون المنتج عبارة عن تعويض.
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.etag

string

علامة تبويب يجب تحديدها عند تعديل منتج. ولا يلزم تحديده إلا في حال إجراء تعديل إذا لم يكن حقل etag فارغًا. لا ينطبق إلا على سيناريوهات الصفقات الفورية.
updateMask

string (FieldMask format)

القناع للتحكّم في الحقول التي سيتم تعديلها مطلوب.

هذه قائمة مفصولة بفواصل تتضمّن أسماء حقول مؤهَّلة بالكامل. مثال: "user.displayName,photo"

نص الاستجابة

إذا كانت الاستجابة ناجحة، يحتوي نص الاستجابة على مثال Product.

نطاقات التفويض

يجب توفير نطاق OAuth التالي:

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

لمزيد من المعلومات، يُرجى الاطّلاع على OAuth 2.0 Overview.