REST Resource: advertisers.insertionOrders

{
  "name": string,
  "advertiserId": string,
  "campaignId": string,
  "insertionOrderId": string,
  "displayName": string,
  "insertionOrderType": enum (InsertionOrderType),
  "entityStatus": enum (EntityStatus),
  "updateTime": string,
  "partnerCosts": [
    {
      object (PartnerCost)
    }
  ],
  "pacing": {
    object (Pacing)
  },
  "frequencyCap": {
    object (FrequencyCap)
  },
  "integrationDetails": {
    object (IntegrationDetails)
  },
  "performanceGoal": {
    object (PerformanceGoal)
  },
  "budget": {
    object (InsertionOrderBudget)
  },
  "bidStrategy": {
    object (BiddingStrategy)
  },
  "reservationType": enum (ReservationType),
  "billableOutcome": enum (BillableOutcome)
}

string

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

string ( int64 format)

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

string ( int64 format)

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

string ( int64 format)

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

string

مورد نیاز. نام نمایشی سفارش درج.

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

enum ( InsertionOrderType )

نوع دستور درج.

اگر این فیلد در ایجاد نامشخص باشد، مقدار پیش‌فرض روی RTB است.

enum ( EntityStatus )

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

• برای روش insertionOrders.create ، فقط ENTITY_STATUS_DRAFT مجاز است. برای فعال کردن سفارش درج، از روش insertionOrders.patch استفاده کنید و وضعیت را پس از ایجاد به ENTITY_STATUS_ACTIVE به روز کنید.
• دستور درج را نمی توان از هر وضعیت دیگری به وضعیت ENTITY_STATUS_DRAFT تغییر داد.
• اگر کمپین اصلی آن فعال نباشد، سفارش درج نمی‌تواند روی ENTITY_STATUS_ACTIVE تنظیم شود.

string ( Timestamp format)

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

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

object ( PartnerCost )

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

اگر در روش insertionOrders.create وجود نداشته باشد یا خالی باشد، سفارش درج جدید ایجاد شده هزینه های شریک را از تنظیمات شریک به ارث می برد.

object ( Pacing )

مورد نیاز. تنظیم سرعت هزینه بودجه در دستور درج.

object ( FrequencyCap )

مورد نیاز. تنظیم دربندی فرکانس ترتیب درج.

object ( IntegrationDetails )

جزئیات ادغام اضافی سفارش درج.

object ( PerformanceGoal )

مورد نیاز. هدف اجرای دستور درج.

object ( InsertionOrderBudget )

مورد نیاز. تنظیمات تخصیص بودجه دستور درج.

object ( BiddingStrategy )

استراتژی مناقصه سفارش درج. به طور پیش فرض، fixedBid تنظیم شده است.

enum ( ReservationType )

فقط خروجی نوع رزرو سفارش درج.

enum ( BillableOutcome )

تغییرناپذیر. نتیجه قابل صدور حکم درج.

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

{
  "budgetUnit": enum (BudgetUnit),
  "automationType": enum (InsertionOrderAutomationType),
  "budgetSegments": [
    {
      object (InsertionOrderBudgetSegment)
    }
  ]
}

enum ( BudgetUnit )

مورد نیاز. تغییرناپذیر. واحد بودجه مشخص می کند که آیا بودجه مبتنی بر ارز است یا بر اساس برداشت.

enum ( InsertionOrderAutomationType )

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

اگر این فیلد در هنگام ایجاد مشخص نشده باشد، مقدار پیش‌فرض INSERTION_ORDER_AUTOMATION_TYPE_NONE است.

object ( InsertionOrderBudgetSegment )

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

{
  "budgetAmountMicros": string,
  "description": string,
  "dateRange": {
    object (DateRange)
  },
  "campaignBudgetId": string
}

string ( int64 format)

مورد نیاز. مبلغ بودجه ای که سفارش درج برای dateRange معین صرف می کند. مقدار بر حسب میکرو می باشد. باید بزرگتر از 0 باشد. برای مثال، 500000000 نشان دهنده 500 واحد استاندارد واحد پول است.

string

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

باید دارای کد UTF-8 باشد.

object ( DateRange )

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

• هنگام ایجاد یک بخش بودجه جدید، هم startDate و هم endDate باید در آینده باشند.
• یک بخش بودجه موجود با startDate در گذشته دارای endDate قابل تغییر است اما startDate غیرقابل تغییر است.
• endDate باید startDate یا بالاتر باشد، هر دو قبل از سال 2037.

string ( int64 format)

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