REST Resource: advertisers

Recurso: Advertiser

Um único anunciante no Display & Video 360 (DV360).

Representação JSON 
{
  "name": string,
  "advertiserId": string,
  "partnerId": string,
  "displayName": string,
  "entityStatus": enum (EntityStatus),
  "updateTime": string,
  "generalConfig": {
    object (AdvertiserGeneralConfig)
  },
  "adServerConfig": {
    object (AdvertiserAdServerConfig)
  },
  "creativeConfig": {
    object (AdvertiserCreativeConfig)
  },
  "dataAccessConfig": {
    object (AdvertiserDataAccessConfig)
  },
  "integrationDetails": {
    object (IntegrationDetails)
  },
  "servingConfig": {
    object (AdvertiserTargetingConfig)
  },
  "prismaEnabled": boolean,
  "billingConfig": {
    object (AdvertiserBillingConfig)
  },
  "containsEuPoliticalAds": enum (EuPoliticalAdvertisingStatus)
}
Campos
name

string

Apenas saída. O nome do recurso do anunciante.
advertiserId

string (int64 format)

Apenas saída. O ID exclusivo do anunciante. Atribuído pelo sistema.
partnerId

string (int64 format)

Obrigatório. Imutável. O ID exclusivo do parceiro a que o anunciante pertence.
displayName

string

Obrigatório. O nome de exibição do anunciante.

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

enum (EntityStatus)

Obrigatório. Controla se os pedidos de inserção e os itens de linha do anunciante podem gastar os orçamentos e dar lances no inventário.

  • Os valores aceitos são ENTITY_STATUS_ACTIVE, ENTITY_STATUS_PAUSED e ENTITY_STATUS_SCHEDULED_FOR_DELETION.
  • Se definido como ENTITY_STATUS_SCHEDULED_FOR_DELETION, o anunciante será excluído 30 dias após a data em que foi programado para exclusão.
updateTime

string (Timestamp format)

Apenas saída. O carimbo de data/hora da última atualização do anunciante. Atribuído pelo sistema.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
generalConfig

object (AdvertiserGeneralConfig)

Obrigatório. Configurações gerais do anunciante.
adServerConfig

object (AdvertiserAdServerConfig)

Obrigatório. Imutável. Configurações relacionadas ao servidor de anúncios do anunciante.
creativeConfig

object (AdvertiserCreativeConfig)

Obrigatório. Configurações relacionadas a criativos do anunciante.
dataAccessConfig

object (AdvertiserDataAccessConfig)

Configurações que controlam como os dados do anunciante podem ser acessados.
integrationDetails

object (IntegrationDetails)

Detalhes da integração do anunciante. No momento, apenas integrationCode é aplicável ao anunciante. Outros campos de IntegrationDetails não são compatíveis e serão ignorados se forem fornecidos.
servingConfig

object (AdvertiserTargetingConfig)

Configurações de segmentação relacionadas à veiculação de anúncios do anunciante.
prismaEnabled

boolean

Indica se a integração com a Mediaocean (Prisma) está ativada. Ao ativar esse recurso, você concorda com o seguinte:

Em nome da minha empresa, autorizo a Mediaocean (Prisma) a enviar planos de segmento de orçamento ao Google. Também autorizo o Google a enviar os relatórios e as faturas correspondentes do DV360 à Mediaocean para fins de planejamento de orçamento, faturamento e reconciliação do anunciante.
billingConfig

object (AdvertiserBillingConfig)

Obrigatório. Configurações relacionadas ao faturamento do anunciante.
containsEuPoliticalAds

enum (EuPoliticalAdvertisingStatus)

Opcional. Se este anunciante tem itens de linha que veiculam anúncios políticos da União Europeia.

Se este campo estiver definido como DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING, vai acontecer o seguinte:

  • Todos os novos itens de linha criados para esse anunciante vão receber DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING, a menos que seja especificado de outra forma.
  • Todos os itens de linha atuais desse anunciante que não têm um valor definido serão atualizados para DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING em um dia.

AdvertiserGeneralConfig

Configurações gerais de um anunciante.

Representação JSON 
{
  "domainUrl": string,
  "timeZone": string,
  "currencyCode": string
}
Campos
domainUrl

string

Obrigatório. O URL do domínio do site principal do anunciante. O sistema envia essas informações aos editores que precisam do URL do site para associar uma campanha a um anunciante.

Informe um URL sem caminho ou string de consulta, começando com http: ou https:. Por exemplo, http://www.example.com
timeZone

string

Apenas saída. O nome padrão do banco de dados TZ do fuso horário do anunciante. Por exemplo, America/New_York.

Saiba mais em: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones

Para anunciantes híbridos do CM360, o fuso horário é o mesmo da conta associada do CM360. Para anunciantes exclusivos de terceiros, o fuso horário é o mesmo do parceiro principal.
currencyCode

string

Obrigatório. Imutável. Moeda do anunciante no formato ISO 4217.

Os códigos aceitos e as moedas que eles representam são:

Código da moeda : nome da moeda

  • ARS : peso argentino
  • AUD : dólar australiano
  • BRL : real brasileiro
  • CAD : dólar canadense
  • CHF : franco suíço
  • CLP : peso chileno
  • CNY : Yuan chinês
  • COP : peso colombiano
  • CZK : coroa tcheca
  • DKK : coroa dinamarquesa
  • EGP : libra egípcia
  • EUR : euro
  • GBP : libra esterlina
  • HKD : dólar de Hong Kong
  • HUF : florim húngaro
  • IDR : rupia indonésia
  • ILS : shekel israelense
  • INR : rúpia indiana
  • JPY : iene japonês
  • KRW : won sul-coreano
  • MXN : pesos mexicanos
  • MYR : ringgit malaio
  • NGN : naira nigeriana
  • NOK : coroa norueguesa
  • NZD : dólar neozelandês
  • PEN : novo sol peruano
  • PLN : zloty polonês
  • RON : Novo leu romeno
  • RUB : rublo russo
  • SEK : coroa sueca
  • TRY : lira turca
  • TWD : novo dólar taiwanês
  • USD : dólar americano
  • ZAR : rand da África do Sul

AdvertiserAdServerConfig

Configurações relacionadas ao servidor de anúncios de um anunciante.

Representação JSON 
{

  // Union field ad_server_config_scheme can be only one of the following:
  "thirdPartyOnlyConfig": {
    object (ThirdPartyOnlyConfig)
  },
  "cmHybridConfig": {
    object (CmHybridConfig)
  }
  // End of list of possible types for union field ad_server_config_scheme.
}
Campos
Campo de união ad_server_config_scheme. Obrigatório. ad_server_config_scheme pode ser apenas de um dos tipos a seguir:
thirdPartyOnlyConfig

object (ThirdPartyOnlyConfig)

A configuração para anunciantes que usam somente servidores de anúncios de terceiros.
cmHybridConfig

object (CmHybridConfig)

A configuração para anunciantes que usam o Campaign Manager 360 (CM360) e servidores de anúncios de terceiros.

ThirdPartyOnlyConfig

Configurações para anunciantes que usam somente servidores de anúncios de terceiros.

Representação JSON 
{
  "pixelOrderIdReportingEnabled": boolean
}
Campos
pixelOrderIdReportingEnabled

boolean

Indica se os relatórios de ID do pedido para pixels estão ativados ou não. Esse valor não pode ser mudado depois de definido como true.

CmHybridConfig

Configurações para anunciantes que usam o Campaign Manager 360 (CM360) e servidores de anúncios de terceiros.

Representação JSON 
{
  "cmAccountId": string,
  "cmFloodlightConfigId": string,
  "cmAdvertiserIds": [
    string
  ],
  "cmSyncableSiteIds": [
    string
  ],
  "dv360ToCmDataSharingEnabled": boolean,
  "dv360ToCmCostReportingEnabled": boolean,
  "cmFloodlightLinkingAuthorized": boolean
}
Campos
cmAccountId

string (int64 format)

Obrigatório. Imutável. ID da conta da configuração do Floodlight do CM360 vinculada ao anunciante do DV360.
cmFloodlightConfigId

string (int64 format)

Obrigatório. Imutável. ID da configuração do Floodlight do CM360 vinculada ao anunciante do DV360.
cmAdvertiserIds[]

string (int64 format)

Apenas saída. O conjunto de IDs de anunciante do CM360 que compartilham a configuração do Floodlight do CM360.
cmSyncableSiteIds[]

string (int64 format)

Uma lista de sites do CM360 cujas posições serão sincronizadas com o DV360 como criativos.

Se estiver ausente ou vazio no método advertisers.create, o sistema vai criar automaticamente um site do CM360.

A remoção de sites dessa lista pode excluir os criativos do DV360 sincronizados do CM360. É necessário especificar pelo menos um site.
dv360ToCmDataSharingEnabled

boolean

Se os dados do DV360 devem ser incluídos nos relatórios da Transferência de dados do CM360.
dv360ToCmCostReportingEnabled

boolean

Se o custo do DV360 será informado ao CM360.
cmFloodlightLinkingAuthorized

boolean

Obrigatório. Imutável. Ao definir esse campo como true, você, em nome da sua empresa, autoriza o compartilhamento de informações da configuração do Floodlight especificada com este anunciante do Display & Video 360.

AdvertiserCreativeConfig

Configurações relacionadas a criativos de um anunciante.

Representação JSON 
{
  "iasClientId": string,
  "obaComplianceDisabled": boolean,
  "dynamicCreativeEnabled": boolean,
  "videoCreativeDataSharingAuthorized": boolean
}
Campos
iasClientId

string (int64 format)

Um ID para configurar o monitoramento de campanha fornecido pela Integral Ad Service (IAS). O sistema do DV360 vai anexar uma tag "Campaign Monitor" da IAS com esse ID à tag de criativo.
obaComplianceDisabled

boolean

Se você quer desativar ou não o recurso "Sobre este anúncio" do Google, que adiciona selos (para identificar o conteúdo como um anúncio) e informações de transparência (ao interagir com "Sobre este anúncio") aos seus anúncios para publicidade comportamental on-line (OBA, na sigla em inglês) e requisitos regulamentares. Com a opção "Sobre este anúncio", os usuários têm mais controle sobre os anúncios que veem, e você pode explicar por que eles estão vendo seu anúncio. Saiba mais.

Se você definir esse campo como true, observe que os anúncios veiculados pelo Display & Video 360 precisam obedecer ao seguinte:

  • Estar em conformidade com a publicidade comportamental on-line (OBA), de acordo com seu contrato com o Google Marketing Platform.
  • No Espaço Econômico Europeu (EEE), inclua informações de transparência e um mecanismo para os usuários denunciarem conteúdo ilegal nos anúncios. Se você usar outra solução de selos de publicidade, transparência e relatórios, verifique se ela inclui as informações de transparência e o mecanismo de sinalização de conteúdo ilegal necessários. Além disso, notifique o Google sobre denúncias de conteúdo ilegal usando o formulário adequado.
dynamicCreativeEnabled

boolean

Indica se o anunciante está ativado para criativos dinâmicos.
videoCreativeDataSharingAuthorized

boolean

Ao definir esse campo como true, você, em nome da sua empresa, autoriza o Google a usar criativos em vídeo associados a esse anunciante do Display & Video 360 para fornecer relatórios e recursos relacionados às campanhas de televisão do anunciante.

Aplicável apenas quando o anunciante tem uma configuração de servidor de anúncios CM360 hybrid.

AdvertiserDataAccessConfig

Configurações que controlam como os dados relacionados ao anunciante podem ser acessados.

Representação JSON 
{
  "sdfConfig": {
    object (AdvertiserSdfConfig)
  }
}
Campos
sdfConfig

object (AdvertiserSdfConfig)

Configurações de arquivos de dados estruturados (SDF) para o anunciante.

Se não for especificado, as configurações de SDF do parceiro principal serão usadas.

AdvertiserSdfConfig

Configurações de arquivos de dados estruturados (SDFs) de um anunciante.

Representação JSON 
{
  "overridePartnerSdfConfig": boolean,
  "sdfConfig": {
    object (SdfConfig)
  }
}
Campos
overridePartnerSdfConfig

boolean

Indica se o anunciante substitui ou não a configuração da SDF do parceiro principal.

Por padrão, um anunciante herda a configuração da SDF do parceiro principal. Para substituir a configuração do parceiro, defina este campo como true e forneça a nova configuração em sdfConfig.
sdfConfig

object (SdfConfig)

A configuração da SDF para o anunciante.

AdvertiserTargetingConfig

Configurações de segmentação relacionadas à veiculação de anúncios de um anunciante.

Representação JSON 
{
  "exemptTvFromViewabilityTargeting": boolean
}
Campos
exemptTvFromViewabilityTargeting

boolean

Se os dispositivos de smart TV estão isentos da segmentação de visibilidade para todos os itens de linha de vídeo do anunciante.

AdvertiserBillingConfig

Configurações relacionadas ao faturamento de um anunciante.

Representação JSON 
{
  "billingProfileId": string
}
Campos
billingProfileId

string (int64 format)

Obrigatório. O ID de um perfil de faturamento atribuído ao anunciante.

Métodos

audit

 Audita um anunciante.

create

 Cria um novo anunciante.

delete

 Exclui um anunciante.

editAssignedTargetingOptions

 Edita opções de segmentação em um único anunciante.

get

 Recebe um anunciante.

list

 Lista os anunciantes acessíveis ao usuário atual.

listAssignedTargetingOptions

 Lista as opções de segmentação atribuídas de um anunciante em todos os tipos de segmentação.

patch

 Atualiza um anunciante.