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 کدبندی شده باشد و حداکثر اندازه آن ۲۴۰ بایت باشد.
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-نرمال‌شده است و از ۰، ۳، ۶، یا ۹ رقم اعشاری استفاده می‌کند. انحراف‌های غیراز «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 منبع فضای آگهی، فضای آگهی را ازطریق «تضمین‌شده با برچسب» می‌فروشد.
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

دلیل ارائه‌شده ازسوی کاربر برای توقف موقت این منبع فضای آگهی.

نباید بیشتر از ۱۰۰ نویسه باشد.

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

تعداد واحدهای نانو (۱۰^-۹) مبلغ. مقدار باید بین ۹۹۹٬۹۹۹٬۹۹۹- و ۹۹۹٬۹۹۹٬۹۹۹+ باشد و می‌تواند این دو عدد را نیز دربر بگیرد. اگر units مثبت باشد، nanos باید مثبت یا صفر باشد. اگر units صفر باشد، nanos می‌تواند مثبت، صفر، یا منفی باشد. اگر units منفی باشد، nanos باید منفی یا صفر باشد. برای مثال، ‎-۱٫۷۵ دلار به‌صورت units=-۱ و nanos=-۷۵۰٬۰۰۰٬۰۰۰ نشان داده می‌شود.

TimeRange

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

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

string (Timestamp format)

الزامی. کران پایین محدوده زمانی، فراگیر.

از RFC 3339 استفاده می‌کند، که در آن خروجی تولیدشده همیشه Z-نرمال‌شده است و از ۰، ۳، ۶، یا ۹ رقم اعشاری استفاده می‌کند. انحراف‌های غیراز «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-نرمال‌شده است و از ۰، ۳، ۶، یا ۹ رقم اعشاری استفاده می‌کند. انحراف‌های غیراز «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

 معامله‌های منبع فضای آگهی را فهرست می‌کند.