REST Resource: advertisers.youtubeAdGroupAds

المرجع: YouTubeAdGroupAd

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

تمثيل 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

تفاصيل إعلان video discovery.

تمثيل 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)

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

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

خيارات الصور المصغّرة المحتملة في "الإعلانات أثناء التصفّح" للفيديو

عمليات التعداد
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 بكسل تتبع 1×1 يتم إرساله عند عرض تصميم إعلان.
AD_URL_TYPE_BEACON_EXPANDABLE_DCM_IMPRESSION إشارة الظهور القابلة للتوسيع في DCM وفي وقت العرض، يتم توسيع النطاق ليشمل عدّة إشارات مرجعية.
AD_URL_TYPE_BEACON_CLICK عنوان URL للتتبّع الذي سيتم إرسال إشعار إليه عند بدء حدث النقر.
AD_URL_TYPE_BEACON_SKIP عنوان URL لتتبّع الذي سيتم إرسال إشعار إليه عند بدء حدث التخطّي

الطُرق

get

تظهر له إعلان مجموعة إعلانية على YouTube.

list

يسرد إعلانات المجموعة الإعلانية على YouTube.