REST Resource: adUnits

Zasób: AdUnit

Pojedyncza jednostka reklamowa.

Zapis JSON 
{
  "name": string,
  "externalId": string,
  "displayName": string,
  "description": string,
  "labels": {
    string: string,
    ...
  },
  "attributes": [
    enum (AdUnitAttribute)
  ],
  "creatives": [
    {
      object (CreativeSpecification)
    }
  ],
  "createTime": string,
  "updateTime": string,
  "state": enum (AdUnitState),
  "rejectedReason": string,
  "location": {
    object (LatLng)
  },
  "directionSet": boolean,
  "direction": integer,
  "elevationMetersSet": boolean,
  "elevationMeters": number,
  "physicalWidthMetersSet": boolean,
  "physicalWidthMeters": number,
  "physicalHeightMetersSet": boolean,
  "physicalHeightMeters": number,
  "venue": enum (OutOfHomeVenue),
  "fixedLocation": boolean,
  "indoors": boolean,
  "impressionDataRanges": [
    {
      object (ImpressionDataRange)
    }
  ],
  "photoUrls": [
    string
  ],
  "products": [
    string
  ]
}
Pola
name

string

Nazwa zasobu jednostki reklamowej w formacie: adUnits/{id}. na przykład adUnits/adUnit123.
externalId

string

Opcjonalnie: Identyfikator zarządzany przez sprzedawcę prawdopodobnie w jego systemie. Po ustawieniu nie może ulec zmianie. Nie należy jej używać wewnętrznie, a ograniczenia nie są egzekwowane.
displayName

string

Wymagane. Wyświetlana nazwa jednostki reklamowej.

Musi być zakodowany w standardzie UTF-8 i maksymalnym rozmiarze 240 bajtów.
description

string

Opcjonalnie: Dodatkowe dowolne pole do opisania jednostki reklamowej.
labels

map (key: string, value: string)

Opcjonalnie: Zbiór dowolnych etykiet do opisania tej jednostki reklamowej.

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

enum (AdUnitAttribute)

Opcjonalnie: Atrybuty pozwalające dokładniej zdefiniować tę jednostkę reklamową.
creatives[]

object (CreativeSpecification)

Opcjonalnie: Lista dozwolonych kreacji, które mogą być wyświetlane w tej jednostce reklamowej. Można je także zdefiniować na poziomie produktu.
createTime

string (Timestamp format)

Tylko dane wyjściowe. Sygnatura czasowa utworzenia jednostki reklamowej.

Sygnatura czasowa w RFC3339 UTC „Zulu” z rozdzielczością nanosekundową i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Tylko dane wyjściowe. Sygnatura czasowa ostatniej aktualizacji jednostki reklamowej.

Sygnatura czasowa w RFC3339 UTC „Zulu” z rozdzielczością nanosekundową i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".
state

enum (AdUnitState)

Tylko dane wyjściowe. Stan jednostki reklamowej. Jeśli AD_UNIT_STATE_REJECTED zawiera powód odrzucenia.
rejectedReason

string

Tylko dane wyjściowe. Jeśli stan zatwierdzenia to AD_UNIT_APPROVAL_STATUS_REJECTED, to pole będzie zawierać przyczynę.
location

object (LatLng)

Wymagane. Stały. Długość i szerokość geograficzna jednostki reklamowej w formacie ze znakiem stopni.
directionSet

boolean

Wymagane. Prawda, jeśli ustawiony jest kierunek.
direction

integer

Opcjonalnie: Stały. Kierunek kardynalny w stopniach, a północ reprezentuje 0. [0–360).
elevationMetersSet

boolean

Wymagane. True, jeśli ustawiona jest wartość HeightMeters.
elevationMeters

number

Opcjonalnie: Stały. Odległość od dolnej części jednostki reklamowej od ziemi w metrach.
physicalWidthMetersSet

boolean

Wymagane. Wartość true, jeśli ustawiona jest wartość securityMeter.
physicalWidthMeters

number

Opcjonalnie: Stały. Fizyczna szerokość jednostki reklamowej w metrach.
physicalHeightMetersSet

boolean

Wymagane. Wartość true (prawda), jeśli ustawiona jest wartość fizycznaHeightMeters.
physicalHeightMeters

number

Opcjonalnie: Stały. Fizyczna wysokość jednostki reklamowej w metrach.
venue

enum (OutOfHomeVenue)

Opcjonalnie: Typ miejsca poza domem zgodny ze standardami DPAA. Jest to pole informacyjne, które może być wyświetlane reklamodawcom i może być również używane do filtrowania jednostek reklamowych.
fixedLocation

boolean

Opcjonalnie: Określa, czy reklama znajduje się w stałej lokalizacji (billboard) czy w ruchu (taksówka).
indoors

boolean

Wymagane. Określa, czy jednostka reklamowa jest wewnątrz budynku.
impressionDataRanges[]

object (ImpressionDataRange)

Wymagane. Zakresy danych o wyświetleniach powiązane z tą jednostką reklamową. Zakresy dat nie powinny się pokrywać. Aby można było kupić jednostkę reklamową, wymagane są dane o wyświetleniach.
photoUrls[]

string

Opcjonalnie: Adresy URL zdjęć jednostki reklamowej.
products[]

string

Wymagane. Nazwy zasobów produktów powiązanych z tą jednostką reklamową w formacie: products/{id}. na przykład products/product123.

AdUnitAttribute

Możliwe atrybuty służące do dalszego definiowania jednostki reklamowej.

Wartości w polu enum
AD_UNIT_ATTRIBUTE_UNSPECIFIED Wartość domyślna, gdy atrybut jednostki reklamowej nie jest określony lub jest nieznany w tej wersji.
AD_UNIT_ATTRIBUTE_ILLUMINATED Czy jednostka reklamowa jest widoczna w ciemności w świecie rzeczywistym?
AD_UNIT_ATTRIBUTE_DIGITAL Jeśli jej nie ma, domniemana jest cyfrowa jednostka reklamowa.
AD_UNIT_ATTRIBUTE_PHYSICAL Jednostka reklamowa istnieje jako obiekt w świecie fizycznym.

AdUnitState

Stan jednostki reklamowej z punktu widzenia sprzedawcy.

Wartości w polu enum
AD_UNIT_STATE_UNSPECIFIED Wartość domyślna, gdy stan jednostki reklamowej nie jest określony lub nieznany w tej wersji.
AD_UNIT_STATE_PENDING Jednostka reklamowa oczekuje na zatwierdzenie.
AD_UNIT_STATE_APPROVED Jednostka reklamowa została zatwierdzona.
AD_UNIT_STATE_REJECTED Jednostka reklamowa została odrzucona.
AD_UNIT_STATE_DELETED Usunięto jednostkę reklamową.

OutOfHomeVenue

Lista typów obiektów poza domem zgodnych ze standardami DPAA.

Wartości w polu enum
OOH_VENUE_UNSPECIFIED Wartość domyślna, gdy obiekt OOO nie jest określony lub jest nieznany w tej wersji.
OOH_VENUE_AIRBORNE Obiekt zewnętrzny sklasyfikowany jako lotniczy.
OOH_VENUE_AIRPORTS_GENERAL Obiekt zewnętrzny sklasyfikowany jako ogólne lotniska.
OOH_VENUE_AIRPORTS_BAGGAGE_CLAIM Obiekt zewnętrzny sklasyfikowany jako punkt odbioru bagażu na lotnisku.
OOH_VENUE_AIRPORTS_TERMINAL Obiekt zewnętrzny sklasyfikowany jako terminal lotniskowy.
OOH_VENUE_AIRPORTS_LOUNGES Obiekt zewnętrzny sklasyfikowany jako poczekalnie na lotnisku.
OOH_VENUE_ATMS Obiekt zewnętrzny sklasyfikowany jako bankomaty.
OOH_VENUE_BACKLIGHTS Plan zewnętrzny sklasyfikowany jako podświetlenie.
OOH_VENUE_BARS Zewnętrzny lokal zaklasyfikowany jako bary
OOH_VENUE_BENCHES Miejsce na zewnątrz sklasyfikowane jako ławki.
OOH_VENUE_BIKE_RACKS Miejsce na zewnątrz sklasyfikowane jako stojaki na rowery.
OOH_VENUE_BULLETINS Reklama zewnętrzna sklasyfikowana jako biuletyny.
OOH_VENUE_BUSES Obiekt zewnętrzny sklasyfikowany jako autobusy.
OOH_VENUE_CAFES Zewnętrzny obiekt zaklasyfikowany jako kawiarnie.
OOH_VENUE_CASUAL_DINING_RESTAURANTS Niezadaszony lokal zaklasyfikowany jako bezpretensjonalne restauracje.
OOH_VENUE_CHILD_CARE Obiekt zewnętrzny sklasyfikowany jako opieka nad dziećmi.
OOH_VENUE_CINEMA Zewnętrzny teatr zaklasyfikowany jako kino.
OOH_VENUE_CITY_INFORMATION_PANELS Miejsce na zewnątrz sklasyfikowane jako miejskie panele informacyjne.
OOH_VENUE_CONVENIENCE_STORES Obiekt na zewnątrz sklasyfikowany jako sklepy osiedlowe.
OOH_VENUE_DEDICATED_WILD_POSTING Zewnętrzne miejsce sklasyfikowane jako przeznaczone do publikowania wiadomości.
OOH_VENUE_DOCTORS_OFFICES_GENERAL Obiekt poza domem zaliczany do ogólnych gabinetów lekarskich.
OOH_VENUE_DOCTORS_OFFICES_OBSTETRICS Obiekt zewnętrzny klasyfikowany jako gabinet lekarski – położnictwo.
OOH_VENUE_DOCTORS_OFFICES_PEDIATRICS Obiekt poza domem zaliczany do gabinetów lekarskich i pediatrii.
OOH_VENUE_FAMILY_ENTERTAINMENT Miejsce na zewnątrz sklasyfikowane jako rozrywka dla całej rodziny.
OOH_VENUE_FERRIES Planeta zewnętrzna sklasyfikowana jako promy.
OOH_VENUE_FINANCIAL_SERVICES Reklama zewnętrzna należąca do kategorii usług finansowych.
OOH_VENUE_GAS_STATIONS Obiekt zewnętrzny sklasyfikowany jako stacje benzynowe.
OOH_VENUE_GOLF_COURSES Obiekt zewnętrzny zaklasyfikowany jako pola golfowe.
OOH_VENUE_GYMS Obiekt na zewnątrz klasyfikowany jako siłownie.
OOH_VENUE_HOSPITALS Obiekt zewnętrzny zaliczany do szpitali.
OOH_VENUE_HOTELS Obiekt zewnętrzny sklasyfikowany jako hotele.
OOH_VENUE_JUNIOR_POSTERS Miejsce na zewnątrz sklasyfikowane jako dziecięce plakaty.
OOH_VENUE_KIOSKS Zewnętrzne miejsce sklasyfikowane jako kioski.
OOH_VENUE_MALLS_GENERAL Niezadaszony obiekt sklasyfikowany jako ogólne centra handlowe.
OOH_VENUE_MALLS_FOOD_COURTS Niezadaszony obiekt sklasyfikowany jako centrum handlowe z restauracjami.
OOH_VENUE_MARINE Obiekt na świeżym powietrzu zaklasyfikowany jako morski.
OOH_VENUE_MOBILE_BILLBOARDS Reklama zewnętrzna sklasyfikowana jako mobilne billboardy.
OOH_VENUE_MOVIE_THEATER_LOBBIES Hala widowiskowa zaliczana do sal kinowych.
OOH_VENUE_NEWSSTANDS Zewnętrzny lokal sklasyfikowany jako kiosk z prasą.
OOH_VENUE_OFFICE_BUILDINGS Obiekt zewnętrzny sklasyfikowany jako biurowce.
OOH_VENUE_PHONE_KIOSKS Obiekty zewnętrzne sklasyfikowane jako kioski telefoniczne.
OOH_VENUE_POSTERS Zewnętrzny obiekt sklasyfikowany jako plakaty.
OOH_VENUE_QSR Reklama zewnętrzna sklasyfikowana jako Qsr.
OOH_VENUE_RAIL Zewnętrzny obiekt sklasyfikowany jako kolejka.
OOH_VENUE_RECEPTACLES Lokal poza domem sklasyfikowany jako „restauracje”.
OOH_VENUE_RESORTS Zewnętrzny obiekt sklasyfikowany jako ośrodek wypoczynkowy.
OOH_VENUE_RETAIL Obiekt na zewnątrz sklasyfikowany jako sklep.
OOH_VENUE_SALONS Zewnętrzne miejsce zaliczane do salonów urody.
OOH_VENUE_SHELTERS Obiekt poza domem sklasyfikowany jako schronisko.
OOH_VENUE_SPORTS_ARENAS Stadion zewnętrzny zaklasyfikowany jako areny sportowe.
OOH_VENUE_SUBWAY Zewnętrzny lokal sklasyfikowany jako metro.
OOH_VENUE_TAXIS Obiekt na zewnątrz sklasyfikowany jako taksówka.
OOH_VENUE_TRUCKSIDE Miejsce poza domem zaliczone do kategorii dla ciężarówek.
OOH_VENUE_UNIVERSITIES Obiekt zewnętrzny sklasyfikowany jako uniwersytet.
OOH_VENUE_URBAN_PANELS Reklama zewnętrzna sklasyfikowana jako panel miejski.
OOH_VENUE_VETERINARIAN_OFFICES Obiekt zewnętrzny sklasyfikowany jako gabinet weterynaryjny.
OOH_VENUE_WALLS Zewnętrzne miejsce sklasyfikowane jako ściany.
OOH_VENUE_OTHER Zewnętrzny lokal sklasyfikowany jako inny.

ImpressionDataRange

Dane o wyświetleniach w określonym zakresie dat.

Zapis JSON 
{
  "impressionDataStartTime": string,
  "impressionDataEndTime": string,
  "impressionDataUnits": [
    {
      object (ImpressionDataUnit)
    }
  ]
}
Pola
impressionDataStartTime

string (Timestamp format)

Wymagane. Początek przedziału czasu, w którym dane o wyświetleniach są prawidłowe (włącznie).

Sygnatura czasowa w RFC3339 UTC „Zulu” z rozdzielczością nanosekundową i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".
impressionDataEndTime

string (Timestamp format)

Wymagane. Koniec przedziału czasu, w którym dane o wyświetleniach są prawidłowe (z wyłączeniem).

Sygnatura czasowa w RFC3339 UTC „Zulu” z rozdzielczością nanosekundową i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".
impressionDataUnits[]

object (ImpressionDataUnit)

Wymagane. Dane o wyświetleniach w wybranym zakresie dat.

ImpressionDataUnit

Dane dotyczące wyświetleń dla danego dnia tygodnia i o wybranych porach dnia.

Zapis JSON 
{
  "dayOfWeek": enum (DayOfWeek),
  "hourOfDay": integer,
  "impressions": string
}
Pola
dayOfWeek

enum (DayOfWeek)

Wymagane. Dzień tygodnia, którego dotyczą dane o wyświetleniach.
hourOfDay

integer

Wymagane. Godziny dnia przedstawione w formacie 24-godzinnym. Wartość powinna mieścić się w zakresie od 0 do 23.
impressions

string (int64 format)

Wymagane. Liczba wyświetleń w określonym dniu tygodnia o określonych porach dnia.

Metody

create

 Tworzy nową jednostkę reklamową.

delete

 Usuwa istniejącą jednostkę reklamową.

get

 Pobiera pojedynczą jednostkę reklamową.

list

 Wyświetla listę jednostek reklamowych.

patch

 Aktualizuje istniejącą jednostkę reklamową.