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 و حداکثر اندازه ۲۴۰ بایت کدگذاری شود.

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 خواهد بود و از ارقام کسری ۰، ۳، ۶ یا ۹ استفاده می‌کند. آفست‌های غیر از "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 باشد، که در این صورت accessorهای خواندن/نوشتن از دستور تضمین‌شده‌ی والد به ارث می‌رسند.

زمانی که commitment INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED باشد، الزامی است.

اگر commitment INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED باشد و یک شریک در این فیلد تنظیم شود، همه تبلیغ‌کنندگان تحت این شریک به طور خودکار به منبع موجودی فقط دسترسی خواندنی خواهند داشت. این تبلیغ‌کنندگان در readAdvertiserIds قرار نخواهند گرفت.

readAdvertiserIds[]

string ( int64 format)

فقط خروجی. شناسه‌های تبلیغ‌کنندگانی که دسترسی فقط خواندنی به منبع موجودی دارند.

readPartnerIds[]

string ( int64 format)

فقط خروجی. شناسه‌های شرکایی که دسترسی فقط خواندنی به منبع موجودی دارند.

همه تبلیغ‌کنندگان شرکای این حوزه، دسترسی فقط خواندنی به منبع موجودی را به ارث می‌برند.

نوع منبع موجودی

انواع منابع موجودی احتمالی.

انوم‌ها
INVENTORY_SOURCE_TYPE_UNSPECIFIED نوع منبع موجودی در این نسخه مشخص نشده یا ناشناخته است.
INVENTORY_SOURCE_TYPE_PRIVATE منبع موجودی خصوصی.
INVENTORY_SOURCE_TYPE_AUCTION_PACKAGE بسته حراجی.

موجودیمنبعنوع محصول

انواع محصولات ممکن از یک منبع موجودی.

انوم‌ها
INVENTORY_SOURCE_PRODUCT_TYPE_UNSPECIFIED نوع محصول در این نسخه مشخص نشده یا ناشناخته است. تغییر منابع موجودی این نوع محصول از طریق API پشتیبانی نمی‌شود.
PREFERRED_DEAL منبع موجودی، موجودی را از طریق معامله ترجیحی می‌فروشد.
PRIVATE_AUCTION منبع موجودی، موجودی را از طریق حراج خصوصی می‌فروشد.
PROGRAMMATIC_GUARANTEED منبع موجودی، موجودی را از طریق Programmatic Guaranteed می‌فروشد.
TAG_GUARANTEED منبع موجودی، موجودی را از طریق Tag Guaranteed می‌فروشد.
YOUTUBE_RESERVE منبع موجودی، موجودی خود را از طریق YouTube Reserve می‌فروشد.
INSTANT_RESERVE منبع موجودی، موجودی را از طریق رزرو فوری می‌فروشد. تغییر منابع موجودی از این نوع محصول از طریق API پشتیبانی نمی‌شود.
GUARANTEED_PACKAGE منبع موجودی، موجودی را از طریق بسته تضمین‌شده می‌فروشد. تغییر منابع موجودی از این نوع محصول از طریق API پشتیبانی نمی‌شود.
PROGRAMMATIC_TV منبع موجودی، موجودی را از طریق Programmtic TV می‌فروشد. تغییر منابع موجودی از این نوع محصول از طریق API پشتیبانی نمی‌شود.
AUCTION_PACKAGE منبع موجودی، موجودی را از طریق بسته حراج می‌فروشد. تغییر منابع موجودی از این نوع محصول از طریق API پشتیبانی نمی‌شود.

تعهد منبع موجودی

انواع تعهدات احتمالی برای یک منبع موجودی.

انوم‌ها
INVENTORY_SOURCE_COMMITMENT_UNSPECIFIED تعهد در این نسخه مشخص نشده یا ناشناخته است.
INVENTORY_SOURCE_COMMITMENT_GUARANTEED تعهد، تحویل تضمین شده است.
INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED تعهد، تحویل بدون تضمین است.

منبع موجودیروش تحویل

روش‌های تحویل ممکن برای منبع موجودی.

انوم‌ها
INVENTORY_SOURCE_DELIVERY_METHOD_UNSPECIFIED روش تحویل در این نسخه مشخص نشده یا ناشناخته است.
INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC روش ارائه به صورت برنامه‌ای است.
INVENTORY_SOURCE_DELIVERY_METHOD_TAG روش ارسال به صورت برچسبی است.

وضعیت موجودیمنبع

تنظیمات مربوط به وضعیت منبع موجودی.

نمایش 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

دلیل ارائه شده توسط کاربر برای توقف موقت این منبع موجودی.

نباید از ۱۰۰ کاراکتر تجاوز کند.

فقط زمانی قابل اجرا است که 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 .

یک منبع موجودی باید قبل از اینکه بتواند خدمت‌رسانی کند، پیکربندی شود (فیلدهای مورد نیاز را پر کنید، موارد خلاقانه را انتخاب کنید و یک کمپین پیش‌فرض را انتخاب کنید).

وضعیت پیکربندی منبع موجودی

حالت‌های پیکربندی ممکن برای یک منبع موجودی تضمین‌شده.

انوم‌ها
INVENTORY_SOURCE_CONFIG_STATUS_UNSPECIFIED وضعیت تأیید در این نسخه مشخص نشده یا ناشناخته است.
INVENTORY_SOURCE_CONFIG_STATUS_PENDING وضعیت اولیه منبع موجودی تضمین شده. منبع موجودی در این حالت باید پیکربندی شود.
INVENTORY_SOURCE_CONFIG_STATUS_COMPLETED وضعیت پس از اینکه خریدار منبع موجودی تضمین‌شده را پیکربندی می‌کند.

جزئیات نرخ

تنظیمات مربوط به نرخ منبع موجودی.

نمایش 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 )

فقط خروجی. مبلغی که خریدار متعهد شده است از قبل برای منبع موجودی هزینه کند.

فقط برای منابع موجودی تضمین شده قابل اجرا است.

نوع نرخ منبع موجودی

انواع نرخ‌های ممکن برای یک منبع موجودی.

انوم‌ها
INVENTORY_SOURCE_RATE_TYPE_UNSPECIFIED نوع نرخ در این نسخه مشخص نشده یا ناشناخته است.
INVENTORY_SOURCE_RATE_TYPE_CPM_FIXED نوع نرخ CPM (ثابت) است.
INVENTORY_SOURCE_RATE_TYPE_CPM_FLOOR نوع نرخ CPM (طبقه) است.
INVENTORY_SOURCE_RATE_TYPE_CPD نوع نرخ، هزینه به ازای هر روز است.
INVENTORY_SOURCE_RATE_TYPE_CPH نوع نرخ، هزینه به ازای هر ساعت است.
INVENTORY_SOURCE_RATE_TYPE_FLAT نوع نرخ ثابت (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 نمایش داده می‌شود.

محدوده زمانی

یک محدوده زمانی.

نمایش JSON 
{
  "startTime": string,
  "endTime": string
}
فیلدها
startTime

string ( Timestamp format)

الزامی. حد پایین یک بازه زمانی، شامل.

از RFC 3339 استفاده می‌کند، که در آن خروجی تولید شده همیشه به صورت Z-normalized خواهد بود و از ارقام کسری ۰، ۳، ۶ یا ۹ استفاده می‌کند. آفست‌های غیر از "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 خواهد بود و از ارقام کسری ۰، ۳، ۶ یا ۹ استفاده می‌کند. آفست‌های غیر از "Z" نیز پذیرفته می‌شوند. مثال‌ها: "2014-10-02T15:01:23Z" ، "2014-10-02T15:01:23.045123456Z" یا "2014-10-02T15:01:23+05:30" .

پیکربندی خلاقانه

پیکربندی خلاقانه الزامات برای منبع موجودی.

نمایش 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

فیلد union 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 باشد، قابل اجرا است.

منبع موجودینمایشگرخلاقیتپیکربندی

پیکربندی برای نمایش آگهی‌های تبلیغاتی.

نمایش JSON 
{
  "creativeSize": {
    object (Dimensions)
  }
}
فیلدها
creativeSize

object ( Dimensions )

الزامات اندازه برای نمایش‌های تبلیغاتی که می‌توانند به منبع موجودی اختصاص داده شوند.

منبع موجودیویدئوخلاقیتپیکربندی

پیکربندی برای ویدیوهای خلاقانه.

نمایش JSON 
{
  "duration": string
}
فیلدها
duration

string ( Duration format)

الزامات مدت زمان برای ویدیوهای تبلیغاتی که می‌توانند به منبع موجودی اختصاص داده شوند.

مدت زمانی بر حسب ثانیه با حداکثر نه رقم کسری که به ' s ' ختم می‌شود. مثال: "3.5s" .

منابع موجودی

شریک یا تبلیغ‌کنندگانی که به منبع موجودی دسترسی دارند.

نمایش 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 )

تبلیغ‌کنندگانی که به منبع موجودی دسترسی دارند. همه تبلیغ‌کنندگان باید متعلق به یک شریک باشند.

دسترسی دهنده شریک

شریکی که به منبع موجودی دسترسی دارد.

نمایش JSON 
{
  "partnerId": string
}
فیلدها
partnerId

string ( int64 format)

مدرک شناسایی شریک.

تبلیغ‌کننده/لوازم جانبی

تبلیغ‌کنندگانی که به منبع موجودی دسترسی دارند.

نمایش JSON 
{
  "advertiserIds": [
    string
  ]
}
فیلدها
advertiserIds[]

string ( int64 format)

شناسه‌های تبلیغ‌کنندگان.

روش‌ها

create

 یک منبع موجودی جدید ایجاد می‌کند.

editInventorySourceReadWriteAccessors

 دسترسی‌های خواندن/نوشتن یک منبع موجودی را ویرایش می‌کند.

get

 یک منبع موجودی دریافت می‌کند.

list

 منابع موجودی را که برای کاربر فعلی قابل دسترسی هستند، فهرست می‌کند.

patch

 یک منبع موجودی موجود را به‌روزرسانی می‌کند.