REST Resource: advertisers.youtubeAdGroupAds

Zasób: YouTubeAdGroupAd

Pojedyncza reklama powiązana z grupą reklam w YouTube.

Zapis 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.
}
Pola
name

string

Nazwa zasobu reklamy.

advertiserId

string (int64 format)

Unikalny identyfikator reklamodawcy, do którego należy reklama.

adGroupAdId

string (int64 format)

Unikalny identyfikator reklamy. Przypisana przez system.

adGroupId

string (int64 format)

Unikalny identyfikator grupy reklam, do której należy reklama.

displayName

string

Wyświetlana nazwa reklamy.

Musi być zakodowany w formacie UTF-8 o maksymalnym rozmiarze 255 bajtów.

entityStatus

enum (EntityStatus)

Stan elementu reklamy.

adUrls[]

object (AdUrl)

Lista adresów URL używanych przez reklamę.

Pole sumy ad_details. Szczegóły reklamy. ad_details może być tylko jedną z tych wartości:
displayVideoSourceAd

object (DisplayVideoSourceAd)

Szczegółowe informacje o reklamie pochodzącej z kreacji Display & Video 360.

mastheadAd

object (MastheadAd)

Szczegółowe informacje o reklamie wyświetlanej na stronie głównej YouTube.

inStreamAd

object (InStreamAd)

Szczegóły reklamy In-Stream możliwej do pominięcia po 5 sekundach, która służy do celów marketingowych związanych ze świadomością marki lub zasięgiem.

nonSkippableAd

object (NonSkippableAd)

Szczegóły krótkiej reklamy wideo In-Stream niemożliwej do pominięcia, która trwa od 6 do 15 sekund, używanej do osiągania celów marketingowych związanych z zasięgiem.

bumperAd

object (BumperAd)

Szczegóły krótkiej reklamy wideo niemożliwej do pominięcia, trwającej maksymalnie 6 sekund, używane na potrzeby określania zasięgu.

audioAd

object (AudioAd)

Szczegółowe informacje o reklamie audio używanej na potrzeby celów marketingowych związanych z zasięgiem.

videoDiscoverAd

object (VideoDiscoveryAd)

Szczegółowe informacje o reklamie promującej film, która wyświetla się w miejscach odkrywania.

videoPerformanceAd

object (VideoPerformanceAd)

Szczegółowe informacje o reklamie używanej w kampanii wideo zachęcającej do działania, która ma zachęcać użytkowników do podejmowania działań związanych z firmą, usługą lub produktem.

DisplayVideoSourceAd

Reklama pochodzi z kreacji DV360.

Zapis JSON
{
  "creativeId": string
}
Pola
creativeId

string (int64 format)

Identyfikator kreacji źródłowej.

MastheadAd

Szczegóły reklamy w banerze masthead.

Zapis 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)
    }
  ]
}
Pola
video

object (YoutubeVideoDetails)

Film w YouTube użyty w reklamie.

headline

string

Nagłówek reklamy.

description

string

Opis reklamy.

videoAspectRatio

enum (VideoAspectRatio)

Współczynnik proporcji automatycznie odtwarzanego filmu z YouTube w mastheadzie.

autoplayVideoStartMillisecond

string (int64 format)

Czas (w milisekundach), po którym rozpocznie się odtwarzanie filmu.

autoplayVideoDuration

string (Duration format)

Czas trwania autoodtwarzania filmu.

Czas trwania w sekundach z maksymalnie 9 cyframi po przecinku, kończącym się cyframi „s”. Przykład: "3.5s".

callToActionButtonLabel

string

Tekst na przycisku wezwania do działania.

callToActionFinalUrl

string

Docelowy adres URL przycisku z wezwaniem do działania.

callToActionTrackingUrl

string

Link monitorujący przycisku wezwania do działania.

showChannelArt

boolean

Określa, czy pokazywać tło, czy baner widoczny u góry strony YouTube.

companionYoutubeVideos[]

object (YoutubeVideoDetails)

Filmy, które wyświetlają się obok reklamy w banerze masthead na komputerach. Może być maksymalnie 2 razy.

YoutubeVideoDetails

Szczegółowe informacje o filmie w YouTube.

Zapis JSON
{
  "id": string,
  "unavailableReason": enum (VideoUnavailableReason)
}
Pola
id

string

Identyfikator filmu w YouTube, który można wyszukiwać na stronie internetowej YouTube.

unavailableReason

enum (VideoUnavailableReason)

Powód, dla którego dane filmu są niedostępne.

VideoUnavailableReason

Możliwe przyczyny niedostępności filmu.

Wartości w polu enum
VIDEO_UNAVAILABLE_REASON_UNSPECIFIED Nieznane lub nieokreślone.
VIDEO_UNAVAILABLE_REASON_PRIVATE Ten film wideo jest prywatny.
VIDEO_UNAVAILABLE_REASON_DELETED Film został usunięty.

VideoAspectRatio

Możliwe formaty obrazu filmu w YouTube.

Wartości w polu enum
VIDEO_ASPECT_RATIO_UNSPECIFIED Nie określono lub nieznane.
VIDEO_ASPECT_RATIO_WIDESCREEN Film jest rozciągnięty, a góra i dół przycięte.
VIDEO_ASPECT_RATIO_FIXED_16_9 Film ma stały format obrazu 16:9.

InStreamAd

Szczegóły reklamy In-Stream.

Zapis JSON
{
  "commonInStreamAttribute": {
    object (CommonInStreamAttribute)
  },
  "customParameters": {
    string: string,
    ...
  }
}
Pola
commonInStreamAttribute

object (CommonInStreamAttribute)

Typowe atrybuty reklam.

customParameters

map (key: string, value: string)

Parametry niestandardowe służące do przekazywania wartości niestandardowych do szablonu linku monitorującego.

Obiekt zawierający listę par "key": value. Przykład: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

CommonInStreamAttribute

Typowe atrybuty reklam In-Stream, reklam niemożliwych do pominięcia i bumperów reklamowych.

Zapis JSON
{
  "displayUrl": string,
  "finalUrl": string,
  "trackingUrl": string,
  "actionButtonLabel": string,
  "actionHeadline": string,
  "video": {
    object (YoutubeVideoDetails)
  },
  "companionBanner": {
    object (ImageAsset)
  }
}
Pola
displayUrl

string

Adres strony internetowej widoczny w reklamie.

finalUrl

string

Adres URL strony internetowej, na którą użytkownik trafia po kliknięciu reklamy.

trackingUrl

string

Adres URL wczytywany w tle na potrzeby śledzenia.

actionButtonLabel

string

Tekst na przycisku wezwania do działania.

actionHeadline

string

Nagłówek banera z wezwaniem do działania.

video

object (YoutubeVideoDetails)

Film reklamy w YouTube.

companionBanner

object (ImageAsset)

Obraz wyświetlany obok reklamy wideo.

ImageAsset

Metadane komponentu z obrazem.

Zapis JSON
{
  "mimeType": string,
  "fullSize": {
    object (Dimensions)
  },
  "fileSize": string
}
Pola
mimeType

string

Typ MIME zasobu graficznego.

fullSize

object (Dimensions)

Metadane tego obrazu w oryginalnym rozmiarze.

fileSize

string (int64 format)

Rozmiar pliku komponentu z obrazem w bajtach.

NonSkippableAd

Szczegóły reklamy niemożliwej do pominięcia.

Zapis JSON
{
  "commonInStreamAttribute": {
    object (CommonInStreamAttribute)
  },
  "customParameters": {
    string: string,
    ...
  }
}
Pola
commonInStreamAttribute

object (CommonInStreamAttribute)

Typowe atrybuty reklam.

customParameters

map (key: string, value: string)

Parametry niestandardowe służące do przekazywania wartości niestandardowych do szablonu linku monitorującego.

Obiekt zawierający listę par "key": value. Przykład: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

BumperAd

Szczegóły bumpera reklamowego.

Zapis JSON
{
  "commonInStreamAttribute": {
    object (CommonInStreamAttribute)
  }
}
Pola
commonInStreamAttribute

object (CommonInStreamAttribute)

Typowe atrybuty reklam.

AudioAd

Szczegóły reklamy audio.

Zapis JSON
{
  "displayUrl": string,
  "finalUrl": string,
  "trackingUrl": string,
  "video": {
    object (YoutubeVideoDetails)
  }
}
Pola
displayUrl

string

Adres strony internetowej widoczny w reklamie.

finalUrl

string

Adres URL strony internetowej, na którą użytkownik trafia po kliknięciu reklamy.

trackingUrl

string

Adres URL wczytywany w tle na potrzeby śledzenia.

video

object (YoutubeVideoDetails)

Film reklamy w YouTube.

VideoDiscoveryAd

Szczegóły reklamy wideo Discovery.

Zapis JSON
{
  "headline": string,
  "description1": string,
  "description2": string,
  "video": {
    object (YoutubeVideoDetails)
  },
  "thumbnail": enum (Thumbnail)
}
Pola
headline

string

Nagłówek reklamy.

description1

string

Pierwszy wiersz tekstu reklamy.

description2

string

Drugi wiersz tekstu reklamy.

video

object (YoutubeVideoDetails)

Film w YouTube promowany przez reklamę.

thumbnail

enum (Thumbnail)

Miniatura obrazu użytego w reklamie.

miniaturę;

Możliwe opcje miniatur w reklamach wideo Discovery.

Wartości w polu enum
THUMBNAIL_UNSPECIFIED Nieznane lub nieokreślone.
THUMBNAIL_DEFAULT Domyślna miniatura może być wygenerowana automatycznie lub przesłana przez użytkownika.
THUMBNAIL_1 Miniatura 1 wygenerowana z filmu.
THUMBNAIL_2 Miniatura 2 wygenerowana z filmu.
THUMBNAIL_3 Miniatura 3 wygenerowana z filmu.

VideoPerformanceAd

Szczegóły reklamy wideo nastawionej na skuteczność.

Zapis 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)
    }
  ]
}
Pola
finalUrl

string

Adres URL strony internetowej, na którą użytkownik trafia po kliknięciu reklamy.

trackingUrl

string

Adres URL wczytywany w tle na potrzeby śledzenia.

actionButtonLabels[]

string

Lista komponentów tekstowych wyświetlanych po kliknięciu przycisku wezwania do działania.

headlines[]

string

Lista nagłówków wyświetlana na banerze z wezwaniem do działania.

longHeadlines[]

string

Lista pojedynczych nagłówków wyświetlanych na banerze z wezwaniem do działania.

descriptions[]

string

Lista opisów wyświetlanych na banerze z wezwaniem do działania.

displayUrlBreadcrumb1

string

Pierwszy element w wyświetlanym adresie URL po domenie.

displayUrlBreadcrumb2

string

Drugi element po domenie w wyświetlanym adresie URL.

domain

string

Domena wyświetlanego adresu URL.

videos[]

object (YoutubeVideoDetails)

Lista komponentów wideo w YouTube użytych w tej reklamie.

customParameters

map (key: string, value: string)

Parametry niestandardowe służące do przekazywania wartości niestandardowych do szablonu linku monitorującego.

Obiekt zawierający listę par "key": value. Przykład: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

companionBanners[]

object (ImageAsset)

Lista banerów towarzyszących używanych przez tę reklamę.

AdUrl

Dodatkowe adresy URL związane z reklamą, w tym obrazy typu beacon.

Zapis JSON
{
  "type": enum (AdUrlType),
  "url": string
}
Pola
type

enum (AdUrlType)

Typ adresu URL reklamy.

url

string

Wartość ciągu tekstowego adresu URL.

AdUrlType

Możliwe typy adresów URL reklam.

Wartości w polu enum
AD_URL_TYPE_UNSPECIFIED Nieznane lub nieokreślone.
AD_URL_TYPE_BEACON_IMPRESSION Piksel śledzący 1 x 1 do pingowania po wyświetleniu kreacji.
AD_URL_TYPE_BEACON_EXPANDABLE_DCM_IMPRESSION Rozwijany obraz typu beacon wyświetleń DCM. Podczas wyświetlania rozszerza się na kilka obrazów typu beacon.
AD_URL_TYPE_BEACON_CLICK Link monitorujący wysyłany po wywołaniu zdarzenia kliknięcia.
AD_URL_TYPE_BEACON_SKIP Link monitorujący wysyłany po wywołaniu zdarzenia pominięcia.

Metody

get

Pobiera reklamę z grupy reklam w YouTube.

list

Wyświetla listę reklam z grupy reklam w YouTube.