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)
  },
  "performanceGoal": {
    object (PerformanceGoal)
  },
  "budget": {
    object (InsertionOrderBudget)
  },
  "bidStrategy": {
    object (BiddingStrategy)
  },
  "reservationType": enum (ReservationType),
  "billableOutcome": enum (BillableOutcome)
}
الحقول
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)

تفاصيل دمج إضافية لطلب الإدراج.
performanceGoal

object (PerformanceGoal)

مطلوبة. هدف الأداء لطلب الإدراج.
budget

object (InsertionOrderBudget)

مطلوبة. إعدادات تخصيص الميزانية لطلب الإدراج.
bidStrategy

object (BiddingStrategy)

استراتيجية عروض الأسعار لطلب الإدراج. بشكل تلقائي، يتم ضبط fixedBid.
reservationType

enum (ReservationType)

النتائج فقط. نوع الحجز لطلب الإدراج.
billableOutcome

enum (BillableOutcome)

غير قابل للتغيير. النتيجة القابلة للفوترة لطلب الإدراج.

تم إيقاف الشراء استنادًا إلى النتائج نهائيًا. وهذه القيمة هي BILLABLE_OUTCOME_PAY_PER_IMPRESSION الوحيدة الصالحة.

InsertionOrderType

الأنواع المحتملة من طلب الإدراج.

يحدّد نوع طلب الإدراج الإعدادات والخيارات السارية، مثل شكل الإعلانات أو خيارات الاستهداف.

عمليات التعداد
INSERTION_ORDER_TYPE_UNSPECIFIED نوع طلب الإدراج غير محدّد أو غير معروف.
RTB عرض الأسعار في الوقت الفعلي.
OVER_THE_TOP خدمة البث المباشر على الإنترنت

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

الخيارات المتاحة لبرمجة عرض السعر والميزانية في طلب الإدراج.

عمليات التعداد
INSERTION_ORDER_AUTOMATION_TYPE_UNSPECIFIED خيار التشغيل الآلي لطلب الإدراج غير محدَّد أو غير معروف في هذا الإصدار.
INSERTION_ORDER_AUTOMATION_TYPE_BUDGET التخصيص التلقائي للميزانية: السماح للنظام بتحويل الميزانية تلقائيًا إلى العناصر المالكة لتحسين الأداء المحدد في performanceGoal. لا حاجة إلى التشغيل الآلي لإعدادات عروض الأسعار.
INSERTION_ORDER_AUTOMATION_TYPE_NONE عدم التشغيل المبرمَج لعرض السعر أو الميزانية على مستوى طلب الإدراج. يجب ضبط عرض السعر والميزانية يدويًا على مستوى العنصر.
INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET السماح للنظام بتعديل عروض الأسعار تلقائيًا وتغيير الميزانية إلى العناصر المالكة لتحسين الأداء المحدّد في performanceGoal.

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 لميزانية الحملة التي تشكّل شريحة الميزانية لطلب الإدراج هذه جزءًا منها.

BillableOutcome

نتائج محتملة قابلة للفوترة لطلب إدراج

عمليات التعداد
BILLABLE_OUTCOME_UNSPECIFIED نتيجة غير محدّدة قابلة للفوترة
BILLABLE_OUTCOME_PAY_PER_IMPRESSION الدفع مقابل مرات الظهور
BILLABLE_OUTCOME_PAY_PER_CLICK

الدفع بالنقرة.
BILLABLE_OUTCOME_PAY_PER_VIEWABLE_IMPRESSION

الدفع مقابل كل مشاهدة نشطة

الطُرق

bulkListInsertionOrderAssignedTargetingOptions

 يسرد خيارات الاستهداف المعيّنة لطلب إدراج على مستوى أنواع الاستهداف.

create

 إنشاء طلب إدراج جديد.

delete

 حذف طلب إدراج

get

 الحصول على طلب إدراج

list

 يسرد طلبات الإدراج في أحد المعلِنين.

patch

 لتعديل طلب إدراج حالي