REST Resource: advertisers.adGroupAds

المورد: AdGroupAd

إعلان واحد مرتبط بمجموعة إعلانية

تمثيل JSON
{
  "name": string,
  "advertiserId": string,
  "adGroupAdId": string,
  "adGroupId": string,
  "displayName": string,
  "entityStatus": enum (EntityStatus),
  "adUrls": [
    {
      object (AdUrl)
    }
  ],

  // Union field ad_details can be only one of the following:
  "displayVideoSourceAd": {
    object (DisplayVideoSourceAd)
  },
  "mastheadAd": {
    object (MastheadAd)
  },
  "inStreamAd": {
    object (InStreamAd)
  },
  "nonSkippableAd": {
    object (NonSkippableAd)
  },
  "bumperAd": {
    object (BumperAd)
  },
  "audioAd": {
    object (AudioAd)
  },
  "videoDiscoverAd": {
    object (VideoDiscoveryAd)
  },
  "videoPerformanceAd": {
    object (VideoPerformanceAd)
  }
  // End of list of possible types for union field ad_details.
}
الحقول
name

string

اسم المورد الخاص بالإعلان.

advertiserId

string (int64 format)

المعرّف الفريد للمعلن الذي ينتمي إليه الإعلان.

adGroupAdId

string (int64 format)

المعرّف الفريد للإعلان. يتم تخصيصها من قِبل النظام.

adGroupId

string (int64 format)

المعرّف الفريد للمجموعة الإعلانية التي ينتمي إليها الإعلان.

displayName

string

الاسم المعروض للإعلان

يجب أن يكون الترميز UTF-8 وبحجم 255 بايت كحدّ أقصى.

entityStatus

enum (EntityStatus)

تمثّل هذه السمة حالة الكيان للإعلان.

adUrls[]

object (AdUrl)

قائمة بعناوين URL التي يستخدمها الإعلان

حقل الدمج ad_details تفاصيل الإعلان يمكن أن تكون ad_details إحدى القيم التالية فقط:
displayVideoSourceAd

object (DisplayVideoSourceAd)

تفاصيل إعلان مصدره تصميم إعلان على "مساحة العرض والفيديو 360"

mastheadAd

object (MastheadAd)

تفاصيل إعلان معروض على خلاصة الصفحة الرئيسية في YouTube

inStreamAd

object (InStreamAd)

تفاصيل إعلان ضمن البث يمكن تخطّيه بعد 5 ثوانٍ، ويُستخدَم لتحقيق أهداف تسويقية مرتبطة بالوعي بالعلامة التجارية أو الوصول إلى الجمهور.

nonSkippableAd

object (NonSkippableAd)

تفاصيل إعلان فيديو قصير غير قابل للتخطّي أثناء عرض الفيديو، تتراوح مدّته بين 6 و15 ثانية، ويُستخدم لتحقيق أهداف تسويقية متعلّقة بالوصول إلى الجمهور

bumperAd

object (BumperAd)

تفاصيل إعلان فيديو قصير غير قابل للتخطّي، مدته 6 ثوانٍ أو أقل، ويُستخدم للوصول إلى الجمهور

audioAd

object (AudioAd)

تفاصيل إعلان صوتي مستخدَم لتحقيق أهداف تسويقية متعلّقة بالوصول إلى الجمهور

videoDiscoverAd

object (VideoDiscoveryAd)

تفاصيل إعلان يروّج لفيديو ويظهر في مواضع البحث عن أفكار جديدة

videoPerformanceAd

object (VideoPerformanceAd)

تفاصيل إعلان مستخدَم في "حملة فيديو تحثّ على اتّخاذ إجراء" لجذب إجراءات إلى النشاط التجاري أو الخدمة أو المنتج

DisplayVideoSourceAd

الإعلان مصدره تصميم إعلان في "مساحة العرض والفيديو 360".

تمثيل JSON
{
  "creativeId": string
}
الحقول
creativeId

string (int64 format)

معرّف تصميم الإعلان المصدر.

MastheadAd

تفاصيل "إعلان على الصفحة الرئيسية"

تمثيل JSON
{
  "video": {
    object (YoutubeVideoDetails)
  },
  "headline": string,
  "description": string,
  "videoAspectRatio": enum (VideoAspectRatio),
  "autoplayVideoStartMillisecond": string,
  "autoplayVideoDuration": string,
  "callToActionButtonLabel": string,
  "callToActionFinalUrl": string,
  "callToActionTrackingUrl": string,
  "showChannelArt": boolean,
  "companionYoutubeVideos": [
    {
      object (YoutubeVideoDetails)
    }
  ]
}
الحقول
video

object (YoutubeVideoDetails)

فيديو YouTube الذي يستخدمه الإعلان

headline

string

عنوان الإعلان.

description

string

وصف الإعلان

videoAspectRatio

enum (VideoAspectRatio)

نسبة العرض إلى الارتفاع لفيديو YouTube الذي يتم تشغيله تلقائيًا في "التسمية الرئيسية"

autoplayVideoStartMillisecond

string (int64 format)

مقدار الوقت بالمللي ثانية الذي سيبدأ بعده تشغيل الفيديو

autoplayVideoDuration

string (Duration format)

تمثّل هذه السمة المدة الزمنية التي سيتم خلالها تشغيل الفيديو تلقائيًا.

مدة بالثواني مع ما يصل إلى تسعة أرقام كسور، وتنتهي بـ "s". مثال: "3.5s"

callToActionButtonLabel

string

النص الظاهر على زر عبارة الحث على اتّخاذ إجراء

callToActionFinalUrl

string

عنوان URL المقصود لزر عبارة الحث على الشراء.

callToActionTrackingUrl

string

عنوان URL للتتبُّع لزر عبارة الحث على اتخاذ إجراء

showChannelArt

boolean

تحديد ما إذا كان سيتم عرض خلفية أو بانر يظهر أعلى صفحة YouTube

companionYoutubeVideos[]

object (YoutubeVideoDetails)

الفيديوهات التي تظهر بجانب "إعلان التسمية الرئيسية" على أجهزة الكمبيوتر المكتبي يمكن أن يكون عددها اثنان على الأكثر.

YoutubeVideoDetails

تعرض هذه السمة تفاصيل حول فيديو على YouTube.

تمثيل JSON
{
  "id": string,
  "unavailableReason": enum (VideoUnavailableReason)
}
الحقول
id

string

هذه السمة هي معرّف فيديو YouTube الذي يمكن البحث عنه في صفحة ويب YouTube.

unavailableReason

enum (VideoUnavailableReason)

سبب عدم توفّر بيانات الفيديو

VideoUnavailableReason

الأسباب المحتملة لعدم توفّر فيديو

عمليات التعداد
VIDEO_UNAVAILABLE_REASON_UNSPECIFIED غير معروف أو غير محدّد
VIDEO_UNAVAILABLE_REASON_PRIVATE الفيديو خاص.
VIDEO_UNAVAILABLE_REASON_DELETED تم حذف الفيديو.

VideoAspectRatio

نِسَب العرض إلى الارتفاع المحتملة لفيديو على YouTube

عمليات التعداد
VIDEO_ASPECT_RATIO_UNSPECIFIED غير محدّد أو غير معروف
VIDEO_ASPECT_RATIO_WIDESCREEN يكون الفيديو ممدودًا ويتم اقتصاص الجزء العلوي والسفلي منه.
VIDEO_ASPECT_RATIO_FIXED_16_9 يستخدم الفيديو نسبة عرض إلى ارتفاع ثابتة تبلغ 16:9.

InStreamAd

تفاصيل إعلان أثناء عرض الفيديو

تمثيل JSON
{
  "commonInStreamAttribute": {
    object (CommonInStreamAttribute)
  },
  "customParameters": {
    string: string,
    ...
  }
}
الحقول
commonInStreamAttribute

object (CommonInStreamAttribute)

سمات الإعلانات الشائعة

customParameters

map (key: string, value: string)

المَعلمات المخصّصة لتمرير القيم المخصّصة إلى نموذج عنوان URL للتتبّع

عنصر يحتوي على قائمة بأزواج "key": value مثال: { "name": "wrench", "mass": "1.3kg", "count": "3" }

CommonInStreamAttribute

السمات الشائعة للإعلانات أثناء عرض الفيديو والإعلانات غير القابلة للتخطي وإعلانات الملصقات الصغيرة

تمثيل JSON
{
  "displayUrl": string,
  "finalUrl": string,
  "trackingUrl": string,
  "actionButtonLabel": string,
  "actionHeadline": string,
  "video": {
    object (YoutubeVideoDetails)
  },
  "companionBanner": {
    object (ImageAsset)
  }
}
الحقول
displayUrl

string

هو عنوان صفحة الويب الذي يظهر مع الإعلان.

finalUrl

string

عنوان URL لصفحة الويب التي يصل إليها المستخدمون بعد النقر على الإعلان.

trackingUrl

string

عنوان URL الذي يتم تحميله في الخلفية لأغراض التتبُّع

actionButtonLabel

string

النص الظاهر على زر عبارة الحث على اتّخاذ إجراء

actionHeadline

string

عنوان بانر الحث على اتخاذ إجراء

video

object (YoutubeVideoDetails)

فيديو الإعلان على YouTube

companionBanner

object (ImageAsset)

الصورة التي تظهر بجانب إعلان الفيديو

ImageAsset

البيانات الوصفية لمادة عرض صورة

تمثيل JSON
{
  "mimeType": string,
  "fullSize": {
    object (Dimensions)
  },
  "fileSize": string
}
الحقول
mimeType

string

نوع MIME لمادة عرض الصورة.

fullSize

object (Dimensions)

تمثّل هذه السمة البيانات الوصفية للصورة بحجمها الأصلي.

fileSize

string (int64 format)

حجم ملف مادة عرض الصورة بالبايت.

NonSkippableAd

تفاصيل إعلان غير قابل للتخطّي

تمثيل JSON
{
  "commonInStreamAttribute": {
    object (CommonInStreamAttribute)
  },
  "customParameters": {
    string: string,
    ...
  }
}
الحقول
commonInStreamAttribute

object (CommonInStreamAttribute)

سمات الإعلانات الشائعة

customParameters

map (key: string, value: string)

المَعلمات المخصّصة لتمرير القيم المخصّصة إلى نموذج عنوان URL للتتبّع

عنصر يحتوي على قائمة بأزواج "key": value مثال: { "name": "wrench", "mass": "1.3kg", "count": "3" }

BumperAd

تفاصيل عن "إعلان الملصق الصغير"

تمثيل JSON
{
  "commonInStreamAttribute": {
    object (CommonInStreamAttribute)
  }
}
الحقول
commonInStreamAttribute

object (CommonInStreamAttribute)

سمات الإعلانات الشائعة

AudioAd

تفاصيل إعلان صوتي

تمثيل JSON
{
  "displayUrl": string,
  "finalUrl": string,
  "trackingUrl": string,
  "video": {
    object (YoutubeVideoDetails)
  }
}
الحقول
displayUrl

string

هو عنوان صفحة الويب الذي يظهر مع الإعلان.

finalUrl

string

عنوان URL لصفحة الويب التي يصل إليها المستخدمون بعد النقر على الإعلان.

trackingUrl

string

عنوان URL الذي يتم تحميله في الخلفية لأغراض التتبُّع

video

object (YoutubeVideoDetails)

فيديو الإعلان على YouTube

VideoDiscoveryAd

تفاصيل عن "إعلان فيديو أثناء التصفّح"

تمثيل JSON
{
  "headline": string,
  "description1": string,
  "description2": string,
  "video": {
    object (YoutubeVideoDetails)
  },
  "thumbnail": enum (Thumbnail)
}
الحقول
headline

string

تمثّل هذه السمة عنوان الإعلان.

description1

string

السطر الأول من نص الإعلان

description2

string

سطر النص الثاني للإعلان

video

object (YoutubeVideoDetails)

فيديو YouTube الذي يروّج له الإعلان

thumbnail

enum (Thumbnail)

الصورة المصغّرة المستخدَمة في الإعلان

الصورة المصغّرة

خيارات الصور المصغّرة المحتملة في "إعلانات Video Discovery"

عمليات التعداد
THUMBNAIL_UNSPECIFIED غير معروف أو غير محدّد
THUMBNAIL_DEFAULT الصورة المصغّرة التلقائية، ويمكن إنشاؤها تلقائيًا أو تحميلها من قِبل المستخدم.
THUMBNAIL_1 الصورة المصغّرة 1، تم إنشاؤها من الفيديو
THUMBNAIL_2 الصورة المصغّرة 2، التي تم إنشاؤها من الفيديو
THUMBNAIL_3 الصورة المصغّرة 3، التي تم إنشاؤها من الفيديو

VideoPerformanceAd

تفاصيل إعلان عن أداء فيديو

تمثيل JSON
{
  "finalUrl": string,
  "trackingUrl": string,
  "actionButtonLabels": [
    string
  ],
  "headlines": [
    string
  ],
  "longHeadlines": [
    string
  ],
  "descriptions": [
    string
  ],
  "displayUrlBreadcrumb1": string,
  "displayUrlBreadcrumb2": string,
  "domain": string,
  "videos": [
    {
      object (YoutubeVideoDetails)
    }
  ],
  "customParameters": {
    string: string,
    ...
  },
  "companionBanners": [
    {
      object (ImageAsset)
    }
  ]
}
الحقول
finalUrl

string

عنوان URL لصفحة الويب التي يصل إليها المستخدمون بعد النقر على الإعلان.

trackingUrl

string

عنوان URL الذي يتم تحميله في الخلفية لأغراض التتبُّع

actionButtonLabels[]

string

قائمة مواد العرض النصية المعروضة على زر عبارة الحث على اتّخاذ إجراء

headlines[]

string

قائمة العناوين المعروضة على بانر الحث على اتخاذ إجراء

longHeadlines[]

string

قائمة العناوين المستقلة المعروضة على بانر عبارة الحث على اتخاذ إجراء

descriptions[]

string

قائمة الأوصاف المعروضة على بانر عبارة الحث على اتّخاذ إجراء

displayUrlBreadcrumb1

string

الجزء الأول بعد النطاق في عنوان URL المعروض

displayUrlBreadcrumb2

string

الجزء الثاني بعد النطاق في عنوان URL المعروض

domain

string

نطاق عنوان URL المعروض

videos[]

object (YoutubeVideoDetails)

قائمة بمواد عرض الفيديو على YouTube التي يستخدمها هذا الإعلان

customParameters

map (key: string, value: string)

المَعلمات المخصّصة لتمرير القيم المخصّصة إلى نموذج عنوان URL للتتبّع

عنصر يحتوي على قائمة بأزواج "key": value مثال: { "name": "wrench", "mass": "1.3kg", "count": "3" }

companionBanners[]

object (ImageAsset)

قائمة إعلانات البانر المصاحبة التي يستخدمها هذا الإعلان

AdUrl

عناوين URL إضافية مرتبطة بالإعلان، بما في ذلك إشارات التتبُّع

تمثيل JSON
{
  "type": enum (AdUrlType),
  "url": string
}
الحقول
type

enum (AdUrlType)

نوع عنوان URL للإعلان.

url

string

قيمة سلسلة عنوان URL

AdUrlType

أنواع عناوين URL للإعلانات المحتملة

عمليات التعداد
AD_URL_TYPE_UNSPECIFIED غير معروف أو غير محدّد
AD_URL_TYPE_BEACON_IMPRESSION بكسل تتبُّع 1x1 لإرسال إشارة عند عرض مرّة ظهور لتصميم إعلان.
AD_URL_TYPE_BEACON_EXPANDABLE_DCM_IMPRESSION إشارة الظهور للإعلانات القابلة للتوسعة في "إدارة حملة DoubleClick" وعند العرض، يتم توسيعه ليشمل عدّة إشارات.
AD_URL_TYPE_BEACON_CLICK عنوان URL للتتبُّع يتم إرسال إشارة إليه عند بدء حدث النقر.
AD_URL_TYPE_BEACON_SKIP عنوان URL للتتبُّع يتم إرسال إشارة إليه عند بدء حدث التخطّي.

الطُرق

get

تعرض هذه الطريقة إعلانًا تابعًا لمجموعة إعلانية.

list

تعرض هذه الطريقة إعلانات المجموعة الإعلانية.