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

المعرّف الخارجي هذا هو رقم تعريف الصفقة في نظام التبادل. ‫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.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.