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. Przypisany 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 standardzie 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 unii ad_details. Szczegóły reklamy. ad_details może być tylko jednym z tych elementów:
displayVideoSourceAd

object (DisplayVideoSourceAd)

Szczegóły reklamy pochodzącej z sieci reklamowej & Kreacja wideo 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, wykorzystywane do celów marketingowych związanych ze świadomością marki lub osiąganiem celów.
nonSkippableAd

object (NonSkippableAd)

Szczegóły krótkiej reklamy wideo In-Stream niemożliwej do pominięcia, trwającej od 6 do 15 sekund, wykorzystywane do celów marketingowych związanych z zasięgiem.
bumperAd

object (BumperAd)

Szczegóły niemożliwej do pominięcia krótkiej reklamy wideo o długości do 6 sekund, która służy do zwiększania zasięgu.
audioAd

object (AudioAd)

Szczegóły reklamy audio używanej do realizacji celów marketingowych związanych z osiąganiem zasięgu.
videoDiscoverAd

object (VideoDiscoveryAd)

Szczegóły reklamy promującej film, która wyświetla się w miejscach do odkrywania treści.
videoPerformanceAd

object (VideoPerformanceAd)

Szczegóły reklamy używanej w kampanii wideo zachęcającej do działania w celu zachęcania do działania względem firmy, usługi lub produktu.

DisplayVideoSourceAd

Reklama pochodząca z kreacji DV360.

Zapis JSON 
{
  "creativeId": string
}
Pola
creativeId

string (int64 format)

Identyfikator kreacji źródłowej.

MastheadAd

Szczegóły reklamy w mastheadzie

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, z którego korzysta reklama.
headline

string

Nagłówek reklamy.
description

string

Opis reklamy.
videoAspectRatio

enum (VideoAspectRatio)

Format obrazu automatycznie odtwarzanego filmu w YouTube w mastheadzie.
autoplayVideoStartMillisecond

string (int64 format)

Wyrażony w milisekundach czas, po którym rozpocznie się odtwarzanie filmu.
autoplayVideoDuration

string (Duration format)

Czas, przez jaki film będzie się automatycznie odtwarzać.

Czas w sekundach z maksymalnie 9 miejscami po przecinku, zakończony literą „s”. Przykład: "3.5s".
callToActionButtonLabel

string

Tekst na przycisku z wezwaniem do działania.
callToActionFinalUrl

string

Docelowy adres URL przycisku z wezwaniem do działania.
callToActionTrackingUrl

string

Adres URL śledzenia przycisku wezwania do działania.
showChannelArt

boolean

Określa, czy wyświetlać tło czy baner wyświetlany u góry strony YouTube.
companionYoutubeVideos[]

object (YoutubeVideoDetails)

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

YoutubeVideoDetails

szczegóły filmu w YouTube,

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

string

Identyfikator filmu w YouTube, który można wyszukać na stronie YouTube.
unavailableReason

enum (VideoUnavailableReason)

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

VideoUnavailableReason

Możliwe przyczyny, dla których film może być niedostępny.

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

VideoAspectRatio

Możliwe formaty obrazu dla filmu w YouTube.

Wartości w polu enum
VIDEO_ASPECT_RATIO_UNSPECIFIED Nie określono lub nie wiadomo.
VIDEO_ASPECT_RATIO_WIDESCREEN Film zostanie rozciągnięty, a jego góra i dół zostaną 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, na którą użytkownik trafia po kliknięciu reklamy.
trackingUrl

string

Adres URL wczytany 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 z reklamą 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 komponentu z obrazem.
fullSize

object (Dimensions)

Metadane tego obrazu w jego oryginalnym rozmiarze.
fileSize

string (int64 format)

Rozmiar pliku komponentu z obrazem w bajtach.

NonSkippableAd

Szczegółowe informacje o reklamie 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ółowe informacje o bumperze reklamowym.

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

object (CommonInStreamAttribute)

Typowe atrybuty reklamy

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, na którą użytkownik trafia po kliknięciu reklamy.
trackingUrl

string

Adres URL wczytany w tle na potrzeby śledzenia.
video

object (YoutubeVideoDetails)

Film z reklamą 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, który promuje reklama.
thumbnail

enum (Thumbnail)

Miniatura użyta w reklamie.

Miniatura

Możliwe opcje miniatur w reklamach wideo Discovery

Wartości w polu enum
THUMBNAIL_UNSPECIFIED Nieznany lub nieokreślony.
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 na podstawie filmu
THUMBNAIL_3 Miniatura 3 wygenerowana z filmu.

VideoPerformanceAd

Szczegóły dotyczące efektywnościowej reklamy wideo.

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, na którą użytkownik trafia po kliknięciu reklamy.
trackingUrl

string

Adres URL wczytany w tle na potrzeby śledzenia.
actionButtonLabels[]

string

Lista komponentów tekstowych wyświetlających się po kliknięciu przycisku wezwania do działania.
headlines[]

string

Lista nagłówków wyświetlanych 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 tekstów reklamy wyświetlanych na banerze z wezwaniem do działania.
displayUrlBreadcrumb1

string

Pierwszy element po domenie w wyświetlanym adresie URL.
displayUrlBreadcrumb2

string

Druga część po domenie w wyświetlanym adresie URL.
domain

string

Domena wyświetlanego adresu URL.
videos[]

object (YoutubeVideoDetails)

Lista komponentów wideo w YouTube wykorzystywanych przez tę 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" }.
companionBanners[]

object (ImageAsset)

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

AdUrl

dodatkowe adresy URL powiązane z reklamą, w tym beacony;

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 Nieznana lub nieokreślona.
AD_URL_TYPE_BEACON_IMPRESSION Piksel śledzący 1 x 1, który ma być pingowany po wyświetleniu kreacji.
AD_URL_TYPE_BEACON_EXPANDABLE_DCM_IMPRESSION Rozwijany obraz typu beacon dla wyświetleń DCM. W momencie wyświetlenia reklamy rozwija się do kilku obrazów typu beacon.
AD_URL_TYPE_BEACON_CLICK Adres URL śledzenia, który ma być pingowany po wywołaniu zdarzenia kliknięcia.
AD_URL_TYPE_BEACON_SKIP Link monitorujący na żądanie ping po wywołaniu zdarzenia pominięcia.

Metody

get

 Pobiera reklamę z grupy reklam w YouTube.

list

 Wyświetla listę reklam w grupach reklam w YouTube.