- Recurso: campanha
- CampaignGoal
- CampaignGoalType
- PerformanceGoal
- PerformanceGoalType
- CampaignFlight
- CampaignBudget
- ExternalBudgetSource
- PrismaConfig
- PrismaType
- PrismaCpeCode (link em inglês)
- Métodos
Recurso: campanha
Uma única campanha.
Representação JSON |
---|
{ "name": string, "advertiserId": string, "campaignId": string, "displayName": string, "entityStatus": enum ( |
Campos | |
---|---|
name |
Apenas saída. O nome do recurso da campanha. |
advertiserId |
Apenas saída. O ID exclusivo do anunciante ao qual a campanha pertence. |
campaignId |
Apenas saída. O ID exclusivo da campanha. Atribuído pelo sistema. |
displayName |
Obrigatório. O nome de exibição da campanha. Precisa ser codificado em UTF-8 com um tamanho máximo de 240 bytes. |
entityStatus |
Obrigatório. Controla se os pedidos de inserção desta campanha podem ou não gastar os orçamentos e dar lances no inventário.
|
updateTime |
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 UTC "Zulu" RFC3339, com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: |
campaignGoal |
Obrigatório. A meta da campanha. |
campaignFlight |
Obrigatório. O gasto planejado e a duração da campanha. |
frequencyCap |
Obrigatório. A configuração do limite de frequência da campanha. |
campaignBudgets[] |
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 ( |
Campos | |
---|---|
campaignGoalType |
Obrigatório. O tipo de meta da campanha. |
performanceGoal |
Obrigatório. A meta de performance da campanha. Os valores aceitáveis para
|
CampaignGoalType
Tipos possíveis de metas da campanha.
Enums | |
---|---|
CAMPAIGN_GOAL_TYPE_UNSPECIFIED |
O valor do objetivo não é especificado ou desconhecido nesta versão. |
CAMPAIGN_GOAL_TYPE_APP_INSTALL |
Gerar instalações ou engajamentos do app |
CAMPAIGN_GOAL_TYPE_BRAND_AWARENESS |
Aumentar o reconhecimento de uma marca ou um produto. |
CAMPAIGN_GOAL_TYPE_OFFLINE_ACTION |
Gerar vendas off-line ou na loja. |
CAMPAIGN_GOAL_TYPE_ONLINE_ACTION |
Promover ações on-line ou visitas. |
PerformanceGoal
Configurações que controlam a meta de performance de uma campanha.
Representação JSON |
---|
{ "performanceGoalType": enum ( |
Campos | |
---|---|
performanceGoalType |
Obrigatório. O tipo de meta de desempenho. |
Campo de união performance_goal_value . Obrigatório. O valor da meta de performance correspondente a um determinado performance_goal_type . performance_goal_value pode ser apenas de um dos tipos a seguir: |
|
performanceGoalAmountMicros |
O valor da meta, em micros na moeda do anunciante. Aplicável quando
Por exemplo, 1.500.000 representa 1,5 unidade padrão da moeda. |
performanceGoalPercentageMicros |
A representação decimal da porcentagem da meta em micros. Aplicável quando
Por exemplo, 70000 representa 7% (decimal 0,07). |
performanceGoalString |
Uma string de indicador principal de desempenho (KPI), que pode estar vazia. Precisa ser codificado em UTF-8 com até 100 caracteres. Aplicável quando |
PerformanceGoalType
Tipos possíveis de metas de desempenho.
Enums | |
---|---|
PERFORMANCE_GOAL_TYPE_UNSPECIFIED |
O tipo de meta de desempenho não é especificado ou é desconhecido nesta versão. |
PERFORMANCE_GOAL_TYPE_CPM |
A meta de desempenho é definida em CPM (custo por mil). |
PERFORMANCE_GOAL_TYPE_CPC |
A meta de desempenho é 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 desempenho é definida em porcentagem de CTR (taxa de cliques). |
PERFORMANCE_GOAL_TYPE_VIEWABILITY |
A meta de performance é definida na 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_CLICK_CVR |
A meta de desempenho é definida de acordo com a porcentagem da taxa de conversão de cliques (conversões por clique). |
PERFORMANCE_GOAL_TYPE_IMPRESSION_CVR |
A meta de desempenho é definida de acordo com a porcentagem da taxa de conversão de impressões (conversões por impressão). |
PERFORMANCE_GOAL_TYPE_VCPM |
A meta de performance é definida em CPV (custo por mil impressões visíveis). |
PERFORMANCE_GOAL_TYPE_VTR |
A meta de desempenho é definida na 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 de acordo com a porcentagem da taxa de conclusão de áudio (ouções de áudio completas por impressão). |
PERFORMANCE_GOAL_TYPE_VIDEO_COMPLETION_RATE |
A meta de desempenho é definida na porcentagem da taxa de visualizações completas (visualizações de vídeos por impressão). |
PERFORMANCE_GOAL_TYPE_OTHER |
A meta de desempenho está definida como "Outras". |
CampaignFlight
Configurações que acompanham o gasto planejado e a duração de uma campanha.
Representação JSON |
---|
{
"plannedSpendAmountMicros": string,
"plannedDates": {
object ( |
Campos | |
---|---|
plannedSpendAmountMicros |
O valor que a campanha deve gastar para o O valor está em micros. Deve ser maior ou igual a 0. Por exemplo, 5.000.000.000 representa 500 unidades padrão da moeda. |
plannedDates |
Obrigatório. As datas em que a campanha está prevista para ser executada. Eles são resolvidos em relação ao fuso horário do anunciante principal.
|
CampaignBudget
Configurações que controlam como o orçamento da campanha é alocado.
Representação JSON |
---|
{ "budgetId": string, "displayName": string, "budgetUnit": enum ( |
Campos | |
---|---|
budgetId |
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 |
displayName |
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 |
Obrigatório. Imutável. Especifica se o orçamento é medido em moeda ou impressões. |
budgetAmountMicros |
Obrigatório. É o valor total que os segmentos de pedidos de inserção vinculados podem definir como orçamento. O valor está em micros. Precisa ser maior que 0. Por exemplo, 5.000.000.000 representa 500 unidades padrão da moeda. |
dateRange |
Obrigatório. 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. Tanto |
externalBudgetSource |
Obrigatório. A fonte externa do orçamento. |
externalBudgetId |
Imutável. O ID que identifica esse orçamento para a fonte externa. Se esse campo for definido, e o nível de detalhe da fatura do perfil de faturamento correspondente estiver definido como "Ordem de compra com nível de orçamento", todas as impressões veiculadas em relação a esse orçamento vão incluir esse ID na fatura. Precisa ser exclusivo na campanha. |
invoiceGroupingId |
Imutável. O ID usado para agrupar orçamentos para que sejam incluídos na mesma fatura. Se esse campo for 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 |
prismaConfig |
Outros metadados para uso pela ferramenta Mediaocean Prisma. Obrigatório para orçamentos da Mediaocean. Aplicável apenas a anunciantes do |
ExternalBudgetSource
Origem externa de um segmento de orçamento da campanha.
Enums | |
---|---|
EXTERNAL_BUDGET_SOURCE_UNSPECIFIED |
O valor de origem do orçamento externo não é especificado ou é desconhecido nesta versão. |
EXTERNAL_BUDGET_SOURCE_NONE |
O orçamento não tem origem 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 ( |
Campos | |
---|---|
prismaType |
Obrigatório. O tipo Prisma. |
prismaCpeCode |
Obrigatório. Códigos relevantes de cliente, produto e estimativa da ferramenta Mediaocean Prisma. |
supplier |
Obrigatório. A entidade alocou esse orçamento (DSP, local etc.). |
PrismaType
Tipos possíveis para um orçamento do Prisma.
Enums | |
---|---|
PRISMA_TYPE_UNSPECIFIED |
O tipo não é especificado ou é desconhecido nesta versão. |
PRISMA_TYPE_DISPLAY |
Tipo de exibição. |
PRISMA_TYPE_SEARCH |
Tipo de pesquisa. |
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 |
O código do cliente do Prisma. |
prismaProductCode |
O código do produto Prisma. |
prismaEstimateCode |
O código de estimativa do Prisma. |
Métodos |
|
---|---|
|
Cria uma nova campanha. |
|
Exclui uma campanha permanentemente. |
|
Recebe uma campanha. |
|
Lista as campanhas em um anunciante. |
|
Lista as opções de segmentação atribuídas a uma campanha de acordo com os tipos de segmentação. |
|
Atualiza uma campanha existente. |