REST Resource: advertisers

Recurso: anunciante

Ter 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)
  }
}
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 ao qual o anunciante pertence.
displayName

string

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

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 primeira exclusão.
updateTime

string (Timestamp format)

Apenas saída. O carimbo de data/hora em que o anunciante foi atualizado pela última vez. Atribuído pelo sistema.

Um carimbo de data/hora no formato UTC "Zulu" RFC3339, 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".
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 ao criativo 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, somente integrationCode é aplicável ao anunciante. Outros campos de IntegrationDetails não são aceitos e serão ignorados se 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 o Mediaocean (Prisma) está ativada. Ao ativar essa opção, você concorda com o seguinte:

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

object (AdvertiserBillingConfig)

Configurações relacionadas ao faturamento do anunciante.

AdvertiserGeneralConfig

Configurações gerais de um anunciante.

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

string

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

Forneça 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 terceirizados, ele é igual ao do parceiro pai.
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 : forint húngaro
  • IDR : rúpia 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 : zloti polonês
  • RON : novo leu romeno
  • RUB : rublo russo
  • SEK : coroa sueca
  • TRY : lira turca
  • TWD : novo dólar de Taiwan
  • USD : dólar americano
  • ZAR : rande sul-africano

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 apenas 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 apenas servidores de anúncios de terceiros.

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

boolean

Se os relatórios de ID do pedido para pixels estão ativados ou não. Não será possível mudar esse valor 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 dos anunciantes do CM360 que compartilham a configuração do Floodlight do CM360.
cmSyncableSiteIds[]

string (int64 format)

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

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

Remover sites desta lista pode fazer com que os criativos do DV360 sincronizados no CM360 sejam excluídos. Pelo menos um site deve ser especificado.
dv360ToCmDataSharingEnabled

boolean

Incluir ou não dados do DV360 nos relatórios de transferência de dados do CM360.
dv360ToCmCostReportingEnabled

boolean

Indica se o custo do DV360 será informado ou não ao CM360.
cmFloodlightLinkingAuthorized

boolean

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

AdvertiserCreativeConfig

Configurações relacionadas aos 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 pelo Integral Ad Service (IAS). O sistema do DV360 anexará uma tag "Campaign Monitor" da IAS com esse ID à tag do criativo.
obaComplianceDisabled

boolean

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 (na interação com a opção "Sobre este anúncio") aos seus anúncios para publicidade comportamental on-line (OBA, na sigla em inglês) e requisitos regulamentares. A opção Sobre este anúncio oferece aos usuários mais controle sobre os anúncios que eles veem e ajuda a explicar por que eles estão vendo o anúncio. Saiba mais.

Se você definir esse campo como true, os anúncios veiculados pelo Display & Video 360 precisarão obedecer ao seguinte:

  • Estar em conformidade com a publicidade comportamental on-line (OBA, na sigla em inglês), conforme seu contrato com o Google Marketing Platform.
  • No Espaço Econômico Europeu (EEE), é preciso incluir informações de transparência e um mecanismo para os usuários denunciarem conteúdo ilegal em anúncios. Se você usar uma solução alternativa de selos de publicidade, transparência e denúncia, confira se ela inclui as informações de transparência necessárias e o mecanismo de sinalização de conteúdo ilegal. Além disso, notifique o Google sobre denúncias de conteúdo ilegal usando o formulário apropriado.
dynamicCreativeEnabled

boolean

Se o anunciante está habilitado para criativos dinâmicos ou não.
videoCreativeDataSharingAuthorized

boolean

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

Aplicável somente 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, na sigla em inglês) do anunciante.

Se não forem especificadas, as configurações de SDF do parceiro pai serão usadas.

AdvertiserSdfConfig

Configurações dos arquivos de dados estruturados (SDF, na sigla em inglês) de um anunciante.

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

boolean

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

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

object (SdfConfig)

A configuração do 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

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

AdvertiserBillingConfig

Configurações relacionadas ao faturamento de um anunciante.

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

string (int64 format)

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

Por padrão, esse campo usará o ID do perfil de faturamento padrão do parceiro principal do anunciante se um valor não for fornecido.

Métodos

audit

 Audita um anunciante.

create

 Cria um novo anunciante.

delete

 Exclui um anunciante.

editAssignedTargetingOptions

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

get

 Extrai um anunciante.

list

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

listAssignedTargetingOptions

 Lista as opções de segmentação atribuídas a um anunciante em vários tipos de segmentação.

patch

 Atualiza um anunciante existente.