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)
  },
  "program": string,
  "buyerCustomParameters": {
    string: string,
    ...
  },
  "etag": string
}
فیلدها
name

string

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

string

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

باید با UTF-8 کدبندی شده باشد و حداکثر اندازه آن ۲۴۰ بایت باشد. الزامی.
externalDealId

string

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

enum (TransactionType)

نوع تراکنش محصول. الزامی.
pricingType

enum (PricingType)

نوع قیمت‌گذاری برای محصول. الزامی.
updateTime
(deprecated)

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".
startTime

string (Timestamp format)

زمانی که این محصول فعال می‌شود. باید قبل‌از endTime باشد. زمان شروع نمی‌تواند بیشتر از ۱ سال در آینده باشد. الزامی.

از 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".
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)

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

object (TargetingCriteria)

فقط خروجی. مراجع معیارهای هدف‌یابی محصول. فقط برای «سناریوهای معامله فوری» قابل‌اعمال است.
forecastResult

object (ForecastResult)

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

object (ErrorDetails)

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

object (FrequencyCap)

فقط خروجی. حدگذاری بسامد انتخاب‌شده توسط خریدار. فقط برای «سناریوهای معامله فوری» قابل‌اعمال است.
program

string

فقط خروجی. برنامه‌ای که خریدار تحت آن معامله فوری را ایجاد کرده است. برای جریان عادی تبادل خالی است. فقط برای «سناریوهای معامله فوری» قابل‌اعمال است.
buyerCustomParameters

map (key: string, value: string)

فقط خروجی. پارامترهای کلید/مقدار سفارشی که خریدار در درخواست معامله فوری تنظیم کرده است. فقط برای «سناریوهای معامله فوری» قابل‌اعمال است.

شیئی که حاوی فهرستی از جفت‌های "key": value است. مثال: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
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

انواع طرح‌آگهی‌های ممکن.

شمارشی‌ها
CREATIVE_TYPE_UNSPECIFIED نوع طرح‌آگهی مشخص نشده است. مقدار ورودی معتبر نیست.
CREATIVE_TYPE_DISPLAY نوع طرح‌آگهی نمایشی.
CREATIVE_TYPE_VIDEO نوع طرح‌آگهی ویدیو.
CREATIVE_TYPE_AUDIO نوع طرح‌آگهی صوتی.
CREATIVE_TYPE_NATIVE نوع طرح‌آگهی بومی. این ویژگی برای محصولات نوع تراکنش RESERVED پشتیبانی نمی‌شود.

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

معیارهای مطابقت برای مدت زمان طرح‌آگهی ویدیویی.

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

SkippableMatchType

معیارهای مطابقت برای اینکه آیا طرح‌آگهی ویدیویی قابل رد شدن است یا نه.

شمارشی‌ها
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

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

string

دلیل جبران خسارت آغازشده توسط فروشنده. حداکثر ۲۵۰ نویسه. الزامی.

CreativeSource

منبع طرح‌آگهی؛ جایی که طرح‌آگهی‌ها از آنجا ارائه خواهد شد.

شمارشی‌ها
CREATIVE_SOURCE_UNSPECIFIED منبع طرح‌آگهی در این نسخه مشخص نشده است یا ناشناخته است. مقدار ورودی معتبر نیست.
CREATIVE_SOURCE_ADVERTISER طرح‌های آگهی توسط DV3 ارائه خواهد شد.
CREATIVE_SOURCE_PUBLISHER ناشر آگهی‌ها را ارائه خواهد کرد. طرح‌آگهی‌های میزبانی‌شده توسط ناشر درحال‌حاضر پشتیبانی نمی‌شوند؛ هر درخواستی که تلاش کند منبع طرح‌آگهی را روی CREATIVE_SOURCE_PUBLISHER تنظیم کند، ناموفق خواهد بود.

AudienceTargetingConfig

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

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

enum (AudienceType)

نوع مخاطب. الزامی.

AudienceType

نوع مخاطب.

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

TargetingCriteria

معیار هدف‌یابی مشخص شد.

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

object (SelectedTargetingOption)

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

SelectedTargetingOption

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

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

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "audienceSelection": {
    object (AudienceSelection)
  },
  "targetingSelection": {
    object (TargetingSelection)
  }
  // End of mutually exclusive fields.
}
فیلدها
type

enum (TargetingType)

نوع هدف‌یابی مرتبط با گزینه‌های انتخاب‌شده.
فقط یک نوع انتخاب می‌تواند گنجانده شود. انتخاب برگزیده باید با TargetingType انتخاب‌شده برای فیلد type مطابقت داشته باشد. در زیر فهرستی از فیلدهای متقابلاً انحصاری آمده است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد:
audienceSelection

object (AudienceSelection)

مخاطب انتخاب‌شده.
targetingSelection

object (TargetingSelection)

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

TargetingType

انواع هدف‌یابی.

شمارشی‌ها
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 حداقل اندازه پخش‌کننده ویدیو نوع هدف‌یابی.
TARGETING_TYPE_VIDEO_COMPLETION نوع هدف‌یابی جای آگهی ویدیویی.
TARGETING_TYPE_VIEWABILITY قابل‌مشاهده بودن نوع هدف‌یابی.
TARGETING_TYPE_REWARDED نوع هدف‌یابی پاداش‌دار.
TARGETING_TYPE_VIDEO_AD_DURATION_THRESHOLD_SEC آستانه مدت آگهی ویدیویی نوع هدف‌یابی (ثانیه).
TARGETING_TYPE_VIDEO_PLACEMENT نوع هدف‌یابی جای آگهی ویدیویی.
TARGETING_TYPE_VIDEO_PLAYBACK_METHOD نوع هدف‌گیری روش بازپخش ویدیو.
TARGETING_TYPE_APP_ID شناسه برنامه نوع هدف‌یابی.
TARGETING_TYPE_DOMAIN_URL نشانی وب دامنه نوع هدف‌یابی.
TARGETING_TYPE_CTR نرخ کلیک‌گذری نوع هدف‌یابی.
TARGETING_TYPE_DEMOGRAPHICS نوع هدف‌یابی جمعیتی.
TARGETING_TYPE_RESTRICTED_CATEGORY دسته محدودشده نوع هدف‌یابی.
TARGETING_TYPE_AD_POSITION جایگاه آگهی نوع هدف‌یابی.
TARGETING_TYPE_DAY_AND_TIME روز و زمان نوع هدف‌یابی.
TARGETING_TYPE_RETAIL_MEDIA_AUDIENCE نوع هدف‌یابی مخاطب رسانه خرده‌فروشی.

AudienceSelection

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

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

object (OrGroup)

گزینه‌های گنجانده‌شده با AND به‌هم متصل می‌شوند، هر گزینه گنجانده‌شده می‌تواند یک گزینه تکی باشد، یا گروهی از گزینه‌ها که با OR به‌هم متصل شده‌اند.
excludedOptionIds[]

string (int64 format)

گزینه‌های مستثنی‌شده با OR ترکیب می‌شوند.

OrGroup

گروهی از گزینه‌های انتخاب‌شده که با «یا» به هم متصل شده‌اند.

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

string (int64 format)

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

TargetingSelection

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

نمایش JSON 
{
  "optionIds": [
    string
  ],
  "externalIds": [
    string
  ],
  "excludedOptionIds": [
    string
  ],
  "excludedExternalIds": [
    string
  ]
}
فیلدها
optionIds[]

string (int64 format)

فقط خروجی. شناسه‌های گزینه هدف‌یابی DV3 انتخاب‌شده با صرافی هم‌رسانی شد. ممکن است در کنار excludedOptionIds برگردانده شود، به‌شرطی که این دو فهرست هم‌پوشانی نداشته باشند.
externalIds[]

string

فقط خروجی. شناسه‌های گزینه هدف‌یابی انتخاب‌شده که توسط صرافی ارائه شده است. ممکن است در کنار excludedExternalIds برگردانده شود، به‌شرطی که این دو فهرست هم‌پوشانی نداشته باشند.
excludedOptionIds[]

string (int64 format)

فقط خروجی. شناسه‌های گزینه هدف‌یابی DV3 مستثنی‌شده که با صرافی هم‌رسانی شده است. ممکن است در کنار optionIds برگردانده شود، به‌شرطی که این دو فهرست هم‌پوشانی نداشته باشند.
excludedExternalIds[]

string

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

ForecastResult

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

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

object (Forecast)

پیش‌بینی. forecastCategory باید برای هر عنصر مشخص‌شده یکتا باشد.

پیش‌بینی وضع هوا

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

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

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "number": string,
  "percentage": integer,
  "cpmPrice": {
    object (Money)
  },
  "cpmRange": {
    object (CpmRange)
  },
  "forecastBreakdownData": {
    object (ForecastBreakdownData)
  }
  // End of mutually exclusive fields.
}
فیلدها
forecastCategory

enum (ForecastCategory)

دسته پیش‌بینی مشخص‌شده که آمار پیش‌بینی نشان می‌دهد.
فقط یک نوع داده آماری می‌تواند گنجانده شود. داده‌های پرشده باید با فیلد forecastCategory مطابقت داشته باشد. در زیر فهرستی از فیلدهای متقابلاً انحصاری آمده است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد:
number

string (int64 format)

داده‌های عددی.
percentage

integer

داده‌های درصدی.
cpmPrice

object (Money)

داده‌های قیمت هزارظهوربها.
cpmRange

object (CpmRange)

داده‌های محدوده قیمت هزارظهوربها.
forecastBreakdownData

object (ForecastBreakdownData)

داده‌های تفکیک پیش‌بینی.
پایان فیلدهای متقابلاً انحصاری.

ForecastCategory

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

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

CpmRange

محدوده هزارظهوربها شامل حداقل و حداکثر هزارظهوربها است.

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

object (Money)

کران پایین محدوده هزارظهوربها.
maxCpm

object (Money)

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

ForecastBreakdownData

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

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

object (ForecastBreakdown)

فهرستی از تفکیک‌های پیش‌بینی.

ForecastBreakdown

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

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

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "impressions": string
  // End of mutually exclusive fields.
}
فیلدها
selectedTargetingOption

object (SelectedTargetingOption)

گزینه یا گزینه‌های هدف‌یابی انتخاب‌شده برای یک نوع هدف‌یابی.
فقط یک نوع داده تفکیک‌شده می‌تواند گنجانده شود. در زیر فهرستی از فیلدهای متقابلاً انحصاری آمده است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد:
impressions

string (int64 format)

دفعات ظهور را پیش‌بینی کنید.
پایان فیلدهای متقابلاً انحصاری.

ErrorDetails

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

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

string

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

enum (InstantDealErrorStatus)

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

InstantDealErrorStatus

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

شمارشی‌ها
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)

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

TimeUnit

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

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

روش‌ها

create

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

get

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

list

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

patch

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