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-normalized ويستخدم 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 يتم تحديد هدف الأداء في "تكلفة المشاركة".
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" البحث عن الحقول المكوّنة لهذا الرمز وفلترتها.

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

string

رمز عميل Prisma
prismaProductCode

string

رمز منتج Prisma
prismaEstimateCode

string

تمثّل هذه السمة رمز تقدير Prisma.

الطُرق

create

 تُنشئ هذه الطريقة حملة جديدة.

delete

 لحذف حملة نهائيًا

get

 تعرض هذه الطريقة إحدى الحملات.

list

 تعرض هذه الطريقة قائمة بالحملات في حساب أحد المعلِنين.

listAssignedTargetingOptions

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

patch

 تعدّل هذه الطريقة حملة حالية.