REST Resource: advertisers.creatives

Zasób: kreacja

jedną kreację,

Zapis JSON
{
  "name": string,
  "advertiserId": string,
  "creativeId": string,
  "cmPlacementId": string,
  "displayName": string,
  "entityStatus": enum (EntityStatus),
  "updateTime": string,
  "createTime": string,
  "creativeType": enum (CreativeType),
  "hostingSource": enum (HostingSource),
  "dynamic": boolean,
  "dimensions": {
    object (Dimensions)
  },
  "additionalDimensions": [
    {
      object (Dimensions)
    }
  ],
  "mediaDuration": string,
  "creativeAttributes": [
    enum (CreativeAttribute)
  ],
  "reviewStatus": {
    object (ReviewStatusInfo)
  },
  "assets": [
    {
      object (AssetAssociation)
    }
  ],
  "exitEvents": [
    {
      object (ExitEvent)
    }
  ],
  "timerEvents": [
    {
      object (TimerEvent)
    }
  ],
  "counterEvents": [
    {
      object (CounterEvent)
    }
  ],
  "appendedTag": string,
  "integrationCode": string,
  "notes": string,
  "iasCampaignMonitoring": boolean,
  "companionCreativeIds": [
    string
  ],
  "skippable": boolean,
  "skipOffset": {
    object (AudioVideoOffset)
  },
  "progressOffset": {
    object (AudioVideoOffset)
  },
  "universalAdId": {
    object (UniversalAdId)
  },
  "thirdPartyUrls": [
    {
      object (ThirdPartyUrl)
    }
  ],
  "transcodes": [
    {
      object (Transcode)
    }
  ],
  "trackerUrls": [
    string
  ],
  "jsTrackerUrl": string,
  "cmTrackingAd": {
    object (CmTrackingAd)
  },
  "obaIcon": {
    object (ObaIcon)
  },
  "thirdPartyTag": string,
  "requireMraid": boolean,
  "requireHtml5": boolean,
  "requirePingForAttribution": boolean,
  "expandingDirection": enum (ExpandingDirection),
  "expandOnHover": boolean,
  "vastTagUrl": string,
  "vpaid": boolean,
  "html5Video": boolean,
  "lineItemIds": [
    string
  ],
  "mp3Audio": boolean,
  "oggAudio": boolean,
  "syntheticContentAttestationStatus": enum (SyntheticContentAttestationStatus)
}
Pola
name

string

Tylko dane wyjściowe. Nazwa zasobu kreacji.

advertiserId

string (int64 format)

Tylko dane wyjściowe. Unikalny identyfikator reklamodawcy, do którego należy kreacja.

creativeId

string (int64 format)

Tylko dane wyjściowe. Unikalny identyfikator kreacji. Przypisany przez system.

cmPlacementId

string (int64 format)

Tylko dane wyjściowe. Unikalny identyfikator miejsca docelowego w usłudze Campaign Manager 360 powiązanego z kreacją. To pole dotyczy tylko kreacji synchronizowanych z Campaign Managera.

displayName

string

Wymagane. Wyświetlana nazwa kreacji.

Musi być zakodowany w formacie UTF-8 i mieć maksymalny rozmiar 240 bajtów.

entityStatus

enum (EntityStatus)

Wymagane. Określa, czy kreacja może się wyświetlać.

Akceptowane wartości to:

  • ENTITY_STATUS_ACTIVE
  • ENTITY_STATUS_ARCHIVED
  • ENTITY_STATUS_PAUSED
updateTime

string (Timestamp format)

Tylko dane wyjściowe. Sygnatura czasowa ostatniej aktualizacji kreacji przez użytkownika lub system (np. w ramach sprawdzania kreacji). Przypisany przez system.

Korzysta ze standardu RFC 3339, w którym wygenerowane dane wyjściowe są zawsze znormalizowane do formatu Z i zawierają 0, 3, 6 lub 9 cyfr po przecinku. Akceptowane są też przesunięcia inne niż „Z”. Przykłady: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" lub "2014-10-02T15:01:23+05:30".

createTime

string (Timestamp format)

Tylko dane wyjściowe. Sygnatura czasowa utworzenia kreacji. Przypisany przez system.

Korzysta ze standardu RFC 3339, w którym wygenerowane dane wyjściowe są zawsze znormalizowane do formatu Z i zawierają 0, 3, 6 lub 9 cyfr po przecinku. Akceptowane są też przesunięcia inne niż „Z”. Przykłady: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" lub "2014-10-02T15:01:23+05:30".

creativeType

enum (CreativeType)

Wymagane. Niezmienne. Typ kreacji.

hostingSource

enum (HostingSource)

Wymagane. Wskazuje, gdzie jest hostowana kreacja.

dynamic

boolean

Tylko dane wyjściowe. Wskazuje, czy kreacja jest dynamiczna.

dimensions

object (Dimensions)

Wymagane. Podstawowe wymiary kreacji. Dotyczy wszystkich typów kreacji. Wartości widthPixels i heightPixels domyślnie wynoszą 0, gdy creativeType ma jedną z tych wartości:

  • CREATIVE_TYPE_VIDEO
  • CREATIVE_TYPE_AUDIO
  • CREATIVE_TYPE_NATIVE_VIDEO
additionalDimensions[]

object (Dimensions)

Opcjonalnie: Dodatkowe wymiary. Dotyczy, gdy creativeType ma jedną z tych wartości:

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_EXPANDABLE
  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_LIGHTBOX
  • CREATIVE_TYPE_PUBLISHER_HOSTED

Jeśli to pole jest określone, wymagane są zarówno wartości widthPixels, jak i heightPixels, które muszą być większe od 0 lub równe 0.

mediaDuration

string (Duration format)

Tylko dane wyjściowe. Czas trwania multimediów kreacji. Dotyczy, gdy creativeType ma jedną z tych wartości:

  • CREATIVE_TYPE_VIDEO
  • CREATIVE_TYPE_AUDIO
  • CREATIVE_TYPE_NATIVE_VIDEO
  • CREATIVE_TYPE_PUBLISHER_HOSTED

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

creativeAttributes[]

enum (CreativeAttribute)

Tylko dane wyjściowe. Lista atrybutów kreacji wygenerowana przez system.

reviewStatus

object (ReviewStatusInfo)

Tylko dane wyjściowe. Bieżący stan procesu sprawdzania kreacji.

assets[]

object (AssetAssociation)

Wymagane. Komponenty powiązane z tą kreacją.

exitEvents[]

object (ExitEvent)

Wymagane. Zdarzenia wyjścia dla tej kreacji. Wyjście (nazywane też tagiem kliknięcia) to dowolny obszar w kreacji, który można kliknąć lub dotknąć, aby otworzyć stronę docelową reklamodawcy. Każda kreacja musi zawierać co najmniej 1 wyjście. Wyjście możesz dodać do kreacji na jeden z tych sposobów:

  • Użyj obszaru kliknięcia w Google Web Designerze.
  • Zdefiniuj zmienną JavaScript o nazwie „clickTag”.
  • Do śledzenia wyjść w formatach rich media używaj komponentu Enabler (Enabler.exit()).
timerEvents[]

object (TimerEvent)

Opcjonalnie: Niestandardowe zdarzenia licznika czasu w kreacji multimedialnej. Liczniki czasu śledzą czas, w którym użytkownik ogląda określoną część kreacji multimedialnej i wchodzi z nią w interakcję. Kreacja może zawierać wiele zdarzeń stopera. Czas każdego z nich mierzymy osobno. Pozostaw to pole puste lub nie ustawiaj go w przypadku kreacji zawierających tylko komponenty z obrazem.

counterEvents[]

object (CounterEvent)

Opcjonalnie: Zdarzenia licznika kreacji multimedialnej. Liczniki śledzą liczbę interakcji użytkownika z dowolną częścią kreacji multimedialnej w określony sposób (najechanie kursorem myszy na reklamę, wyjechanie poza nią, kliknięcie, dotknięcie, wczytanie danych, użycie klawiatury itp.). Za pomocą licznika można rejestrować wszystkie zdarzenia, które da się przechwycić w kreacji. Pozostaw to pole puste lub nie ustawiaj go w przypadku kreacji zawierających tylko komponenty z obrazem.

appendedTag

string

Opcjonalnie: Tag śledzenia HTML firmy zewnętrznej, który ma zostać dołączony do tagu kreacji.

integrationCode

string

Opcjonalnie: Informacje o identyfikatorze używane do powiązania tej kreacji z systemem zewnętrznym. Musi być zakodowany w formacie UTF-8 i mieć maksymalnie 10 000 znaków.

notes

string

Opcjonalnie: Uwagi użytkownika dotyczące tej kreacji. Musi być zakodowany w formacie UTF-8 i mieć maksymalnie 20 000 znaków.

iasCampaignMonitoring

boolean

Opcjonalnie: Wskazuje, czy monitorowanie kampanii Integral Ad Science (IAS) jest włączone. Aby włączyć tę funkcję w przypadku kreacji, upewnij się, że w parametrze Advertiser.creative_config.ias_client_id ustawiono identyfikator klienta IAS.

companionCreativeIds[]

string (int64 format)

Opcjonalnie: Identyfikatory kreacji towarzyszących kreacji wideo.

Możesz dodać istniejące kreacje displayowe (z zasobami graficznymi lub HTML5), które będą wyświetlane w odtwarzaczu wydawcy. Kreacje towarzyszące wyświetlają się podczas odtwarzania filmu i po jego zakończeniu.

Kreacje zawierające additional dimensions nie mogą być kreacjami towarzyszącymi.

To pole jest obsługiwane tylko w przypadku tych creativeType:

  • CREATIVE_TYPE_AUDIO
  • CREATIVE_TYPE_VIDEO
skippable

boolean

Opcjonalnie: Określa, czy użytkownik może pominąć kreację wideo.

To pole jest obsługiwane tylko w przypadku tych creativeType:

  • CREATIVE_TYPE_VIDEO
skipOffset

object (AudioVideoOffset)

Opcjonalnie: Czas odtwarzania filmu do momentu wyświetlenia przycisku pominięcia.

To pole jest wymagane, gdy wartość skippable to „true”.

To pole jest obsługiwane tylko w przypadku tych creativeType:

  • CREATIVE_TYPE_VIDEO
progressOffset

object (AudioVideoOffset)

Opcjonalnie: Czas odtwarzania filmu przed zaliczeniem wyświetlenia.

To pole jest wymagane, gdy wartość skippable to „true”.

To pole jest obsługiwane tylko w przypadku tych creativeType:

  • CREATIVE_TYPE_VIDEO
universalAdId

object (UniversalAdId)

Opcjonalnie: Opcjonalny identyfikator kreacji podany przez rejestr, który jest niepowtarzalny na wszystkich platformach.

Uniwersalny identyfikator reklamy jest częścią standardu VAST 4.0. Można ją zmienić po utworzeniu kreacji.

To pole jest obsługiwane tylko w przypadku tych creativeType:

  • CREATIVE_TYPE_VIDEO
thirdPartyUrls[]

object (ThirdPartyUrl)

Opcjonalnie: linki monitorujące firm zewnętrznych, które służą do śledzenia interakcji z kreacją wideo.

To pole jest obsługiwane tylko w przypadku tych creativeType:

  • CREATIVE_TYPE_AUDIO
  • CREATIVE_TYPE_VIDEO
  • CREATIVE_TYPE_NATIVE_VIDEO
transcodes[]

object (Transcode)

Tylko dane wyjściowe. transkodowanie audio/wideo;

Transkoduje główny komponent na kilka wersji dodatkowych, które mają inny format lub zmienione właściwości (rozdzielczość oraz szybkość transmisji bitów obrazu i dźwięku) dobrane pod kątem określonych odtwarzaczy wideo lub przepustowości.

Dzięki temu system wydawcy ma więcej możliwości do wyboru podczas wyświetlania filmu. Możesz mieć pewność, że wyświetli się odpowiedni plik dopasowany do połączenia, z którego korzysta użytkownik, oraz do rozmiaru ekranu.

To pole jest obsługiwane tylko w tych creativeType:

  • CREATIVE_TYPE_VIDEO
  • CREATIVE_TYPE_NATIVE_VIDEO
  • CREATIVE_TYPE_AUDIO
trackerUrls[]

string

Opcjonalnie: linki monitorujące dla dostawców usług analitycznych lub zewnętrznych dostawców technologii reklamowej;

Adresy URL muszą zaczynać się od https: (z wyjątkiem zasobów reklamowych, które nie wymagają zgodności z protokołem SSL). Jeśli w adresach URL stosujesz makra, używaj tylko tych obsługiwanych przez Display & Video 360.

Można używać tylko standardowych adresów URL, a nie tagów IMG czy SCRIPT.

To pole można zapisywać tylko w tych creativeType:

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
jsTrackerUrl

string

Opcjonalnie: Adres URL pomiaru JavaScript od obsługiwanych dostawców zewnętrznych systemów weryfikacji (ComScore, DoubleVerify, IAS, Moat). Tagi skryptu HTML nie są obsługiwane.

To pole można zapisywać tylko w tych creativeType:

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
cmTrackingAd

object (CmTrackingAd)

Opcjonalnie: Reklama śledząca Campaign Managera 360 powiązana z kreacją.

Opcjonalne w przypadku tych creativeType, które zostały utworzone przez reklamodawcę korzystającego zarówno z Campaign Managera 360, jak i z wyświetlania reklam firm zewnętrznych:

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE

W innych przypadkach tylko dane wyjściowe.

obaIcon

object (ObaIcon)

Opcjonalnie: Określa ikonę OBA w przypadku kreacji wideo.

To pole jest obsługiwane tylko w tych creativeType:

  • CREATIVE_TYPE_VIDEO
thirdPartyTag

string

Opcjonalnie: Oryginalny tag usługi zewnętrznej używany w kreacji.

Wymagany i ważny tylko w przypadku kreacji z tagiem usługi zewnętrznej.

Kreacje z tagiem usługi zewnętrznej to kreacje z tymi cechami:hostingSource

  • HOSTING_SOURCE_THIRD_PARTY

w połączeniu z tymi danymi creativeType:

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_EXPANDABLE
requireMraid

boolean

Opcjonalnie: Wskazuje, że kreacja wymaga MRAID (specyfikacji Mobile Rich Media Ad Interface Definitions).

Ustaw tę opcję, jeśli kreacja wymaga interakcji za pomocą gestów na urządzeniu mobilnym, takich jak przesuwanie lub klikanie.

Opcjonalny i ważny tylko w przypadku kreacji z tagiem usługi zewnętrznej.

Kreacje z tagiem usługi zewnętrznej to kreacje z tymi cechami:hostingSource

  • HOSTING_SOURCE_THIRD_PARTY

w połączeniu z tymi danymi creativeType:

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_EXPANDABLE
requireHtml5

boolean

Opcjonalnie: Wskazuje, że kreacja wymaga HTML5, aby renderować się prawidłowo.

Opcjonalny i ważny tylko w przypadku kreacji z tagiem usługi zewnętrznej. Kreacje z tagiem usługi zewnętrznej to kreacje z tymi cechami:hostingSource

  • HOSTING_SOURCE_THIRD_PARTY

w połączeniu z tymi danymi creativeType:

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_EXPANDABLE
requirePingForAttribution

boolean

Opcjonalnie: Wskazuje, że kreacja będzie czekać na ping zwrotny na potrzeby atrybucji.

Prawidłowe tylko w przypadku używania reklamy śledzącej Campaign Managera 360 z parametrem serwera reklamowego firmy zewnętrznej i makrem ${DC_DBM_TOKEN}.

Opcjonalny i ważny tylko w przypadku kreacji z tagami innych firm lub kreacji z tagami VAST innych firm.

Kreacje z tagiem usługi zewnętrznej to kreacje z tymi cechami:hostingSource

  • HOSTING_SOURCE_THIRD_PARTY

w połączeniu z tymi danymi creativeType:

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_EXPANDABLE

Kreacje z tagami VAST innych firm to kreacje, które mają te cechy:hostingSource

  • HOSTING_SOURCE_THIRD_PARTY

w połączeniu z tymi danymi creativeType:

  • CREATIVE_TYPE_AUDIO
  • CREATIVE_TYPE_VIDEO
expandingDirection

enum (ExpandingDirection)

Opcjonalnie: Określa kierunek rozwijania kreacji.

Wymagany i ważny tylko w przypadku kreacji rozwijanych innych firm.

Kreacje rozwijane innych firm to kreacje, których źródłem hostingu jest:

  • HOSTING_SOURCE_THIRD_PARTY

w połączeniu z tymi danymi creativeType:

  • CREATIVE_TYPE_EXPANDABLE
expandOnHover

boolean

Opcjonalnie: Wskazuje, że kreacja automatycznie rozwinie się po najechaniu na nią kursorem.

Opcjonalny i ważny tylko w przypadku kreacji rozwijanych innych firm. Kreacje rozwijane innych firm to kreacje, których źródłem hostingu jest:

  • HOSTING_SOURCE_THIRD_PARTY

w połączeniu z tymi danymi creativeType:

  • CREATIVE_TYPE_EXPANDABLE
vastTagUrl

string

Opcjonalnie: Adres URL tagu VAST w przypadku kreacji z tagiem VAST firmy zewnętrznej.

Wymagany i ważny tylko w przypadku kreacji z tagiem VAST innej firmy.

Kreacje z tagami VAST innych firm to kreacje, które mają te cechy:hostingSource

  • HOSTING_SOURCE_THIRD_PARTY

w połączeniu z tymi danymi creativeType:

  • CREATIVE_TYPE_AUDIO
  • CREATIVE_TYPE_VIDEO
vpaid

boolean

Tylko dane wyjściowe. Wskazuje, że kreacja tagu VAST firmy zewnętrznej wymaga VPAID (Digital Video Player-Ad Interface).

Tylko dane wyjściowe i tylko w przypadku kreacji z tagami VAST innych firm.

Kreacje z tagami VAST innych firm to kreacje, które mają te cechy:hostingSource

  • HOSTING_SOURCE_THIRD_PARTY

w połączeniu z tymi danymi creativeType:

  • CREATIVE_TYPE_VIDEO
html5Video

boolean

Tylko dane wyjściowe. Wskazuje, że kreacja tagu VAST innej firmy wymaga obsługi wideo HTML5.

Tylko dane wyjściowe i tylko w przypadku kreacji z tagami VAST innych firm.

Kreacje z tagami VAST innych firm to kreacje, które mają te cechy:hostingSource

  • HOSTING_SOURCE_THIRD_PARTY

w połączeniu z tymi danymi creativeType:

  • CREATIVE_TYPE_VIDEO
lineItemIds[]

string (int64 format)

Tylko dane wyjściowe. Identyfikatory elementów zamówienia, z którymi jest powiązana ta kreacja.

Aby powiązać kreację z elementem zamówienia, użyj LineItem.creative_ids.

mp3Audio

boolean

Tylko dane wyjściowe. Wskazuje, że kreacja audio firmy zewnętrznej obsługuje format MP3.

Tylko dane wyjściowe i tylko w przypadku kreacji audio innych firm.

Kreacje audio innych firm to kreacje, które mają te cechy:hostingSource

  • HOSTING_SOURCE_THIRD_PARTY

w połączeniu z tymi danymi creativeType:

  • CREATIVE_TYPE_AUDIO
oggAudio

boolean

Tylko dane wyjściowe. Wskazuje, że kreacja audio firmy zewnętrznej obsługuje format OGG.

Tylko dane wyjściowe i tylko w przypadku kreacji audio innych firm.

Kreacje audio innych firm to kreacje, które mają te cechy:hostingSource

  • HOSTING_SOURCE_THIRD_PARTY

w połączeniu z tymi danymi creativeType:

  • CREATIVE_TYPE_AUDIO
syntheticContentAttestationStatus

enum (SyntheticContentAttestationStatus)

Opcjonalnie: Określa, czy do kreacji ma być dodawana etykieta informująca, że została ona utworzona lub edytowana za pomocą AI, gdy jest wyświetlana w regionach, w których obowiązują lokalne przepisy dotyczące oznaczania treści generowanych przez AI.

HostingSource

Możliwe źródła hostingu kreacji. Wskazuje, gdzie kreacja została utworzona i gdzie jest hostowana.

Wartości w polu enum
HOSTING_SOURCE_UNSPECIFIED Źródło hostingu nie jest określone lub jest nieznane w tej wersji.
HOSTING_SOURCE_CM

Kreacja zsynchronizowana z Campaign Managera 360.

Metody tworzenia i aktualizowania nie są obsługiwane w przypadku tego typu hostingu.

HOSTING_SOURCE_THIRD_PARTY

Kreacja hostowana przez serwer reklamowy firmy zewnętrznej.

Metody tworzenia i aktualizowania są obsługiwane w przypadku tego typu hostingu, jeśli creativeType jest jednym z tych elementów:

  • CREATIVE_TYPE_AUDIO
  • CREATIVE_TYPE_EXPANDABLE
  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_VIDEO
HOSTING_SOURCE_HOSTED

Kreacja utworzona w DV360 i hostowana przez Campaign Managera 360.

Metody tworzenia i aktualizowania są obsługiwane w przypadku tego typu hostingu, jeśli creativeType jest jednym z tych typów:

  • CREATIVE_TYPE_AUDIO
  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_VIDEO
HOSTING_SOURCE_RICH_MEDIA

Kreacja multimedialna utworzona w Studio i hostowana przez Campaign Managera 360.

Metody tworzenia i aktualizowania nie są obsługiwane w przypadku tego typu hostingu.

CreativeAttribute

Możliwe atrybuty kreacji.

Wartości w polu enum
CREATIVE_ATTRIBUTE_UNSPECIFIED Atrybut kreacji nie jest określony lub jest nieznany w tej wersji.
CREATIVE_ATTRIBUTE_VAST Kreacja jest kreacją VAST.
CREATIVE_ATTRIBUTE_VPAID_LINEAR Kreacja jest liniową kreacją VPAID.
CREATIVE_ATTRIBUTE_VPAID_NON_LINEAR Kreacja jest nielinearną kreacją VPAID.

ReviewStatusInfo

Sprawdź stany kreacji.

Zapis JSON
{
  "approvalStatus": enum (ApprovalStatus),
  "creativeAndLandingPageReviewStatus": enum (ReviewStatus),
  "contentAndPolicyReviewStatus": enum (ReviewStatus),
  "exchangeReviewStatuses": [
    {
      object (ExchangeReviewStatus)
    }
  ]
}
Pola
approvalStatus

enum (ApprovalStatus)

Oznacza podstawowe zatwierdzenie wymagane, aby kreacja mogła rozpocząć wyświetlanie. Podsumowanie creativeAndLandingPageReviewStatus i contentAndPolicyReviewStatus.

creativeAndLandingPageReviewStatus

enum (ReviewStatus)

Stan weryfikacji kreacji i strony docelowej.

contentAndPolicyReviewStatus

enum (ReviewStatus)

Stan weryfikacji treści i zgodności kreacji z zasadami.

exchangeReviewStatuses[]

object (ExchangeReviewStatus)

Stany sprawdzania kreacji na giełdzie.

Stan zatwierdzenia

Możliwe typy stanu zatwierdzenia. Jest to podsumowanie creativeAndLandingPageReviewStatus i contentAndPolicyReviewStatus.

Wartości w polu enum
APPROVAL_STATUS_UNSPECIFIED Wartość typu nie jest określona lub jest nieznana w tej wersji.
APPROVAL_STATUS_PENDING_NOT_SERVABLE Kreacja jest wciąż w trakcie sprawdzania i nie może być wyświetlana.
APPROVAL_STATUS_PENDING_SERVABLE Kreacja przeszła weryfikację kreacji i strony docelowej i może być wyświetlana, ale czeka na dodatkową weryfikację treści i zgodności z zasadami.
APPROVAL_STATUS_APPROVED_SERVABLE Zatwierdzona jest zarówno weryfikacja kreacji i strony docelowej, jak i weryfikacja treści i zgodności z zasadami. Kreacja może być wyświetlana.
APPROVAL_STATUS_REJECTED_NOT_SERVABLE Występuje problem z kreacją, który trzeba rozwiązać, zanim zostanie ona dopuszczona do wyświetlania.

ReviewStatus

Możliwe typy stanu weryfikacji.

Wartości w polu enum
REVIEW_STATUS_UNSPECIFIED Wartość typu nie jest określona lub jest nieznana w tej wersji.
REVIEW_STATUS_APPROVED Kreacja została zatwierdzona.
REVIEW_STATUS_REJECTED Kreacja zostanie odrzucona.
REVIEW_STATUS_PENDING Kreacja oczekuje na sprawdzenie.

ExchangeReviewStatus

Stan weryfikacji kreacji na giełdzie.

Zapis JSON
{
  "exchange": enum (Exchange),
  "status": enum (ReviewStatus)
}
Pola
exchange

enum (Exchange)

Giełda sprawdzająca kreację.

status

enum (ReviewStatus)

Stan weryfikacji giełdy.

AssetAssociation

Powiązanie komponentu z kreacją.

Zapis JSON
{
  "asset": {
    object (Asset)
  },
  "role": enum (AssetRole)
}
Pola
asset

object (Asset)

Opcjonalnie: Powiązany zasób.

role

enum (AssetRole)

Opcjonalnie: Rola tego komponentu w kreacji.

Komponent

pojedynczy komponent,

Zapis JSON
{
  "mediaId": string,
  "content": string
}
Pola
mediaId

string (int64 format)

Identyfikator multimediów przesłanego komponentu. Jest to unikalny identyfikator zasobu. Ten identyfikator można przekazywać do innych wywołań interfejsu API, np. creatives.create, aby powiązać komponent z kreacją.

Przestrzeń identyfikatorów multimediów została zaktualizowana 5 kwietnia 2023 r. Zaktualizuj identyfikatory multimediów zapisane w pamięci podręcznej przed 5 kwietnia 2023 r., pobierając nowy identyfikator multimediów z powiązanych kreacji lub ponownie przesyłając komponent.

content

string

Treść komponentu. W przypadku przesłanych komponentów treść jest ścieżką wyświetlania.

AssetRole

Rola tego komponentu w kreacji.

Wartości w polu enum
ASSET_ROLE_UNSPECIFIED Rola komponentu nie jest określona lub jest nieznana w tej wersji.
ASSET_ROLE_MAIN Komponent jest głównym komponentem kreacji.
ASSET_ROLE_BACKUP Komponent jest komponentem zapasowym kreacji.
ASSET_ROLE_POLITE_LOAD Zasób jest zasobem kreacji z kontrolą wczytywania.
ASSET_ROLE_HEADLINE

Nagłówek kreacji natywnej.

Parametr content musi być zakodowany w formacie UTF-8 i mieć maksymalnie 25 znaków.

Ta rola jest obsługiwana tylko w tych creativeType:

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
ASSET_ROLE_LONG_HEADLINE

Długi nagłówek kreacji natywnej.

Parametr content musi być zakodowany w formacie UTF-8 i mieć długość nie większą niż 50 znaków.

Ta rola jest obsługiwana tylko w tych creativeType:

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
ASSET_ROLE_BODY

Treść kreacji natywnej.

Parametr content musi być zakodowany w formacie UTF-8 i mieć długość nie większą niż 90 znaków.

Ta rola jest obsługiwana tylko w tych creativeType:

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
ASSET_ROLE_LONG_BODY

Długi tekst główny kreacji natywnej.

content musi być zakodowany w formacie UTF-8 i mieć długość nie większą niż 150 znaków.

Ta rola jest obsługiwana tylko w tych creativeType:

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
ASSET_ROLE_CAPTION_URL

Krótka, prosta wersja adresu URL strony docelowej, która będzie się wyświetlać w kreacji. Ten adres URL daje użytkownikom wyobrażenie o stronie, na którą trafią po kliknięciu kreacji.

Parametr content musi być zakodowany w formacie UTF-8 i mieć maksymalnie 30 znaków.

Jeśli np. adres URL strony docelowej to „http://www.example.com/page”, adres URL podpisu może mieć postać „example.com”. Protokół (http://) jest opcjonalny, ale adres URL nie może zawierać spacji ani znaków specjalnych.

Ta rola jest obsługiwana tylko w tych creativeType:

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
ASSET_ROLE_CALL_TO_ACTION

Tekst, który ma być używany na przycisku wezwania do działania w kreacji natywnej.

Parametr content musi być zakodowany w formacie UTF-8 i mieć długość nie większą niż 15 znaków.

Ta rola jest obsługiwana tylko w tych creativeType:

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
ASSET_ROLE_ADVERTISER_NAME

Tekst identyfikujący reklamodawcę lub nazwę marki.

Parametr content musi być zakodowany w formacie UTF-8 i mieć maksymalnie 25 znaków.

Ta rola jest obsługiwana tylko w tych creativeType:

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
ASSET_ROLE_PRICE

Cena zakupu aplikacji w Sklepie Google Play lub sklepie z aplikacjami na iOS (np.5, 99 zł).

Pamiętaj, że ta wartość nie jest automatycznie synchronizowana z rzeczywistą wartością podaną w sklepie. Zawsze będzie to wartość podana podczas zapisywania kreacji.

Parametr content musi być zakodowany w formacie UTF-8 i mieć długość nie większą niż 15 znaków.

Zasoby tej roli są tylko do odczytu.

ASSET_ROLE_ANDROID_APP_ID

Identyfikator aplikacji na Androida w Sklepie Google Play.

Ten identyfikator znajdziesz w adresie URL aplikacji w Sklepie Google Play po słowie „id”. Na przykład w https://play.google.com/store/apps/details?id=com.company.appname identyfikatorem jest com.company.appname.

Zasoby tej roli są tylko do odczytu.

ASSET_ROLE_IOS_APP_ID

Identyfikator aplikacji na iOS w sklepie Apple App Store.

Ten numer identyfikacyjny znajdziesz w adresie URL Apple App Store jako ciąg cyfr bezpośrednio po „id”. Na przykład w przypadku https://apps.apple.com/us/app/gmail-email-by-google/id422689480 identyfikator to 422689480.

Zasoby tej roli są tylko do odczytu.

ASSET_ROLE_RATING

ocena aplikacji w Sklepie Google Play lub w sklepie z aplikacjami na iOS;

Pamiętaj, że ta wartość nie jest automatycznie synchronizowana z rzeczywistą oceną w sklepie. Zawsze będzie to wartość podana podczas zapisywania kreacji.

Zasoby tej roli są tylko do odczytu.

ASSET_ROLE_ICON

Ikona kreacji.

Ta rola jest obsługiwana i wymagana tylko w tych creativeType:

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
ASSET_ROLE_COVER_IMAGE

Obraz okładki natywnej kreacji wideo.

Ta rola jest obsługiwana i wymagana tylko w tych creativeType:

  • CREATIVE_TYPE_VIDEO
ASSET_ROLE_BACKGROUND_COLOR

Główny kolor, który ma być używany w kreacji.

Ta rola jest obsługiwana i wymagana tylko w tych creativeType:

  • CREATIVE_TYPE_ASSET_BASED_CREATIVE
ASSET_ROLE_ACCENT_COLOR

Kolor uzupełniający, który ma być używany w kreacji.

Ta rola jest obsługiwana i wymagana tylko w tych creativeType:

  • CREATIVE_TYPE_ASSET_BASED_CREATIVE
ASSET_ROLE_REQUIRE_IMAGE

Określa, czy kreacja musi używać komponentu z obrazem.

Ta rola jest obsługiwana i wymagana tylko w tych creativeType:

  • CREATIVE_TYPE_ASSET_BASED_CREATIVE
ASSET_ROLE_ENABLE_ASSET_ENHANCEMENTS

Określa, czy do kreacji można zastosować ulepszenia komponentów.

Ta rola jest obsługiwana i wymagana tylko w tych creativeType:

  • CREATIVE_TYPE_ASSET_BASED_CREATIVE

ExitEvent

Zdarzenie wyjścia z kreacji.

Zapis JSON
{
  "type": enum (ExitEventType),
  "url": string,
  "name": string,
  "reportingName": string
}
Pola
type

enum (ExitEventType)

Wymagane. Typ zdarzenia wyjścia.

url

string

Wymagane. Docelowy URL zdarzenia wyjściowego. Jest to wymagane, gdy type ma wartość:

  • EXIT_EVENT_TYPE_DEFAULT
  • EXIT_EVENT_TYPE_BACKUP
name

string

Opcjonalnie: Nazwa tagu kliknięcia zdarzenia wyjścia.

Nazwa musi być niepowtarzalna w obrębie jednej kreacji.

Pozostaw to pole puste lub nie ustawiaj go w przypadku kreacji zawierających tylko komponenty z obrazem.

reportingName

string

Opcjonalnie: Nazwa używana do identyfikowania tego zdarzenia w raportach. W przypadku kreacji zawierających tylko komponenty z obrazem pozostaw to pole puste lub nie ustawiaj go.

ExitEventType

Typ zdarzenia wyjścia.

Wartości w polu enum
EXIT_EVENT_TYPE_UNSPECIFIED Typ zdarzenia wyjścia nie jest określony lub jest nieznany w tej wersji.
EXIT_EVENT_TYPE_DEFAULT Domyślnym zdarzeniem jest zdarzenie wyjściowe.
EXIT_EVENT_TYPE_BACKUP Zdarzenie wyjściowe jest zapasowym zdarzeniem wyjściowym. Kreacja może zawierać wiele zdarzeń wyjściowych kopii zapasowej.

TimerEvent

Zdarzenie licznika czasu kreacji.

Zapis JSON
{
  "name": string,
  "reportingName": string
}
Pola
name

string

Wymagane. Nazwa zdarzenia licznika czasu.

reportingName

string

Wymagane. Nazwa używana do identyfikowania tego zdarzenia licznika czasu w raportach.

CounterEvent

Zdarzenie licznika kreacji.

Zapis JSON
{
  "name": string,
  "reportingName": string
}
Pola
name

string

Wymagane. Nazwa zdarzenia licznika.

reportingName

string

Wymagane. Nazwa używana do identyfikowania tego zdarzenia licznika w raportach.

AudioVideoOffset

Długość odtwarzania dźwięku lub filmu.

Zapis JSON
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "percentage": string,
  "seconds": string
  // End of mutually exclusive fields.
}
Pola
Wartość przesunięcia. Poniżej znajduje się lista pól, które się wzajemnie wykluczają. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól:
percentage

string (int64 format)

Opcjonalnie: Przesunięcie w procentach czasu trwania dźwięku lub filmu.

seconds

string (int64 format)

Opcjonalnie: Przesunięcie w sekundach od początku dźwięku lub filmu.

Koniec pól wykluczających się nawzajem.

UniversalAdId

Identyfikator kreacji podany przez rejestr, który jest unikalny na wszystkich platformach. Jest to część standardu VAST 4.0.

Zapis JSON
{
  "id": string,
  "registry": enum (UniversalAdRegistry)
}
Pola
id

string

Opcjonalnie: Unikalny identyfikator kreacji.

registry

enum (UniversalAdRegistry)

Opcjonalnie: Rejestr udostępnia niepowtarzalne identyfikatory kreacji.

UniversalAdRegistry

Rejestr udostępnia unikalne identyfikatory kreacji w uniwersalnym identyfikatorze reklamy.

Wartości w polu enum
UNIVERSAL_AD_REGISTRY_UNSPECIFIED Rejestr reklam uniwersalnych jest nieokreślony lub nieznany w tej wersji.
UNIVERSAL_AD_REGISTRY_OTHER Użyj niestandardowego dostawcy, aby podać uniwersalny identyfikator reklamy.
UNIVERSAL_AD_REGISTRY_AD_ID Użyj Ad-ID, aby podać uniwersalny identyfikator reklamy.
UNIVERSAL_AD_REGISTRY_CLEARCAST Aby podać uniwersalny identyfikator reklamy, użyj strony clearcast.co.uk.
UNIVERSAL_AD_REGISTRY_DV360 Użyj Display & Video 360, aby podać uniwersalny identyfikator reklamy.
UNIVERSAL_AD_REGISTRY_CM Użyj Campaign Managera 360, aby podać uniwersalny identyfikator reklamy.

ThirdPartyUrl

linki monitorujące firm zewnętrznych, które służą do śledzenia interakcji z kreacją audio lub wideo;

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

enum (ThirdPartyUrlType)

Opcjonalnie: Typ interakcji musi być śledzony przez link monitorujący.

url

string

Opcjonalnie: Link monitorujący służący do śledzenia interakcji.

Podaj adres URL z opcjonalną ścieżką lub ciągiem zapytania, zaczynający się od https:. Na przykład https://www.example.com/path

ThirdPartyUrlType

Typ interakcji musi być śledzony przez link monitorujący firmy zewnętrznej.

Wartości w polu enum
THIRD_PARTY_URL_TYPE_UNSPECIFIED Typ adresu URL firmy zewnętrznej jest nieokreślony lub nieznany w tej wersji.
THIRD_PARTY_URL_TYPE_IMPRESSION Służy do zliczania wyświetleń kreacji po zakończeniu buforowania dźwięku lub obrazu.
THIRD_PARTY_URL_TYPE_CLICK_TRACKING Służy do śledzenia kliknięć użytkowników w przypadku plików audio lub wideo.
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_START Służy do śledzenia, ile razy użytkownik rozpoczął odtwarzanie dźwięku lub filmu.
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_FIRST_QUARTILE Służy do śledzenia liczby odtworzeń pliku audio lub wideo do 25% jego długości.
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_MIDPOINT Służy do śledzenia liczby odtworzeń pliku audio lub wideo do 50% jego długości.
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_THIRD_QUARTILE Służy do śledzenia liczby odtworzeń pliku audio lub wideo do 75% jego długości.
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_COMPLETE Służy do śledzenia liczby odtworzeń dźwięku lub filmu do końca.
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_MUTE Służy do śledzenia, ile razy użytkownik wyciszył dźwięk lub film.
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_PAUSE Służy do śledzenia, ile razy użytkownik wstrzymał odtwarzanie dźwięku lub filmu.
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_REWIND Służy do śledzenia, ile razy użytkownik ponownie odtworzył dźwięk lub film.
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_FULLSCREEN Służy do śledzenia, ile razy użytkownik podczas odtwarzania dźwięku włączył tryb pełnoekranowy.
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_STOP Służy do śledzenia, ile razy użytkownik zatrzymał odtwarzanie dźwięku lub filmu.
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_CUSTOM Służy do śledzenia liczby kliknięć niestandardowych wykonanych przez użytkownika, takich jak kliknięcie ciekawego miejsca w filmie.
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_SKIP Służy do śledzenia liczby pominięć dźwięku lub filmu.
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_PROGRESS Służy do śledzenia liczby odtworzeń dźwięku lub filmu do momentu określonego przez parametr progressOffset.

Transkodowanie

Zawiera informacje o przekodowanym pliku audio lub wideo.

Zapis JSON
{
  "name": string,
  "mimeType": string,
  "transcoded": boolean,
  "dimensions": {
    object (Dimensions)
  },
  "bitRateKbps": string,
  "frameRate": number,
  "audioBitRateKbps": string,
  "audioSampleRateHz": string,
  "fileSizeBytes": string
}
Pola
name

string

Opcjonalnie: Nazwa przekodowanego pliku.

mimeType

string

Opcjonalnie: Typ MIME przekodowanego pliku.

transcoded

boolean

Opcjonalnie: Wskazuje, czy transkodowanie się powiodło.

dimensions

object (Dimensions)

Opcjonalnie: Wymiary transkodowanego filmu.

bitRateKbps

string (int64 format)

Opcjonalnie: Szybkość transmisji transkodowanego filmu w kilobitach na sekundę.

frameRate

number

Opcjonalnie: Liczba klatek na sekundę w transkodowanym filmie.

audioBitRateKbps

string (int64 format)

Opcjonalnie: Szybkość transmisji strumienia audio transkodowanego filmu lub transkodowanego dźwięku w kilobitach na sekundę.

audioSampleRateHz

string (int64 format)

Opcjonalnie: Częstotliwość próbkowania strumienia audio transkodowanego filmu lub transkodowanego dźwięku w hercach.

fileSizeBytes

string (int64 format)

Opcjonalnie: Rozmiar przekodowanego pliku w bajtach.

CmTrackingAd

reklama śledząca Campaign Managera 360;

Zapis JSON
{
  "cmPlacementId": string,
  "cmCreativeId": string,
  "cmAdId": string
}
Pola
cmPlacementId

string (int64 format)

Opcjonalnie: Identyfikator miejsca docelowego reklamy śledzącej w usłudze Campaign Manager 360.

cmCreativeId

string (int64 format)

Opcjonalnie: Identyfikator kreacji w reklamie śledzącej w usłudze Campaign Manager 360.

cmAdId

string (int64 format)

Opcjonalnie: Identyfikator reklamy śledzącej w usłudze Campaign Manager 360.

ObaIcon

Ikona programu OBA w przypadku kreacji

Zapis JSON
{
  "resourceUrl": string,
  "resourceMimeType": string,
  "position": enum (ObaIconPosition),
  "dimensions": {
    object (Dimensions)
  },
  "program": string,
  "landingPageUrl": string,
  "clickTrackingUrl": string,
  "viewTrackingUrl": string
}
Pola
resourceUrl

string

Opcjonalnie: Adres URL zasobu ikony OBA.

resourceMimeType

string

Opcjonalnie: Typ MIME zasobu ikony reklamy behawioralnej.

position

enum (ObaIconPosition)

Opcjonalnie: Położenie ikony OBA w kreacji.

dimensions

object (Dimensions)

Opcjonalnie: Wymiary ikony OBA.

program

string

Opcjonalnie: Program ikony OBA. Na przykład „AdChoices”.

landingPageUrl

string

Wymagane. URL strony docelowej ikony OBA.

Dozwolone są tylko adresy URL z tych domen:

  • https://info.evidon.com
  • https://l.betrad.com
clickTrackingUrl

string

Wymagane. Link monitorujący kliknięcia ikony OBA.

Dozwolone są tylko adresy URL z tych domen:

  • https://info.evidon.com
  • https://l.betrad.com
viewTrackingUrl

string

Wymagane. Link monitorujący wyświetlenia ikony OBA.

Dozwolone są tylko adresy URL z tych domen:

  • https://info.evidon.com
  • https://l.betrad.com

ObaIconPosition

Położenie ikony OBA w kreacji.

Wartości w polu enum
OBA_ICON_POSITION_UNSPECIFIED Pozycja ikony OBA nie jest określona.
OBA_ICON_POSITION_UPPER_RIGHT w prawym górnym rogu kreacji.
OBA_ICON_POSITION_UPPER_LEFT W lewym górnym rogu kreacji.
OBA_ICON_POSITION_LOWER_RIGHT w prawym dolnym rogu kreacji.
OBA_ICON_POSITION_LOWER_LEFT W lewym dolnym rogu kreacji.

ExpandingDirection

Kierunek rozwijania kreacji rozwijanej firmy zewnętrznej.

Wartości w polu enum
EXPANDING_DIRECTION_UNSPECIFIED Kierunek rozwijania nie jest określony.
EXPANDING_DIRECTION_NONE Nie rozszerza się w żadnym kierunku.
EXPANDING_DIRECTION_UP Rozwija się w górę.
EXPANDING_DIRECTION_DOWN Rozwija się w dół.
EXPANDING_DIRECTION_LEFT Rozwija się w lewo.
EXPANDING_DIRECTION_RIGHT Rozwija się w prawo.
EXPANDING_DIRECTION_UP_AND_LEFT Rozwija się w górę i w lewo.
EXPANDING_DIRECTION_UP_AND_RIGHT Rozwija się w górę i w prawo.
EXPANDING_DIRECTION_DOWN_AND_LEFT Rozwija się w dół i w lewo.
EXPANDING_DIRECTION_DOWN_AND_RIGHT Rozwija się w dół i w prawo.
EXPANDING_DIRECTION_UP_OR_DOWN Rozwija się w górę lub w dół.
EXPANDING_DIRECTION_LEFT_OR_RIGHT Rozwija się w lewo lub w prawo.
EXPANDING_DIRECTION_ANY_DIAGONAL Może się rozszerzać w dowolnym kierunku po przekątnej.

Metody

create

Tworzy nową kreację.

delete

Usuwa kreację.

get

Pobiera kreację.

list

Wyświetla listę kreacji reklamodawcy.

patch

Aktualizuje istniejącą kreację.