REST Resource: sellers.adUnits

Recurso: Bloco de anúncios

Um único bloco de anúncios.

Representação 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,
  "photoUris": [
    string
  ],
  "products": [
    string
  ]
}
Campos
name

string

O nome de recurso do bloco de anúncios no formato: sellers/{seller}/adUnits/{adUnit}. Por exemplo, sellers/seller321/adUnits/adUnit123.
externalId

string

ID gerenciado pelo vendedor, supostamente no próprio sistema. Após a configuração, é improvável que mude.
displayName

string

Obrigatório. O nome de exibição do bloco de anúncios.

Precisa ser codificado em UTF-8 com tamanho máximo de 240 bytes.
description

string

Campo de formato livre adicional para descrever o bloco de anúncios.
labels

map (key: string, value: string)

O conjunto de rótulos de forma livre para descrever este bloco de anúncios.

Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
attributes[]

enum (AdUnitAttribute)

Atributos para definir melhor esse bloco de anúncios.
creatives[]

object (CreativeSpecification)

Lista de criativos permitidos que podem ser veiculados para este bloco de anúncios. Isso também pode ser definido no nível do produto.
createTime

string (Timestamp format)

Apenas saída. Carimbo de data/hora de criação do bloco de anúncios.

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Apenas saída. Carimbo de data/hora da última atualização do bloco de anúncios.

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
state

enum (AdUnitState)

Apenas saída. O estado do bloco de anúncios. Se AD_UNIT_STATE_REJECTED, o knownReason contém o motivo.
rejectedReason

string

Apenas saída. Se approval_status for AD_UNIT_APPROVAL_STATUS_REJECTED, esse campo conterá o motivo.
location

object (LatLng)

Obrigatório. Imutável. A latitude e a longitude do bloco de anúncios no formato de graus com sinal.
directionSet

boolean

Se verdadeiro, o campo de direção conterá o valor de direção. Se falso, a direção deve ser zero.
direction

integer

Imutável. A direção cardeal em graus com o norte representando 0. [0 a 360].
elevationMetersSet

boolean

Se verdadeiro, o campo de elevação conterá a elevação em metros. Se falso, a elevação deve ser zero.
elevationMeters

number

Imutável. A distância da parte inferior do bloco de anúncios até o solo, em metros.
physicalWidthMetersSet

boolean

Se for verdadeiro, o campo "PhysicalWidthMeters" conterá a largura física em metros. Se for falso, ele deve ser zero.
physicalWidthMeters

number

Imutável. A largura física do bloco de anúncios em metros.
physicalHeightMetersSet

boolean

Se verdadeiro, o campo "PhysicalHeightMeters" conterá a altura física em metros. Se for falso, "PhysicalHeightMeters" deve ser zero.
physicalHeightMeters

number

Imutável. A altura física do bloco de anúncios em metros.
venue

enum (OutOfHomeVenue)

O tipo de local out of home com base nos padrões da DPAA. Este é um campo informativo que pode ser apresentado aos anunciantes e também pode ser usado para filtrar blocos de anúncios.
fixedLocation

boolean

Se o anúncio está em um local fixo (outdoor) ou em movimento (táxi).
indoors

boolean

Obrigatório. Se o bloco de anúncios é interno.
photoUris[]

string

URIs de fotos do bloco de anúncios.
products[]

string

Obrigatório. Os nomes de recurso dos produtos associados a este bloco de anúncios no formato: sellers/{seller}/products/{product}. Por exemplo, sellers/seller111/products/product123.

AdUnitAttribute

Possíveis atributos usados para definir melhor o bloco de anúncios.

Enums
AD_UNIT_ATTRIBUTE_UNSPECIFIED Valor padrão quando o atributo do bloco de anúncios não é especificado ou é desconhecido nesta versão.
AD_UNIT_ATTRIBUTE_ILLUMINATED O bloco de anúncios é visível no escuro se estiver no mundo físico?
AD_UNIT_ATTRIBUTE_DIGITAL Um bloco de anúncios digital é implícito, se não estiver incluído.
AD_UNIT_ATTRIBUTE_PHYSICAL O bloco de anúncios existe como um objeto no mundo físico.

AdUnitState

Estado de um bloco de anúncios na perspectiva de um vendedor.

Enums
AD_UNIT_STATE_UNSPECIFIED Valor padrão quando o estado do bloco de anúncios não é especificado ou é desconhecido nesta versão.
AD_UNIT_STATE_PENDING A aprovação do bloco de anúncios está pendente.
AD_UNIT_STATE_APPROVED O bloco de anúncios foi aprovado.
AD_UNIT_STATE_REJECTED O bloco de anúncios foi rejeitado.
AD_UNIT_STATE_DELETED O bloco de anúncios foi excluído.

OutOfHomeVenue

Lista de tipos de locais out of home com base nos padrões da DPAA.

Enums
OOH_VENUE_UNSPECIFIED Valor padrão quando o local OOH não está especificado ou é desconhecido nesta versão.
OOH_VENUE_AIRBORNE Local out of home categorizado como aéreo.
OOH_VENUE_AIRPORTS_GENERAL Local "out of home" classificado como aeroportos em geral.
OOH_VENUE_AIRPORTS_BAGGAGE_CLAIM Local out of home categorizado como retirada de bagagens de aeroportos.
OOH_VENUE_AIRPORTS_TERMINAL Local out of home categorizado como terminal de aeroporto.
OOH_VENUE_AIRPORTS_LOUNGES Local out of home categorizado como lounges de aeroporto.
OOH_VENUE_ATMS Local "Fora de casa" categorizado como caixas eletrônicos.
OOH_VENUE_BACKLIGHTS Local "out of home" categorizado como "luzes de fundo".
OOH_VENUE_BARS Local out of home categorizado como bares.
OOH_VENUE_BENCHES Espaço out of home categorizado como bancos.
OOH_VENUE_BIKE_RACKS Local out of home categorizado como bicicletário.
OOH_VENUE_BULLETINS Local de fora de casa categorizado como boletins.
OOH_VENUE_BUSES Local "out of home" classificado como "ônibus".
OOH_VENUE_CAFES Local fora de casa categorizado como cafés.
OOH_VENUE_CASUAL_DINING_RESTAURANTS Local out of home categorizado como restaurantes casuais.
OOH_VENUE_CHILD_CARE Local out of home categorizado como creche.
OOH_VENUE_CINEMA Local out of home categorizado como cinema.
OOH_VENUE_CITY_INFORMATION_PANELS Local out of home categorizado como painéis de informações de cidade.
OOH_VENUE_CONVENIENCE_STORES Local out-of-home categorizado como lojas de conveniência.
OOH_VENUE_DEDICATED_WILD_POSTING Local out of home categorizado como postagem dedicada.
OOH_VENUE_DOCTORS_OFFICES_GENERAL Local out of home categorizado como consultórios médicos em geral.
OOH_VENUE_DOCTORS_OFFICES_OBSTETRICS Local out of home categorizado como consultórios médicos, obstetrícia.
OOH_VENUE_DOCTORS_OFFICES_PEDIATRICS Local out of home categorizado como consultórios médicos em pediatria.
OOH_VENUE_FAMILY_ENTERTAINMENT Local out of home categorizado como entretenimento para a família.
OOH_VENUE_FERRIES Local out of home categorizado como balsa.
OOH_VENUE_FINANCIAL_SERVICES Local out of home categorizado como serviços financeiros.
OOH_VENUE_GAS_STATIONS Local out of home categorizado como postos de gasolina.
OOH_VENUE_GOLF_COURSES Local out of home categorizado como campos de golfe.
OOH_VENUE_GYMS Local out of home categorizado como academias.
OOH_VENUE_HOSPITALS Local out of home categorizado como hospitais.
OOH_VENUE_HOTELS Local out of home categorizado como hotéis.
OOH_VENUE_JUNIOR_POSTERS Local out of home categorizado como pôster júnior.
OOH_VENUE_KIOSKS Local out of home categorizado como quiosques.
OOH_VENUE_MALLS_GENERAL Local out of home categorizado como shoppings em geral.
OOH_VENUE_MALLS_FOOD_COURTS Local out of home categorizado como praça de alimentação de shopping.
OOH_VENUE_MARINE Local out of home categorizado como marinho.
OOH_VENUE_MOBILE_BILLBOARDS Local out of home categorizado como outdoors móveis.
OOH_VENUE_MOVIE_THEATER_LOBBIES Local out of home categorizado como recepções de cinema.
OOH_VENUE_NEWSSTANDS Local out of home categorizado como banca de jornal.
OOH_VENUE_OFFICE_BUILDINGS Local out of home categorizado como edifícios de escritórios.
OOH_VENUE_PHONE_KIOSKS Local out of home categorizado como quiosques de telefonia.
OOH_VENUE_POSTERS Local out of home categorizado como pôster.
OOH_VENUE_QSR Local "Fora de casa" categorizado como "qsr".
OOH_VENUE_RAIL Local out of home categorizado como trem.
OOH_VENUE_RECEPTACLES Local out of home categorizado como receptáculos.
OOH_VENUE_RESORTS Local out of home categorizado como resorts.
OOH_VENUE_RETAIL Local out of home categorizado como varejo.
OOH_VENUE_SALONS Local out of home categorizado como salões de beleza.
OOH_VENUE_SHELTERS Local de fora de casa categorizado como abrigo.
OOH_VENUE_SPORTS_ARENAS Local out of home categorizado como arenas esportivas.
OOH_VENUE_SUBWAY Local "out of home" categorizado como metrô.
OOH_VENUE_TAXIS Local out of home categorizado como táxi.
OOH_VENUE_TRUCKSIDE Local out of home categorizado como "caminhão".
OOH_VENUE_UNIVERSITIES Local de fora de casa categorizado como universidades.
OOH_VENUE_URBAN_PANELS Local out of home categorizado como painéis urbanos.
OOH_VENUE_VETERINARIAN_OFFICES Local out-of-home categorizado como consultórios veterinários.
OOH_VENUE_WALLS Local "fora de casa" categorizado como paredes.
OOH_VENUE_OTHER Local "Fora de casa" categorizado como "Outro".

Métodos

create

 Cria um novo bloco de anúncios.

delete

 Exclui um bloco de anúncios existente.

get

 Recupera um bloco de anúncios individual.

list

 Lista os blocos de anúncios.

patch

 Atualiza um bloco de anúncios existente.