REST Resource: adUnits

Recurso: AdUnit

Una sola unidad de anuncios.

Representación 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
  ]
}
Campos
name

string

Es el nombre del recurso de la unidad de anuncios en el formato adUnits/{id}. Por ejemplo, adUnits/adUnit123.
externalId

string

Opcional. Es posible que el ID administrado por el vendedor se encuentre en su propio sistema. Una vez que se configura, es poco probable que cambie. No debe usarse a nivel interno y no se aplican restricciones de manera forzosa.
displayName

string

Obligatorio. Es el nombre visible de la unidad de anuncios.

Debe estar codificado en UTF-8, con un tamaño máximo de 240 bytes.
description

string

Opcional. Es el campo de formato libre adicional para describir la unidad de anuncios.
labels

map (key: string, value: string)

Opcional. Es el conjunto de etiquetas de formato libre para describir esta unidad de anuncios.

Es un objeto que contiene una lista de pares "key": value. Ejemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
attributes[]

enum (AdUnitAttribute)

Opcional. Son los atributos para definir aún más esta unidad de anuncios.
creatives[]

object (CreativeSpecification)

Opcional. Es la lista de creatividades permitidas que se pueden publicar para esta unidad de anuncios. Esto también se puede definir a nivel del producto.
createTime

string (Timestamp format)

Solo salida. Es la marca de tiempo de creación de la unidad de anuncios.

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Solo salida. Marca de tiempo de la última actualización de la unidad de anuncios.

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".
state

enum (AdUnitState)

Solo salida. Es el estado de la unidad de anuncios. Si es AD_UNIT_STATE_REJECTED, el motivo rechazado tendrá el motivo.
rejectedReason

string

Solo salida. Si aprueba_status es AD_UNIT_APPROVAL_STATUS_REJECTED, este campo contendrá el motivo.
location

object (LatLng)

Obligatorio. Inmutable. Es la latitud y longitud de la unidad de anuncios en formato de grados con signo.
directionSet

boolean

Obligatorio. Es verdadero si se estableció una dirección.
direction

integer

Opcional. Inmutable. La dirección cardinal en grados, en la que el norte representa 0. [0-360].
elevationMetersSet

boolean

Obligatorio. Es verdadero si se establece ElevationMeters.
elevationMeters

number

Opcional. Inmutable. Es la distancia en metros desde la parte inferior de la unidad de anuncios hasta el suelo.
physicalWidthMetersSet

boolean

Obligatorio. Es verdadero si se establece físicoWidthMeters.
physicalWidthMeters

number

Opcional. Inmutable. Es el ancho físico de la unidad de anuncios en metros.
physicalHeightMetersSet

boolean

Obligatorio. Es verdadero si se establece físicoHeightMeters.
physicalHeightMeters

number

Opcional. Inmutable. Es la altura física de la unidad de anuncios en metros.
venue

enum (OutOfHomeVenue)

Opcional. El tipo de local externo según los estándares de la DPAA. Se trata de un campo informativo que se puede presentar a los anunciantes y que también se puede usar para filtrar unidades de anuncios.
fixedLocation

boolean

Opcional. Si el anuncio está en una ubicación fija (valla publicitaria) o se encuentra en movimiento (taxi).
indoors

boolean

Obligatorio. Indica si la unidad de anuncios es en interiores.
impressionDataRanges[]

object (ImpressionDataRange)

Obligatorio. Son los rangos de datos de impresiones asociados a esta unidad de anuncios. No se espera que los períodos se superpongan. Los datos de las impresiones son obligatorios para que la unidad de anuncios sea apta para la compra.
photoUrls[]

string

Opcional. Son las URLs de las fotos de la unidad de anuncios.
products[]

string

Obligatorio. Son los nombres de recursos de productos asociados con esta unidad de anuncios en el formato: products/{id}. Por ejemplo, products/product123.

AdUnitAttribute

Son los atributos posibles que se usan para definir con más detalle la unidad de anuncios.

Enumeraciones
AD_UNIT_ATTRIBUTE_UNSPECIFIED Es el valor predeterminado cuando no se especifica el atributo de la unidad de anuncios en esta versión o se desconoce.
AD_UNIT_ATTRIBUTE_ILLUMINATED La unidad de anuncios es visible en la oscuridad si se encuentra en el mundo físico.
AD_UNIT_ATTRIBUTE_DIGITAL Si no se incluye una unidad de anuncios digital, está implícita.
AD_UNIT_ATTRIBUTE_PHYSICAL La unidad de anuncios existe como un objeto en el mundo físico.

AdUnitState

Estado de una unidad de anuncios desde la perspectiva de un vendedor

Enumeraciones
AD_UNIT_STATE_UNSPECIFIED Es el valor predeterminado cuando no se especifica el estado de la unidad de anuncios o se desconoce en esta versión.
AD_UNIT_STATE_PENDING La unidad de anuncios está pendiente de aprobación.
AD_UNIT_STATE_APPROVED Se aprobó la unidad de anuncios.
AD_UNIT_STATE_REJECTED Se rechazó la unidad de anuncios.
AD_UNIT_STATE_DELETED Se borró la unidad de anuncios.

OutOfHomeVenue

Es una lista de los tipos de lugares que no son locales según los estándares de la DPAA.

Enumeraciones
OOH_VENUE_UNSPECIFIED Valor predeterminado cuando no se especifica o se desconoce el lugar OOH en esta versión.
OOH_VENUE_AIRBORNE Lugar fuera de casa categorizado como aéreo.
OOH_VENUE_AIRPORTS_GENERAL Lugar fuera de casa categorizado como aeropuertos generales.
OOH_VENUE_AIRPORTS_BAGGAGE_CLAIM Lugar fuera de casa categorizado como área de retiro de equipaje de aeropuertos.
OOH_VENUE_AIRPORTS_TERMINAL Lugar fuera de casa categorizado como terminal de aeropuertos.
OOH_VENUE_AIRPORTS_LOUNGES Lugar fuera de casa categorizado como salas de aeropuertos.
OOH_VENUE_ATMS Lugar fuera de casa categorizado como cajeros automáticos.
OOH_VENUE_BACKLIGHTS Local exterior categorizado como retroiluminación.
OOH_VENUE_BARS Establecimiento exterior categorizado como bares.
OOH_VENUE_BENCHES Lugar fuera de casa categorizado como bancos.
OOH_VENUE_BIKE_RACKS Lugar fuera de casa categorizado como portabicicletas.
OOH_VENUE_BULLETINS Sede fuera de casa categorizada como boletines.
OOH_VENUE_BUSES Local exterior categorizado como autobuses.
OOH_VENUE_CAFES Establecimiento exterior categorizado como cafeterías.
OOH_VENUE_CASUAL_DINING_RESTAURANTS Lugar fuera de casa categorizado como restaurantes informales.
OOH_VENUE_CHILD_CARE Lugar fuera de casa categorizado como cuidado infantil.
OOH_VENUE_CINEMA Establecimiento externo categorizado como cine.
OOH_VENUE_CITY_INFORMATION_PANELS Local exterior categorizado como paneles informativos sobre la ciudad.
OOH_VENUE_CONVENIENCE_STORES Establecimiento exterior categorizado como minimercados.
OOH_VENUE_DEDICATED_WILD_POSTING Lugar fuera de casa categorizado como publicación salvaje dedicada.
OOH_VENUE_DOCTORS_OFFICES_GENERAL Establecimiento exterior clasificado como consultorios médicos generales.
OOH_VENUE_DOCTORS_OFFICES_OBSTETRICS Establecimiento exterior categorizado como consultorio médico y obstetricia.
OOH_VENUE_DOCTORS_OFFICES_PEDIATRICS Establecimiento externo categorizado como consultorios médicos y pediatría.
OOH_VENUE_FAMILY_ENTERTAINMENT Establecimiento exterior clasificado como entretenimiento familiar.
OOH_VENUE_FERRIES Lugar fuera de casa categorizado como ferris.
OOH_VENUE_FINANCIAL_SERVICES Lugar fuera de casa categorizado como servicios financieros.
OOH_VENUE_GAS_STATIONS Establecimiento externo categorizado como gasolineras.
OOH_VENUE_GOLF_COURSES Lugar fuera de casa categorizado como campos de golf.
OOH_VENUE_GYMS Establecimiento exterior categorizado como gimnasios.
OOH_VENUE_HOSPITALS Establecimiento externo categorizado como hospitales.
OOH_VENUE_HOTELS Lugar fuera de la casa categorizado como hoteles.
OOH_VENUE_JUNIOR_POSTERS Lugar fuera de casa categorizado como pósteres júnior.
OOH_VENUE_KIOSKS Establecimiento externo categorizado como kioscos.
OOH_VENUE_MALLS_GENERAL Establecimiento exterior clasificado como centros comerciales generales.
OOH_VENUE_MALLS_FOOD_COURTS Lugar fuera de casa categorizado como patios de comidas de centros comerciales.
OOH_VENUE_MARINE Lugar fuera de casa categorizado como marino.
OOH_VENUE_MOBILE_BILLBOARDS Lugar fuera de casa categorizado como vallas publicitarias móviles.
OOH_VENUE_MOVIE_THEATER_LOBBIES Lugar fuera del hogar categorizado como vestíbulos de cines.
OOH_VENUE_NEWSSTANDS Establecimiento exterior clasificado como kioscos.
OOH_VENUE_OFFICE_BUILDINGS Local exterior categorizado como edificios de oficinas.
OOH_VENUE_PHONE_KIOSKS Lugar fuera de casa categorizado como kioscos telefónicos.
OOH_VENUE_POSTERS Lugar fuera de casa categorizado como pósteres.
OOH_VENUE_QSR Lugar fuera de casa categorizado como qsr.
OOH_VENUE_RAIL Establecimiento exterior clasificado como riel.
OOH_VENUE_RECEPTACLES Lugar fuera de casa categorizado como receptáculos.
OOH_VENUE_RESORTS Lugar fuera de casa categorizado como complejos turísticos.
OOH_VENUE_RETAIL Establecimiento exterior clasificado como de venta minorista.
OOH_VENUE_SALONS Establecimiento exterior categorizado como salones de belleza.
OOH_VENUE_SHELTERS Lugar fuera de casa categorizado como refugios.
OOH_VENUE_SPORTS_ARENAS Establecimiento externo categorizado como estadios deportivos.
OOH_VENUE_SUBWAY Lugar fuera de casa categorizado como metro.
OOH_VENUE_TAXIS Local fuera de casa categorizado como taxis.
OOH_VENUE_TRUCKSIDE Lugar fuera de casa categorizado como camión.
OOH_VENUE_UNIVERSITIES Sede fuera del hogar categorizado como universidades.
OOH_VENUE_URBAN_PANELS Local exterior categorizado como paneles urbanos.
OOH_VENUE_VETERINARIAN_OFFICES Lugar fuera del hogar categorizado como consultorios veterinarios.
OOH_VENUE_WALLS Establecimiento exterior clasificado como paredes.
OOH_VENUE_OTHER Lugar fuera de casa categorizado como otro.

ImpressionDataRange

Datos de impresiones para un período.

Representación JSON 
{
  "impressionDataStartTime": string,
  "impressionDataEndTime": string,
  "impressionDataUnits": [
    {
      object (ImpressionDataUnit)
    }
  ]
}
Campos
impressionDataStartTime

string (Timestamp format)

Obligatorio. Inicio del intervalo cuando los datos de impresión son válidos (inclusive).

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".
impressionDataEndTime

string (Timestamp format)

Obligatorio. Final del intervalo cuando los datos de impresión son válidos (exclusivo).

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".
impressionDataUnits[]

object (ImpressionDataUnit)

Obligatorio. Son los datos de impresiones durante el período especificado.

ImpressionDataUnit

Son los datos de impresiones de un día de la semana y una hora del día determinados.

Representación JSON 
{
  "dayOfWeek": enum (DayOfWeek),
  "hourOfDay": integer,
  "impressions": string
}
Campos
dayOfWeek

enum (DayOfWeek)

Obligatorio. Día de la semana que representan los datos de impresiones.
hourOfDay

integer

Obligatorio. Son las horas del día que los datos de impresiones representan en un formato de 24 horas. Debe ser del 0 al 23.
impressions

string (int64 format)

Obligatorio. Cantidad de impresiones en el día de la semana especificado a las horas especificadas.

Métodos

create

 Crea una nueva unidad de anuncios.

delete

 Borra una unidad de anuncios existente.

get

 Recupera una unidad de anuncios individual.

list

 Muestra una lista de las unidades de anuncios.

patch

 Actualiza una unidad de anuncios existente.