REST Resource: adUnits

Ressource: Anzeigenblock

Ein einzelner Anzeigenblock.

JSON-Darstellung 
{
  "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
  ]
}
Felder
name

string

Der Ressourcenname des Anzeigenblocks im Format adUnits/{id}. z. B. adUnits/adUnit123.
externalId

string

Optional. Vom Verkäufer verwaltete ID vermutlich in seinem eigenen System. Wird einmal festgelegt, wird sich wahrscheinlich nicht ändern. Es sollte nicht intern verwendet werden und Einschränkungen werden nicht erzwungen.
displayName

string

Erforderlich. Der Anzeigename des Anzeigenblocks.

Muss UTF-8-codiert sein und darf maximal 240 Byte groß sein.
description

string

Optional. Zusätzliches Freiform-Feld zur Beschreibung des Anzeigenblocks.
labels

map (key: string, value: string)

Optional. Die frei definierbaren Labels zur Beschreibung dieses Anzeigenblocks

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
attributes[]

enum (AdUnitAttribute)

Optional. Attribute zur weiteren Definition dieses Anzeigenblocks.
creatives[]

object (CreativeSpecification)

Optional. Liste der zulässigen Creatives, die für diesen Anzeigenblock geschaltet werden können. Dies kann auch auf Produktebene definiert werden.
createTime

string (Timestamp format)

Nur Ausgabe. Zeitstempel der Erstellung des Anzeigenblocks.

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Nur Ausgabe. Zeitstempel der letzten Aktualisierung für den Anzeigenblock.

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".
state

enum (AdUnitState)

Nur Ausgabe. Der Status des Anzeigenblocks. Wenn AD_UNIT_STATE_REJECTED den Grund enthält, enthält der abgelehnte Grund den Grund.
rejectedReason

string

Nur Ausgabe. Wenn der Freigabestatus AD_UNIT_APPROVAL_STATUS_REJECTED lautet, enthält dieses Feld den Grund.
location

object (LatLng)

Erforderlich. Nicht veränderbar. Der Breiten- und Längengrad des Anzeigenblocks im Format mit signierten Graden.
directionSet

boolean

Erforderlich. "True", wenn die Richtung festgelegt ist.
direction

integer

Optional. Nicht veränderbar. Die Himmelsrichtung in Grad, wobei Norden 0 darstellt. [0–360].
elevationMetersSet

boolean

Erforderlich. "True", wenn ElevationMeters festgelegt ist.
elevationMeters

number

Optional. Nicht veränderbar. Der Abstand vom unteren Rand des Anzeigenblocks zum Boden in Metern.
physicalWidthMetersSet

boolean

Erforderlich. „True“, wenn „physicalWidthMeters“ festgelegt ist.
physicalWidthMeters

number

Optional. Nicht veränderbar. Die physische Breite des Anzeigenblocks in Metern.
physicalHeightMetersSet

boolean

Erforderlich. „True“, wenn „physikalHeightMeters“ festgelegt ist.
physicalHeightMeters

number

Optional. Nicht veränderbar. Die physische Höhe des Anzeigenblocks in Metern.
venue

enum (OutOfHomeVenue)

Optional. Die Art der Außenwerbung gemäß DPAA-Standards. Dies ist ein Informationsfeld, das Werbetreibenden angezeigt und auch zum Filtern von Anzeigenblöcken verwendet werden kann.
fixedLocation

boolean

Optional. Gibt an, ob sich die Anzeige an einer festen Position (Werbeanzeige) oder an einer Fortbewegung (Taxi) befindet.
indoors

boolean

Erforderlich. Gibt an, ob sich der Anzeigenblock in einem Gebäude befindet.
impressionDataRanges[]

object (ImpressionDataRange)

Erforderlich. Die Impressionsdatenbereiche, die diesem Anzeigenblock zugewiesen sind. Es ist nicht davon auszugehen, dass sich Zeiträume überschneiden. Damit der Anzeigenblock gekauft werden kann, sind Impressionsdaten erforderlich.
photoUrls[]

string

Optional. Foto-URLs des Anzeigenblocks.
products[]

string

Erforderlich. Die Ressourcennamen von Produkten, die mit diesem Anzeigenblock verknüpft sind, im Format products/{id}. z. B. products/product123.

AdUnitAttribute

Mögliche Attribute zur weiteren Definition des Anzeigenblocks.

Enums
AD_UNIT_ATTRIBUTE_UNSPECIFIED Standardwert, wenn das Anzeigenblockattribut nicht angegeben oder in dieser Version unbekannt ist.
AD_UNIT_ATTRIBUTE_ILLUMINATED Ist der Anzeigenblock im Dunkeln sichtbar?
AD_UNIT_ATTRIBUTE_DIGITAL Es wird ein digitaler Anzeigenblock impliziert, sofern nicht ein klassischer physischer Anzeigenblock enthalten ist.
AD_UNIT_ATTRIBUTE_PHYSICAL Der Anzeigenblock existiert als Objekt in der physischen Welt.

AdUnitState

Status eines Anzeigenblocks aus der Sicht eines Verkäufers.

Enums
AD_UNIT_STATE_UNSPECIFIED Standardwert, wenn der Status des Anzeigenblocks nicht angegeben oder in dieser Version unbekannt ist.
AD_UNIT_STATE_PENDING Die Genehmigung des Anzeigenblocks steht noch aus.
AD_UNIT_STATE_APPROVED Der Anzeigenblock ist freigegeben.
AD_UNIT_STATE_REJECTED Der Anzeigenblock wurde abgelehnt.
AD_UNIT_STATE_DELETED Anzeigenblock wurde gelöscht.

OutOfHomeVenue

Liste der Arten von Außenveranstaltungen basierend auf den DPAA-Standards.

Enums
OOH_VENUE_UNSPECIFIED Standardwert, wenn der Veranstaltungsort für Außenwerbung nicht angegeben ist oder in dieser Version unbekannt ist.
OOH_VENUE_AIRBORNE Veranstaltungsort für Außenwerbung kategorisiert als Luftfahrt.
OOH_VENUE_AIRPORTS_GENERAL Flughafen für Außenwerbung kategorisiert als allgemeine Flughäfen.
OOH_VENUE_AIRPORTS_BAGGAGE_CLAIM Veranstaltungsort für Außenwerbung kategorisiert als Gepäckausgabe von Flughäfen.
OOH_VENUE_AIRPORTS_TERMINAL Veranstaltungsort für Außenwerbung kategorisiert als Terminal für Flughäfen.
OOH_VENUE_AIRPORTS_LOUNGES Unterkunft für Außenwerbung kategorisiert als Flughafenlounges.
OOH_VENUE_ATMS Orte für Außenwerbung, die als Geldautomaten kategorisiert sind.
OOH_VENUE_BACKLIGHTS Ort für Außenwerbung ist als Hintergrundbeleuchtung kategorisiert.
OOH_VENUE_BARS Veranstaltungsort für Außenwerbung kategorisiert als Bars.
OOH_VENUE_BENCHES Einrichtung für Außenwerbung, die als Bänke kategorisiert ist.
OOH_VENUE_BIKE_RACKS Standort für Außenwerbung kategorisiert als Fahrradständer.
OOH_VENUE_BULLETINS Außenwerbung, kategorisiert als Bulletins.
OOH_VENUE_BUSES Veranstaltungsort für Außenwerbung kategorisiert als Busse.
OOH_VENUE_CAFES Standort für Außenwerbung, kategorisiert als Cafés.
OOH_VENUE_CASUAL_DINING_RESTAURANTS Unterkünfte mit Außengastronomie, die als zwanglose Restaurants kategorisiert sind.
OOH_VENUE_CHILD_CARE Einrichtung für Außenwerbung, die als Kinderbetreuung kategorisiert ist.
OOH_VENUE_CINEMA Außenwerbung der Kategorie „Kino“.
OOH_VENUE_CITY_INFORMATION_PANELS Ort für Außenwerbung kategorisiert als Infobereiche der Stadt.
OOH_VENUE_CONVENIENCE_STORES Ladengeschäfte, die als Minimärkte kategorisiert sind.
OOH_VENUE_DEDICATED_WILD_POSTING Veranstaltungsort für Außenwerbung, kategorisiert als „spezielle Wildnis“-Anzeige.
OOH_VENUE_DOCTORS_OFFICES_GENERAL Einrichtungen für Außenwerbung, die als allgemeine Arztpraxen kategorisiert sind.
OOH_VENUE_DOCTORS_OFFICES_OBSTETRICS Einrichtungen für Außenwerbung, die als Geburtshilfen von Arztpraxen kategorisiert sind.
OOH_VENUE_DOCTORS_OFFICES_PEDIATRICS Einrichtung für Außenwerbung, die als Kinderarztpraxen kategorisiert ist.
OOH_VENUE_FAMILY_ENTERTAINMENT Freizeitanlage für Außenwerbung, die als Familienunterhaltung kategorisiert ist.
OOH_VENUE_FERRIES Ort für Außenwerbung, kategorisiert als Fähren.
OOH_VENUE_FINANCIAL_SERVICES Standort für Außenwerbung, der als Finanzdienstleistungen kategorisiert ist.
OOH_VENUE_GAS_STATIONS Standort für Außenwerbung, kategorisiert als Tankstellen.
OOH_VENUE_GOLF_COURSES Anlage für Außenwerbung, die als Golfplätze kategorisiert ist.
OOH_VENUE_GYMS Veranstaltungsort für Außenwerbung kategorisiert als Fitnessstudios.
OOH_VENUE_HOSPITALS Standort für Außenwerbung kategorisiert als Krankenhäuser.
OOH_VENUE_HOTELS Angebote für Außenwerbung, die als Hotels kategorisiert sind.
OOH_VENUE_JUNIOR_POSTERS Veranstaltungsort für Außenwerbung kategorisiert als Junior-Poster.
OOH_VENUE_KIOSKS Verkaufsplattform für Außenwerbung, die als Kioske kategorisiert ist.
OOH_VENUE_MALLS_GENERAL Freizeitanlage für Außenwerbung, die als allgemeine Einkaufszentren kategorisiert ist.
OOH_VENUE_MALLS_FOOD_COURTS Freizeitanlage für Außenwerbung, die als Food-Court in Einkaufszentren kategorisiert ist.
OOH_VENUE_MARINE Ort für Außenwerbung der Kategorie „Meerblau“.
OOH_VENUE_MOBILE_BILLBOARDS Außenwerbung kategorisiert als mobile Billboards.
OOH_VENUE_MOVIE_THEATER_LOBBIES Außenwerbung, die als Lobbys für Kinos kategorisiert ist.
OOH_VENUE_NEWSSTANDS Veranstaltungsort für Außenwerbung kategorisiert als Zeitungskioske.
OOH_VENUE_OFFICE_BUILDINGS Außenwerbung kategorisiert als Bürogebäude.
OOH_VENUE_PHONE_KIOSKS Standort für Außenwerbung, kategorisiert als Telefonkioske.
OOH_VENUE_POSTERS Veranstaltungsort für Außenwerbung kategorisiert als Plakate.
OOH_VENUE_QSR Ort für Außenwerbung kategorisiert als qsr.
OOH_VENUE_RAIL Außenwerbung kategorisiert als Bahn.
OOH_VENUE_RECEPTACLES Ort für Außenwerbung, der als Behälter kategorisiert ist.
OOH_VENUE_RESORTS Unterkunft für Außenwerbung, kategorisiert als Resorts.
OOH_VENUE_RETAIL Geschäft für Außenwerbung der Kategorie „Einzelhandel“.
OOH_VENUE_SALONS Einrichtung für Außenwerbung, die als Friseursalons kategorisiert ist.
OOH_VENUE_SHELTERS Anlage für Außenwerbung kategorisiert als Notunterkünfte.
OOH_VENUE_SPORTS_ARENAS Veranstaltungsort für Außenwerbung, kategorisiert als Sportarenen.
OOH_VENUE_SUBWAY Außenwerbung kategorisiert als U-Bahn.
OOH_VENUE_TAXIS Ort für Außenwerbung der Kategorie „Taxis“.
OOH_VENUE_TRUCKSIDE Außendienstfläche mit Lkw-Seiten.
OOH_VENUE_UNIVERSITIES Einrichtung für Außenwerbung der Kategorie „Universitäten“.
OOH_VENUE_URBAN_PANELS Außenwerbung kategorisiert als städtische Infobereiche.
OOH_VENUE_VETERINARIAN_OFFICES Außenwerbung, die als Tierarztpraxen kategorisiert ist.
OOH_VENUE_WALLS Veranstaltungsort für Außenwerbung mit Wänden
OOH_VENUE_OTHER Ort für Außenwerbung als „Sonstiges“ kategorisiert.

ImpressionDataRange

Impressionsdaten für einen Zeitraum

JSON-Darstellung 
{
  "impressionDataStartTime": string,
  "impressionDataEndTime": string,
  "impressionDataUnits": [
    {
      object (ImpressionDataUnit)
    }
  ]
}
Felder
impressionDataStartTime

string (Timestamp format)

Erforderlich. Beginn des Intervalls, wenn die Impression-Daten gültig sind (einschließlich).

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".
impressionDataEndTime

string (Timestamp format)

Erforderlich. Ende des Intervalls, wenn die Impression-Daten gültig sind (ausschließlich).

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".
impressionDataUnits[]

object (ImpressionDataUnit)

Erforderlich. Impressionsdaten für den angegebenen Zeitraum

ImpressionDataUnit

Impressionsdaten für einen bestimmten Wochentag und eine bestimmte Tageszeit.

JSON-Darstellung 
{
  "dayOfWeek": enum (DayOfWeek),
  "hourOfDay": integer,
  "impressions": string
}
Felder
dayOfWeek

enum (DayOfWeek)

Erforderlich. Wochentag, den die Impression-Daten darstellen.
hourOfDay

integer

Erforderlich. Tageszeiten, die die Impression-Daten im 24-Stunden-Format darstellen. Sollte zwischen 0 und 23 liegen.
impressions

string (int64 format)

Erforderlich. Anzahl der Impressions am angegebenen Wochentag zu den angegebenen Tageszeiten.

Methoden

create

 Erstellt einen neuen Anzeigenblock.

delete

 Löscht einen vorhandenen Anzeigenblock.

get

 Ruft einen einzelnen Anzeigenblock ab.

list

 Listet Anzeigenblöcke auf.

patch

 Aktualisiert einen vorhandenen Anzeigenblock.