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 ao qual 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 tamanho máximo de 240 bytes.
entityStatus

enum (EntityStatus)

Obrigatório. Controla se os pedidos de inserção desta campanha podem gastar seus orçamentos e fazer lances em 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 em que a campanha foi atualizada pela última vez. Atribuído pelo sistema.

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".
campaignGoal

object (CampaignGoal)

Obrigatório. A meta da campanha.
campaignFlight

object (CampaignFlight)

Obrigatório. O gasto planejado e a duração 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 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.

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

CampaignFlight

Configurações que acompanham o gasto planejado e a duração de uma campanha.

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

string (int64 format)

É o valor esperado que a campanha vai gastar para os plannedDates especificados. Isso não limitará a veiculação, mas será usado para rastrear os 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 está prevista para ser exibida. Elas são resolvidas em relação ao fuso horário do anunciante pai.

  • As datas especificadas aqui não afetarão a veiculação. Eles são usados para gerar alertas e avisos. Por exemplo, se o período de veiculação de um pedido de inserção filho estiver fora desse período, a interface do usuário exibirá um aviso.
  • startDate é obrigatório e precisa ser a data atual ou posterior.
  • endDate é opcional. Se especificado, precisa ser startDate ou posterior.
  • Qualquer data especificada precisa ser anterior ao ano 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 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 pedidos de inserção vinculados podem definir no orçamento.

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. Período do orçamento da campanha. Os segmentos de orçamento vinculados podem ter um período diferente. Elas são resolvidas em relação ao fuso horário do anunciante pai.

Tanto startDate quanto endDate precisam ser anteriores ao ano de 2037.
externalBudgetSource

enum (ExternalBudgetSource)

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

string

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

Se esse campo estiver definido e o nível de detalhes da fatura do perfil de faturamento correspondente estiver definido como "Ordem de compra no nível do orçamento", todas as impressões veiculadas com esse 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 a serem 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 compartilharem o mesmo invoiceGroupingId serão agrupados na mesma fatura.
prismaConfig

object (PrismaConfig)

Metadados adicionais para uso pela ferramenta Mediaocean Prisma.

Obrigatório para orçamentos da Mediaocean.

Aplicável apenas a anunciantes do prismaEnabled.

ExternalBudgetSource

Fonte externa para um segmento de orçamento de campanha.

Enums
EXTERNAL_BUDGET_SOURCE_UNSPECIFIED O valor da fonte de orçamento externa 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 é 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 Prisma.
prismaCpeCode

object (PrismaCpeCode)

Obrigatório. Códigos relevantes de clientes, produtos e estimativas da ferramenta Mediaocean Prisma.
supplier

string

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

PrismaType

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

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

PrismaCpeCode

A central de pagamentos do Google oferece suporte à pesquisa e à filtragem nos 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 de estimativa do Prisma.

Métodos

bulkListCampaignAssignedTargetingOptions

 Lista as opções de segmentação atribuídas de uma campanha a diferentes tipos de segmentação.

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 existente.