REST Resource: advertisers.adGroupAds

Zasób: AdGroupAd

Pojedyncza reklama powiązana z grupą reklam.

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 formacie UTF-8 i mieć maksymalny rozmiar 255 bajtów.
entityStatus

enum (EntityStatus)

Stan reklamy.
adUrls[]

object (AdUrl)

Lista adresów URL używanych przez reklamę.
Pole zbiorcze ad_details. Szczegóły reklamy. ad_details może mieć tylko jedną z tych wartości:
displayVideoSourceAd

object (DisplayVideoSourceAd)

Szczegóły reklamy pochodzącej z kreacji Display & Video 360.
mastheadAd

object (MastheadAd)

Szczegóły reklamy 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 jest używana do osiągania 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 i jest używana do realizacji 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 nieprzekraczającej 6 sekund, która jest używana do zwiększania zasięgu.
audioAd

object (AudioAd)

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

object (VideoDiscoveryAd)

Szczegóły reklamy promującej film, która wyświetla się w miejscach, w których użytkownicy odkrywają treści.
videoPerformanceAd

object (VideoPerformanceAd)

Szczegóły reklamy 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 Twoją 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żywany przez reklamę.
headline

string

Nagłówek reklamy.
description

string

Opis reklamy.
videoAspectRatio

enum (VideoAspectRatio)

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

string (int64 format)

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

string (Duration format)

Czas, przez jaki film będzie odtwarzany automatycznie.

Czas trwania w sekundach z maksymalnie 9 miejscami po przecinku, zakończony znakiem „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 ma być wyświetlane tło lub baner u góry strony w YouTube.
companionYoutubeVideos[]

object (YoutubeVideoDetails)

Filmy wyświetlane obok reklamy w banerze masthead na komputerach. 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)

Przyczyna niedostępności danych o filmie.

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 zostanie usunięty.

VideoAspectRatio

Możliwe formaty obrazu filmu w YouTube.

Wartości w polu enum
VIDEO_ASPECT_RATIO_UNSPECIFIED Nieokreślony lub nieznany.
VIDEO_ASPECT_RATIO_WIDESCREEN Film jest rozciągnięty, a jego górna i dolna część są 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 reklamy.
customParameters

map (key: string, value: string)

Parametry niestandardowe 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

Wspólne 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 ładowany w tle na potrzeby śledzenia.
actionButtonLabel

string

Tekst na przycisku z wezwaniem do działania.
actionHeadline

string

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

object (YoutubeVideoDetails)

Film w YouTube, który jest reklamą.
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 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 reklamy.
customParameters

map (key: string, value: string)

Parametry niestandardowe 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 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 ładowany w tle na potrzeby śledzenia.
video

object (YoutubeVideoDetails)

Film w YouTube, który jest reklamą.

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

Druga linia tekstu reklamy.
video

object (YoutubeVideoDetails)

Film w YouTube, który jest promowany przez reklamę.
thumbnail

enum (Thumbnail)

Miniatura używana w reklamie.

Miniatura

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 na podstawie filmu.
THUMBNAIL_3 Miniatura 3 wygenerowana z filmu.

VideoPerformanceAd

Szczegóły reklamy wideo zachęcającej do działania.

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 ładowany w tle na potrzeby śledzenia.
actionButtonLabels[]

string

Lista komponentów tekstowych wyświetlanych na przycisku z wezwaniem do działania.
headlines[]

string

Lista nagłówków wyświetlanych na banerze wezwania do działania.
longHeadlines[]

string

Lista samodzielnych nagłówków wyświetlanych na banerze wezwania do działania.
descriptions[]

string

Lista opisów wyświetlanych na banerze wezwania do działania.
displayUrlBreadcrumb1

string

Pierwsza część wyświetlanego adresu 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 z filmem w YouTube używanych przez tę reklamę.
customParameters

map (key: string, value: string)

Parametry niestandardowe 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 sygnały.

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

enum (AdUrlType)

Typ adresu URL reklamy.
url

string

Wartość ciągu URL.

AdUrlType

Możliwe typy adresów URL reklamy.

Wartości w polu enum
AD_URL_TYPE_UNSPECIFIED Nieznane lub nieokreślone.
AD_URL_TYPE_BEACON_IMPRESSION Piksel śledzący 1 x 1, który wysyła sygnał ping, gdy wyświetlenie kreacji zostanie zrealizowane.
AD_URL_TYPE_BEACON_EXPANDABLE_DCM_IMPRESSION Śledzenie wyświetleń (beacon) rozwijanej reklamy DCM. W momencie wyświetlania reklamy jest ona rozwijana do kilku sygnałów.
AD_URL_TYPE_BEACON_CLICK Link monitorujący, który należy wysłać pingiem po aktywowaniu zdarzenia kliknięcia.
AD_URL_TYPE_BEACON_SKIP Adres URL śledzenia, który należy pingować po wywołaniu zdarzenia pominięcia.

Metody

get

 Pobiera reklamę w grupie reklam.

list

 Wyświetla reklamy w grupie reklam.