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)
    }
  ],
  "subSitePropertyId": string,
  "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 يبيع مصدر المستودع المستودع من خلال Preferred Deal.
PRIVATE_AUCTION يبيع مصدر المستودع المستودع من خلال المزاد الخاص.
PROGRAMMATIC_GUARANTEED يبيع مصدر المستودع المستودع من خلال البيع الآلي المضمون.
TAG_GUARANTEED يبيع مصدر المستودع المستودع من خلال العلامة "ضمان العلامة".
YOUTUBE_RESERVE يبيع مصدر المستودع الإعلاني المستودع من خلال YouTube Reserve.
INSTANT_RESERVE يبيع مصدر المستودع المستودع من خلال "الحجز الفوري". لا تتيح واجهة برمجة التطبيقات إمكانية تعديل مصادر المستودع لنوع المنتج هذا.
GUARANTEED_PACKAGE يبيع مصدر المستودع المستودع من خلال "الحزمة المضمونة". لا تتيح واجهة برمجة التطبيقات إمكانية تعديل مصادر المستودع لنوع المنتج هذا.
PROGRAMMATIC_TV يبيع مصدر المستودع المستودع من خلال Programmtic 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

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