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)
  },
  "kpi": {
    object (Kpi)
  },
  "budget": {
    object (InsertionOrderBudget)
  },
  "bidStrategy": {
    object (BiddingStrategy)
  },
  "reservationType": enum (ReservationType),
  "optimizationObjective": enum (OptimizationObjective)
}

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 (Kpi)

مطلوبة. مؤشر الأداء الرئيسي (KPI) لطلب الإدراج.

ويُشار إلى ذلك باسم "الهدف" في واجهة "مساحة العرض والفيديو 360".

object (InsertionOrderBudget)

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

object (BiddingStrategy)

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

enum (ReservationType)

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

enum (OptimizationObjective)

اختياريّ. هدف التحسين لطلب الإدراج

لا يتوفّر هذا الحقل إلا للعملاء المدرَجين في القائمة المسموح بها. إذا لم يكن عميل مُدرَجًا في القائمة المسموح بها، سيكون هذا الحقل خاليًا، وستؤدي محاولة ضبطه إلى ظهور خطأ.

{
  "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.
}

enum (KpiType)

مطلوبة. نوع مؤشر الأداء الرئيسي.

string (int64 format)

اختياريّ. رقم تعريف خوارزمية عروض الأسعار المخصّصة المرتبط بـ KPI_CUSTOM_IMPRESSION_VALUE_OVER_COST. ويتم تجاهل هذا الحقل في حال عدم اختيار مؤشر الأداء الرئيسي المناسب.

string (int64 format)

مبلغ الهدف بالميكرو بعملة المعلِن.

سارٍ عندما تكون السمة kpiType واحدة مما يلي:

• KPI_TYPE_CPM
• KPI_TYPE_CPC
• KPI_TYPE_CPA
• KPI_TYPE_CPIAVC
• KPI_TYPE_VCPM

على سبيل المثال: 1500000 يمثل 1.5 وحدة قياسية للعملة.

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).

string

سلسلة مؤشر الأداء الرئيسي، والتي يمكن أن تكون فارغة. يجب أن يكون بترميز UTF-8 بطول لا يزيد عن 100 حرف.

يسري هذا العرض عندما تكون قيمة الحقل "kpiType" هي KPI_TYPE_OTHER.

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