REST Resource: advertisers.campaigns

Recurso: Campaign

Uma única campanha.

Representação JSON 
{
  "name": string,
  "advertiserId": string,
  "campaignId": string,
  "displayName": string,
  "entityStatus": enum (EntityStatus),
  "updateTime": string,
  "campaignGoal": {
    object (CampaignGoal)
  },
  "campaignFlight": {
    object (CampaignFlight)
  },
  "frequencyCap": {
    object (FrequencyCap)
  },
  "campaignBudgets": [
    {
      object (CampaignBudget)
    }
  ]
}
Campos
name

string

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

string (int64 format)

Apenas saída. O ID exclusivo do anunciante a que a campanha pertence.
campaignId

string (int64 format)

Apenas saída. O ID exclusivo da campanha. Atribuído pelo sistema.
displayName

string

Obrigatório. O nome de exibição da campanha.

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 dessa campanha podem gastar os orçamentos e dar lances no inventário.

  • Os valores aceitos são ENTITY_STATUS_ACTIVE, ENTITY_STATUS_ARCHIVED e ENTITY_STATUS_PAUSED.
  • Para o método campaigns.create, ENTITY_STATUS_ARCHIVED não é permitido.
updateTime

string (Timestamp format)

Apenas saída. O carimbo de data/hora da última atualização da campanha. 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".
campaignGoal

object (CampaignGoal)

Obrigatório. A meta da campanha.
campaignFlight

object (CampaignFlight)

Obrigatório. O gasto e a duração planejados da campanha.
frequencyCap

object (FrequencyCap)

Obrigatório. A configuração do limite de frequência da campanha.
campaignBudgets[]

object (CampaignBudget)

A lista de orçamentos disponíveis para esta campanha.

Se esse campo não for definido, a campanha vai usar um orçamento ilimitado.

CampaignGoal

Configurações que controlam a meta de uma campanha.

Representação JSON 
{
  "campaignGoalType": enum (CampaignGoalType),
  "performanceGoal": {
    object (PerformanceGoal)
  }
}
Campos
campaignGoalType

enum (CampaignGoalType)

Obrigatório. O tipo de meta da campanha.
performanceGoal

object (PerformanceGoal)

Obrigatório. A meta de performance da campanha.

Os valores aceitáveis para performanceGoalType são:

  • PERFORMANCE_GOAL_TYPE_CPM
  • PERFORMANCE_GOAL_TYPE_CPC
  • PERFORMANCE_GOAL_TYPE_CPA
  • PERFORMANCE_GOAL_TYPE_CPIAVC
  • PERFORMANCE_GOAL_TYPE_CTR
  • PERFORMANCE_GOAL_TYPE_VIEWABILITY
  • PERFORMANCE_GOAL_TYPE_OTHER

CampaignGoalType

Possíveis tipos de metas de campanha.

Tipos enumerados
CAMPAIGN_GOAL_TYPE_UNSPECIFIED O valor da meta não foi especificado ou é desconhecido nesta versão.
CAMPAIGN_GOAL_TYPE_APP_INSTALL Aumentar instalações ou engajamentos do aplicativo.
CAMPAIGN_GOAL_TYPE_BRAND_AWARENESS Aumentar o reconhecimento de uma marca ou produto.
CAMPAIGN_GOAL_TYPE_OFFLINE_ACTION Impulsione as vendas off-line ou na loja.
CAMPAIGN_GOAL_TYPE_ONLINE_ACTION Impulsionar ações ou visitas on-line.

PerformanceGoal

Configurações que controlam a meta de performance de uma campanha.

Representação JSON 
{
  "performanceGoalType": enum (PerformanceGoalType),

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "performanceGoalAmountMicros": string,
  "performanceGoalPercentageMicros": string,
  "performanceGoalString": string
  // End of mutually exclusive fields.
}
Campos
performanceGoalType

enum (PerformanceGoalType)

Obrigatório. O tipo da meta de performance.
Obrigatório. O valor da meta de performance correspondente a um determinado performance_goal_type. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta:
performanceGoalAmountMicros

string (int64 format)

O valor da meta, em micros da moeda do anunciante.

Aplicável quando performanceGoalType é um dos seguintes:

  • PERFORMANCE_GOAL_TYPE_CPM
  • PERFORMANCE_GOAL_TYPE_CPC
  • PERFORMANCE_GOAL_TYPE_CPA
  • PERFORMANCE_GOAL_TYPE_CPIAVC
  • PERFORMANCE_GOAL_TYPE_VCPM

Por exemplo, 1500000 representa 1,5 unidades padrão da moeda.
performanceGoalPercentageMicros

string (int64 format)

A representação decimal da porcentagem da meta em micros.

Aplicável quando performanceGoalType é um dos seguintes:

  • PERFORMANCE_GOAL_TYPE_CTR
  • PERFORMANCE_GOAL_TYPE_VIEWABILITY
  • PERFORMANCE_GOAL_TYPE_CLICK_CVR
  • PERFORMANCE_GOAL_TYPE_IMPRESSION_CVR
  • PERFORMANCE_GOAL_TYPE_VTR
  • PERFORMANCE_GOAL_TYPE_AUDIO_COMPLETION_RATE
  • PERFORMANCE_GOAL_TYPE_VIDEO_COMPLETION_RATE

Por exemplo, 70000 representa 7% (decimal 0,07).
performanceGoalString

string

Uma string de indicador principal de desempenho (KPI), que pode estar vazia. Precisa ser codificado em UTF-8 e ter no máximo 100 caracteres.

Aplicável quando performanceGoalType está definido como PERFORMANCE_GOAL_TYPE_OTHER.
Fim dos campos mutuamente exclusivos.

PerformanceGoalType

Tipos possíveis de metas de performance.

Tipos enumerados
PERFORMANCE_GOAL_TYPE_UNSPECIFIED O tipo de meta de performance não foi especificado ou é desconhecido nesta versão.
PERFORMANCE_GOAL_TYPE_CPM A meta de performance é definida em CPM (custo por mil impressões).
PERFORMANCE_GOAL_TYPE_CPC A meta de performance é definida em CPC (custo por clique).
PERFORMANCE_GOAL_TYPE_CPA A meta de performance é definida em CPA (custo por ação).
PERFORMANCE_GOAL_TYPE_CTR A meta de performance é definida em porcentagem de CTR (taxa de cliques).
PERFORMANCE_GOAL_TYPE_VIEWABILITY A meta de performance é definida em Porcentagem de visibilidade.
PERFORMANCE_GOAL_TYPE_CPIAVC A meta de performance é definida como CPIAVC (custo por impressão audível e visível na conclusão).
PERFORMANCE_GOAL_TYPE_CPE A meta de performance é definida em CPE (custo por engajamento).
PERFORMANCE_GOAL_TYPE_CPV A meta de performance é definida em CPV (custo por visualização).
PERFORMANCE_GOAL_TYPE_CLICK_CVR A meta de performance é definida em porcentagem da taxa de conversão de cliques (conversões por clique).
PERFORMANCE_GOAL_TYPE_IMPRESSION_CVR A meta de performance é definida em porcentagem da taxa de conversão de impressão (conversões por impressão).
PERFORMANCE_GOAL_TYPE_VCPM A meta de performance é definida em vCPM (custo por mil impressões visíveis).
PERFORMANCE_GOAL_TYPE_VTR A meta de performance é definida em porcentagem da taxa de visualização do YouTube (visualizações do YouTube por impressão).
PERFORMANCE_GOAL_TYPE_AUDIO_COMPLETION_RATE A meta de performance é definida em porcentagem da taxa de conclusão de áudio (reproduções completas de áudio por impressão).
PERFORMANCE_GOAL_TYPE_VIDEO_COMPLETION_RATE A meta de performance é definida em porcentagem da taxa de visualizações completas de vídeo (visualizações completas de vídeo por impressão).
PERFORMANCE_GOAL_TYPE_OTHER A meta de performance está definida como "Outro".

CampaignFlight

Configurações que rastreiam o gasto e a duração planejados de uma campanha.

Representação JSON 
{
  "plannedSpendAmountMicros": string,
  "plannedDates": {
    object (DateRange)
  }
}
Campos
plannedSpendAmountMicros

string (int64 format)

O valor que a campanha deve gastar no determinado plannedDates. Isso não vai limitar a veiculação, mas será usado para rastrear gastos na interface do DV360.

O valor está em micros. Deve ser maior ou igual a 0. Por exemplo, 500000000 representa 500 unidades padrão da moeda.
plannedDates

object (DateRange)

Obrigatório. As datas em que a campanha deve ser veiculada. Eles são resolvidos em relação ao fuso horário do anunciante principal.

  • As datas especificadas aqui não afetam a veiculação. Eles são usados para gerar alertas e avisos. Por exemplo, se a data de veiculação de um pedido de inserção secundário estiver fora do intervalo dessas datas, a interface vai mostrar um aviso.
  • startDate é obrigatório e precisa ser a data atual ou posterior.
  • endDate é opcional. Se especificado, precisa ser startDate ou mais recente.
  • Qualquer data especificada precisa ser anterior ao ano de 2037.

CampaignBudget

Configurações que controlam como o orçamento da campanha é alocado.

Representação JSON 
{
  "budgetId": string,
  "displayName": string,
  "budgetUnit": enum (BudgetUnit),
  "budgetAmountMicros": string,
  "dateRange": {
    object (DateRange)
  },
  "externalBudgetSource": enum (ExternalBudgetSource),
  "externalBudgetId": string,
  "invoiceGroupingId": string,
  "prismaConfig": {
    object (PrismaConfig)
  }
}
Campos
budgetId

string (int64 format)

O ID exclusivo do orçamento da campanha. Atribuído pelo sistema. Não defina para novos orçamentos.

Precisa ser incluído ao atualizar ou adicionar orçamentos a campaignBudgets. Caso contrário, um novo ID será gerado e atribuído.
displayName

string

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

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

enum (BudgetUnit)

Obrigatório. Imutável. Especifica se o orçamento é medido em moeda ou impressões.
budgetAmountMicros

string (int64 format)

Obrigatório. O valor total que os segmentos de pedido de inserção vinculados podem orçar.

O valor está em micros. Precisa ser maior que 0. Por exemplo, 500000000 representa 500 unidades padrão da moeda.
dateRange

object (DateRange)

Obrigatório. O período do orçamento da campanha. Os segmentos de orçamento vinculados podem ter um período diferente. Eles são resolvidos em relação ao fuso horário do anunciante principal.

startDate e endDate precisam ser anteriores ao ano de 2037.
externalBudgetSource

enum (ExternalBudgetSource)

Obrigatório. A origem externa do orçamento.
externalBudgetId

string

Imutável. O ID que identifica este orçamento para a fonte externa.

Se esse campo estiver definido e o nível de detalhe da fatura do perfil de faturamento correspondente estiver definido como "OC no nível do orçamento", todas as impressões veiculadas com base nesse orçamento vão incluir esse ID na fatura.

Precisa ser exclusivo na campanha.
invoiceGroupingId

string

Imutável. O ID usado para agrupar orçamentos que serão incluídos na mesma fatura.

Se esse campo estiver definido e o nível da fatura do perfil de faturamento correspondente estiver definido como "ID do agrupamento de faturas de orçamento", todos os externalBudgetId que compartilham o mesmo invoiceGroupingId serão agrupados na mesma fatura.
prismaConfig

object (PrismaConfig)

Metadados adicionais para uso pela ferramenta Prisma da Mediaocean.

Obrigatório para orçamentos da Mediaocean.

Válido apenas para anunciantes prismaEnabled.

ExternalBudgetSource

Origem externa para um segmento de orçamento da campanha.

Tipos enumerados
EXTERNAL_BUDGET_SOURCE_UNSPECIFIED O valor da origem do orçamento externo não foi especificado ou é desconhecido nesta versão.
EXTERNAL_BUDGET_SOURCE_NONE O orçamento não tem uma fonte externa.
EXTERNAL_BUDGET_SOURCE_MEDIA_OCEAN A origem do orçamento é a Mediaocean.

PrismaConfig

Configurações específicas da ferramenta Mediaocean Prisma.

Representação JSON 
{
  "prismaType": enum (PrismaType),
  "prismaCpeCode": {
    object (PrismaCpeCode)
  },
  "supplier": string
}
Campos
prismaType

enum (PrismaType)

Obrigatório. O tipo do Prisma.
prismaCpeCode

object (PrismaCpeCode)

Obrigatório. Códigos relevantes de cliente, produto e estimativa da ferramenta Mediaocean Prisma.
supplier

string

Obrigatório. A entidade alocou esse orçamento (DSP, site etc.).

PrismaType

Tipos possíveis para um orçamento do Prisma.

Tipos enumerados
PRISMA_TYPE_UNSPECIFIED O tipo não foi especificado ou é desconhecido nesta versão.
PRISMA_TYPE_DISPLAY Tipo de tela.
PRISMA_TYPE_VIDEO Tipo de vídeo.
PRISMA_TYPE_AUDIO Tipo de áudio.
PRISMA_TYPE_SOCIAL Tipo social.
PRISMA_TYPE_FEE Tipo de taxa.

PrismaCpeCode

A Central de pagamentos do Google permite pesquisar e filtrar os campos de componentes desse código.

Representação JSON 
{
  "prismaClientCode": string,
  "prismaProductCode": string,
  "prismaEstimateCode": string
}
Campos
prismaClientCode

string

O código do cliente do Prisma.
prismaProductCode

string

O código do produto do Prisma.
prismaEstimateCode

string

O código da estimativa do Prisma.

Métodos

create

 Cria uma nova campanha.

delete

 Exclui uma campanha permanentemente.

get

 Recebe uma campanha.

list

 Lista as campanhas de um anunciante.

patch

 Atualiza uma campanha.