REST Resource: exchanges.orders.products

المورد: المنتج

المنتج

تمثيل JSON 
{
  "name": string,
  "displayName": string,
  "externalDealId": string,
  "transactionType": enum (TransactionType),
  "pricingType": enum (PricingType),
  "updateTime": string,
  "startTime": string,
  "endTime": string,
  "rateDetails": {
    object (RateDetails)
  },
  "creativeConfig": [
    {
      object (CreativeConfig)
    }
  ],
  "makegood": boolean,
  "makegoodDetails": {
    object (MakegoodDetails)
  },
  "creativeSource": enum (CreativeSource),
  "mediumType": enum (MediumType),
  "audienceTargetingConfig": {
    object (AudienceTargetingConfig)
  },
  "targetingCriteria": {
    object (TargetingCriteria)
  },
  "forecastResult": {
    object (ForecastResult)
  },
  "errorDetails": {
    object (ErrorDetails)
  },
  "frequencyCap": {
    object (FrequencyCap)
  },
  "etag": string
}
الحقول
name

string

اسم المسار النسبي للمنتج. يتم إنشاؤه بواسطة الخادم. مثال: "exchanges/1234/orders/5678/products/abc". النتائج فقط.
displayName

string

تمثّل هذه السمة الاسم المعروض للمنتج.

يجب أن يكون الترميز UTF-8 وبحجم 240 بايت كحد أقصى. الحقل مطلوب.
externalDealId

string

المعرّف الخارجي هذا هو رقم تعريف الصفقة في نظام التبادل. يمكن استخدام 100 حرف كحدّ أقصى. الأحرف المسموح بها هي الأحرف الأبجدية الرقمية والشرطة السفلية والشرطة العادية والنقطة. يجب أن يكون المعرّف فريدًا في جميع المنتجات. الحقل مطلوب.
transactionType

enum (TransactionType)

نوع معاملة المنتج الحقل مطلوب.
pricingType

enum (PricingType)

تمثّل هذه السمة نوع السعر للمنتج. الحقل مطلوب.
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".
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".
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".
rateDetails

object (RateDetails)

تفاصيل السعر الحقل مطلوب.
creativeConfig[]

object (CreativeConfig)

متطلبات المواد الإبداعية الخاصة بمنتج معيّن مطلوبة للمنتجات التي يكون نوع المعاملة فيها محجوزًا
makegood
(deprecated)

boolean

تحدّد هذه السمة ما إذا كان المنتج منتجًا تعويضيًا.
makegoodDetails
(deprecated)

object (MakegoodDetails)

تفاصيل التعويض عن الإعلان غير المعروض لمنتج مطلوبة عندما يكون المنتج عبارة عن تعويض.
creativeSource

enum (CreativeSource)

مصدر تصميم الإعلان الخاص بمنتج اختياري، ويتم ضبطه تلقائيًا على CREATIVE_SOURCE_ADVERTISER. لا يمكن تغيير هذا الخيار بعد إنشاء المنتج.
mediumType

enum (MediumType)

نوع الوسائط لمنتج يتم ضبط القيمة تلقائيًا على DIGITAL في حال عدم تحديدها من أجل التوافق مع الأنظمة القديمة. لا يمكن تغيير هذا الخيار بعد إنشاء المنتج.
audienceTargetingConfig

object (AudienceTargetingConfig)

الحقل اختياري. يتم تطبيق إعدادات استهداف الجمهور المحدّدة على مستوى الصفقة في "التبادل".
targetingCriteria

object (TargetingCriteria)

النتائج فقط. مراجع لمعايير استهداف المنتجات لا ينطبق هذا الخيار إلا على سيناريوهات "الصفقات الفورية".
forecastResult

object (ForecastResult)

نتائج توقّعات المنتجات يجب توفير هذه السمة عندما لا تكون معايير الاستهداف فارغة ولم يتم تقديم التوقّعات. لا ينطبق هذا الخيار إلا على سيناريوهات "الصفقات الفورية".
errorDetails

object (ErrorDetails)

يجب تحديد تفاصيل الخطأ عندما يتعذّر تعديل حقول منتج معيّن. يجب إدخال هذه السمة عندما يتعذّر تقديم نتيجة التوقّع بسبب معيار استهداف أو عندما يتعذّر إجراء تعديل على المنتج. لا ينطبق هذا الخيار إلا على سيناريوهات "الصفقات الفورية".
frequencyCap

object (FrequencyCap)

النتائج فقط. حدّ عدد مرات الظهور الذي يحدّده المشتري لا ينطبق هذا الخيار إلا على سيناريوهات "الصفقات الفورية".
etag

string

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

CreativeConfig

إعدادات متطلبات تصميمات الإعلانات لمنتج معيّن

تمثيل JSON 
{
  "creativeType": enum (CreativeType),
  "dimensionCreativeConfig": {
    object (DimensionCreativeConfig)
  },
  "durationCreativeConfig": {
    object (DurationCreativeConfig)
  }
}
الحقول
creativeType

enum (CreativeType)

نوع تصميم الإعلان الحقل مطلوب.
dimensionCreativeConfig

object (DimensionCreativeConfig)

إعدادات تصاميم الإعلانات الصورية

هذا الحقل غير متاح لتصاميم الإعلانات المدمجة مع المحتوى (CREATIVE_TYPE_NATIVE).
durationCreativeConfig

object (DurationCreativeConfig)

إعدادات تصاميم إعلانات الفيديو

CreativeType

أنواع التصاميم المحتملة

عمليات التعداد
CREATIVE_TYPE_UNSPECIFIED لم يتم تحديد نوع تصميم الإعلان. قيمة الإدخال غير صالحة.
CREATIVE_TYPE_DISPLAY نوع عرض تصميم الإعلان
CREATIVE_TYPE_VIDEO نوع تصميم الفيديو
CREATIVE_TYPE_AUDIO نوع الصوت
CREATIVE_TYPE_NATIVE نوع التصميم الأصلي.

DimensionCreativeConfig

عرض بُعد تصميم الإعلان بالبكسل

تمثيل JSON 
{
  "width": integer,
  "height": integer
}
الحقول
width

integer

تعرِض هذه السمة عرض تصميم الإعلان. الحقل مطلوب.
height

integer

تعرِض هذه السمة ارتفاع تصميم الإعلان. الحقل مطلوب.

DurationCreativeConfig

إعدادات تصميم الإعلان من حيث المدة.

تمثيل JSON 
{
  "duration": string,
  "durationMatchType": enum (DurationMatchType),
  "skippableMatchType": enum (SkippableMatchType)
}
الحقول
duration

string (Duration format)

تمثّل هذه السمة مدة تصميم إعلان الفيديو بالثواني. مطلوب

مدة بالثواني مع ما يصل إلى تسعة أرقام كسور، وتنتهي بـ "s". مثال: "3.5s"
durationMatchType

enum (DurationMatchType)

معايير مطابقة المدة
skippableMatchType

enum (SkippableMatchType)

نوع تصميم إعلان الفيديو القابل للتخطّي

DurationMatchType

التنسيقات المحتملة لمعيار مطابقة المدة.

عمليات التعداد
DURATION_MATCH_TYPE_UNSPECIFIED لم يتم تحديد معيار مطابقة المدة أو أنّه غير معروف في هذا الإصدار. قيمة الإدخال غير صالحة.
DURATION_MATCH_TYPE_EQUAL_TO يجب أن تكون مدة تصميم الإعلان هي نفسها المدة المطلوبة.
DURATION_MATCH_TYPE_LESS_THAN_OR_EQUAL_TO يجب أن تكون مدة تصميم الإعلان مساوية للمدة المطلوبة أو أقل منها.

SkippableMatchType

تنسيقات المنتج المحتملة

عمليات التعداد
SKIPPABLE_MATCH_TYPE_UNSPECIFIED لم يتم تحديد نوع المحتوى القابل للتخطّي أو أنّه غير معروف في هذا الإصدار. قيمة الإدخال غير صالحة.
SKIPPABLE_MATCH_TYPE_SKIPPABLE يجب أن يكون تصميم الإعلان قابلاً للتخطّي.
SKIPPABLE_MATCH_TYPE_NOT_SKIPPABLE يجب أن يكون تصميم الإعلان غير قابل للتخطّي.
SKIPPABLE_MATCH_TYPE_ANY يمكن أن يكون تصميم الإعلان قابلاً للتخطّي أو غير قابل للتخطّي.

MakegoodDetails

إعدادات تفاصيل التعويض

تمثيل JSON 
{
  "originalExternalDealId": string,
  "reason": string
}
الحقول
originalExternalDealId

string

رقم تعريف الصفقة الخارجية الأصلي الذي يطلب تعويضًا يمكن استخدام 100 حرف كحدّ أقصى. الأحرف المسموح بها هي الأحرف الأبجدية الرقمية والشرطة السفلية والشرطة العادية والنقطة. الحقل مطلوب.
reason

string

سبب التعويض الذي بدأه البائع يمكن استخدام 250 حرفًا كحدّ أقصى. الحقل مطلوب.

CreativeSource

مصدر تصميم الإعلان: المكان الذي سيتم عرض تصاميم الإعلانات منه

عمليات التعداد
CREATIVE_SOURCE_UNSPECIFIED لم يتم تحديد مصدر تصميم الإعلان أو أنّه غير معروف في هذا الإصدار. قيمة الإدخال غير صالحة.
CREATIVE_SOURCE_ADVERTISER ستعرض "مساحة العرض والفيديو 360" تصميمات الإعلانات.
CREATIVE_SOURCE_PUBLISHER سيعرض الناشر تصميمات الإعلانات. لا تتوفّر حاليًا تصاميم الإعلانات المستضافة من الناشر، وسيؤدي أي طلب يحاول ضبط مصدر تصميم الإعلان على CREATIVE_SOURCE_PUBLISHER إلى حدوث خطأ.

AudienceTargetingConfig

إعدادات استهداف الجمهور

تمثيل JSON 
{
  "audienceType": enum (AudienceType)
}
الحقول
audienceType

enum (AudienceType)

نوع الجمهور الحقل مطلوب.

AudienceType

نوع الجمهور

عمليات التعداد
AUDIENCE_TYPE_UNSPECIFIED نوع الجمهور غير محدَّد. غير صالح للإدخال.
AUDIENCE_TYPE_COMMERCE نوع جمهور التجارة

TargetingCriteria

تم تحديد معايير الاستهداف.

تمثيل JSON 
{
  "selectedTargetingOptions": [
    {
      object (SelectedTargetingOption)
    }
  ]
}
الحقول
selectedTargetingOptions[]

object (SelectedTargetingOption)

الخيارات المحدّدة

SelectedTargetingOption

خيار الاستهداف المحدّد أو خيارات الاستهداف المحدّدة لنوع استهداف واحد

تمثيل JSON 
{
  "type": enum (TargetingType),

  // Union field value can be only one of the following:
  "audienceSelection": {
    object (AudienceSelection)
  },
  "targetingSelection": {
    object (TargetingSelection)
  }
  // End of list of possible types for union field value.
}
الحقول
type

enum (TargetingType)

نوع الاستهداف المرتبط بالخيارات المحدّدة
حقل الدمج value يمكن تضمين نوع واحد فقط من أنواع التحديد. يجب أن يتطابق الاختيار مع TargetingType الذي تم اختياره للحقل "type". يمكن أن تكون value إحدى القيم التالية فقط:
audienceSelection

object (AudienceSelection)

الجمهور المحدّد
targetingSelection

object (TargetingSelection)

مجموعة عامة من معرّفات الخيارات المحدّدة.

TargetingType

أنواع الاستهداف

عمليات التعداد
TARGETING_TYPE_UNSPECIFIED نوع الاستهداف غير محدّد، وهو غير صالح للإدخال.
TARGETING_TYPE_AUDIENCE الجمهور المستهدَف حسب نوع الاستهداف
TARGETING_TYPE_COUNTRY البلد الذي يتم فيه تحديد نوع الاستهداف.
TARGETING_TYPE_DMA ‫Targeting type dma.
TARGETING_TYPE_PROGRAMMER نوع الاستهداف للمبرمج
TARGETING_TYPE_BRAND Targeting type brand.
TARGETING_TYPE_CONTENT_GENRE نوع الاستهداف هو نوع المحتوى.
TARGETING_TYPE_DEVICE نوع استهداف الجهاز
TARGETING_TYPE_OPERATING_SYSTEM نظام التشغيل لنوع الاستهداف
TARGETING_TYPE_RATING تقييم نوع الاستهداف
TARGETING_TYPE_ENVIRONMENT بيئة نوع الاستهداف
TARGETING_TYPE_LANGUAGE لغة نوع الاستهداف
TARGETING_TYPE_GEO الموقع الجغرافي لنوع الاستهداف
TARGETING_TYPE_AGE عمر نوع الاستهداف
TARGETING_TYPE_GENDER جنس نوع الاستهداف
TARGETING_TYPE_CONTEXTUAL_SEGMENT شريحة استهداف المحتوى حسب نوع الاستهداف.
TARGETING_TYPE_REQUEST_FORMAT تنسيق طلب نوع الاستهداف.
TARGETING_TYPE_PUBLISHER ناشر نوع الاستهداف
TARGETING_TYPE_INVENTORY_SIZE حجم نوع الاستهداف
TARGETING_TYPE_NETWORK شبكة نوع الاستهداف
TARGETING_TYPE_PLATFORM منصة نوع الاستهداف
TARGETING_TYPE_VIDEO_DELIVERY_TYPE نوع عرض الفيديو المستهدَف
TARGETING_TYPE_VIDEO_MINIMUM_PLAYER_SIZE الحدّ الأدنى لحجم مشغّل الفيديو حسب نوع الاستهداف

AudienceSelection

خيارات استهداف الجمهور المحدّدة

تمثيل JSON 
{
  "includedOrGroups": [
    {
      object (OrGroup)
    }
  ],
  "excludedOptionIds": [
    string
  ]
}
الحقول
includedOrGroups[]

object (OrGroup)

يتم ربط الخيارات المضمّنة بأداة العطف AND، ويمكن أن يكون كل خيار مضمّن خيارًا فرديًا أو مجموعة من الخيارات المرتبطة بأداة العطف OR.
excludedOptionIds[]

string (int64 format)

يتم ربط الخيارات المستبعَدة باستخدام OR.

OrGroup

مجموعة من الخيارات المحدّدة يتم ربطها باستخدام OR.

تمثيل JSON 
{
  "optionIds": [
    string
  ]
}
الحقول
optionIds[]

string (int64 format)

أرقام تعريف الخيارات المحدّدة

TargetingSelection

مجموعة من معرّفات الخيارات المحدّدة، تنطبق على معظم أنواع الاستهداف

تمثيل JSON 
{
  "optionIds": [
    string
  ]
}
الحقول
optionIds[]

string (int64 format)

أرقام تعريف الخيارات المحدّدة

ForecastResult

تم تحديد نتيجة التوقّع.

تمثيل JSON 
{
  "forecasts": [
    {
      object (Forecast)
    }
  ]
}
الحقول
forecasts[]

object (Forecast)

التوقّعات يجب أن تكون قيمة "forecastCategory" فريدة لكل عنصر محدّد.

التوقعات

توقّعات الفئة المحدّدة من فئات التوقّعات

تمثيل JSON 
{
  "forecastCategory": enum (ForecastCategory),

  // Union field forecast_data can be only one of the following:
  "number": string,
  "percentage": integer,
  "cpmPrice": {
    object (Money)
  },
  "cpmRange": {
    object (CpmRange)
  },
  "forecastBreakdownData": {
    object (ForecastBreakdownData)
  }
  // End of list of possible types for union field forecast_data.
}
الحقول
forecastCategory

enum (ForecastCategory)

فئة التوقعات المحدّدة التي تمثّلها إحصاءات التوقعات
حقل الدمج forecast_data يمكن تضمين نوع واحد فقط من بيانات الإحصاءات. يجب أن تتوافق البيانات التي يتمّ ملؤها مع الحقل "forecastCategory". يمكن أن تكون forecast_data إحدى القيم التالية فقط:
number

string (int64 format)

بيانات الأرقام
percentage

integer

بيانات النسبة المئوية
cpmPrice

object (Money)

بيانات أسعار التكلفة لكل ألف ظهور
cpmRange

object (CpmRange)

بيانات نطاق الأسعار لكل ألف ظهور
forecastBreakdownData

object (ForecastBreakdownData)

بيانات التصنيفات التفصيلية للتوقّعات

ForecastCategory

فئة التوقّعات

عمليات التعداد
FORECAST_CATEGORY_UNSPECIFIED فئة غير محدَّدة غير صالح للإدخال.
FORECAST_CATEGORY_TOTAL_OPPORTUNITIES إجمالي الفرص بيانات الأرقام
FORECAST_CATEGORY_TOTAL_AUDIENCE إجمالي الجمهور بيانات الأرقام
FORECAST_CATEGORY_DIGITAL_TRP نقاط تقييم الاستهداف الرقمية بيانات النسبة المئوية
FORECAST_CATEGORY_SUGGESTED_CPM سعر التكلفة لكل ألف ظهور المقترَح نطاق التكلفة لكل ألف ظهور أو بيانات أسعار التكلفة لكل ألف ظهور
FORECAST_CATEGORY_UNIQUE_REACH توقّع مدى الوصول الفريد. بيانات الأرقام
FORECAST_CATEGORY_FORECAST_BREAKDOWN تصنيف التوقّعات بيانات التصنيفات التفصيلية للتوقّعات

CpmRange

يحتوي "نطاق التكلفة لكل ألف ظهور" على الحدّ الأدنى والأقصى للتكلفة لكل ألف ظهور.

تمثيل JSON 
{
  "minCpm": {
    object (Money)
  },
  "maxCpm": {
    object (Money)
  }
}
الحقول
minCpm

object (Money)

الحدّ الأدنى لنطاق التكلفة لكل ألف ظهور.
maxCpm

object (Money)

الحدّ الأعلى لنطاق التكلفة لكل ألف ظهور

ForecastBreakdownData

تحتوي بيانات تقسيم التوقعات على قائمة بتقسيم التوقعات.

تمثيل JSON 
{
  "forecastBreakdowns": [
    {
      object (ForecastBreakdown)
    }
  ]
}
الحقول
forecastBreakdowns[]

object (ForecastBreakdown)

قائمة بتقسيمات التوقعات

ForecastBreakdown

تقسيم التوقّعات لخيارات الاستهداف المحدّدة

تمثيل JSON 
{
  "selectedTargetingOption": {
    object (SelectedTargetingOption)
  },

  // Union field breakdown_data can be only one of the following:
  "impressions": string
  // End of list of possible types for union field breakdown_data.
}
الحقول
selectedTargetingOption

object (SelectedTargetingOption)

خيار الاستهداف المحدّد أو خيارات الاستهداف المحدّدة لنوع استهداف واحد
حقل الدمج breakdown_data يمكن تضمين نوع واحد فقط من بيانات التقسيم. يمكن أن تكون breakdown_data إحدى القيم التالية فقط:
impressions

string (int64 format)

مرّات الظهور المتوقّعة

ErrorDetails

تفاصيل الخطأ المحدّدة عند حدوث أخطاء في التعديل

تمثيل JSON 
{
  "message": string,
  "instantDealErrorStatus": enum (InstantDealErrorStatus)
}
الحقول
message

string

تحدّد الرسالة متى تحدث أخطاء أثناء التحديث.
instantDealErrorStatus

enum (InstantDealErrorStatus)

حالة الخطأ المحدّدة عندما يكون هناك أخطاء في تحديث الصفقات الفورية.

InstantDealErrorStatus

حالة الخطأ المحدّدة عند حدوث أخطاء في تعديل الصفقة الفورية

عمليات التعداد
INSTANT_DEAL_ERROR_STATUS_UNSPECIFIED حالة الخطأ غير المحدَّد
INSTANT_DEAL_ERROR_STATUS_INVENTORY_UNAVAILABLE تشير حالة الخطأ إلى أنّ المستودع غير متوفّر.
INSTANT_DEAL_ERROR_STATUS_FORECAST_UNAVAILABLE تشير حالة الخطأ إلى أنّ التوقعات غير متاحة.
INSTANT_DEAL_ERROR_STATUS_INVALID_INPUT تشير حالة الخطأ إلى وجود حقول إدخال غير صالحة.

FrequencyCap

عدد المرّات التي يمكن أن يظهر فيها الإعلان نفسه للمستخدِم خلال فترة زمنية معيّنة

تمثيل JSON 
{
  "timeUnit": enum (TimeUnit),
  "maxImpressions": string
}
الحقول
timeUnit

enum (TimeUnit)

الوحدة الزمنية التي سيتم تطبيق تحديد عدد مرات الظهور فيها.
maxImpressions

string (int64 format)

الحد الأقصى لعدد مرات ظهور الإعلان نفسه للمستخدم خلال هذه الفترة

TimeUnit

الوحدة الزمنية التي سيتم تطبيق تحديد عدد مرات الظهور فيها.

عمليات التعداد
TIME_UNIT_UNSPECIFIED وحدة زمنية غير محدّدة
TIME_UNIT_LIFETIME سيتم تطبيق الحد الأقصى لتحديد عدد مرات الظهور على المدة بالكامل.
TIME_UNIT_MONTHS سيتم تطبيق الحدّ الأقصى لمعدّل التكرار على عدد من الأشهر.
TIME_UNIT_WEEKS سيتم تطبيق الحدّ الأقصى لعدد مرات الظهور على عدد من الأسابيع.
TIME_UNIT_DAYS سيتم تطبيق ميزة "تحديد عدد مرات الظهور" على عدد من الأيام.

الطُرق

create

 تُستخدَم لإنشاء منتج.

get

 تعرض المنتج.

list

 تعرض هذه السمة المنتج.

patch

 تعدّل هذه الطريقة منتجًا.