REST Resource: advertisers.campaigns

{
  "name": string,
  "advertiserId": string,
  "campaignId": string,
  "displayName": string,
  "entityStatus": enum (EntityStatus),
  "updateTime": string,
  "campaignGoal": {
    object (CampaignGoal)
  },
  "campaignFlight": {
    object (CampaignFlight)
  },
  "frequencyCap": {
    object (FrequencyCap)
  },
  "campaignBudgets": [
    {
      object (CampaignBudget)
    }
  ]
}

string

النتائج فقط. اسم مورد الحملة.

string (int64 format)

النتائج فقط. المعرّف الفريد للمعلِن الذي تنتمي إليه الحملة

string (int64 format)

النتائج فقط. المعرّف الفريد للحملة. يحدده النظام.

string

مطلوب. الاسم المعروض للحملة.

يجب أن يكون بترميز UTF-8 بحيث لا يزيد حجمه عن 240 بايت.

enum (EntityStatus)

مطلوب. تتحكّم هذه السياسة في ما إذا كان يمكن لطلبات الإدراج ضمن هذه الحملة إنفاق ميزانياتها وتقديم عروض أسعار على المستودع الإعلاني.

• القيم المقبولة هي ENTITY_STATUS_ACTIVE وENTITY_STATUS_ARCHIVED وENTITY_STATUS_PAUSED.
• بالنسبة إلى طريقة campaigns.create، لا يُسمح باستخدام السمة ENTITY_STATUS_ARCHIVED.

string (Timestamp format)

النتائج فقط. الطابع الزمني لآخر تعديل للحملة يحدده النظام.

طابع زمني بتنسيق RFC3339 حسب التوقيت العالمي المنسَّق (UTC) "زولو" بدقة نانوثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: "2014-10-02T15:01:23Z" و"2014-10-02T15:01:23.045123456Z".

object (CampaignGoal)

مطلوب. هدف الحملة.

object (CampaignFlight)

مطلوب. الإنفاق المخطط للحملة ومدتها

object (FrequencyCap)

مطلوب. إعداد تحديد عدد مرات الظهور للحملة

object (CampaignBudget)

قائمة الميزانيات المتاحة لهذه الحملة.

في حال عدم ضبط هذا الحقل، تستخدم الحملة ميزانية غير محدودة.

{
  "campaignGoalType": enum (CampaignGoalType),
  "performanceGoal": {
    object (PerformanceGoal)
  }
}

enum (CampaignGoalType)

مطلوب. نوع هدف الحملة

object (PerformanceGoal)

مطلوب. هدف أداء الحملة

القيم المقبولة لـ performanceGoalType هي:

• PERFORMANCE_GOAL_TYPE_CPM
• PERFORMANCE_GOAL_TYPE_CPC
• PERFORMANCE_GOAL_TYPE_CPA
• PERFORMANCE_GOAL_TYPE_CPIAVC
• PERFORMANCE_GOAL_TYPE_CTR
• PERFORMANCE_GOAL_TYPE_VIEWABILITY
• PERFORMANCE_GOAL_TYPE_OTHER

{
  "performanceGoalType": enum (PerformanceGoalType),

  // Union field performance_goal_value can be only one of the following:
  "performanceGoalAmountMicros": string,
  "performanceGoalPercentageMicros": string,
  "performanceGoalString": string
  // End of list of possible types for union field performance_goal_value.
}

enum (PerformanceGoalType)

مطلوب. نوع هدف الأداء

string (int64 format)

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

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

• PERFORMANCE_GOAL_TYPE_CPM
• PERFORMANCE_GOAL_TYPE_CPC
• PERFORMANCE_GOAL_TYPE_CPA
• PERFORMANCE_GOAL_TYPE_CPIAVC
• PERFORMANCE_GOAL_TYPE_VCPM

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

string (int64 format)

التمثيل العشري للنسبة المئوية للهدف بوحدات المايكرو

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

• PERFORMANCE_GOAL_TYPE_CTR
• PERFORMANCE_GOAL_TYPE_VIEWABILITY
• PERFORMANCE_GOAL_TYPE_CLICK_CVR
• PERFORMANCE_GOAL_TYPE_IMPRESSION_CVR
• PERFORMANCE_GOAL_TYPE_VTR
• PERFORMANCE_GOAL_TYPE_AUDIO_COMPLETION_RATE
• PERFORMANCE_GOAL_TYPE_VIDEO_COMPLETION_RATE

على سبيل المثال، يمثّل الرقم 70000 نسبة 7% (الرقم العشري 0.07).

string

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

يسري هذا العرض عند ضبط performanceGoalType على PERFORMANCE_GOAL_TYPE_OTHER.

{
  "plannedSpendAmountMicros": string,
  "plannedDates": {
    object (DateRange)
  }
}

string (int64 format)

المبلغ الذي من المتوقّع أن تنفقه الحملة مقابل plannedDates. لن يؤدي ذلك إلى الحدّ من عرض الإعلانات، ولكن سيتم استخدامه لتتبُّع الإنفاق في واجهة مستخدم "مساحة العرض والفيديو 360".

يكون المبلغ بالمايكرو. يجب أن تكون القيمة أكبر من 0 أو مساوية له. على سبيل المثال، يمثل 500000000 500 وحدة قياسية من العملة.

object (DateRange)

مطلوب. التواريخ التي من المتوقّع أن تبدأ تشغيل الحملة فيها. ويتم حلها وفقًا للمنطقة الزمنية للمعلِن الرئيسي.

• لن تؤثر التواريخ المحدّدة هنا في عرض الإعلانات. وتُستخدم لإنشاء التنبيهات والتحذيرات. على سبيل المثال، إذا كان تاريخ عرض أي طلب إدراج ثانوي خارج نطاق هذه التواريخ، ستعرض واجهة المستخدم تحذيرًا.
• startDate مطلوب ويجب أن يكون التاريخ الحالي أو تاريخ لاحق.
• وتكون السمة endDate اختيارية. وإذا تم تحديدها، يجب أن تكون السمة startDate أو تاريخ لاحق.
• يجب أن يكون أي تاريخ محدد قبل العام 2037.

{
  "budgetId": string,
  "displayName": string,
  "budgetUnit": enum (BudgetUnit),
  "budgetAmountMicros": string,
  "dateRange": {
    object (DateRange)
  },
  "externalBudgetSource": enum (ExternalBudgetSource),
  "externalBudgetId": string,
  "invoiceGroupingId": string,
  "prismaConfig": {
    object (PrismaConfig)
  }
}

string (int64 format)

المعرّف الفريد لميزانية الحملة يحدده النظام. لا تضبطها للميزانيات الجديدة.

يجب تضمينها عند تعديل الميزانيات أو إضافتها إلى campaignBudgets. وبخلاف ذلك، سيتم إنشاء معرّف جديد وتعيينه.

string

مطلوب. الاسم المعروض للميزانية.

يجب أن يكون بترميز UTF-8 بحيث لا يزيد حجمه عن 240 بايت.

enum (BudgetUnit)

مطلوب. غير قابل للتغيير. تحدِّد ما إذا كانت الميزانية تُقاس بالعملة أو بمرّات الظهور.

string (int64 format)

مطلوب. المبلغ الإجمالي الذي يمكن أن تضعه شرائح طلب الإدراج المرتبطة في الميزانية.

يكون المبلغ بالمايكرو. يجب أن تكون القيمة أكبر من 0. على سبيل المثال، يمثل 500000000 500 وحدة قياسية من العملة.

object (DateRange)

مطلوب. النطاق الزمني لميزانية الحملة قد يكون لشرائح الميزانية المرتبطة نطاق زمني مختلف. ويتم حلها وفقًا للمنطقة الزمنية للمعلِن الرئيسي.

يجب أن يكون كل من startDate وendDate قبل العام 2037.

enum (ExternalBudgetSource)

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

string

غير قابل للتغيير. رقم التعريف الذي يحدد هذه الميزانية للمصدر الخارجي.

في حال ضبط هذا الحقل وضبط مستوى تفاصيل الفاتورة في الملف التعريفي للفوترة المناسب على "طلب الشراء على مستوى الميزانية"، ستتضمّن جميع مرات الظهور المعروضة في حدود هذه الميزانية هذا المعرّف في الفاتورة.

يجب أن يكون فريدًا ضمن الحملة.

string

غير قابل للتغيير. المعرّف المستخدم لتجميع الميزانيات من أجل تضمين الفاتورة نفسها.

إذا تم ضبط هذا الحقل وضبط مستوى الفاتورة للملف الشخصي المقابل للفوترة على "معرّف تجميع فواتير الميزانية"، سيتم تجميع كل externalBudgetId التي تتشارك invoiceGroupingId نفسه في الفاتورة نفسها.

object (PrismaConfig)

البيانات الوصفية الإضافية التي تستخدمها أداة Mediaocean Prisma

مطلوب لميزانيات Mediaocean.

لا ينطبق هذا العرض إلا على prismaEnabled معلِنين.

{
  "prismaType": enum (PrismaType),
  "prismaCpeCode": {
    object (PrismaCpeCode)
  },
  "supplier": string
}

enum (PrismaType)

مطلوب. نوع Prisma.

object (PrismaCpeCode)

مطلوب. رموز العملاء والمنتج والتقدير ذات الصلة من أداة Mediaocean Prisma.

string

مطلوب. خصص الكيان هذه الميزانية (DSP، أو موقع إلكتروني، أو غير ذلك).

{
  "prismaClientCode": string,
  "prismaProductCode": string,
  "prismaEstimateCode": string
}

string

رمز عميل Prisma

string

رمز منتج Prisma.

string

رمز تقدير Prisma.