REST Resource: advertisers.insertionOrders

منبع: InsertionOrder

یک دستور درج واحد.

نمایندگی JSON
{
  "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)
  },
  "kpi": {
    object (Kpi)
  },
  "budget": {
    object (InsertionOrderBudget)
  },
  "bidStrategy": {
    object (BiddingStrategy)
  },
  "reservationType": enum (ReservationType)
}
زمینه های
name

string

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

advertiserId

string ( int64 format)

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

campaignId

string ( int64 format)

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

insertionOrderId

string ( int64 format)

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

displayName

string

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

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

insertionOrderType

enum ( InsertionOrderType )

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

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

entityStatus

enum ( EntityStatus )

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

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

string ( Timestamp format)

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

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

partnerCosts[]

object ( PartnerCost )

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

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

pacing

object ( Pacing )

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

frequencyCap

object ( FrequencyCap )

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

integrationDetails

object ( IntegrationDetails )

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

kpi

object ( Kpi )

ضروری. شاخص عملکرد کلیدی (KPI) ترتیب درج.

این به عنوان "هدف" در رابط Display & Video 360 نشان داده می شود.

budget

object ( InsertionOrderBudget )

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

bidStrategy

object ( BiddingStrategy )

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

reservationType

enum ( ReservationType )

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

InsertionOrderType

انواع احتمالی سفارش درج

نوع دستور درج تعیین می‌کند که کدام تنظیمات و گزینه‌ها، مانند قالب تبلیغات یا گزینه‌های هدف، قابل اجرا هستند.

Enums
INSERTION_ORDER_TYPE_UNSPECIFIED نوع سفارش درج مشخص نشده است یا ناشناخته است.
RTB مناقصه در زمان واقعی
OVER_THE_TOP بیش از حد.

Kpi

تنظیماتی که شاخص عملکرد کلیدی یا KPI یک دستور درج را کنترل می‌کنند.

نمایندگی JSON
{
  "kpiType": enum (KpiType),
  "kpiAlgorithmId": string,

  // Union field kpi_value can be only one of the following:
  "kpiAmountMicros": string,
  "kpiPercentageMicros": string,
  "kpiString": string
  // End of list of possible types for union field kpi_value.
}
زمینه های
kpiType

enum ( KpiType )

ضروری. نوع KPI.

kpiAlgorithmId

string ( int64 format)

اختیاری. شناسه الگوریتم مناقصه سفارشی مرتبط با KPI_CUSTOM_IMPRESSION_VALUE_OVER_COST. اگر KPI مناسب انتخاب نشده باشد، این فیلد نادیده گرفته می شود.

فیلد اتحادیه kpi_value . ضروری. ارزش KPI. فیلد مربوطه با kpi_type مطابقت دارد. kpi_value می تواند تنها یکی از موارد زیر باشد:
kpiAmountMicros

string ( int64 format)

مقدار هدف، بر حسب میکرو واحد پول تبلیغ‌کننده.

زمانی قابل استفاده است که kpiType یکی از موارد زیر باشد:

  • KPI_TYPE_CPM
  • KPI_TYPE_CPC
  • KPI_TYPE_CPA
  • KPI_TYPE_CPIAVC
  • KPI_TYPE_VCPM

به عنوان مثال: 1500000 نشان دهنده 1.5 واحد استاندارد واحد پول است.

kpiPercentageMicros

string ( int64 format)

نمایش اعشاری درصد هدف در میکرو.

زمانی قابل استفاده است که kpiType یکی از موارد زیر باشد:

  • KPI_TYPE_CTR
  • KPI_TYPE_VIEWABILITY
  • KPI_TYPE_CLICK_CVR
  • KPI_TYPE_IMPRESSION_CVR
  • KPI_TYPE_VTR
  • KPI_TYPE_AUDIO_COMPLETION_RATE
  • KPI_TYPE_VIDEO_COMPLETION_RATE

به عنوان مثال: 70000 نشان دهنده 7٪ است (اعشار 0.07).

kpiString

string

یک رشته KPI که می تواند خالی باشد. باید UTF-8 با طول بیش از 100 کاراکتر رمزگذاری شده باشد.

زمانی که kpiType KPI_TYPE_OTHER باشد قابل اجرا است.

KpiType

انواع شاخص عملکرد کلیدی ممکن (KPI).

Enums
KPI_TYPE_UNSPECIFIED نوع KPI در این نسخه مشخص نشده یا ناشناخته است.
KPI_TYPE_CPM KPI CPM (هزینه در هر میلیون) است.
KPI_TYPE_CPC KPI CPC (هزینه هر کلیک) است.
KPI_TYPE_CPA KPI CPA (هزینه هر عمل) است.
KPI_TYPE_CTR KPI درصد CTR (نرخ کلیک) است.
KPI_TYPE_VIEWABILITY KPI درصد قابلیت مشاهده است.
KPI_TYPE_CPIAVC KPI CPIAVC است (هزینه هر نمایش قابل شنیدن و قابل مشاهده در تکمیل).
KPI_TYPE_CPE KPI CPE (هزینه هر تعامل) است.
KPI_TYPE_CPV KPI بر حسب CPV (هزینه هر نمایش) تنظیم می شود.
KPI_TYPE_CLICK_CVR KPI نرخ تبدیل کلیک (تبدیل در هر کلیک) درصد است.
KPI_TYPE_IMPRESSION_CVR KPI درصد نرخ تبدیل (تبدیل در هر نمایش) است.
KPI_TYPE_VCPM KPI VCPM (هزینه به ازای هر هزار نمایش قابل مشاهده) است.
KPI_TYPE_VTR KPI نرخ بازدید YouTube (بازدیدهای یوتیوب در هر نمایش) درصد است.
KPI_TYPE_AUDIO_COMPLETION_RATE KPI درصد تکمیل صدا (شنوایی کامل صدا در هر نمایش) است.
KPI_TYPE_VIDEO_COMPLETION_RATE KPI درصد تکمیل ویدیو (بازدید کامل ویدیو در هر نمایش) است.
KPI_TYPE_CPCL KPI در CPCL (هزینه هر گوش دادن کامل صوتی) تنظیم شده است.
KPI_TYPE_CPCV KPI بر حسب CPCV (هزینه هر نمایش کامل ویدیو) تنظیم شده است.
KPI_TYPE_TOS10 KPI بر حسب نرخ زمان روی صفحه نمایش 10+ ثانیه تنظیم می‌شود (درصد نمایش‌های قابل اندازه‌گیری و غیرقابل رد شدن که حداقل 10 ثانیه روی صفحه بوده است).
KPI_TYPE_MAXIMIZE_PACING KPI قرار است تأثیر نام تجاری را به حداکثر برساند و در عین حال هزینه کامل بودجه را در اولویت قرار دهد.
KPI_TYPE_CUSTOM_IMPRESSION_VALUE_OVER_COST KPI بر اساس ارزش نمایش سفارشی تقسیم بر هزینه تنظیم می شود.
KPI_TYPE_OTHER KPI مقدار دیگری است.

InsertionOrderBudget

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

نمایندگی JSON
{
  "budgetUnit": enum (BudgetUnit),
  "automationType": enum (InsertionOrderAutomationType),
  "budgetSegments": [
    {
      object (InsertionOrderBudgetSegment)
    }
  ]
}
زمینه های
budgetUnit

enum ( BudgetUnit )

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

automationType

enum ( InsertionOrderAutomationType )

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

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

budgetSegments[]

object ( InsertionOrderBudgetSegment )

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

InsertionOrderAutomationType

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

Enums
INSERTION_ORDER_AUTOMATION_TYPE_UNSPECIFIED گزینه Insertion order automation مشخص نشده یا در این نسخه ناشناخته است.
INSERTION_ORDER_AUTOMATION_TYPE_BUDGET تخصیص خودکار بودجه به سیستم اجازه دهید به طور خودکار بودجه را به مالکیت موارد خط تغییر دهد تا عملکرد تعریف شده توسط kpi را بهینه کند. بدون اتوماسیون در تنظیمات پیشنهاد.
INSERTION_ORDER_AUTOMATION_TYPE_NONE بدون اتوماسیون پیشنهاد یا بودجه در سطح سفارش درج. پیشنهاد و بودجه باید به صورت دستی در سطح آیتم خط پیکربندی شوند.
INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET به سیستم اجازه دهید به طور خودکار پیشنهادها را تنظیم کند و بودجه را به مالکیت اقلام خط تغییر دهد تا عملکرد تعریف شده توسط kpi را بهینه کند.

InsertionOrderBudgetSegment

تنظیماتی که بودجه یک بخش بودجه را کنترل می کند.

نمایندگی JSON
{
  "budgetAmountMicros": string,
  "description": string,
  "dateRange": {
    object (DateRange)
  },
  "campaignBudgetId": string
}
زمینه های
budgetAmountMicros

string ( int64 format)

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

description

string

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

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

dateRange

object ( DateRange )

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

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

string ( int64 format)

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

مواد و روش ها

create

 یک ترتیب درج جدید ایجاد می کند.

delete

 یک سفارش درج را حذف می کند.

get

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

list

 سفارش‌های درج را در یک تبلیغ‌کننده فهرست می‌کند.

listAssignedTargetingOptions

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

patch

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