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

نام منبع آگهی

advertiser Id

string ( int64 format)

شناسه منحصر به فرد تبلیغ کننده ای که تبلیغ به آن تعلق دارد.

ad Group Ad Id

string ( int64 format)

شناسه منحصر به فرد آگهی. توسط سیستم تعیین شده است.

ad Group Id

string ( int64 format)

شناسه منحصر به فرد گروه تبلیغاتی که آگهی به آن تعلق دارد.

display Name

string

نام نمایشی آگهی

باید UTF-8 با حداکثر اندازه 255 بایت کدگذاری شود.

entity Status

enum ( EntityStatus )

وضعیت موجودیت آگهی.

ad Urls[]

object ( AdUrl )

لیست URL های استفاده شده توسط آگهی.

فیلد اتحادیه ad_details . جزئیات آگهی ad_details فقط می تواند یکی از موارد زیر باشد:
display Video Source Ad

object ( DisplayVideoSourceAd )

جزئیات تبلیغی که از یک خلاقیت Display & Video 360 منشأ گرفته است.

masthead Ad

object ( MastheadAd )

جزئیات آگهی ارائه شده در فید Home YouTube .

in Stream Ad

object ( InStreamAd )

جزئیات یک تبلیغ درون جریانی که پس از 5 ثانیه قابل رد شدن است ، برای آگاهی از نام تجاری یا رسیدن به اهداف بازاریابی استفاده می شود.

non Skippable Ad

object ( NonSkippableAd )

جزئیات یک آگهی ویدیویی کوتاه غیرقابل رد شدن ، بین 6 تا 15 ثانیه، که برای رسیدن به اهداف بازاریابی استفاده می‌شود.

bumper Ad

object ( BumperAd )

جزئیات یک آگهی ویدیویی کوتاه غیرقابل رد شدن ، برابر یا کمتر از ۶ ثانیه، که برای دسترسی استفاده می‌شود.

audio Ad

object ( AudioAd )

جزئیات یک آگهی صوتی که برای رسیدن به اهداف بازاریابی استفاده می شود.

video Discover Ad

object ( VideoDiscoveryAd )

جزئیات آگهی تبلیغاتی ویدیویی که در مکان‌های کشف نشان داده می‌شود.

video Performance Ad

object ( VideoPerformanceAd )

جزئیات آگهی مورد استفاده در کمپین اقدام ویدیویی برای هدایت کنش‌ها به سمت کسب و کار، خدمات یا محصول.

DisplayVideoSourceAd

منبع آگهی از یک خلاقیت DV360 است.

نمایندگی JSON 
{
  "creativeId": string
}
فیلدها
creative Id

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 )

ویدیوی یوتیوب که توسط تبلیغ استفاده شده است.

headline

string

تیتر آگهی.

description

string

توضیحات آگهی

video Aspect Ratio

enum ( VideoAspectRatio )

نسبت تصویر پخش خودکار ویدیوی YouTube در مستدل.

autoplay Video Start Millisecond

string ( int64 format)

مقدار زمانی بر حسب میلی ثانیه که پس از آن ویدیو شروع به پخش می کند.

autoplay Video Duration

string ( Duration format)

مدت زمان پخش خودکار ویدیو.

مدت زمان در ثانیه با حداکثر نه رقم کسری که با ' s ' ختم می شود. مثال: "3.5s" .

call To Action Button Label

string

متن روی دکمه فراخوان برای اقدام.

call To Action Final Url

string

نشانی وب مقصد برای دکمه فراخوان برای اقدام.

call To Action Tracking Url

string

URL ردیابی دکمه فراخوان برای اقدام.

show Channel Art

boolean

آیا برای نمایش پس‌زمینه یا بنری که در بالای صفحه YouTube ظاهر می‌شود.

companion Youtube Videos[]

object ( YoutubeVideoDetails )

ویدیوهایی که در کنار آگهی سرصفحه دسکتاپ ظاهر می شوند. نمی تواند بیشتر از دو باشد.

YouTubeVideoDetails

جزئیات یک ویدیوی یوتیوب.

نمایندگی JSON 
{
  "id": string,
  "unavailableReason": enum (VideoUnavailableReason)
}
فیلدها
id

string

شناسه ویدیوی YouTube که در صفحه وب YouTube قابل جستجو است.

unavailable Reason

enum ( VideoUnavailableReason )

دلیل در دسترس نبودن داده های ویدیویی

Video UnavailableReason

دلایل احتمالی در دسترس نبودن یک ویدیو.

Enums
VIDEO_UNAVAILABLE_REASON_UNSPECIFIED ناشناخته یا نامشخص.
VIDEO_UNAVAILABLE_REASON_PRIVATE ویدیو خصوصی است.
VIDEO_UNAVAILABLE_REASON_DELETED ویدیو حذف شده است.

نسبت ابعاد ویدیویی

نسبت های ممکن برای یک ویدیوی YouTube.

Enums
VIDEO_ASPECT_RATIO_UNSPECIFIED مشخص یا ناشناخته
VIDEO_ASPECT_RATIO_WIDESCREEN ویدیو کشیده شده و بالا و پایین برش داده شده است.
VIDEO_ASPECT_RATIO_FIXED_16_9 این ویدیو از نسبت تصویر ثابت 16:9 استفاده می کند.

InStreamAd

جزئیات یک تبلیغ درون جریانی.

نمایندگی JSON 
{
  "commonInStreamAttribute": {
    object (CommonInStreamAttribute)
  },
  "customParameters": {
    string: string,
    ...
  }
}
فیلدها
common In Stream Attribute

object ( CommonInStreamAttribute )

ویژگی های رایج تبلیغات

custom Parameters

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)
  }
}
فیلدها
display Url

string

آدرس صفحه وب که همراه آگهی ظاهر می شود.

final Url

string

آدرس URL صفحه وب که افراد پس از کلیک بر روی تبلیغ به آن دسترسی پیدا می کنند.

tracking Url

string

آدرس URL بارگیری شده در پس‌زمینه برای اهداف ردیابی.

action Button Label

string

متن روی دکمه فراخوان برای اقدام.

action Headline

string

تیتر بنر دعوت به اقدام.

video

object ( YoutubeVideoDetails )

ویدیوی یوتیوب آگهی.

companion Banner

object ( ImageAsset )

تصویری که در کنار آگهی ویدیویی نشان داده می شود.

ImageAsset

متا داده یک دارایی تصویر.

نمایندگی JSON 
{
  "mimeType": string,
  "fullSize": {
    object (Dimensions)
  },
  "fileSize": string
}
فیلدها
mime Type

string

نوع MIME دارایی تصویر.

full Size

object ( Dimensions )

فراداده این تصویر در اندازه اصلی آن.

file Size

string ( int64 format)

اندازه فایل دارایی تصویر بر حسب بایت.

NonSkippable Ad

جزئیات یک آگهی غیر قابل رد شدن.

نمایندگی JSON 
{
  "commonInStreamAttribute": {
    object (CommonInStreamAttribute)
  },
  "customParameters": {
    string: string,
    ...
  }
}
فیلدها
common In Stream Attribute

object ( CommonInStreamAttribute )

ویژگی های رایج تبلیغات

custom Parameters

map (key: string, value: string)

پارامترهای سفارشی برای ارسال مقادیر سفارشی به الگوی URL ردیابی.

یک شی حاوی لیستی از "key": value . مثال: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

BumperAd

جزئیات یک آگهی بامپر.

نمایندگی JSON 
{
  "commonInStreamAttribute": {
    object (CommonInStreamAttribute)
  }
}
فیلدها
common In Stream Attribute

object ( CommonInStreamAttribute )

ویژگی های رایج تبلیغات

Audio Ad

جزئیات یک آگهی صوتی

نمایندگی JSON 
{
  "displayUrl": string,
  "finalUrl": string,
  "trackingUrl": string,
  "video": {
    object (YoutubeVideoDetails)
  }
}
فیلدها
display Url

string

آدرس صفحه وب که همراه آگهی ظاهر می شود.

final Url

string

آدرس URL صفحه وب که افراد پس از کلیک بر روی تبلیغ به آن دسترسی پیدا می کنند.

tracking Url

string

آدرس URL بارگیری شده در پس‌زمینه برای اهداف ردیابی.

video

object ( YoutubeVideoDetails )

ویدیوی یوتیوب آگهی.

VideoDiscovery Ad

جزئیات یک آگهی اکتشافی ویدیویی.

نمایندگی 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 )

تصویر کوچک استفاده شده در آگهی.

تصویر کوچک

گزینه های احتمالی تصویر کوچک در تبلیغات کشف ویدیو.

Enums
THUMBNAIL_UNSPECIFIED ناشناخته یا نامشخص.
THUMBNAIL_DEFAULT تصویر بندانگشتی پیش‌فرض، می‌تواند به‌طور خودکار تولید شود یا توسط کاربر آپلود شود.
THUMBNAIL_1 تصویر بندانگشتی 1، ایجاد شده از ویدیو.
THUMBNAIL_2 تصویر بندانگشتی 2، ایجاد شده از ویدیو.
THUMBNAIL_3 تصویر کوچک 3، ایجاد شده از ویدیو.

Video Performance Ad

جزئیات یک تبلیغ عملکرد ویدیویی.

نمایندگی 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)
    }
  ]
}
فیلدها
final Url

string

آدرس URL صفحه وب که افراد پس از کلیک بر روی تبلیغ به آن دسترسی پیدا می کنند.

tracking Url

string

آدرس URL بارگیری شده در پس‌زمینه برای اهداف ردیابی.

action Button Labels[]

string

لیست دارایی های متنی که در دکمه فراخوان به اقدام نشان داده شده است.

headlines[]

string

لیستی از عناوین نشان داده شده در بنر دعوت به اقدام.

long Headlines[]

string

لیستی از سرفصل های تنها که در بنر دعوت به اقدام نشان داده شده است.

descriptions[]

string

لیستی از توضیحات نشان داده شده در بنر دعوت به اقدام.

display Url Breadcrumb1

string

اولین قطعه بعد از دامنه در URL نمایش داده می شود.

display Url Breadcrumb2

string

قطعه دوم بعد از دامنه در URL نمایش داده می شود.

domain

string

دامنه URL نمایش داده می شود.

videos[]

object ( YoutubeVideoDetails )

فهرست دارایی‌های ویدیوی YouTube استفاده شده توسط این آگهی.

custom Parameters

map (key: string, value: string)

پارامترهای سفارشی برای ارسال مقادیر سفارشی به الگوی URL ردیابی.

یک شی حاوی لیستی از "key": value . مثال: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

companion Banners[]

object ( ImageAsset )

لیست بنرهای همراه استفاده شده توسط این آگهی.

AdUrl

نشانی‌های اینترنتی اضافی مرتبط با آگهی، از جمله چراغ‌های روشنایی.

نمایندگی JSON 
{
  "type": enum (AdUrlType),
  "url": string
}
فیلدها
type

enum ( AdUrlType )

نوع URL آگهی.

url

string

مقدار رشته URL.

AdUrlType

انواع URL تبلیغاتی ممکن

Enums
AD_URL_TYPE_UNSPECIFIED ناشناخته یا نامشخص.
AD_URL_TYPE_BEACON_IMPRESSION یک پیکسل ردیابی 1x1 برای پینگ زمانی که برداشتی از یک خلاق ارائه می شود.
AD_URL_TYPE_BEACON_EXPANDABLE_DCM_IMPRESSION چراغ نمایش DCM قابل ارتقا. در زمان خدمت، آن را به چندین چراغ گسترش می یابد.
AD_URL_TYPE_BEACON_CLICK ردیابی URL برای پینگ زمانی که رویداد کلیک فعال می شود.
AD_URL_TYPE_BEACON_SKIP ردیابی URL برای پینگ زمانی که رویداد پرش فعال می شود.

روش ها

get

 یک تبلیغ گروه تبلیغاتی دریافت می کند.

list

 تبلیغات گروه های تبلیغاتی را فهرست می کند.