REST Resource: exchanges.orders.products

منبع: محصول

محصول

نمایندگی JSON 
{
  "name": string,
  "displayName": string,
  "externalDealId": string,
  "transactionType": enum (TransactionType),
  "pricingType": enum (PricingType),
  "updateTime": string,
  "startTime": string,
  "endTime": string,
  "rateDetails": {
    object (RateDetails)
  },
  "creativeConfig": [
    {
      object (CreativeConfig)
    }
  ],
  "makegood": boolean,
  "makegoodDetails": {
    object (MakegoodDetails)
  },
  "creativeSource": enum (CreativeSource),
  "mediumType": enum (MediumType),
  "audienceTargetingConfig": {
    object (AudienceTargetingConfig)
  },
  "targetingCriteria": {
    object (TargetingCriteria)
  },
  "forecastResult": {
    object (ForecastResult)
  },
  "errorDetails": {
    object (ErrorDetails)
  },
  "frequencyCap": {
    object (FrequencyCap)
  },
  "etag": string
}
فیلدها
name

string

نام مسیر نسبی برای محصول. تولید شده توسط سرور مثال: "exchanges/1234/orders/5678/products/abc". فقط خروجی

displayName

string

نام نمایشی محصول

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

externalDealId

string

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

transactionType

enum ( TransactionType )

نوع معامله محصول مورد نیاز.

pricingType

enum ( PricingType )

نوع قیمت گذاری برای محصول مورد نیاز.

updateTime
(deprecated)

string ( Timestamp format)

مهر زمانی آخرین به روز رسانی محصول.

از RFC 3339 استفاده می کند، که در آن خروجی تولید شده همیشه با Z نرمال می شود و از 0، 3، 6 یا 9 رقم کسری استفاده می کند. افست های غیر از "Z" نیز پذیرفته می شود. مثال‌ها: "2014-10-02T15:01:23Z" ، "2014-10-02T15:01:23.045123456Z" یا "2014-10-02T15:01:23+05:30" .

startTime

string ( Timestamp format)

زمانی که این محصول فعال می شود. باید زودتر از پایان زمان باشد. زمان شروع نمی تواند بیش از 1 سال در آینده باشد. مورد نیاز.

از RFC 3339 استفاده می کند، که در آن خروجی تولید شده همیشه با Z نرمال می شود و از 0، 3، 6 یا 9 رقم کسری استفاده می کند. افست های غیر از "Z" نیز پذیرفته می شود. مثال‌ها: "2014-10-02T15:01:23Z" ، "2014-10-02T15:01:23.045123456Z" یا "2014-10-02T15:01:23+05:30" .

endTime

string ( Timestamp format)

زمانی که این محصول غیر فعال می شود. در حال حاضر نمی تواند بعد از سال 2036 باشد. الزامی است.

از RFC 3339 استفاده می کند، که در آن خروجی تولید شده همیشه با Z نرمال می شود و از 0، 3، 6 یا 9 رقم کسری استفاده می کند. افست های غیر از "Z" نیز پذیرفته می شود. مثال‌ها: "2014-10-02T15:01:23Z" ، "2014-10-02T15:01:23.045123456Z" یا "2014-10-02T15:01:23+05:30" .

rateDetails

object ( RateDetails )

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

creativeConfig[]

object ( CreativeConfig )

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

makegood
(deprecated)

boolean

نشان می دهد که آیا یک محصول یک محصول ساختگی است یا خیر.

makegoodDetails
(deprecated)

object ( MakegoodDetails )

جزئیات ساخت خوب برای یک محصول زمانی که محصول کالای اولیه است الزامی است.

creativeSource

enum ( CreativeSource )

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

mediumType

enum ( MediumType )

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

audienceTargetingConfig

object ( AudienceTargetingConfig )

اختیاری. پیکربندی هدفگیری مخاطب انتخاب شده در سطح معامله در Exchange اعمال شد.

targetingCriteria

object ( TargetingCriteria )

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

forecastResult

object ( ForecastResult )

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

errorDetails

object ( ErrorDetails )

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

frequencyCap

object ( FrequencyCap )

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

etag

string

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

CreativeConfig

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

نمایندگی JSON 
{
  "creativeType": enum (CreativeType),
  "dimensionCreativeConfig": {
    object (DimensionCreativeConfig)
  },
  "durationCreativeConfig": {
    object (DurationCreativeConfig)
  }
}
فیلدها
creativeType

enum ( CreativeType )

نوع خلاقانه مورد نیاز.

dimensionCreativeConfig

object ( DimensionCreativeConfig )

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

این فیلد برای خلاقیت‌های بومی (CREATIVE_TYPE_NATIVE) پشتیبانی نمی‌شود.

durationCreativeConfig

object ( DurationCreativeConfig )

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

CreativeType

انواع خلاقانه احتمالی

Enums
CREATIVE_TYPE_UNSPECIFIED نوع خلاقیت مشخص نشده است. مقدار ورودی معتبر نیست.
CREATIVE_TYPE_DISPLAY نوع خلاقانه نمایشگر
CREATIVE_TYPE_VIDEO نوع خلاقانه ویدیو
CREATIVE_TYPE_AUDIO نوع خلاقانه صدا
CREATIVE_TYPE_NATIVE نوع خلاق بومی.

DimensionCreativeConfig

نمایش ابعاد خلاقانه در پیکسل

نمایندگی JSON 
{
  "width": integer,
  "height": integer
}
فیلدها
width

integer

نمایش عرض خلاق. مورد نیاز.

height

integer

نمایش ارتفاع خلاق مورد نیاز.

DurationCreativeConfig

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

نمایندگی JSON 
{
  "duration": string,
  "durationMatchType": enum (DurationMatchType),
  "skippableMatchType": enum (SkippableMatchType)
}
فیلدها
duration

string ( Duration format)

مدت زمان خلاقیت ویدیو بر حسب ثانیه. مورد نیاز

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

durationMatchType

enum ( DurationMatchType )

معیارهای تطبیق مدت

skippableMatchType

enum ( SkippableMatchType )

نوع خلاق ویدیویی قابل رد شدن.

DurationMatchType

قالب‌های ممکن برای معیار مطابقت مدت.

Enums
DURATION_MATCH_TYPE_UNSPECIFIED معیار تطابق مدت زمان در این نسخه مشخص نشده است یا ناشناخته است. مقدار ورودی معتبر نیست.
DURATION_MATCH_TYPE_EQUAL_TO مدت زمان خلاقیت باید با مدت زمان مورد نیاز یکسان باشد.
DURATION_MATCH_TYPE_LESS_THAN_OR_EQUAL_TO مدت زمان خلاقیت باید برابر یا کمتر از مدت زمان لازم باشد.

SkippableMatchType

فرمت های ممکن برای یک محصول

Enums
SKIPPABLE_MATCH_TYPE_UNSPECIFIED نوع قابل پرش در این نسخه مشخص نشده یا ناشناخته است. مقدار ورودی معتبر نیست.
SKIPPABLE_MATCH_TYPE_SKIPPABLE خلاق باید قابل رد شدن باشد.
SKIPPABLE_MATCH_TYPE_NOT_SKIPPABLE خلاقیت باید قابل رد شدن نباشد.
SKIPPABLE_MATCH_TYPE_ANY خلاقیت می تواند قابل رد شدن یا غیر قابل رد شدن باشد.

MakegoodDetails

پیکربندی برای جزئیات ساخت خوب.

نمایندگی JSON 
{
  "originalExternalDealId": string,
  "reason": string
}
فیلدها
originalExternalDealId

string

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

reason

string

دلیل Makegood که توسط فروشنده آغاز شده است. حداکثر 250 کاراکتر مورد نیاز.

CreativeSource

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

Enums
CREATIVE_SOURCE_UNSPECIFIED منبع خلاق در این نسخه مشخص یا ناشناخته نیست. مقدار ورودی معتبر نیست.
CREATIVE_SOURCE_ADVERTISER خلاقیت ها توسط DV3 ارائه می شود.
CREATIVE_SOURCE_PUBLISHER خلاقیت ها توسط ناشر ارائه می شود. خلاقیت های میزبانی شده توسط ناشر در حال حاضر پشتیبانی نمی شوند. هر درخواستی که بخواهد منبع خلاق را روی CREATIVE_SOURCE_PUBLISHER تنظیم کند با شکست مواجه خواهد شد.

AudienceTargetingConfig

پیکربندی برای هدف قرار دادن مخاطب.

نمایندگی JSON 
{
  "audienceType": enum (AudienceType)
}
فیلدها
audienceType

enum ( AudienceType )

نوع مخاطب مورد نیاز.

نوع مخاطب

نوع مخاطب

Enums
AUDIENCE_TYPE_UNSPECIFIED نوع مخاطب نامشخص برای ورودی معتبر نیست.
AUDIENCE_TYPE_COMMERCE نوع مخاطب تجاری

معیارهای هدف گذاری

معیارهای هدف گذاری مشخص شده است.

نمایندگی JSON 
{
  "selectedTargetingOptions": [
    {
      object (SelectedTargetingOption)
    }
  ]
}
فیلدها
selectedTargetingOptions[]

object ( SelectedTargetingOption )

گزینه های انتخاب شده

SelectedTargetingOption

گزینه یا گزینه های هدف گیری انتخاب شده برای یک نوع هدف گیری واحد.

نمایندگی JSON 
{
  "type": enum (TargetingType),

  // Union field value can be only one of the following:
  "audienceSelection": {
    object (AudienceSelection)
  },
  "targetingSelection": {
    object (TargetingSelection)
  }
  // End of list of possible types for union field value.
}
فیلدها
type

enum ( TargetingType )

نوع هدف مرتبط با گزینه های انتخاب شده.

value فیلد اتحادیه فقط یک نوع انتخاب می تواند گنجانده شود. انتخاب انتخاب شده باید با TargetingType انتخاب شده برای فیلد "نوع" مطابقت داشته باشد. value فقط می تواند یکی از موارد زیر باشد:
audienceSelection

object ( AudienceSelection )

مخاطبان منتخب

targetingSelection

object ( TargetingSelection )

مجموعه ای عمومی از شناسه های گزینه انتخاب شده.

نوع هدف

انواع هدف گذاری

Enums
TARGETING_TYPE_UNSPECIFIED نوع هدف نامشخص، برای ورودی معتبر نیست.
TARGETING_TYPE_AUDIENCE مخاطب نوع هدف.
TARGETING_TYPE_COUNTRY کشور نوع هدف.
TARGETING_TYPE_DMA نوع هدف dma.
TARGETING_TYPE_PROGRAMMER برنامه نویس نوع هدف.
TARGETING_TYPE_BRAND نام تجاری نوع هدف.
TARGETING_TYPE_CONTENT_GENRE ژانر محتوای نوع هدف.
TARGETING_TYPE_DEVICE دستگاه نوع هدف گیری
TARGETING_TYPE_OPERATING_SYSTEM سیستم عامل نوع هدف.
TARGETING_TYPE_RATING رتبه بندی نوع هدف.
TARGETING_TYPE_ENVIRONMENT محیط نوع هدف گذاری
TARGETING_TYPE_LANGUAGE زبان نوع هدف.
TARGETING_TYPE_GEO جغرافیای نوع هدف.
TARGETING_TYPE_AGE سن نوع هدف گذاری
TARGETING_TYPE_GENDER نوع هدف جنسیت.
TARGETING_TYPE_CONTEXTUAL_SEGMENT بخش متنی نوع هدف.
TARGETING_TYPE_REQUEST_FORMAT قالب درخواست نوع هدف.
TARGETING_TYPE_PUBLISHER ناشر نوع هدف.
TARGETING_TYPE_INVENTORY_SIZE اندازه نوع هدف.
TARGETING_TYPE_NETWORK شبکه نوع هدف گیری
TARGETING_TYPE_PLATFORM پلت فرم نوع هدف گیری.
TARGETING_TYPE_VIDEO_DELIVERY_TYPE نوع ارسال ویدیوی هدفمند.
TARGETING_TYPE_VIDEO_MINIMUM_PLAYER_SIZE نوع هدف حداقل اندازه پخش کننده ویدیو.

انتخاب مخاطب

گزینه های انتخاب شده برای هدف گیری مخاطب

نمایندگی JSON 
{
  "includedOrGroups": [
    {
      object (OrGroup)
    }
  ],
  "excludedOptionIds": [
    string
  ]
}
فیلدها
includedOrGroups[]

object ( OrGroup )

گزینه های موجود با AND همراه هستند، هر گزینه شامل می تواند یک گزینه جداگانه یا گروهی از گزینه های همراه با OR باشد.

excludedOptionIds[]

string ( int64 format)

گزینه های حذف شده با OR همراه هستند.

OrGroup

گروهی از گزینه های انتخاب شده به همراه OR.

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

string ( int64 format)

شناسه گزینه انتخاب شده

TargetingSelection

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

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

string ( int64 format)

شناسه گزینه انتخاب شده

نتیجه پیش بینی

نتیجه پیش بینی مشخص شد

نمایندگی JSON 
{
  "forecasts": [
    {
      object (Forecast)
    }
  ]
}
فیلدها
forecasts[]

object ( Forecast )

پیش بینی. "forecastCategory" باید برای هر عنصر مشخص شده منحصر به فرد باشد.

پیش بینی

پیش بینی دسته پیش بینی مشخص شده.

نمایندگی JSON 
{
  "forecastCategory": enum (ForecastCategory),

  // Union field forecast_data can be only one of the following:
  "number": string,
  "percentage": integer,
  "cpmPrice": {
    object (Money)
  },
  "cpmRange": {
    object (CpmRange)
  },
  "forecastBreakdownData": {
    object (ForecastBreakdownData)
  }
  // End of list of possible types for union field forecast_data.
}
فیلدها
forecastCategory

enum ( ForecastCategory )

دسته پیش بینی مشخص شده که آمار پیش بینی نشان داده شده است.

forecast_data فیلد اتحادیه . فقط یک نوع داده آماری را می توان گنجاند. داده های جمع شده باید با فیلد "forecastCategory" مطابقت داشته باشد. forecast_data می تواند تنها یکی از موارد زیر باشد:
number

string ( int64 format)

داده های شماره

percentage

integer

داده های درصدی

cpmPrice

object ( Money )

داده های قیمت CPM

cpmRange

object ( CpmRange )

داده های محدوده قیمت CPM.

forecastBreakdownData

object ( ForecastBreakdownData )

پیش بینی داده های شکست

دسته بندی پیش بینی

دسته پیش بینی

Enums
FORECAST_CATEGORY_UNSPECIFIED دسته بندی نامشخص برای ورودی معتبر نیست.
FORECAST_CATEGORY_TOTAL_OPPORTUNITIES مجموع فرصت ها داده های شماره
FORECAST_CATEGORY_TOTAL_AUDIENCE کل مخاطب داده های شماره
FORECAST_CATEGORY_DIGITAL_TRP امتیاز هدف دیجیتال داده های درصدی
FORECAST_CATEGORY_SUGGESTED_CPM قیمت CPM پیشنهادی محدوده CPM یا داده های قیمت CPM.
FORECAST_CATEGORY_UNIQUE_REACH پیش بینی دسترسی منحصر به فرد داده های شماره
FORECAST_CATEGORY_FORECAST_BREAKDOWN تفکیک پیش بینی پیش بینی داده های شکست

Cpm Range

محدوده CPM شامل حداقل و حداکثر CPM است.

نمایندگی JSON 
{
  "minCpm": {
    object (Money)
  },
  "maxCpm": {
    object (Money)
  }
}
فیلدها
minCpm

object ( Money )

کران پایینی محدوده CPM.

maxCpm

object ( Money )

کران بالای محدوده CPM.

ForecastBreakdownData

داده های شکست پیش بینی فهرستی از تفکیک پیش بینی را در خود جای داده است.

نمایندگی JSON 
{
  "forecastBreakdowns": [
    {
      object (ForecastBreakdown)
    }
  ]
}
فیلدها
forecastBreakdowns[]

object ( ForecastBreakdown )

لیستی از خرابی های پیش بینی

ForecastBreakdown

پیش بینی تفکیک گزینه هدف انتخابی.

نمایندگی JSON 
{
  "selectedTargetingOption": {
    object (SelectedTargetingOption)
  },

  // Union field breakdown_data can be only one of the following:
  "impressions": string
  // End of list of possible types for union field breakdown_data.
}
فیلدها
selectedTargetingOption

object ( SelectedTargetingOption )

گزینه یا گزینه های هدف گیری انتخاب شده برای یک نوع هدف گیری واحد.

breakdown_data فیلد اتحادیه. فقط یک نوع داده تفکیک را می توان گنجاند. breakdown_data می تواند تنها یکی از موارد زیر باشد:
impressions

string ( int64 format)

پیش بینی برداشت ها

جزئیات خطا

جزئیات خطا مشخص شده زمانی که به روز رسانی دارای خطا است.

نمایندگی JSON 
{
  "message": string,
  "instantDealErrorStatus": enum (InstantDealErrorStatus)
}
فیلدها
message

string

پیام مشخص شده هنگام بروز رسانی دارای خطا است.

instantDealErrorStatus

enum ( InstantDealErrorStatus )

وضعیت خطا مشخص شده زمانی که به‌روزرسانی دارای خطاهایی برای معاملات فوری باشد.

InstantDealErrorStatus

وقتی به‌روزرسانی معامله فوری دارای خطا باشد، وضعیت خطا مشخص می‌شود.

Enums
INSTANT_DEAL_ERROR_STATUS_UNSPECIFIED وضعیت خطای نامشخص
INSTANT_DEAL_ERROR_STATUS_INVENTORY_UNAVAILABLE وضعیت خطا نشان می دهد موجودی در دسترس نیست.
INSTANT_DEAL_ERROR_STATUS_FORECAST_UNAVAILABLE وضعیت خطا نشان می دهد که پیش بینی در دسترس نیست.
INSTANT_DEAL_ERROR_STATUS_INVALID_INPUT وضعیت خطا نشان می دهد که فیلدهای ورودی نامعتبر است.

FrequencyCap

تعداد دفعاتی که ممکن است یک کاربر با یک تبلیغ در یک بازه زمانی مشخص نشان داده شود

نمایندگی JSON 
{
  "timeUnit": enum (TimeUnit),
  "maxImpressions": string
}
فیلدها
timeUnit

enum ( TimeUnit )

واحد زمانی که در آن سقف فرکانس اعمال خواهد شد.

maxImpressions

string ( int64 format)

حداکثر تعداد دفعاتی که ممکن است یک کاربر با همان تبلیغ در این مدت نمایش داده شود.

واحد زمان

واحد زمانی که در آن سقف فرکانس اعمال خواهد شد.

Enums
TIME_UNIT_UNSPECIFIED واحد زمان نامشخص
TIME_UNIT_LIFETIME سقف فرکانس برای کل طول عمر اعمال خواهد شد.
TIME_UNIT_MONTHS محدودیت فرکانس برای چند ماه اعمال خواهد شد.
TIME_UNIT_WEEKS محدودیت فرکانس برای چند هفته اعمال خواهد شد.
TIME_UNIT_DAYS محدودیت فرکانس برای چند روز اعمال خواهد شد.

روش ها

create

 یک محصول ایجاد می کند.

get

 محصول می گیرد.

list

 محصول را فهرست می کند.

patch

 یک محصول را به روز می کند.