REST Resource: advertisers.inventorySources

المورد: InventorySource

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

تمثيل JSON 
{
  "name": string,
  "inventorySourceId": string,
  "displayName": string,
  "inventorySourceType": enum (InventorySourceType),
  "inventorySourceProductType": enum (InventorySourceProductType),
  "commitment": enum (InventorySourceCommitment),
  "deliveryMethod": enum (InventorySourceDeliveryMethod),
  "dealId": string,
  "status": {
    object (InventorySourceStatus)
  },
  "exchange": enum (Exchange),
  "updateTime": string,
  "rateDetails": {
    object (RateDetails)
  },
  "publisherName": string,
  "timeRange": {
    object (TimeRange)
  },
  "creativeConfigs": [
    {
      object (CreativeConfig)
    }
  ],
  "guaranteedOrderId": string,
  "readWriteAccessors": {
    object (InventorySourceAccessors)
  },
  "readAdvertiserIds": [
    string
  ],
  "readPartnerIds": [
    string
  ]
}
الحقول
name

string

للعرض فقط. اسم المورد لمصدر المساحة الإعلانية
inventorySourceId

string (int64 format)

للعرض فقط. المعرّف الفريد لمصدر المساحة الإعلانية يتم تخصيصه من قِبل النظام.
displayName

string

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

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

enum (InventorySourceType)

تشير إلى نوع مصدر المساحة الإعلانية.
inventorySourceProductType

enum (InventorySourceProductType)

للعرض فقط. نوع المنتج لمصدر المساحة الإعلانية، والذي يشير إلى الطريقة التي يبيع بها المساحة الإعلانية.
commitment

enum (InventorySourceCommitment)

ما إذا كان مصدر المساحة الإعلانية يتضمّن عرضًا مضمونًا أو غير مضمون
deliveryMethod

enum (InventorySourceDeliveryMethod)

طريقة عرض مصدر المساحة الإعلانية

  • بالنسبة إلى مصادر المساحات الإعلانية غير المضمونة، القيمة الوحيدة المقبولة هي INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC.
  • بالنسبة إلى مصادر المساحات الإعلانية المضمونة، القيم المقبولة هي INVENTORY_SOURCE_DELIVERY_METHOD_TAG وINVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC.
dealId

string

رقم التعريف في مساحة التبادل الذي يحدّد مصدر المستودع بشكلٍ فريد.

يجب أن يكون فريدًا لكل مشترٍ ضمن كلّ منصّة تبادل إعلاني، ولكن ليس بالضرورة أن يكون فريدًا على مستوى منصّات التبادل الإعلاني.
status

object (InventorySourceStatus)

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

enum (Exchange)

سوق الإعلانات التي ينتمي إليها مصدر المساحة الإعلانية المتاحة
updateTime

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"
rateDetails

object (RateDetails)

الحقل مطلوب. تفاصيل أسعار مصدر المساحة الإعلانية المتاحة
publisherName

string

اسم الناشر/البائع لمصدر المستودع الإعلاني
timeRange

object (TimeRange)

النطاق الزمني الذي يبدأ فيه مصدر المستودع هذا عرض الإعلانات ويتوقف عن ذلك
creativeConfigs[]

object (CreativeConfig)

متطلبات تصميم الإعلان لمصدر المستودع

لا ينطبق ذلك على حزم المزادات.
guaranteedOrderId

string

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

ينطبق ذلك فقط عندما تكون قيمة commitment هي INVENTORY_SOURCE_COMMITMENT_GUARANTEED.
readWriteAccessors

object (InventorySourceAccessors)

الشريك أو المعلنون الذين لديهم الإذن بالقراءة والتعديل لمصدر المساحة الإعلانية

لا يتم عرض هذه السمة إلا عندما تكون قيمة commitment هي INVENTORY_SOURCE_COMMITMENT_GUARANTEED، وفي هذه الحالة يتم اكتساب دوال استرداد القيمة للقراءة/الكتابة من الطلب المضمون الرئيسي.

مطلوبة عندما تكون قيمة commitment هي INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED.

إذا كانت قيمة commitment هي INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED وتم ضبط شريك في هذا الحقل، سيحصل جميع المعلنين التابعين لهذا الشريك تلقائيًا على إذن بالقراءة فقط لمصدر المساحة الإعلانية. لن يتم تضمين هؤلاء المعلنين في readAdvertiserIds.
readAdvertiserIds[]

string (int64 format)

للعرض فقط. أرقام تعريف المعلِنين الذين لديهم إذن بالقراءة فقط للوصول إلى مصدر المساحة الإعلانية
readPartnerIds[]

string (int64 format)

للعرض فقط. أرقام تعريف الشركاء الذين لديهم إذن بالقراءة فقط لمصدر المستودع

يحصل جميع المعلِنين التابعين للشركاء في هذا الحقل على إذن بالقراءة فقط لمصدر المساحة الإعلانية.

InventorySourceType

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

عمليات التعداد
INVENTORY_SOURCE_TYPE_UNSPECIFIED لم يتم تحديد نوع مصدر المستودع أو أنّه غير معروف في هذا الإصدار.
INVENTORY_SOURCE_TYPE_PRIVATE مصدر مساحة إعلانية خاص
INVENTORY_SOURCE_TYPE_AUCTION_PACKAGE حزمة المزاد:

InventorySourceProductType

أنواع المنتجات المحتملة لمصدر المستودع

عمليات التعداد
INVENTORY_SOURCE_PRODUCT_TYPE_UNSPECIFIED لم يتم تحديد نوع المنتج أو أنّه غير معروف في هذا الإصدار. لا يمكن تعديل مصادر المستودع الإعلاني لنوع المنتج هذا من خلال واجهة برمجة التطبيقات.
PREFERRED_DEAL يبيع مصدر المساحة الإعلانية مساحات إعلانية من خلال صفقة مفضّلة.
PRIVATE_AUCTION يبيع مصدر المساحة الإعلانية مساحات إعلانية من خلال "المزاد الخاص".
PROGRAMMATIC_GUARANTEED يبيع مصدر المساحة الإعلانية مساحة إعلانية من خلال Programmatic Guaranteed.
TAG_GUARANTEED يبيع مصدر المساحة الإعلانية مساحات إعلانية من خلال "مضمونة بعلامة".
YOUTUBE_RESERVE يبيع مصدر المساحة الإعلانية مساحات إعلانية من خلال YouTube Reserve.
INSTANT_RESERVE يبيع مصدر المساحة الإعلانية مساحات إعلانية من خلال "الحجز الفوري". لا يمكن تعديل مصادر المستودع الإعلاني لنوع المنتج هذا من خلال واجهة برمجة التطبيقات.
GUARANTEED_PACKAGE يبيع مصدر المساحة الإعلانية مساحات إعلانية من خلال "حزمة الإعلانات المضمونة". لا يمكن تعديل مصادر المستودع الإعلاني لنوع المنتج هذا من خلال واجهة برمجة التطبيقات.
PROGRAMMATIC_TV يبيع مصدر المساحة الإعلانية مساحات إعلانية من خلال "الإعلانات التلفزيونية الآلية". لا يمكن تعديل مصادر المستودع الإعلاني لنوع المنتج هذا من خلال واجهة برمجة التطبيقات.
AUCTION_PACKAGE يبيع مصدر المساحة الإعلانية مساحات إعلانية من خلال حزمة المزاد. لا يمكن تعديل مصادر المستودع الإعلاني لنوع المنتج هذا من خلال واجهة برمجة التطبيقات.

InventorySourceCommitment

أنواع الالتزامات المحتملة لمصدر مساحة إعلانية

عمليات التعداد
INVENTORY_SOURCE_COMMITMENT_UNSPECIFIED لم يتم تحديد الالتزام أو أنّه غير معروف في هذا الإصدار.
INVENTORY_SOURCE_COMMITMENT_GUARANTEED والالتزام هو التسليم المضمون.
INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED الالتزام هو عرض غير مضمون.

InventorySourceDeliveryMethod

طرق التسليم المحتملة لمصدر مستودع

عمليات التعداد
INVENTORY_SOURCE_DELIVERY_METHOD_UNSPECIFIED لم يتم تحديد طريقة التسليم أو أنّها غير معروفة في هذا الإصدار.
INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC طريقة العرض آلية.
INVENTORY_SOURCE_DELIVERY_METHOD_TAG طريقة التسليم هي علامة التتبُّع.

InventorySourceStatus

الإعدادات ذات الصلة بالحالة لمصدر المستودع

تمثيل JSON 
{
  "entityStatus": enum (EntityStatus),
  "entityPauseReason": string,
  "sellerStatus": enum (EntityStatus),
  "sellerPauseReason": string,
  "configStatus": enum (InventorySourceConfigStatus)
}
الحقول
entityStatus

enum (EntityStatus)

ما إذا كان مصدر المساحة الإعلانية قابلاً للعرض أم لا

القيم المقبولة هي ENTITY_STATUS_ACTIVE وENTITY_STATUS_ARCHIVED وENTITY_STATUS_PAUSED. القيمة التلقائية هي ENTITY_STATUS_ACTIVE.
entityPauseReason

string

السبب الذي قدّمه المستخدم لإيقاف مصدر المساحة الإعلانية هذا مؤقتًا

يجب ألا يتجاوز 100 حرف.

لا ينطبق ذلك إلا عند ضبط entityStatus على ENTITY_STATUS_PAUSED.
sellerStatus

enum (EntityStatus)

للعرض فقط. الحالة التي حدّدها البائع لمصدر المستودع

ينطبق ذلك فقط على مصادر المساحات الإعلانية التي تتم مزامنتها مباشرةً من الناشرين. القيمتان المقبولتان هما ENTITY_STATUS_ACTIVE وENTITY_STATUS_PAUSED.
sellerPauseReason

string

للعرض فقط. السبب الذي قدّمه البائع لإيقاف مصدر المساحة الإعلانية هذا مؤقتًا

لا ينطبق ذلك إلا على مصادر المساحات الإعلانية المتاحة التي تتم مزامنتها مباشرةً من الناشرين وعند ضبط sellerStatus على ENTITY_STATUS_PAUSED.
configStatus

enum (InventorySourceConfigStatus)

للعرض فقط. حالة إعداد مصدر المستودع الإعلاني

ينطبق ذلك على مصادر المساحات الإعلانية المضمونة فقط. القيمتان المقبولتان هما INVENTORY_SOURCE_CONFIG_STATUS_PENDING وINVENTORY_SOURCE_CONFIG_STATUS_COMPLETED.

يجب ضبط مصدر المستودع الإعلاني (ملء الحقول المطلوبة واختيار تصاميم الإعلانات واختيار حملة تلقائية) قبل أن يتمكّن من عرض الإعلانات.

InventorySourceConfigStatus

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

عمليات التعداد
INVENTORY_SOURCE_CONFIG_STATUS_UNSPECIFIED لم يتم تحديد حالة الموافقة أو أنّها غير معروفة في هذا الإصدار.
INVENTORY_SOURCE_CONFIG_STATUS_PENDING الحالة الأولية لمصدر مساحة إعلانية مضمونة يجب ضبط مصدر المستودع في هذه الحالة.
INVENTORY_SOURCE_CONFIG_STATUS_COMPLETED الحالة بعد أن يضبط المشتري مصدر مساحة إعلانية مضمونة.

RateDetails

الإعدادات ذات الصلة بالسعر لمصدر المستودع

تمثيل JSON 
{
  "inventorySourceRateType": enum (InventorySourceRateType),
  "rate": {
    object (Money)
  },
  "unitsPurchased": string,
  "minimumSpend": {
    object (Money)
  }
}
الحقول
inventorySourceRateType

enum (InventorySourceRateType)

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

القيم المقبولة هي INVENTORY_SOURCE_RATE_TYPE_CPM_FIXED وINVENTORY_SOURCE_RATE_TYPE_CPM_FLOOR وINVENTORY_SOURCE_RATE_TYPE_CPD.
rate

object (Money)

معدّل مصدر المساحة الإعلانية
unitsPurchased

string (int64 format)

مطلوب لمصادر المساحات الإعلانية المضمونة. عدد مرّات الظهور التي يضمنها البائع
minimumSpend

object (Money)

للعرض فقط. المبلغ الذي التزم المشتري بإنفاقه على مصدر المساحة الإعلانية مسبقًا

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

InventorySourceRateType

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

عمليات التعداد
INVENTORY_SOURCE_RATE_TYPE_UNSPECIFIED لم يتم تحديد نوع السعر أو أنّه غير معروف في هذا الإصدار.
INVENTORY_SOURCE_RATE_TYPE_CPM_FIXED نوع السعر هو التكلفة لكل ألف ظهور (ثابتة).
INVENTORY_SOURCE_RATE_TYPE_CPM_FLOOR نوع السعر هو "التكلفة لكل ألف ظهور (الحدّ الأدنى)".
INVENTORY_SOURCE_RATE_TYPE_CPD نوع السعر هو "التكلفة في اليوم".
INVENTORY_SOURCE_RATE_TYPE_CPH نوع السعر هو "التكلفة في الساعة".
INVENTORY_SOURCE_RATE_TYPE_FLAT نوع السعر هو "ثابت".

المال

تمثّل هذه السمة مبلغًا ماليًا مع نوع العملة.

تمثيل JSON 
{
  "currencyCode": string,
  "units": string,
  "nanos": integer
}
الحقول
currencyCode

string

رمز العملة المكوّن من ثلاثة أحرف والمحدّد في ISO 4217.
units

string (int64 format)

الوحدات الكاملة للمبلغ على سبيل المثال، إذا كانت قيمة currencyCode هي "USD"، تكون الوحدة الواحدة دولارًا أمريكيًا واحدًا.
nanos

integer

عدد وحدات النانو (10^-9) من المبلغ يجب أن تتراوح القيمة بين ‎-999,999,999 و‎+999,999,999، بما في ذلك طرفي النطاق. إذا كانت قيمة units موجبة، يجب أن تكون قيمة nanos موجبة أو صفرًا. إذا كانت قيمة units صفرًا، يمكن أن تكون قيمة nanos موجبة أو صفرًا أو سالبة. إذا كانت قيمة units سالبة، يجب أن تكون قيمة nanos سالبة أو صفرًا. على سبيل المثال، يتم تمثيل ‎ $-1.75 على النحو التالي: units=-1 وnanos=-750,000,000.

TimeRange

نطاق زمني

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

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"
endTime

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"

CreativeConfig

إعداد متطلبات تصميم الإعلان لمصدر المستودع

تمثيل JSON 
{
  "creativeType": enum (CreativeType),

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "displayCreativeConfig": {
    object (InventorySourceDisplayCreativeConfig)
  },
  "videoCreativeConfig": {
    object (InventorySourceVideoCreativeConfig)
  }
  // End of mutually exclusive fields.
}
الحقول
creativeType

enum (CreativeType)

نوع تصميم الإعلان الذي يمكن تعيينه لمصدر المساحة الإعلانية تتوفّر الأنواع التالية فقط:

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_VIDEO

تنطبق هذه السمة عندما تكون قيمة creative_type إحدى القيم التالية:

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_VIDEO

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

object (InventorySourceDisplayCreativeConfig)

إعدادات تصاميم الإعلانات الصورية تنطبق هذه السمة عندما تكون قيمة السمة creativeType هي CREATIVE_TYPE_STANDARD.
videoCreativeConfig

object (InventorySourceVideoCreativeConfig)

إعدادات تصاميم إعلانات الفيديو تنطبق هذه السمة عندما تكون قيمة السمة creativeType هي CREATIVE_TYPE_VIDEO.
نهاية الحقول التي يستبعد كلّ منها الآخر

InventorySourceDisplayCreativeConfig

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

تمثيل JSON 
{
  "creativeSize": {
    object (Dimensions)
  }
}
الحقول
creativeSize

object (Dimensions)

متطلبات الحجم لتصاميم الإعلانات الصورية التي يمكن تخصيصها لمصدر المساحة الإعلانية

InventorySourceVideoCreativeConfig

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

تمثيل JSON 
{
  "duration": string
}
الحقول
duration

string (Duration format)

متطلبات المدة لتصاميم إعلانات الفيديو التي يمكن تعيينها لمصدر المساحة الإعلانية.

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

InventorySourceAccessors

الشريك أو المعلِنون الذين لديهم إذن بالوصول إلى مصدر المساحة الإعلانية

تمثيل JSON 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "partner": {
    object (PartnerAccessor)
  },
  "advertisers": {
    object (AdvertiserAccessors)
  }
  // End of mutually exclusive fields.
}
الحقول
الشريك أو المعلِنون الذين لديهم إذن بالوصول إلى مصدر المساحة الإعلانية في ما يلي قائمة بالحقول التي يستبعد بعضها بعضًا. سيتم ضبط حقل واحد على الأكثر في الرد:
partner

object (PartnerAccessor)

الشريك الذي لديه إذن بالوصول إلى مصدر المساحة الإعلانية
advertisers

object (AdvertiserAccessors)

المعلِنون الذين لديهم إذن بالوصول إلى مصدر المساحة الإعلانية المتاحة يجب أن ينتمي جميع المعلِنين إلى الشريك نفسه.
نهاية الحقول التي يستبعد كلّ منها الآخر

PartnerAccessor

الشريك الذي لديه إذن بالوصول إلى مصدر المساحة الإعلانية

تمثيل JSON 
{
  "partnerId": string
}
الحقول
partnerId

string (int64 format)

معرّف الشريك

AdvertiserAccessors

المعلِنون الذين لديهم إذن بالوصول إلى مصدر المساحة الإعلانية

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

string (int64 format)

أرقام تعريف المعلِنين

الطُرق

get

 يستردّ صفقة مصدر مستودع.

list

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