REST Resource: adUnits

Risorsa: unità pubblicitaria

Una singola unità pubblicitaria.

Rappresentazione 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
  ]
}
Campi
name

string

Il nome della risorsa dell'unità pubblicitaria nel formato: adUnits/{id}. Ad esempio adUnits/adUnit123.

externalId

string

(Facoltativo) ID gestito dal venditore, presumibilmente nel proprio sistema. Una volta impostato, è improbabile che cambi. Non deve essere usato internamente e i vincoli non vengono applicati.

displayName

string

Obbligatorio. Il nome visualizzato dell'unità pubblicitaria.

Deve essere codificata in UTF-8 con una dimensione massima di 240 byte.

description

string

(Facoltativo) Campo in formato libero aggiuntivo per descrivere l'unità pubblicitaria.

labels

map (key: string, value: string)

(Facoltativo) L'insieme di etichette in formato libero per descrivere questa unità pubblicitaria.

Un oggetto contenente un elenco di "key": value coppie. Esempio: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

attributes[]

enum (AdUnitAttribute)

(Facoltativo) Attributi per definire ulteriormente l'unità pubblicitaria.

creatives[]

object (CreativeSpecification)

(Facoltativo) Elenco delle creatività consentite che possono essere pubblicate per questa unità pubblicitaria. Può essere definito anche a livello di prodotto.

createTime

string (Timestamp format)

Solo output. Timestamp della creazione dell'unità pubblicitaria.

Un timestamp nel formato RFC3339 UTC "Zulu" con risoluzione in nanosecondi e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

Solo output. Timestamp dell'ultimo aggiornamento dell'unità pubblicitaria.

Un timestamp nel formato RFC3339 UTC "Zulu" con risoluzione in nanosecondi e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

state

enum (AdUnitState)

Solo output. Lo stato dell'unità pubblicitaria. Se AD_UNIT_STATE_REJECTED, il motivo del rifiuto conterrà il motivo.

rejectedReason

string

Solo output. Se lo stato di approvazione è AD_UNIT_APPROVAL_STATUS_REJECTED, questo campo conterrà il motivo.

location

object (LatLng)

Obbligatorio. Immutabile. La latitudine e la longitudine dell'unità pubblicitaria nel formato in gradi con segno.

directionSet

boolean

Obbligatorio. True se è impostata la direzione.

direction

integer

(Facoltativo) Immutabile. La direzione dei cardinali in gradi con il nord che rappresenta 0. [0-360].

elevationMetersSet

boolean

Obbligatorio. True se elevazioneMeters è impostata.

elevationMeters

number

(Facoltativo) Immutabile. La distanza dal bordo inferiore dell'unità pubblicitaria al suolo in metri.

physicalWidthMetersSet

boolean

Obbligatorio. Vero se è impostato l'utilizzo di fisicheLarghezzaMeters.

physicalWidthMeters

number

(Facoltativo) Immutabile. La larghezza fisica dell'unità pubblicitaria in metri.

physicalHeightMetersSet

boolean

Obbligatorio. True se è impostato l'HeightMeters fisici.

physicalHeightMeters

number

(Facoltativo) Immutabile. L'altezza fisica dell'unità pubblicitaria in metri.

venue

enum (OutOfHomeVenue)

(Facoltativo) Il tipo di locale fuori casa in base agli standard del DPAA. Si tratta di un campo informativo che può essere presentato agli inserzionisti e può anche essere utilizzato per filtrare le unità pubblicitarie.

fixedLocation

boolean

(Facoltativo) Se l'annuncio si trova in una posizione fissa (billboard) o in movimento (taxi).

indoors

boolean

Obbligatorio. Indica se l'unità pubblicitaria è interna.

impressionDataRanges[]

object (ImpressionDataRange)

Obbligatorio. Gli intervalli di dati sulle impressioni associati a questa unità pubblicitaria. Non è previsto che gli intervalli di date si sovrappongano. I dati sulle impressioni sono necessari affinché l'unità pubblicitaria sia idonea all'acquisto.

photoUrls[]

string

(Facoltativo) URL di foto dell'unità pubblicitaria.

products[]

string

Obbligatorio. I nomi delle risorse dei prodotti associati a questa unità pubblicitaria nel formato: products/{id}. Ad esempio products/product123.

AdUnitAttribute

Possibili attributi utilizzati per definire ulteriormente l'unità pubblicitaria.

Enum
AD_UNIT_ATTRIBUTE_UNSPECIFIED Valore predefinito quando l'attributo dell'unità pubblicitaria non è specificato o non è noto in questa versione.
AD_UNIT_ATTRIBUTE_ILLUMINATED L'unità pubblicitaria è visibile al buio se si trova nel mondo fisico.
AD_UNIT_ATTRIBUTE_DIGITAL È implicita un'unità pubblicitaria digitale, se non è incluso il fisico classico.
AD_UNIT_ATTRIBUTE_PHYSICAL L'unità pubblicitaria esiste come oggetto nel mondo fisico.

AdUnitState

Stato di un'unità pubblicitaria dal punto di vista del venditore.

Enum
AD_UNIT_STATE_UNSPECIFIED Valore predefinito quando lo stato dell'unità pubblicitaria non è specificato o è sconosciuto in questa versione.
AD_UNIT_STATE_PENDING L'unità pubblicitaria è in attesa di approvazione.
AD_UNIT_STATE_APPROVED L'unità pubblicitaria è approvata.
AD_UNIT_STATE_REJECTED L'unità pubblicitaria è stata rifiutata.
AD_UNIT_STATE_DELETED Unità pubblicitaria eliminata.

OutOfHomeVenue

Elenco dei tipi di sedi esterne in base agli standard del DPAA.

Enum
OOH_VENUE_UNSPECIFIED Valore predefinito quando la sede OOH non è specificata o è sconosciuta in questa versione.
OOH_VENUE_AIRBORNE Luogo fuori casa classificato come in volo.
OOH_VENUE_AIRPORTS_GENERAL Sede esterna classificata come aeroporti generali.
OOH_VENUE_AIRPORTS_BAGGAGE_CLAIM Sede esterna classificata come ritiro bagagli in aeroporto.
OOH_VENUE_AIRPORTS_TERMINAL Sede esterna classificata come terminal degli aeroporti.
OOH_VENUE_AIRPORTS_LOUNGES Struttura esterna classificata come lounge degli aeroporti.
OOH_VENUE_ATMS Locale esterno classificato come bancomat.
OOH_VENUE_BACKLIGHTS Locale esterno classificato come retroilluminazione.
OOH_VENUE_BARS Locale fuori casa classificato come bar.
OOH_VENUE_BENCHES Locale fuori casa classificato come panchine.
OOH_VENUE_BIKE_RACKS Luogo fuori casa classificato come portabici.
OOH_VENUE_BULLETINS Sede fuori casa classificata come bollettini.
OOH_VENUE_BUSES Luogo fuori casa classificato come autobus.
OOH_VENUE_CAFES Locale fuori casa classificato come bar.
OOH_VENUE_CASUAL_DINING_RESTAURANTS Locale fuori casa classificato come ristoranti informali.
OOH_VENUE_CHILD_CARE Sede fuori casa classificata come asilo nido.
OOH_VENUE_CINEMA Locale fuori casa classificato come cinema.
OOH_VENUE_CITY_INFORMATION_PANELS Luogo fuori casa classificato come riquadri informativi sulla città.
OOH_VENUE_CONVENIENCE_STORES Locale esterno classificato come minimarket.
OOH_VENUE_DEDICATED_WILD_POSTING Luogo esterno classificato come pubblicazione selvaggia dedicata.
OOH_VENUE_DOCTORS_OFFICES_GENERAL Sede esterna classificata come studi medici generali.
OOH_VENUE_DOCTORS_OFFICES_OBSTETRICS Luogo fuori casa classificato come ostetricia degli studi medici.
OOH_VENUE_DOCTORS_OFFICES_PEDIATRICS Struttura esterna classificata come studi medici pediatrici.
OOH_VENUE_FAMILY_ENTERTAINMENT Locale fuori casa classificato come intrattenimento per famiglie.
OOH_VENUE_FERRIES Luogo fuori casa classificato come traghetti.
OOH_VENUE_FINANCIAL_SERVICES Locale esterno classificato come servizi finanziari.
OOH_VENUE_GAS_STATIONS Locale esterno classificato come stazioni di servizio.
OOH_VENUE_GOLF_COURSES Luogo fuori casa classificato come campi da golf.
OOH_VENUE_GYMS Struttura esterna classificata come palestre.
OOH_VENUE_HOSPITALS Struttura esterna classificata come ospedali.
OOH_VENUE_HOTELS Struttura esterna classificata come hotel.
OOH_VENUE_JUNIOR_POSTERS Locale esterno classificato come locandina per ragazzi.
OOH_VENUE_KIOSKS Locale esterno classificato come chioschi.
OOH_VENUE_MALLS_GENERAL Centro fuori casa classificato come centri commerciali generali.
OOH_VENUE_MALLS_FOOD_COURTS Locale fuori casa classificato come aree ristorazione dei centri commerciali.
OOH_VENUE_MARINE Luogo fuori casa classificato come marino.
OOH_VENUE_MOBILE_BILLBOARDS Locale esterno classificato come cartelloni pubblicitari mobile.
OOH_VENUE_MOVIE_THEATER_LOBBIES Locale esterno classificato come sala cinema.
OOH_VENUE_NEWSSTANDS Locale esterno classificato come edicola.
OOH_VENUE_OFFICE_BUILDINGS Sede fuori casa classificata come edifici per uffici.
OOH_VENUE_PHONE_KIOSKS Locale esterno classificato come chioschi telefonici.
OOH_VENUE_POSTERS Locale esterno classificato come poster.
OOH_VENUE_QSR Sede esterna classificata come qsr.
OOH_VENUE_RAIL Luogo esterno classificato come ferroviario.
OOH_VENUE_RECEPTACLES Locale esterno classificato come prese.
OOH_VENUE_RESORTS Struttura esterna classificata come resort.
OOH_VENUE_RETAIL Locale esterno classificato come vendita al dettaglio.
OOH_VENUE_SALONS Centro fuori casa classificato come parrucchiere.
OOH_VENUE_SHELTERS Luogo esterno classificato come rifugi.
OOH_VENUE_SPORTS_ARENAS Sede esterna classificata come arene sportive.
OOH_VENUE_SUBWAY Locale fuori casa classificato come metropolitana.
OOH_VENUE_TAXIS Locale esterno classificato come taxi.
OOH_VENUE_TRUCKSIDE Locale fuori casa classificato come lato camion.
OOH_VENUE_UNIVERSITIES Sede esterna classificata come università.
OOH_VENUE_URBAN_PANELS Locale esterno classificato come pannelli urbani.
OOH_VENUE_VETERINARIAN_OFFICES Luogo fuori casa classificato come ambulatori veterinari.
OOH_VENUE_WALLS Locale fuori casa classificato come pareti.
OOH_VENUE_OTHER Locale fuori casa classificato come altro.

ImpressionDataRange

Dati sulle impressioni per un intervallo di date.

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

string (Timestamp format)

Obbligatorio. Inizio dell'intervallo in cui i dati sulle impressioni sono validi (inclusi).

Un timestamp nel formato RFC3339 UTC "Zulu" con risoluzione in nanosecondi e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

impressionDataEndTime

string (Timestamp format)

Obbligatorio. Fine dell'intervallo in cui i dati sulle impressioni sono validi (esclusi).

Un timestamp nel formato RFC3339 UTC "Zulu" con risoluzione in nanosecondi e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

impressionDataUnits[]

object (ImpressionDataUnit)

Obbligatorio. Dati relativi alle impressioni per l'intervallo di date specificato.

ImpressionDataUnit

Dati delle impressioni per un determinato giorno della settimana e ore del giorno.

Rappresentazione JSON
{
  "dayOfWeek": enum (DayOfWeek),
  "hourOfDay": integer,
  "impressions": string
}
Campi
dayOfWeek

enum (DayOfWeek)

Obbligatorio. Giorno della settimana rappresentato dai dati delle impressioni.

hourOfDay

integer

Obbligatorio. Le ore del giorno rappresentate dai dati sulle impressioni nel formato 24 ore. Deve essere compreso tra 0 e 23.

impressions

string (int64 format)

Obbligatorio. Numero di impressioni nel giorno della settimana specificato alle ore del giorno specificate.

Metodi

create

Crea una nuova unità pubblicitaria.

delete

Elimina un'unità pubblicitaria esistente.

get

Recupera una singola unità pubblicitaria.

list

Elenca le unità pubblicitarie.

patch

Consente di aggiornare un'unità pubblicitaria esistente.