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)

النتائج فقط. الطابع الزمني لآخر تعديل لمصدر المستودع تمّ تعيينه من قِبل النظام.

يجب أن يكون طابعًا زمنيًا بالتنسيق RFC3339 UTC "Zulu"‎ وبدقة تصل إلى نانوثانية وما يصل إلى تسعة أرقام كسور. أمثلة: "2014-10-02T15:01:23Z" و"2014-10-02T15:01:23.045123456Z".
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 يبيع مصدر المستودع الإعلاني من خلال "ضمان العلامة".
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)

مطلوب. الحد الأدنى لفترة زمنية، شاملاً

يجب أن يكون طابعًا زمنيًا بالتنسيق RFC3339 UTC "Zulu"‎ وبدقة تصل إلى نانوثانية وما يصل إلى تسعة أرقام كسور. أمثلة: "2014-10-02T15:01:23Z" و"2014-10-02T15:01:23.045123456Z".
endTime

string (Timestamp format)

مطلوب. الحد الأعلى للنطاق الزمني، بشكل شامل

يجب أن يكون طابعًا زمنيًا بالتنسيق RFC3339 UTC "Zulu"‎ وبدقة تصل إلى نانوثانية وما يصل إلى تسعة أرقام كسور. أمثلة: "2014-10-02T15:01:23Z" و"2014-10-02T15:01:23.045123456Z".

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

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