API de Charboost — Métodos de campaña

Última actualización:
Algunos de estos endpoints requieren tu ID de campaña. ¿Dónde puedo encontrar mi ID de campaña?

 

 

Este endpoint proporciona información de una campaña determinada si se especifica, de lo contrario devolverá todas las campañas, independientemente del estado.

El bid_id aparece en la respuesta que puede utilizarse para los endpoints de abajo.

Método HTTP GET
Endpoint https://api.chartboost.com/campaigns
Ejemplo de solicitud https://api.chartboost.com/campaigns/?user_id={{ID de usuario del cliente de Chartboost}}&user_signature={{firma de usuario del cliente de Chartboost}}

Parámetros
Parámetro Tipo de solicitud ¿Requerido? Descripción Por defecto
campaign_id Cadena Opcional Un único ID de campaña Todo

Campos de respuesta
Parámetro Descripción Devuelto para ...
app_id ID de la app anunciada Anunciante
bids ID(s) del objetivo de campaña; bid_id para los endpoints de abajo Todos
campaign_type marketplace, directdeal, crosspromotion Todos
date_created Fecha de creación de la campaña (UNIX) Todos
date_max Fecha del fin de la campaña, si está configurada (UNIX) Todos
date_min Fecha de inicio de la campaña, si está configurada (UNIX) Todos
date_modified Fecha de la última modificación de la campaña (UNIX) Todos
id ID de campaña Todos
name Nombre de la campaña Todos
plataforma ios, google_play, amazon Todos
priority Priopridad de la campaña actual Todos
promote_in ID(s) de la aplicación ofertante Ofertantes
status Estado actual de la campaña: activa, pausada, archivada Todos

▲ Volver arriba

 

Este endpoint devuelve información detallada acerca de una oferta determinada si se especifica en una campaña. De lo contrario, se devolverán todas las ofertas de la campaña. El endpoint /bid se utiliza para Obtener información de pujasy todos los métodos siguientes.


Método HTTP GET
Endpoint https://api.chartboost.com/campaigns/{{Campaign ID}}/bid/{{Bid ID}}
Ejemplo de solicitud https://api.chartboost.com/campaigns/?{{Campaign ID}}/bid/{{Bid ID}}?campaign_id={{Campaign ID}}&bid_id={{Bid ID}}&user_id={{Chartboost customer's user ID}}&user_signature={{CB customer's user signature}}


Parámetros
Parámetro Tipo de solicitud ¿Requerido? Descripción Por defecto
bid_id Cadena Opcional Un único ID de puja Todo
campaign_id Cadena Requerido Un único ID de campaña N/D

Campos de respuesta
Parámetro Descripción Devuelto para ...
app_filter Desfasado Todos
app_toggle Desfasado Todos
bid_amount Valor de la puja en $USD Anunciantes
bid_id ID de puja Todos
bid_type Tipo de puja de anuncio
Más información sobre los tipos de puja ▶
Anunciantes
budget Presupuesto diario total para la puja (objetivo) Anunciantes
device_filter Series o modelos de dispositivo seleccionados en la segmentación Todos
device_toggle true = incluir; false = excluir Todos
expire_date Fecha en la que caduca la puja en los acuerdos directos (UNIX) Todos
is_enabled Determina si la puja (objetivo) está activada: true, false Todos
location_filter Países seleccionados en la segmentación Todos
location_toggle true = incluir; false = excluir Todos
os_filter Sistemas operativos seleccionados en la segmentación: max = versión máxima; min = versión mínima Todos
title Nombre de la puja (objetivo) Todos

▲ Volver arriba

 

Este método permite editar una puja existente. Solo se puede editar una puja por solicitud.


Método HTTP PUT
Endpoint https://api.chartboost.com/campaigns/{{Campaign ID}}/bid/{{Bid ID}}
Ejemplo de solicitud Ver el código de abajo

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

Cuerpo de la solicitud:
{
    "campaign_id": {{ID de campaña}},
    "bid_id": {{ID de puja}},
    "user_id": {{ID de usuario del cliente de Chartboost}},
    "user_signature": {{firma de usuario del cliente de Chartboost}}
}
				

Parámetros
Parámetro Tipo de solicitud ¿Requerido? Descripción Por defecto
bid_amount Número Opcional Valor de la puja en $USD (por ejemplo, "0.55")
Nota: bid_type también debe configurarse al actualizar la cantidad.
N/D
bid_id Cadena Requerido Un único ID de puja N/D
bid_type Cadena Opcional, pero requerido con bid_amount Tipo de puja (CPC o CPI) N/D
budget Número Opcional Presupuesto diario en $USD para esta puja. N/D
campaign_id Cadena Requerido Un único ID de campaña N/D
device_filter Cadena Opcional Una lista de tipos de dispositivo separados por comas (por ejemplo, "iphone,ipod touch,ipad") N/D
device_toggle Booleano Opcional Operador de lista en device_filter;
truepara excluir
false o absent para incluir
false (incluir)
is_enabled Booleano Opcional Una botón para activar/desactivar la puja;
true = habilitar, false = inhabilitar
N/D
location_filter Cadena Opcional Una lista separada por comas de códigos de países de dos caracteres (por ejemplo, "US,CA"); si está en blanco, incluirá todos los países.
Nota: location_toggle también debe configurarse al actualizar el filtro por país.
N/D
location_toggle Booleano Opcional, pero requerido con location_filter true si location_filter es lista blanca (por ejemplo, incluye solo estos países),
false si location_filter es lista negra (por ejemplo, incluye todos los países menos estos).
N/D
os_filter_max Número Opcional Versión de OS máxima (por ejemplo, 8.0) N/D
os_filter_min Número Opcional Versión de OS mínima (por ejemplo, 4.3) N/D

Campos de respuesta
Parámetro Descripción Devuelto para ...
app_filter Desfasado Todos
app_toggle Desfasado Todos
bid_amount Valor de la puja en $USD Anunciantes
bid_id ID de puja Todos
bid_type Tipo de puja (CPC o CPI)
Más información sobre tipos de puja ▶
Anunciantes
budget Presupuesto diario en $USD para esta puja. Anunciantes
device_filter Lista de tipos de dispositivo Todos
device_toggle true = excluir; false = incluir Todos
expire_date Fecha en la que caduca la puja en los acuerdos directos (UNIX) Todos
is_enabled Determina si la puja está activa;
true = habilitar
false = inhabilitar
Todos
location_filter Lista de países Todos
location_toggle true = incluir; false = excluir Todos
os_filter min = versión de OS mínima; max = versión de OS máxima Todos
title Nombre del objetivo (puja) Todos

▲ Volver arriba

 

Este método es únicamente para campañas de anuncios y te permite crear nuevas pujas en una campaña. El título de la nueva puja coincide con el ID de puja, pero puedes cambiar su nombre en el panel de control.


Método HTTP POST
Endpoint https://api.chartboost.com/campaigns/{{ID de campaña}}/bid
Ejemplo de solicitud Ver el código de abajo

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 solicitud ¿Requerido? Descripción Por defecto
bid_amount Número Requerido Valor de la puja en $USD (por ejemplo, "0.55")
Nota: bid_type también debe configurarse al actualizar la cantidad
N/D
bid_type Cadena Requerido Tipo de puja (CPC o CPI) N/D
budget Número Requerido Presupuesto diario en $USD para esta puja. N/D
campaign_id Cadena Requerido Un único ID de campaña N/D
device_filter Cadena Opcional Una lista de tipos de dispositivo separados por comas (por ejemplo, "iphone,ipod touch,ipad") N/D
device_toggle Booleano Opcional Operador de lista en device_filter
true para excluir
false oabsent para incluir
false (incluir)
is_enabled Booleano Opcional Una botón para activar/desactivar la puja;
true = habilitar, false = inhabilitar
N/D
location_filter Cadena Opcional Una lista separada por comas de códigos de países de dos caracteres (por ejemplo, "US,CA"); si está en blanco, incluirá todos los países
Nota: location_toggle también debe configurarse al actualizar el filtro por país
N/D
location_toggle Booleano Opcional, pero requerido con location_filter true si location_filter es lista blanca (por ejemplo, incluye solo estos países),
false si location_filter es lista negra (por ejemplo, incluye todos los países menos estos).
N/D
os_filter_max Número Opcional Versión de OS máxima (por ejemplo, 8.0) N/D
os_filter_min Número Opcional Versión de OS mínima (por ejemplo, 4.3) N/D

Campos de respuesta
Parámetro Descripción Devuelto para ...
app_filter Desfasado Todos
app_toggle Desfasado Todos
bid_amount Valor de la puja en $USD Anunciantes
bid_id ID de puja Todos
bid_type Tipo de puja (CPC o CPI)
Más información sobre tipos de puja ▶
Anunciantes
budget Presupuesto diario en $USD para esta puja. Anunciantes
device_filter Lista de tipos de dispositivo Todos
device_toggle true = excluir; false = incluir Todos
expire_date Fecha en la que caduca la puja en los acuerdos directos (UNIX) Todos
is_enabled Determina si la puja está activa;
true = habilitar
false = inhabilitar
Todos
location_filter Lista de países Todos
location_toggle true = incluir; false = excluir Todos
os_filter min = versión de OS mínima; max = versión de OS máxima Todos
title Nombre del objetivo (puja) Todos

▲ Volver arriba

 


Quizás también te interese...