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) "زولو" بدقة نانوثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: "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

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

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

PerformanceGoalType

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

عمليات التعداد
PERFORMANCE_GOAL_TYPE_UNSPECIFIED نوع هدف الأداء غير محدّد أو غير معروف في هذا الإصدار.
PERFORMANCE_GOAL_TYPE_CPM يتم ضبط هدف الأداء بنظام التكلفة لكل ألف ظهور (CPM).
PERFORMANCE_GOAL_TYPE_CPC يتم تحديد هدف الأداء بنظام تكلفة النقرة (CPC).
PERFORMANCE_GOAL_TYPE_CPA يتم تحديد هدف الأداء في تكلفة الإجراء (CPA).
PERFORMANCE_GOAL_TYPE_CTR يتم ضبط هدف الأداء كنسبة النقر إلى الظهور (CTR).
PERFORMANCE_GOAL_TYPE_VIEWABILITY يتم ضبط هدف الأداء في النسبة المئوية لإمكانية العرض.
PERFORMANCE_GOAL_TYPE_CPIAVC يتم تحديد هدف الأداء على أنّه تكلفة الظهور المسموعة والمرئية عند الانتهاء.
PERFORMANCE_GOAL_TYPE_CPE يتم تحديد هدف الأداء بنظام تكلفة المشاركة (CPE).
PERFORMANCE_GOAL_TYPE_CLICK_CVR يتم ضبط هدف الأداء على النسبة المئوية لمعدّل الإحالات الناجحة الناتجة عن النقر (الإحالات الناجحة لكل نقرة).
PERFORMANCE_GOAL_TYPE_IMPRESSION_CVR يتم تحديد هدف الأداء على أساس النسبة المئوية لمعدّل الإحالات الناجحة لمرات الظهور (الإحالات الناجحة لكل ظهور).
PERFORMANCE_GOAL_TYPE_VCPM يتم تحديد هدف الأداء بنظام التكلفة لكل ألف ظهور قابل للعرض (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

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