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

فقط خروجی نام منبع منبع موجودی.

inventory Source Id

string ( int64 format)

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

display Name

string

نام نمایشی منبع موجودی.

باید UTF-8 با حداکثر اندازه 240 بایت کدگذاری شود.

inventory Source Type

enum ( InventorySourceType )

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

inventory Source Product Type

enum ( InventorySourceProductType )

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

commitment

enum ( InventorySourceCommitment )

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

delivery Method

enum ( InventorySourceDeliveryMethod )

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

  • برای منابع موجودی غیر تضمینی، تنها مقدار قابل قبول INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC است.
  • برای منابع موجودی تضمین شده، مقادیر قابل قبول INVENTORY_SOURCE_DELIVERY_METHOD_TAG و INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC هستند.
deal Id

string

شناسه ای در فضای مبادله که منبع موجودی را به طور منحصر به فرد شناسایی می کند.

باید در بین خریداران در هر صرافی منحصر به فرد باشد اما لزوماً در بین صرافی ها منحصر به فرد نباشد.

status

object ( InventorySourceStatus )

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

exchange

enum ( Exchange )

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

update Time

string ( Timestamp format)

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

مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" .

rate Details

object ( RateDetails )

مورد نیاز. جزئیات نرخ منبع موجودی.

publisher Name

string

نام ناشر/فروشنده منبع موجودی.

time Range

object ( TimeRange )

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

creative Configs[]

object ( CreativeConfig )

الزامات خلاقانه منبع موجودی

برای بسته های حراج قابل استفاده نیست.

guaranteed Order Id

string

تغییرناپذیر. شناسه سفارش تضمین شده که این منبع موجودی به آن تعلق دارد.

فقط زمانی قابل اعمال است که commitment INVENTORY_SOURCE_COMMITMENT_GUARANTEED باشد.

read Write Accessors

object ( InventorySourceAccessors )

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

خروجی فقط زمانی است که commitment INVENTORY_SOURCE_COMMITMENT_GUARANTEED باشد، در این صورت دسترسی‌های خواندن/نوشتن از سفارش تضمین‌شده والد به ارث می‌رسند.

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

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

read Advertiser Ids[]

string ( int64 format)

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

read Partner Ids[]

string ( int64 format)

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

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

InventorySourceType

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

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

InventorySourceProductType

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

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

InventorySourceCommitment

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

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

InventorySourceDeliveryMethod

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

Enums
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)
}
فیلدها
entity Status

enum ( EntityStatus )

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

مقادیر قابل قبول ENTITY_STATUS_ACTIVE ، ENTITY_STATUS_ARCHIVED و ENTITY_STATUS_PAUSED هستند. مقدار پیش‌فرض ENTITY_STATUS_ACTIVE است.

entity Pause Reason

string

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

نباید بیش از 100 کاراکتر باشد.

فقط زمانی قابل اعمال است که entityStatus روی ENTITY_STATUS_PAUSED تنظیم شده باشد.

seller Status

enum ( EntityStatus )

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

فقط برای منابع موجودی که مستقیماً از ناشران همگام‌سازی شده‌اند قابل اجرا است. مقادیر قابل قبول ENTITY_STATUS_ACTIVE و ENTITY_STATUS_PAUSED هستند.

seller Pause Reason

string

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

فقط برای منابع موجودی که مستقیماً از ناشران همگام‌سازی شده‌اند و زمانی که sellerStatus روی ENTITY_STATUS_PAUSED تنظیم شده باشد، قابل اجرا است.

config Status

enum ( InventorySourceConfigStatus )

فقط خروجی وضعیت پیکربندی منبع موجودی.

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

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

InventorySourceConfigStatus

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

Enums
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)
  }
}
فیلدها
inventory Source Rate Type

enum ( InventorySourceRateType )

نوع نرخ

مقادیر قابل قبول عبارتند از INVENTORY_SOURCE_RATE_TYPE_CPM_FIXED ، INVENTORY_SOURCE_RATE_TYPE_CPM_FLOOR ، و INVENTORY_SOURCE_RATE_TYPE_CPD .

rate

object ( Money )

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

units Purchased

string ( int64 format)

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

minimum Spend

object ( Money )

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

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

InventorySourceRateType

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

Enums
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_FLAT نوع نرخ تخت است.

پول

مقداری پول را با نوع ارز آن نشان می دهد.

نمایندگی JSON 
{
  "currencyCode": string,
  "units": string,
  "nanos": integer
}
فیلدها
currency Code

string

کد ارز سه حرفی تعریف شده در ISO 4217.

units

string ( int64 format)

کل واحدهای مقدار. به عنوان مثال، اگر currencyCode "USD" باشد، 1 واحد یک دلار آمریکا است.

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
}
فیلدها
start Time

string ( Timestamp format)

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

مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" .

end Time

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.
}
فیلدها
creative Type

enum ( CreativeType )

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

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_VIDEO

فیلد اتحادیه creative_config_scheme . زمانی که creative_type یکی از موارد زیر باشد قابل استفاده است:

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_VIDEO

پیکربندی برای خلاقیت هایی که می توان به منبع موجودی اختصاص داد. creative_config_scheme فقط می تواند یکی از موارد زیر باشد:

display Creative Config

object ( InventorySourceDisplayCreativeConfig )

پیکربندی برای نمایش خلاقیت ها. زمانی که creativeType CREATIVE_TYPE_STANDARD باشد قابل اجرا است.

video Creative Config

object ( InventorySourceVideoCreativeConfig )

پیکربندی برای خلاقیت های ویدیویی. زمانی که creativeType CREATIVE_TYPE_VIDEO باشد قابل استفاده است.

InventorySourceDisplayCreativeConfig

پیکربندی برای نمایش خلاقیت ها.

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

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
}
فیلدها
partner Id

string ( int64 format)

شناسه شریک

AdvertiserAccessors

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

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

string ( int64 format)

شناسه آگهی دهندگان

روش ها

create

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

edit Inventory Source Read Write Accessors

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

get

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

list

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

patch

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