REST Resource: advertisers.campaigns

المورد: الحملة

حملة واحدة.

تمثيل JSON 
{
  "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)
    }
  ]
}
الحقول
name

string

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

string (int64 format)

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

string (int64 format)

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

string

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

يجب أن يكون بترميز UTF-8 بحد أقصى 240 بايت.
entityStatus

enum (EntityStatus)

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

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

string (Timestamp format)

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

يستخدم معيار RFC 3339، حيث يكون الناتج الذي يتم إنشاؤه دائمًا مُعدَّلاً وفقًا لقاعدة Z ويستخدم 0 أو 3 أو 6 أو 9 أرقام عشرية. يتم أيضًا قبول العناصر غير "Z". أمثلة: "2014-10-02T15:01:23Z" أو "2014-10-02T15:01:23.045123456Z" أو "2014-10-02T15:01:23+05:30"
campaignGoal

object (CampaignGoal)

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

object (CampaignFlight)

مطلوب. الإنفاق المخطّط ومدة الحملة.
frequencyCap

object (FrequencyCap)

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

object (CampaignBudget)

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

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

CampaignGoal

الإعدادات التي تتحكّم في هدف الحملة

تمثيل JSON 
{
  "campaignGoalType": enum (CampaignGoalType),
  "performanceGoal": {
    object (PerformanceGoal)
  }
}
الحقول
campaignGoalType

enum (CampaignGoalType)

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

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

CampaignGoalType

الأنواع المحتمَلة لأهداف الحملة

عمليات التعداد
CAMPAIGN_GOAL_TYPE_UNSPECIFIED قيمة الهدف غير محدّدة أو غير معروفة في هذا الإصدار.
CAMPAIGN_GOAL_TYPE_APP_INSTALL زيادة عمليات تثبيت التطبيق أو التفاعلات مع التطبيق
CAMPAIGN_GOAL_TYPE_BRAND_AWARENESS زيادة الوعي بعلامة تجارية أو منتج
CAMPAIGN_GOAL_TYPE_OFFLINE_ACTION زيادة المبيعات التي تتم بلا إنترنت أو في المتجر
CAMPAIGN_GOAL_TYPE_ONLINE_ACTION زيادة الزيارات أو الإجراءات على الإنترنت

PerformanceGoal

الإعدادات التي تتحكّم في هدف الأداء لحملة معيّنة

تمثيل JSON 
{
  "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.
}
الحقول
performanceGoalType

enum (PerformanceGoalType)

مطلوب. نوع هدف الأداء
حقل الربط performance_goal_value مطلوب. قيمة هدف الأداء المقابلة لقيمة performance_goal_type معيّنة. يمكن أن يكون performance_goal_value واحدًا مما يلي فقط:
performanceGoalAmountMicros

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 وحدة عادية من العملة.
performanceGoalPercentageMicros

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

string

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

تنطبق هذه السمة عند ضبط performanceGoalType على PERFORMANCE_GOAL_TYPE_OTHER.

PerformanceGoalType

الأنواع المحتمَلة لأهداف الأداء

عمليات التعداد
PERFORMANCE_GOAL_TYPE_UNSPECIFIED لم يتم تحديد نوع هدف الأداء أو هو غير معروف في هذا الإصدار.
PERFORMANCE_GOAL_TYPE_CPM يتمّ ضبط هدف الأداء بالتكلفة لكلّ ألف ظهور.
PERFORMANCE_GOAL_TYPE_CPC يتمّ ضبط هدف الأداء بوحدة تكلفة النقرة.
PERFORMANCE_GOAL_TYPE_CPA يتمّ ضبط هدف الأداء في تكلفة الإجراء.
PERFORMANCE_GOAL_TYPE_CTR يتمّ ضبط هدف الأداء كنسبة مئوية ونسبة النقر إلى الظهور.
PERFORMANCE_GOAL_TYPE_VIEWABILITY يتمّ ضبط هدف الأداء كنسبة مئوية لإمكانية المشاهدة.
PERFORMANCE_GOAL_TYPE_CPIAVC يتمّ ضبط هدف الأداء على "تكلفة مرّة الظهور للمحتوى المسموع والمعروض عند الاكتمال".
PERFORMANCE_GOAL_TYPE_CPE يتمّ ضبط هدف الأداء في تكلفة المشاركة (CPE).
PERFORMANCE_GOAL_TYPE_CPV يتمّ ضبط هدف الأداء بوحدة تكلفة المشاهدة.
PERFORMANCE_GOAL_TYPE_CLICK_CVR يتمّ ضبط هدف الأداء كنسبة مئوية لمعدّل الإحالات الناجحة الناتجة عن النقر (الإحالات الناجحة لكلّ نقرة).
PERFORMANCE_GOAL_TYPE_IMPRESSION_CVR يتمّ ضبط هدف الأداء في معدّل الإحالات الناجحة لكلّ مرّة ظهور (الإحالات الناجحة لكلّ مرّة ظهور) كنسبة مئوية.
PERFORMANCE_GOAL_TYPE_VCPM يتمّ ضبط هدف الأداء في التكلفة لكلّ ألف ظهور قابل للعرض.
PERFORMANCE_GOAL_TYPE_VTR يتمّ ضبط هدف الأداء في النسبة المئوية لعدد المشاهدات على YouTube (عدد المشاهدات على YouTube لكلّ مرّة ظهور).
PERFORMANCE_GOAL_TYPE_AUDIO_COMPLETION_RATE يتمّ ضبط هدف الأداء في معدّل إكمال الملف الصوتي (مرّات الاستماع إلى الملف الصوتي الكامل لكلّ مرّة ظهور) كنسبة مئوية.
PERFORMANCE_GOAL_TYPE_VIDEO_COMPLETION_RATE يتمّ ضبط هدف الأداء في نسبة مشاهدة الفيديو بالكامل (مرّات مشاهدة الفيديو بالكامل لكلّ مرّة ظهور).
PERFORMANCE_GOAL_TYPE_OTHER تم ضبط هدف الأداء على "غير ذلك".

CampaignFlight

الإعدادات التي تتتبّع الإنفاق المخطّط ومدة الحملة

تمثيل JSON 
{
  "plannedSpendAmountMicros": string,
  "plannedDates": {
    object (DateRange)
  }
}
الحقول
plannedSpendAmountMicros

string (int64 format)

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

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

object (DateRange)

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

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

CampaignBudget

الإعدادات التي تتحكّم في كيفية تخصيص ميزانية الحملة

تمثيل JSON 
{
  "budgetId": string,
  "displayName": string,
  "budgetUnit": enum (BudgetUnit),
  "budgetAmountMicros": string,
  "dateRange": {
    object (DateRange)
  },
  "externalBudgetSource": enum (ExternalBudgetSource),
  "externalBudgetId": string,
  "invoiceGroupingId": string,
  "prismaConfig": {
    object (PrismaConfig)
  }
}
الحقول
budgetId

string (int64 format)

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

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

string

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

يجب أن يكون بترميز UTF-8 بحد أقصى 240 بايت.
budgetUnit

enum (BudgetUnit)

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

string (int64 format)

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

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

object (DateRange)

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

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

enum (ExternalBudgetSource)

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

string

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

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

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

string

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

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

object (PrismaConfig)

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

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

لا ينطبق إلا على المعلِنين في prismaEnabled.

ExternalBudgetSource

مصدر خارجي لشريحة ميزانية الحملة

عمليات التعداد
EXTERNAL_BUDGET_SOURCE_UNSPECIFIED لم يتم تحديد قيمة مصدر الميزانية الخارجية أو هي غير معروفة في هذا الإصدار.
EXTERNAL_BUDGET_SOURCE_NONE لا تتضمّن الميزانية مصدرًا خارجيًا.
EXTERNAL_BUDGET_SOURCE_MEDIA_OCEAN مصدر الميزانية هو Mediaocean.

PrismaConfig

الإعدادات الخاصة بأداة Mediaocean Prisma

تمثيل JSON 
{
  "prismaType": enum (PrismaType),
  "prismaCpeCode": {
    object (PrismaCpeCode)
  },
  "supplier": string
}
الحقول
prismaType

enum (PrismaType)

مطلوب. نوع Prisma
prismaCpeCode

object (PrismaCpeCode)

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

string

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

PrismaType

الأنواع المحتملة لميزانية Prisma

عمليات التعداد
PRISMA_TYPE_UNSPECIFIED النوع غير محدّد أو غير معروف في هذا الإصدار.
PRISMA_TYPE_DISPLAY نوع العرض
PRISMA_TYPE_VIDEO نوع الفيديو
PRISMA_TYPE_AUDIO نوع الصوت
PRISMA_TYPE_SOCIAL النوع الاجتماعي
PRISMA_TYPE_FEE نوع الرسوم

PrismaCpeCode

يتيح Google Payments Center البحث والفلترة في حقول المكوّنات لهذا الرمز.

تمثيل JSON 
{
  "prismaClientCode": string,
  "prismaProductCode": string,
  "prismaEstimateCode": string
}
الحقول
prismaClientCode

string

رمز عميل Prisma
prismaProductCode

string

رمز منتج Prisma
prismaEstimateCode

string

رمز تقدير Prisma

الطُرق

create

 لإنشاء حملة جديدة

delete

 يؤدي هذا الإجراء إلى حذف حملة نهائيًا.

get

 الحصول على حملة

list

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

listAssignedTargetingOptions

 تُدرِج هذه السمة خيارات الاستهداف المحدّدة لحملة معيّنة على مستوى أنواع الاستهداف.

patch

 تعديل حملة حالية