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)

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

طابع زمني بتنسيق RFC3339 UTC "Zulu" ، بدقة نانو ثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: "2014-10-02T15:01:23Z" و"2014-10-02T15:01:23.045123456Z"
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 يتم تحديد هدف الأداء بتكلفة الإجراء (CPA).
PERFORMANCE_GOAL_TYPE_CTR يتم تحديد هدف الأداء بالنسبة المئوية إلى نسبة النقر إلى الظهور.
PERFORMANCE_GOAL_TYPE_VIEWABILITY يتم ضبط هدف الأداء على النسبة المئوية لإمكانية العرض.
PERFORMANCE_GOAL_TYPE_CPIAVC يتم تحديد هدف الأداء على أنّه CPIAVC (تكلفة مرة ظهور مسموعة ومرئية عند الانتهاء).
PERFORMANCE_GOAL_TYPE_CPE يتم تحديد هدف الأداء بتكلفة المشاركة (CPE).
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

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

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

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