- المورد: المنتج
- CreativeConfig
- CreativeType
- DimensionCreativeConfig
- DurationCreativeConfig
- DurationMatchType
- SkippableMatchType
- MakegoodDetails
- CreativeSource
- AudienceTargetingConfig
- AudienceType
- TargetingCriteria
- SelectedTargetingOption
- TargetingType
- AudienceSelection
- OrGroup
- TargetingSelection
- ForecastResult
- التوقعات
- ForecastCategory
- CpmRange
- ForecastBreakdownData
- ForecastBreakdown
- ErrorDetails
- InstantDealErrorStatus
- FrequencyCap
- TimeUnit
- الطُرق
المورد: المنتج
المنتج
| تمثيل JSON |
|---|
{ "name": string, "displayName": string, "externalDealId": string, "transactionType": enum ( |
| الحقول | |
|---|---|
name |
اسم المسار النسبي للمنتج. تم إنشاؤه بواسطة الخادم. مثال: "exchanges/1234/orders/5678/products/abc". النتائج فقط. |
displayName |
تمثّل هذه السمة الاسم المعروض للمنتج. يجب أن يكون الترميز UTF-8 وبحجم 240 بايت كحد أقصى. الحقل مطلوب. |
externalDealId |
المعرّف الخارجي هذا هو رقم تعريف الصفقة في نظام التبادل. يمكن استخدام 100 حرف كحدّ أقصى. الأحرف المسموح بها هي الأحرف الأبجدية الرقمية والشرطة السفلية والشرطة والنقطة. يجب أن يكون فريدًا في كل المنتجات. الحقل مطلوب. |
transactionType |
نوع معاملة المنتج الحقل مطلوب. |
pricingType |
تمثّل هذه السمة نوع السعر الخاص بالمنتج. الحقل مطلوب. |
updateTime |
الطابع الزمني لآخر تعديل للمنتج يستخدم المعيار RFC 3339، حيث يكون الناتج الذي يتم إنشاؤه مُمثلاً بالتوقيت العالمي المنسَّق مع حرف Z في النهاية ويستخدم الأرقام الجزئية 0 أو 3 أو 6 أو 9. تُقبل أيضًا المعادلات الأخرى التي لا تستخدم حرف Z. أمثلة: |
startTime |
الوقت الذي يصبح فيه هذا المنتج نشطًا. يجب أن يكون قبل endTime. لا يمكن أن يكون وقت البدء بعد أكثر من عام واحد في المستقبل. الحقل مطلوب. يستخدم المعيار RFC 3339، حيث يكون الناتج الذي يتم إنشاؤه مُمثلاً بالتوقيت العالمي المنسَّق مع حرف Z في النهاية ويستخدم الأرقام الجزئية 0 أو 3 أو 6 أو 9. تُقبل أيضًا المعادلات الأخرى التي لا تستخدم حرف Z. أمثلة: |
endTime |
الوقت الذي يصبح فيه هذا المنتج غير نشط. لا يمكن أن يكون التاريخ حاليًا بعد عام 2036. الحقل مطلوب. يستخدم المعيار RFC 3339، حيث يكون الناتج الذي يتم إنشاؤه مُمثلاً بالتوقيت العالمي المنسَّق مع حرف Z في النهاية ويستخدم الأرقام الجزئية 0 أو 3 أو 6 أو 9. تُقبل أيضًا المعادلات الأخرى التي لا تستخدم حرف Z. أمثلة: |
rateDetails |
تفاصيل السعر الحقل مطلوب. |
creativeConfig[] |
متطلبات المواد الإبداعية الخاصة بمنتج مطلوبة للمنتجات التي يكون نوع المعاملة فيها محجوزًا |
makegood |
تحدّد هذه السمة ما إذا كان المنتج منتجًا تعويضيًا. |
makegoodDetails |
تفاصيل التعويض عن الإعلانات الفائتة لمنتج مطلوبة عندما يكون المنتج عبارة عن تعويض. |
creativeSource |
مصدر تصميم الإعلان عن منتج اختياري، والقيمة التلقائية هي CREATIVE_SOURCE_ADVERTISER. لا يمكن تغييره بعد إنشاء المنتج. |
mediumType |
نوع الوسيط للمنتج يتم ضبط القيمة تلقائيًا على DIGITAL في حال عدم تحديدها من أجل التوافق مع الأنظمة القديمة. لا يمكن تغييره بعد إنشاء المنتج. |
audienceTargetingConfig |
اختياريّ. يتم تطبيق إعدادات استهداف الجمهور المحدّدة على مستوى الصفقة في "مبادل الإعلانات". |
targetingCriteria |
النتائج فقط. مراجع لمعايير استهداف المنتجات لا ينطبق هذا الخيار إلا على سيناريوهات "الصفقات الفورية". |
forecastResult |
نتائج توقّعات المنتجات يجب توفير هذه السمة عندما لا تكون معايير الاستهداف فارغة ولم يتم تقديم التوقّعات. لا ينطبق هذا الخيار إلا على سيناريوهات "الصفقات الفورية". |
errorDetails |
يجب تحديد تفاصيل الخطأ عندما يتعذّر تعديل حقول منتج معيّن. يجب توفير هذه السمة عندما يتعذّر تقديم نتيجة التوقّع بسبب معيار استهداف أو عندما يتعذّر إجراء تعديل على المنتج. لا ينطبق هذا الخيار إلا على سيناريوهات "الصفقات الفورية". |
frequencyCap |
النتائج فقط. حدّ عدد مرات الظهور الذي يختاره المشتري لا ينطبق هذا الخيار إلا على سيناريوهات "الصفقات الفورية". |
etag |
تمثّل هذه السمة علامة etag يجب تحديدها عند تعديل منتج. يجب تحديدها فقط عند إجراء تعديل إذا لم يكن حقل etag فارغًا. لا ينطبق هذا الخيار إلا على سيناريوهات "الصفقات الفورية". |
CreativeConfig
إعداد متطلبات تصميم المنتج
| تمثيل JSON |
|---|
{ "creativeType": enum ( |
| الحقول | |
|---|---|
creativeType |
نوع تصميم الإعلان الحقل مطلوب. |
dimensionCreativeConfig |
إعدادات تصميمات الإعلانات الصورية هذا الحقل غير متاح لتصاميم الإعلانات على المنصات الأصلية (CREATIVE_TYPE_NATIVE). |
durationCreativeConfig |
إعدادات تصاميم إعلانات الفيديو |
CreativeType
أنواع تصاميم الإعلانات المحتملة
| عمليات التعداد | |
|---|---|
CREATIVE_TYPE_UNSPECIFIED |
لم يتم تحديد نوع تصميم الإعلان. قيمة الإدخال غير صالحة. |
CREATIVE_TYPE_DISPLAY |
نوع عرض تصميم الإعلان |
CREATIVE_TYPE_VIDEO |
نوع تصميم الفيديو |
CREATIVE_TYPE_AUDIO |
نوع التصميم الصوتي. |
CREATIVE_TYPE_NATIVE |
نوع تصميم الإعلان المدمج مع المحتوى |
DimensionCreativeConfig
عرض بُعد تصميم الإعلان بالبكسل
| تمثيل JSON |
|---|
{ "width": integer, "height": integer } |
| الحقول | |
|---|---|
width |
تعرِض هذه السمة عرض تصميم الإعلان. الحقل مطلوب. |
height |
تعرِض هذه السمة ارتفاع تصميم الإعلان. الحقل مطلوب. |
DurationCreativeConfig
إعدادات تصميم الإعلان من حيث المدة.
| تمثيل JSON |
|---|
{ "duration": string, "durationMatchType": enum ( |
| الحقول | |
|---|---|
duration |
تمثّل هذه السمة مدة تصميم إعلان الفيديو بالثواني. مطلوب مدة بالثواني مع ما يصل إلى تسعة أرقام كسور، وتنتهي بـ " |
durationMatchType |
معايير مطابقة المدة |
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 |
رقم تعريف الصفقة الخارجية الأصلي الذي تطلب منه التعويض يمكن استخدام 100 حرف كحدّ أقصى. الأحرف المسموح بها هي الأحرف الأبجدية الرقمية والشرطة السفلية والشرطة والنقطة. الحقل مطلوب. |
reason |
سبب التعويض الذي بدأه البائع 250 حرفًا كحدّ أقصى الحقل مطلوب. |
CreativeSource
مصدر تصميم الإعلان: المكان الذي سيتم عرض تصاميم الإعلانات منه
| عمليات التعداد | |
|---|---|
CREATIVE_SOURCE_UNSPECIFIED |
لم يتم تحديد مصدر تصميم الإعلان أو أنّه غير معروف في هذا الإصدار. قيمة الإدخال غير صالحة. |
CREATIVE_SOURCE_ADVERTISER |
ستعرض "مساحة العرض والفيديو 360" تصميمات الإعلانات. |
CREATIVE_SOURCE_PUBLISHER |
سيعرض الناشر تصميمات الإعلانات. لا تتوفّر حاليًا تصاميم الإعلانات المستضافة من الناشر، وسيؤدي أي طلب يحاول ضبط مصدر تصميم الإعلان على CREATIVE_SOURCE_PUBLISHER إلى حدوث خطأ. |
AudienceTargetingConfig
إعدادات استهداف الجمهور
| تمثيل JSON |
|---|
{
"audienceType": enum ( |
| الحقول | |
|---|---|
audienceType |
نوع الجمهور الحقل مطلوب. |
AudienceType
نوع الجمهور
| عمليات التعداد | |
|---|---|
AUDIENCE_TYPE_UNSPECIFIED |
نوع الجمهور غير محدَّد. غير صالح للإدخال. |
AUDIENCE_TYPE_COMMERCE |
نوع جمهور التجارة |
TargetingCriteria
تم تحديد معايير الاستهداف.
| تمثيل JSON |
|---|
{
"selectedTargetingOptions": [
{
object ( |
| الحقول | |
|---|---|
selectedTargetingOptions[] |
الخيارات المحدّدة |
SelectedTargetingOption
خيارات الاستهداف المحدّدة لنوع استهداف واحد
| تمثيل JSON |
|---|
{ "type": enum ( |
| الحقول | |
|---|---|
type |
نوع الاستهداف المرتبط بالخيارات المحدّدة |
| يمكن تضمين نوع واحد فقط من الاختيارات. يجب أن يتطابق الخيار المحدّد مع TargetingType المحدّد للحقل "type". في ما يلي قائمة بالحقول التي يستبعد كلّ منها الآخر. سيتم ضبط حقل واحد على الأكثر في الردّ: | |
audienceSelection |
الجمهور المحدّد |
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_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 |
الحدّ الأدنى لحجم مشغّل الفيديو حسب نوع الاستهداف |
TARGETING_TYPE_VIDEO_COMPLETION |
موضع الفيديو المستهدَف حسب نوع الاستهداف |
TARGETING_TYPE_VIEWABILITY |
إمكانية عرض الإعلانات حسب نوع الاستهداف |
TARGETING_TYPE_REWARDED |
نوع الاستهداف الذي تمّت مكافأته. |
TARGETING_TYPE_VIDEO_AD_DURATION_THRESHOLD_SEC |
الحد الأدنى لمدّة إعلان الفيديو حسب نوع الاستهداف بالثواني |
TARGETING_TYPE_VIDEO_PLACEMENT |
موضع الفيديو المستهدَف حسب نوع الاستهداف |
TARGETING_TYPE_VIDEO_PLAYBACK_METHOD |
طريقة تشغيل الفيديو لنوع الاستهداف |
TARGETING_TYPE_APP_ID |
معرّف تطبيق نوع الاستهداف |
TARGETING_TYPE_DOMAIN_URL |
عنوان URL للنطاق المستهدَف |
TARGETING_TYPE_CTR |
نسبة النقر إلى الظهور حسب نوع الاستهداف |
TARGETING_TYPE_DEMOGRAPHICS |
الخصائص الديمغرافية لنوع الاستهداف |
TARGETING_TYPE_RESTRICTED_CATEGORY |
فئة خاضعة لقيود لنوع الاستهداف |
TARGETING_TYPE_AD_POSITION |
موضع عرض الإعلان حسب نوع الاستهداف |
TARGETING_TYPE_DAY_AND_TIME |
يوم ووقت الاستهداف |
AudienceSelection
خيارات استهداف الجمهور المحدّدة
| تمثيل JSON |
|---|
{
"includedOrGroups": [
{
object ( |
| الحقول | |
|---|---|
includedOrGroups[] |
يتم ربط الخيارات المضمّنة بأداة العطف AND، ويمكن أن يكون كل خيار مضمّن خيارًا فرديًا أو مجموعة من الخيارات المرتبطة بأداة العطف OR. |
excludedOptionIds[] |
يتم ربط الخيارات المستبعَدة باستخدام "أو". |
OrGroup
مجموعة من الخيارات المحدّدة التي يتم ربطها باستخدام OR
| تمثيل JSON |
|---|
{ "optionIds": [ string ] } |
| الحقول | |
|---|---|
optionIds[] |
معرّفات الخيارات المحدّدة |
TargetingSelection
مجموعة من معرّفات الخيارات المحدّدة، تنطبق على معظم أنواع الاستهداف
| تمثيل JSON |
|---|
{ "optionIds": [ string ], "externalIds": [ string ] } |
| الحقول | |
|---|---|
optionIds[] |
معرّفات الخيارات المحدّدة |
externalIds[] |
النتائج فقط. المعرّفات الخارجية المحدّدة |
ForecastResult
تم تحديد نتيجة التوقّع.
| تمثيل JSON |
|---|
{
"forecasts": [
{
object ( |
| الحقول | |
|---|---|
forecasts[] |
التوقّعات يجب أن تكون قيمة "forecastCategory" فريدة لكل عنصر محدّد. |
التوقعات
توقّعات الفئة المحدّدة من فئات التوقّعات
| تمثيل JSON |
|---|
{ "forecastCategory": enum ( |
| الحقول | |
|---|---|
forecastCategory |
فئة التوقعات المحدّدة التي تمثّلها إحصاءات التوقعات |
| يمكن تضمين نوع واحد فقط من بيانات الإحصاءات. يجب أن تتطابق البيانات المدخلة مع حقل "forecastCategory". في ما يلي قائمة بالحقول التي يستبعد كلّ منها الآخر. سيتم ضبط حقل واحد على الأكثر في الردّ: | |
number |
بيانات الأرقام |
percentage |
بيانات النسبة المئوية |
cpmPrice |
بيانات أسعار التكلفة لكل ألف ظهور |
cpmRange |
بيانات نطاق الأسعار لكل ألف ظهور |
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 ( |
| الحقول | |
|---|---|
minCpm |
الحدّ الأدنى لنطاق التكلفة لكل ألف ظهور. |
maxCpm |
الحدّ الأعلى لنطاق التكلفة لكلّ ألف ظهور. |
ForecastBreakdownData
تحتوي بيانات تقسيم التوقعات على قائمة بتقسيم التوقعات.
| تمثيل JSON |
|---|
{
"forecastBreakdowns": [
{
object ( |
| الحقول | |
|---|---|
forecastBreakdowns[] |
قائمة بتقسيمات التوقعات |
ForecastBreakdown
تقسيم التوقّعات لخيارات الاستهداف المحدّدة
| تمثيل JSON |
|---|
{
"selectedTargetingOption": {
object ( |
| الحقول | |
|---|---|
selectedTargetingOption |
خيارات الاستهداف المحدّدة لنوع استهداف واحد |
| يمكن تضمين نوع واحد فقط من بيانات التقسيم. في ما يلي قائمة بالحقول التي يستبعد كلّ منها الآخر. سيتم ضبط حقل واحد على الأكثر في الردّ: | |
impressions |
مرّات الظهور المتوقّعة |
| نهاية الحقول التي يستبعد كلّ منها الآخر | |
ErrorDetails
تفاصيل الخطأ المحدّدة عند حدوث أخطاء في التعديل
| تمثيل JSON |
|---|
{
"message": string,
"instantDealErrorStatus": enum ( |
| الحقول | |
|---|---|
message |
الرسالة المحدّدة عند حدوث أخطاء في التحديث |
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 |
الحد الأقصى لعدد مرات ظهور الإعلان نفسه للمستخدم خلال هذه الفترة |
TimeUnit
الوحدة الزمنية التي سيتم تطبيق تحديد عدد مرات الظهور فيها.
| عمليات التعداد | |
|---|---|
TIME_UNIT_UNSPECIFIED |
وحدة وقت غير محدّدة |
TIME_UNIT_LIFETIME |
سيتم تطبيق الحد الأقصى لتحديد عدد مرات الظهور على المدة بالكامل. |
TIME_UNIT_MONTHS |
سيتم تطبيق الحدّ الأقصى لعدد مرات الظهور على عدد من الأشهر. |
TIME_UNIT_WEEKS |
سيتم تطبيق حدّ عدد مرات الظهور على عدد من الأسابيع. |
TIME_UNIT_DAYS |
سيتم تطبيق الحدّ الأقصى لعدد مرات الظهور على عدد من الأيام. |
الطُرق |
|
|---|---|
|
تنشئ هذه الطريقة منتجًا. |
|
يحصل على المنتج. |
|
تعرض هذه السمة المنتج. |
|
تعديل منتج |