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 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 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 służy do zwiększania świadomości marki lub realizacji celów marketingowych związanych z docieraniem do odbiorców.
nonSkippableAd

object (NonSkippableAd)

Szczegóły niemożliwej do pominięcia krótkiej reklamy wideo In-Stream (od 6 do 15 sekund), która służy do osiągania celów marketingowych związanych z docieraniem do odbiorców.
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 służącej 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, która ma zachęcać użytkowników do podejmowania działań związanych z Twoją firmą, usługą lub produktem.

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 używany przez reklamę.
headline

string

Nagłówek reklamy.
description

string

Opis reklamy.
videoAspectRatio

enum (VideoAspectRatio)

Format obrazu automatycznie odtwarzanego filmu w YouTube na 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 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 wezwania 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. 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 wideo 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 Nieznany lub nieokreślony.
VIDEO_UNAVAILABLE_REASON_PRIVATE Ten film wideo jest prywatny.
VIDEO_UNAVAILABLE_REASON_DELETED Film został usunięty.

VideoAspectRatio

Możliwe formaty obrazu filmów 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 góra i dół są przycięte.
VIDEO_ASPECT_RATIO_FIXED_16_9 Film ma format 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 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

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 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 zasobu obrazu 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 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 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 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 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 z filmu.
THUMBNAIL_3 Miniatura 3 wygenerowana z filmu.

VideoPerformanceAd

Szczegóły reklamy wideo promującej działanie.

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ś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 pojedynczych 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

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 używanych 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 adresu URL.

AdUrlType

Możliwe typy adresów URL reklam

Wartości w polu enum
AD_URL_TYPE_UNSPECIFIED Nieznany lub nieokreślony.
AD_URL_TYPE_BEACON_IMPRESSION Piksel śledzący 1 x 1, który wysyła ping po wyświetleniu kreacji.
AD_URL_TYPE_BEACON_EXPANDABLE_DCM_IMPRESSION śledzenia wyświetleń (beacon) rozwijanej reklamy DCM. W momencie wyświetlania jest ona rozszerzana do kilku beaconów.
AD_URL_TYPE_BEACON_CLICK Adres URL śledzenia, który ma być pingowany po wywołaniu zdarzenia kliknięcia.
AD_URL_TYPE_BEACON_SKIP Śledzenie adresu URL, który należy pingować po wywołaniu zdarzenia pominięcia.

Metody

get

 Pobiera reklamę z grupy reklam.

list

 Wyświetla reklamy w grupie reklam.