تنبيه: يتم عرض مستندات واجهة REST API. تستخدم معظم مكتبات العملاء الرسمية خدمة gRPC. يمكنك الاطلاع على مقدمة عن REST للحصول على التفاصيل.

تمت ترجمة هذه الصفحة بواسطة Cloud Translation API‏.

AdGroup

تمثيل JSON
AdGroupStatus
AdGroupAdRotationMode
AudienceSetting
- تمثيل JSON
AdGroupPrimaryStatus
AdGroupPrimaryStatusReason

مجموعة إعلانية.

تمثيل JSON

تمثيل JSON
{ "resourceName": string, "status": enum (`AdGroupStatus`), "type": enum (`AdGroupType`), "adRotationMode": enum (`AdGroupAdRotationMode`), "urlCustomParameters": [ { object (`CustomParameter`) } ], "optimizedTargetingEnabled": boolean, "displayCustomBidDimension": enum (`TargetingDimension`), "targetingSetting": { object (`TargetingSetting`) }, "audienceSetting": { object (`AudienceSetting`) }, "effectiveTargetCpaSource": enum (`BiddingSource`), "effectiveTargetRoasSource": enum (`BiddingSource`), "labels": [ string ], "excludedParentAssetFieldTypes": [ enum (`AssetFieldType`) ], "excludedParentAssetSetTypes": [ enum (`AssetSetType`) ], "primaryStatus": enum (`AdGroupPrimaryStatus`), "primaryStatusReasons": [ enum (`AdGroupPrimaryStatusReason`) ], "id": string, "name": string, "baseAdGroup": string, "trackingUrlTemplate": string, "campaign": string, "cpcBidMicros": string, "effectiveCpcBidMicros": string, "cpmBidMicros": string, "targetCpaMicros": string, "cpvBidMicros": string, "targetCpmMicros": string, "targetRoas": number, "percentCpcBidMicros": string, "finalUrlSuffix": string, "effectiveTargetCpaMicros": string, "effectiveTargetRoas": number }

{
  "resourceName": string,
  "status": enum (AdGroupStatus),
  "type": enum (AdGroupType),
  "adRotationMode": enum (AdGroupAdRotationMode),
  "urlCustomParameters": [
    {
      object (CustomParameter)
    }
  ],
  "optimizedTargetingEnabled": boolean,
  "displayCustomBidDimension": enum (TargetingDimension),
  "targetingSetting": {
    object (TargetingSetting)
  },
  "audienceSetting": {
    object (AudienceSetting)
  },
  "effectiveTargetCpaSource": enum (BiddingSource),
  "effectiveTargetRoasSource": enum (BiddingSource),
  "labels": [
    string
  ],
  "excludedParentAssetFieldTypes": [
    enum (AssetFieldType)
  ],
  "excludedParentAssetSetTypes": [
    enum (AssetSetType)
  ],
  "primaryStatus": enum (AdGroupPrimaryStatus),
  "primaryStatusReasons": [
    enum (AdGroupPrimaryStatusReason)
  ],
  "id": string,
  "name": string,
  "baseAdGroup": string,
  "trackingUrlTemplate": string,
  "campaign": string,
  "cpcBidMicros": string,
  "effectiveCpcBidMicros": string,
  "cpmBidMicros": string,
  "targetCpaMicros": string,
  "cpvBidMicros": string,
  "targetCpmMicros": string,
  "targetRoas": number,
  "percentCpcBidMicros": string,
  "finalUrlSuffix": string,
  "effectiveTargetCpaMicros": string,
  "effectiveTargetRoas": number
}

الحقول
`resourceName`	`string` غير قابل للتغيير. اسم مورد المجموعة الإعلانية. وتكون أسماء موارد المجموعة الإعلانية على النحو التالي: `customers/{customerId}/adGroups/{adGroupId}`
`status`	`enum (AdGroupStatus)` حالة المجموعة الإعلانية.
`type`	`enum (AdGroupType)` غير قابل للتغيير. نوع المجموعة الإعلانية.
`adRotationMode`	`enum (AdGroupAdRotationMode)` وضع عرض الإعلانات بالتناوب للمجموعة الإعلانية.
`urlCustomParameters[]`	`object (CustomParameter)` قائمة عمليات الربط المستخدَمة لاستبدال علامات المَعلمات المخصَّصة في `trackingUrlTemplate` أو `finalUrls` أو `mobile_final_urls`.
`optimizedTargetingEnabled`	`boolean` صحيح في حال تفعيل الاستهداف المحسّن. "الاستهداف المحسّن" هو بديل لميزة "توسيع نطاق الجمهور".
`displayCustomBidDimension`	`enum (TargetingDimension)` تسمح للمعلنين بتحديد سمة استهداف يمكن وضع عروض أسعار مطلقة عليها. وينطبق هذا فقط على الحملات التي تستهدف الشبكة الإعلانية فقط وليس شبكة البحث.
`targetingSetting`	`object (TargetingSetting)` إعداد لاستهداف الميزات ذات الصلة.
`audienceSetting`	`object (AudienceSetting)` غير قابل للتغيير. إعداد للميزات المتعلّقة بالجمهور
`effectiveTargetCpaSource`	`enum (BiddingSource)` النتائج فقط. مصدر التكلفة المستهدفة الفعالة للإجراء. هذا الحقل للقراءة فقط.
`effectiveTargetRoasSource`	`enum (BiddingSource)` النتائج فقط. مصدر عائد الإنفاق الإعلاني المستهدف الفعال. هذا الحقل للقراءة فقط.
`labels[]`	`string` النتائج فقط. أسماء الموارد للتصنيفات المرفقة بهذه المجموعة الإعلانية.
`excludedParentAssetFieldTypes[]`	`enum (AssetFieldType)` أنواع حقول مواد العرض التي يجب استبعادها من هذه المجموعة الإعلانية. لن تكتسب هذه المجموعة الإعلانية روابط مواد العرض مع أنواع الحقول هذه من المستويات العليا.
`excludedParentAssetSetTypes[]`	`enum (AssetSetType)` أنواع مجموعات مواد العرض التي يجب استبعادها من هذه المجموعة الإعلانية. لن تكتسب هذه المجموعة الإعلانية روابط مجموعة مواد العرض بهذه الأنواع من المستويات العليا. أنواع مجموعات المواقع الجغرافية (GMB_DYNAMIC_LOCATION_GROUP وCHAIN_DYNAMIC_LOCATION_GROUP وStatIC_LOCATION_GROUP) هي أنواع فرعية من LOCATION_SYNC. وبالتالي، في حال ضبط LOCATION_SYNC لهذا الحقل، لا يُسمح بربط كل مجموعات مواد عرض مجموعة المواقع الجغرافية بهذه المجموعة الإعلانية، ولن يتم عرض كل إضافات المواقع الجغرافية (LE) وإضافات مواقع المعلنين الجغرافية (ALE) ضمن هذه المجموعة الإعلانية. لا يتوفّر حاليًا سوى LOCATION_SYNC.
`primaryStatus`	`enum (AdGroupPrimaryStatus)` النتائج فقط. يوفّر عرضًا مجمّعًا حول سبب عدم عرض مجموعة إعلانية أو عدم عرضها على النحو الأمثل.
`primaryStatusReasons[]`	`enum (AdGroupPrimaryStatusReason)` النتائج فقط. يقدّم هذا التقرير أسباب عدم عرض مجموعة إعلانية أو عدم عرض إعلاناتها على النحو الأمثل.
`id`	`string (int64 format)` النتائج فقط. رقم تعريف المجموعة الإعلانية.
`name`	`string` اسم المجموعة هذا الحقل مطلوب ويجب ألا يكون فارغًا عند إنشاء مجموعات إعلانية جديدة. ويجب أن يحتوي على أقل من 255 حرفًا بالعرض الكامل لترميز UTF-8. ويجب ألا يحتوي على أي أحرف فارغة (نقطة الرمز 0x0) أو خلاصة سطر NL (نقطة الرمز 0xA) أو أحرف الرجوع إلى أول السطر (رمز النقطة 0xD).
`baseAdGroup`	`string` النتائج فقط. بالنسبة إلى المجموعات الإعلانية الاختبارية أو التجريبية، يمثل هذا الحقل اسم مورد المجموعة الإعلانية الأساسية التي تم إنشاء هذه المجموعة الإعلانية منها. إذا لم تتضمّن مسودة أو مجموعة إعلانية تجريبية أي مجموعة إعلانية أساسية، سيكون هذا الحقل خاليًا. بالنسبة إلى المجموعات الإعلانية الأساسية، يساوي هذا الحقل اسم مورد المجموعة الإعلانية. هذا الحقل للقراءة فقط.
`trackingUrlTemplate`	`string` نموذج عنوان URL لإنشاء عنوان URL للتتبّع.
`campaign`	`string` غير قابل للتغيير. الحملة التي تنتمي إليها المجموعة الإعلانية.
`cpcBidMicros`	`string (int64 format)` عرض السعر الأقصى للنقرة.
`effectiveCpcBidMicros`	`string (int64 format)` النتائج فقط. ستكون القيمة مماثلة لقيمة عرض سعر النقرة عندما تكون استراتيجية عروض الأسعار تستند إلى تكلفة النقرة اليدوية أو تكلفة النقرة المحسّنة أو حصة المرتبة الأعلى المستهدفة أو الصفحة الأولى، وإلا ستكون القيمة فارغة.
`cpmBidMicros`	`string (int64 format)` عرض السعر الأقصى لكل ألف ظهور.
`targetCpaMicros`	`string (int64 format)` التكلفة المستهدفة للإجراء (CPA). وإذا كانت استراتيجية عروض الأسعار في الحملة ضمن المجموعة الإعلانية هي "التكلفة المستهدفة للإجراء" أو "تحقيق الحد الأقصى من الإحالات الناجحة" (مع تحديد حقل التكلفة المستهدفة للإجراء)، سيلغي هذا الحقل التكلفة المستهدفة للإجراء المحدّدة في استراتيجية عروض أسعار الحملة. وبخلاف ذلك، يتم تجاهل هذه القيمة.
`cpvBidMicros`	`string (int64 format)` عرض سعر المشاهدة.
`targetCpmMicros`	`string (int64 format)` متوسّط المبلغ بالمايكرو الذي يرغب المعلِن في دفعه مقابل كل ألف مرّة ظهور للإعلان.
`targetRoas`	`number` إلغاء عائد الإنفاق الإعلاني المستهدف (ROAS). إذا كانت استراتيجية عروض أسعار الحملة ضمن المجموعة الإعلانية هي TargetRoas أو MaxConversionValue (مع ضبط حقل targetRoas المتعلق بها)، فإن هذا الحقل يلغي عائد الإنفاق الإعلاني المستهدف المحدد في استراتيجية عروض أسعار الحملة. وبخلاف ذلك، يتم تجاهل هذه القيمة.
`percentCpcBidMicros`	`string (int64 format)` مبلغ عرض سعر النقرة بالنسبة المئوية، يتم التعبير عنه كجزء من السعر المُعلَن عنه لبعض السلع أو الخدمات. النطاق الصالح للكسر هو [0,1) والقيمة المخزنة هنا هي 1,000,000 * [fraction].
`finalUrlSuffix`	`string` نموذج عنوان URL لإلحاق المَعلمات برابط عنوان URL النهائي
`effectiveTargetCpaMicros`	`string (int64 format)` النتائج فقط. التكلفة المستهدفة الفعالة للإجراء (تكلفة الإجراء). هذا الحقل للقراءة فقط.
`effectiveTargetRoas`	`number` النتائج فقط. عائد الإنفاق الإعلاني المستهدف الفعال. هذا الحقل للقراءة فقط.

AdGroupStatus

الحالات المحتملة للمجموعة الإعلانية.

عمليات التعداد
`UNSPECIFIED`	لم يتمّ تحديد الحالة.
`UNKNOWN`	القيمة المُستلَمة غير معروفة في هذا الإصدار. هذه قيمة للاستجابة فقط.
`ENABLED`	المجموعة الإعلانية مفعّلة.
`PAUSED`	المجموعة الإعلانية متوقفة مؤقتًا.
`REMOVED`	تتم إزالة المجموعة الإعلانية.

AdGroupAdRotationMode

أوضاع عرض الإعلانات بالتناوب الممكنة لإحدى المجموعات الإعلانية.

عمليات التعداد
`UNSPECIFIED`	لم يتم تحديد وضع عرض الإعلانات بالتناوب.
`UNKNOWN`	القيمة المُستلَمة غير معروفة في هذا الإصدار. هذه قيمة للاستجابة فقط.
`OPTIMIZE`	حسِّن إعلانات المجموعة الإعلانية استنادًا إلى النقرات أو الإحالات الناجحة.
`ROTATE_FOREVER`	عرض الإعلانات بالتناوب بشكل متساوٍ إلى الأبد.

AudienceSetting

إعدادات استهداف الجمهور.

تمثيل JSON
{ "useAudienceGrouped": boolean }

الحقول

الحقول
`useAudienceGrouped`	`boolean` غير قابل للتغيير. إذا كانت هذه المعلومات صحيحة، تستخدم هذه المجموعة الإعلانية موردًا للجمهور لاستهداف الجمهور. في حال اختيار "خطأ"، قد تستخدِم هذه المجموعة الإعلانية معايير شريحة الجمهور بدلاً من ذلك.

useAudienceGrouped

boolean

غير قابل للتغيير. إذا كانت هذه المعلومات صحيحة، تستخدم هذه المجموعة الإعلانية موردًا للجمهور لاستهداف الجمهور. في حال اختيار "خطأ"، قد تستخدِم هذه المجموعة الإعلانية معايير شريحة الجمهور بدلاً من ذلك.

AdGroupPrimaryStatus

الحالات المحتملة للمجموعة الإعلانية.

عمليات التعداد
`UNSPECIFIED`	عدم تحديد صيغة مخاطبة
`UNKNOWN`	تُستخدَم هذه السمة للقيمة المعروضة فقط. يعرض قيمة غير معروفة في هذا الإصدار.
`ELIGIBLE`	المجموعة الإعلانية مؤهَّلة لعرض الإعلانات.
`PAUSED`	المجموعة الإعلانية متوقفة مؤقتًا.
`REMOVED`	تتم إزالة المجموعة الإعلانية.
`PENDING`	قد يتم عرض المجموعة الإعلانية في المستقبل.
`NOT_ELIGIBLE`	المجموعة الإعلانية غير مؤهَّلة لعرض الإعلانات.
`LIMITED`	إمكانية عرض المجموعة الإعلانية محدودة.

AdGroupPrimaryStatusReason

الأسباب المحتملة لحالة المجموعة الإعلانية.

عمليات التعداد
`UNSPECIFIED`	عدم تحديد صيغة مخاطبة
`UNKNOWN`	تُستخدَم هذه السمة للقيمة المعروضة فقط. يعرض قيمة غير معروفة في هذا الإصدار.
`CAMPAIGN_REMOVED`	تتمّ إزالة حالة الحملة التي حدّدها المستخدِم. يساهم في مجموعة adPrimaryStatus.NOT_advertiser.
`CAMPAIGN_PAUSED`	حالة الحملة التي يحدِّدها المستخدِم متوقفة مؤقتًا. يساهم في مجموعة adPrimaryStatus.NOT_advertiser.
`CAMPAIGN_PENDING`	يقع الوقت الذي يحدِّده المستخدم لبدء هذه الحملة في المستقبل. يساهم في مجموعة adPrimaryStatus.NOT_eligibility
`CAMPAIGN_ENDED`	لقد انقضى الوقت الذي حدّده المستخدم لانتهاء هذه الحملة. يساهم في مجموعة adPrimaryStatus.NOT_advertiser.
`AD_GROUP_PAUSED`	حالة المجموعة الإعلانية التي حدّدها المستخدم متوقفة مؤقتًا. يساهم في مجموعة سياسة adPrimaryStatus.PAUSE.
`AD_GROUP_REMOVED`	تتم إزالة حالة المجموعة الإعلانية التي حدّدها المستخدم. يساهم في مجموعة groupPrimaryStatus.REMOVE
`AD_GROUP_INCOMPLETE`	إنشاء هذه المجموعة الإعلانية غير مكتمل بعد. يساهم في مجموعة adPrimaryStatus.NOT_advertiser.
`KEYWORDS_PAUSED`	إنّ جميع حالات الكلمات الرئيسية التي يحدِّدها المستخدِم في هذه المجموعة الإعلانية متوقفة مؤقتًا. يساهم في مجموعة adPrimaryStatus.NOT_advertiser.
`NO_KEYWORDS`	لا تتوفّر أي كلمات رئيسية مؤهَّلة في هذه المجموعة الإعلانية. يساهم في مجموعة adPrimaryStatus.NOT_advertiser.
`AD_GROUP_ADS_PAUSED`	جميع حالات إعلانات المجموعة الإعلانية التي حدّدها المستخدم في هذه المجموعة الإعلانية متوقفة مؤقتًا. يساهم في مجموعة adPrimaryStatus.NOT_advertiser.
`NO_AD_GROUP_ADS`	لا توجد إعلانات مؤهلة للمجموعة الإعلانية في هذه المجموعة الإعلانية. يساهم في مجموعة adPrimaryStatus.NOT_advertiser.
`HAS_ADS_DISAPPROVED`	سبب حالة السياسة عند رفض إعلان واحد على الأقل. يساهم في حالة مجموعة إعلانية أساسية متعددة
`HAS_ADS_LIMITED_BY_POLICY`	سبب حالة السياسة عندما يكون إعلان واحد على الأقل مقيَّدًا بالسياسة. يساهم في حالة مجموعة إعلانية أساسية متعددة
`MOST_ADS_UNDER_REVIEW`	هو سبب حالة السياسة عندما تكون معظم الإعلانات في انتظار المراجعة. يساهم في مجموعة adPrimaryStatus.PENDING.
`CAMPAIGN_DRAFT`	تنتمي المجموعة الإعلانية إلى حملة اختبارية. يساهم في مجموعة adPrimaryStatus.NOT_advertiser.
`AD_GROUP_PAUSED_DUE_TO_LOW_ACTIVITY`	تم إيقاف المجموعة الإعلانية مؤقتًا بسبب انخفاض نشاط العرض لفترات طويلة. يساهم في مجموعة سياسة adPrimaryStatus.PAUSE.