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 حث المستخدمين على اتخاذ إجراء أو زيارات على الإنترنت.

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

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