API do Charboost — Métodos de campanha

Última atualização:
Alguns destes pontos de extremidade requerem o seu ID da campanha. Onde está meu ID da campanha?

 

 

Este ponto de extremidade fornece informações para uma determinada campanha se for especificado, senão retorna todas as campanhas, não importando o status.

O bid_id é fornecido na resposta aqui, que pode ser usada para os pontos de extremidade abaixo.

Método HTTP GET
Ponto de extremidade https://api.chartboost.com/campaigns
Solicitação de exemplo https://api.chartboost.com/campaigns/?user_id={{ID do usuário do cliente Chartboost}}&user_signature={{assinatura de usuário do cliente CB}}

Parâmetros
Parâmetro Tipo de solicitação Necessário? Descrição Padrão
campaign_id String Opcional Um id de campanha único Tudo

Campos de resposta
Parâmetro Descrição Retornado para...
app_id ID do app de publicidade Anunciante
bids IDs do direcionamento da campanha; bid_id para pontos de extremidade abaixo Todos
campaign_type marketplace, directdeal, crosspromotion Todos
date_created Data de criação da campanha (carimbo de data e hora UNIX) Todos
date_max Data do fim da campanha, se definida (carimbo de data e hora UNIX) Todos
date_min Data do início da campanha, se definida (carimbo de data e hora UNIX) Todos
date_modified Data em que a campanha foi modificada pela última vez (carimbo de data e hora UNIX) Todos
id ID da campanha Todos
name Nome da campanha Todos
platform ios, google_play, amazon Todos
priority Prioridade de exibição da campanha atual Todos
promote_in ID(s) do app de publicação Editoras
status Status da campanha atual: ativa, pausada, arquivada Todos

▲ Voltar para o topo

 

Este ponto de extremidade retorna informações detalhadas sobre um determinado lance se estiver especificado em uma campanha. Senão, todos os lances da campanha são retornados. O ponto de extremidade /bid é usado para Obter informações do lance e todos os métodos seguintes.


Método HTTP GET
Ponto de extremidade https://api.chartboost.com/campaigns/{{ID da campanha}}/bid/{{ID do lance}}
Solicitação de exemplo https://api.chartboost.com/campaigns/?{{ID da campanha}}/bid/{{ID do lance}}?campaign_id={{ID da campanha}}&bid_id={{ID do lance}}&user_id={{ID do usuário do cliente Chartboost}}&user_signature={{assinatura de usuário do cliente CB}}


Parâmetros
Parâmetro Tipo de solicitação Necessário? Descrição Padrão
bid_id String Opcional Um ID do lance único (destino) Tudo
campaign_id String Necessário Um ID de campanha único N/D

Campos de resposta
Parâmetro Descrição Retornado para...
app_filter Obsoleto Todos
app_toggle Obsoleto Todos
bid_amount Valor do lance em $USD Anunciantes
bid_id ID do lance Todos
bid_type Tipo de lance de publicidade
Saiba mais sobre tipos de lances ▶
Anunciantes
budget Orçamento diário total do lance (destino) Anunciantes
device_filter Dispositivo(s) por série ou modelo selecionado(s) no direcionamento Todos
device_toggle true = incluir; false = excluir Todos
expire_date Data quando o lance irá expirar em vendas diretas (carimbo de data e hora UNIX) Todos
is_enabled Determina se o lance (destino) está ativado: true, false Todos
location_filter Países selecionados no direcionamento Todos
location_toggle true = incluir; false = excluir Todos
os_filter Sistemas operacionais selecionados no direcionamento: max = Versão máxima; min = Versão mínima Todos
title Nome do lance (destino) Todos

▲ Voltar para o topo

 

Este método permite que um lance existente seja editado. Somente um único lance pode ser editado por solicitação.


Método HTTP PUT
Ponto de extremidade https://api.chartboost.com/campaigns/{{ID da campanha}}/bid/{{ID do lance}}
Solicitação de exemplo Ver código abaixo

https://api.chartboost.com/campaigns/{{ID da campanha}}/bid/{{ID do lance}}

Corpo da solicitação:
{
    "campaign_id": {{ID da campanha}},
    "bid_id": {{ID do lance}},
    "user_id": {{ID de usuário do cliente Chartboost}},
    "user_signature": {{assinatura do usuário do cliente CB}}
}
				

Parâmetros
Parâmetro Tipo de solicitação Necessário? Descrição Padrão
bid_amount Número Opcional Valor do lance em $USD (ex: "0,55")
Obs.: bid_type também deve ser definido ao atualizar o valor.
N/D
bid_id String Necessário Um ID do lance único (destino) N/D
bid_type String Opcional, mas necessário com bid_amount Tipo de lance (CPC ou CPI) N/D
budget Número Opcional Orçamento diário em $USD para este lance N/D
campaign_id String Necessário Um id de campanha único N/D
device_filter String Opcional Uma lista separada por vírgula dos tipos de dispositivos (ex.:"iphone,ipod touch,ipad") N/D
device_toggle Booleano Opcional Operador para lista em device_filter;
true se excluir
false ou absent para incluir
false (incluir)
is_enabled Booleano Opcional Um comutador para ativar ou desativar o lance;
true = ativar, false = desativar
N/D
location_filter String Opcional Uma lista separada por vírgulas dos códigos de países de dois caracteres (ex: "US,CA"); se estiver em branco, o padrão será todos os países.
Obs: location_toggle também deve ser definido ao atualizar o filtro de país.
N/D
location_toggle Booleano Opcional, mas necessário com location_filter true se location_filter estiver na lista branca (direcionar somente esses países);
false se location_filter estiver na lista negra (ou seja, direcionar todos os países, menos esses).
N/D
os_filter_max Número Opcional Versão máxima do sistema operacional (ex.: 8.0) N/D
os_filter_min Número Opcional Versão mínima do sistema operacional (ex.: 4.3) N/D

Campos de resposta
Parâmetro Descrição Retornado para...
app_filter Obsoleto Todos
app_toggle Obsoleto Todos
bid_amount Valor do lance em $USD Anunciantes
bid_id ID do lance Todos
bid_type Tipo de lance (CPC ou CPI)
Saiba mais sobre tipos de lances ▶
Anunciantes
budget Orçamento diário em $USD para este lance Anunciantes
device_filter Lista de tipos de dispositivos Todos
device_toggle true = excluir; false = incluir Todos
expire_date Data quando o lance irá expirar em vendas diretas (carimbo de data e hora UNIX) Todos
is_enabled Determina se o lance está ativo;
true = ativar
false = desativar
Todos
location_filter Lista de países Todos
location_toggle true = incluir; false = excluir Todos
os_filter min = versão minima do sistema operacional; max = versões máximas do sistema operacional Todos
title Nome do destino (lance) Todos

▲ Voltar para o topo

 

Este método é somente para campanhas de publicidade e permite criar novos lances em uma campanha. O título do novo lance corresponderá ao ID do lance, mas pode ser renomeado no seu painel.


Método HTTP POST
Ponto de extremidade https://api.chartboost.com/campaigns/{{ID da campanha}}/bid
Solicitação de exemplo Ver código abaixo

https://api.chartboost.com/campaigns/{{Campaign ID}}/bid

Request Body:
{
 "campaign_id": {{Campaign ID}},
 "bid_amount": {{Bid Amount}},
 "bid_type": {{Bid Type}},
 "user_id": {{Chartboost customer's user ID}},
 "user_signature": {{CB customer's user signature}}
}

Parâmetros
Parâmetro Tipo de solicitação Necessário? Descrição Padrão
bid_amount Número Necessário Valor do lance em $USD (ex: "0.55")
Obs.: bid_type também deve ser definido ao atualizar o valor.
N/D
bid_type String Necessário Tipo de lance (CPC ou CPI) N/D
budget Número Necessário Orçamento diário em $USD para este lance N/D
campaign_id String Necessário Um ID de campanha único N/D
device_filter String Opcional Uma lista separada por vírgula dos tipos de dispositivos (ex.:"iphone,ipod touch,ipad") N/D
device_toggle Booleano Opcional Operador para lista em device_filter
true se excluir
false ou absent para incluir
false (incluir)
is_enabled Booleano Opcional Um comutador para ativar ou desativar o lance
true = ativar, false = desativar
N/D
location_filter String Opcional Uma lista separada por vírgulas dos códigos de países de dois caracteres (ex: "US, CA"); se estiver em branco, o padrão será todos os países
Obs.: location_toggle também deve ser definido ao atualizar o filtro de país
N/D
location_toggle Booleano Opcional, mas necessário com location_filter true se location_filter estiver na lista branca (direcionar somente esses países)
false se location_filter estiver na lista negra (ou seja, direcionar todos os países, menos esses).
N/D
os_filter_max Número Opcional Versão máxima do sistema operacional (ex.: 8.0) N/D
os_filter_min Número Opcional Versão mínima do sistema operacional (ex.: 4.3) N/D

Campos de resposta
Parâmetro Descrição Retornado para...
app_filter Obsoleto Todos
app_toggle Obsoleto Todos
bid_amount Valor do lance em $USD Anunciantes
bid_id ID do lance Todos
bid_type Tipo de lance (CPC ou CPI)
Saiba mais sobre tipos de lances ▶
Anunciantes
budget Orçamento diário em $USD para este lance Anunciantes
device_filter Lista de tipos de dispositivos Todos
device_toggle true = excluir; false = incluir Todos
expire_date Data quando o lance irá expirar em vendas diretas (carimbo de data e hora UNIX) Todos
is_enabled Determina se o lance está ativo;
true = ativar
false = desativar
Todos
location_filter Lista de países Todos
location_toggle true = incluir; false = excluir Todos
os_filter min = versão minima do sistema operacional; max = versões máximas do sistema operacional Todos
title Nome do destino (lance) Todos

▲ Voltar para o topo

 


Você também pode se interessar...