REST Resource: 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-normalized وسيستخدم 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 يبيع مصدر المساحة الإعلانية المساحة الإعلانية من خلال "الإعلانات الآلية المضمونة".
TAG_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_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-normalized وسيستخدم 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-normalized وسيستخدم 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),

  // Union field creative_config_scheme can be only one of the following:
  "displayCreativeConfig": {
    object (InventorySourceDisplayCreativeConfig)
  },
  "videoCreativeConfig": {
    object (InventorySourceVideoCreativeConfig)
  }
  // End of list of possible types for union field creative_config_scheme.
}
الحقول
creativeType

enum (CreativeType)

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

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_VIDEO

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

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_VIDEO

إعدادات تصميمات الإعلانات التي يمكن تعيينها لمصدر المستودع الإعلاني. يمكن أن تكون creative_config_scheme إحدى القيم التالية فقط:
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 
{

  // Union field accessors can be only one of the following:
  "partner": {
    object (PartnerAccessor)
  },
  "advertisers": {
    object (AdvertiserAccessors)
  }
  // End of list of possible types for union field accessors.
}
الحقول
حقل الدمج accessors الشريك أو المعلِنون الذين يمكنهم الوصول إلى مصدر المساحة الإعلانية يمكن أن تكون accessors إحدى القيم التالية فقط:
partner

object (PartnerAccessor)

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

object (AdvertiserAccessors)

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

PartnerAccessor

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

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

string (int64 format)

معرّف الشريك

AdvertiserAccessors

المعلِنون الذين يمكنهم الوصول إلى مصدر المستودع

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

string (int64 format)

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

الطُرق

create

 تنشئ هذه الطريقة مصدر مستودع إعلاني جديدًا.

editInventorySourceReadWriteAccessors

 تعديل أدوات الوصول للقراءة والكتابة الخاصة بمصدر مستودع

get

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

list

 تعرض هذه السمة مصادر المستودع الإعلاني التي يمكن للمستخدم الحالي الوصول إليها.

patch

 تعدّل هذه الطريقة مصدر مستودع حالي.