Chartboost API

Последнее обновление:

 

Chartboost API предлагает доступ к аналитике кампаний и приложений, позволяет извлекать информацию об учетной записи и выручке, обновлять предложения цены для кампании и делать многое другое.

 

 

  • Проверка подлинности: Для проверки подлинности запросов API нужно указать ид. и подпись пользователя вашей учетной записи. Идентификатор и подпись пользователя можно увидеть в верхней части страницы «Проводник API» на панели пользователя.
  • Методы HTTP: Требуемые методы HTTP — GET, POST, PUT и т. д. — зависят от конечной точки. Метод HTTP каждого запроса можно увидеть в «Проводнике API» на панели пользователя. Все запросы следует делать через HTTPS. В примере аналитики ниже показаны два запроса: первый ставит задание в очередь, а последующий использует ид. задания для извлечения результатов.
// пример кода для исходного запроса
query_url = "http://analytics.chartboost.com/v3/metrics/campaign?" + query_params
query_params = "... groupBy=app,creative ..."

response = get(query_url);
if (response.status = 202) {
 jobId = response.parse('jobId');
// получение jobId для функции retrieve()
 file.write(jobId);
 }
else {
// управление при сбое
};


// пример кода для извлечения результатов jobId
query_url = "http://analytics.chartboost.com/v3/metrics/jobs/" + jobId
query_params = ""

created = get(query_url + "?status=true");
if (created.status == 201) {
response = get(query_url);
if (response.status == 200) {
// можно развлекаться с данными
}
else {
// управление при сбое
}
};
  • Получив запрос GET /campaign или GET /install, использующий параметр groupBy, API Chartboost отвечает на них идентификатором задания, который служит подтверждением того, что запрос принят и поставлен в очередь на обработку.
  • Затем этот идентификатор можно использовать для проверки состояния задания в последующих запросах – с помощью новой конечной точки: GET /v3/metrics/jobs/[job_id]?status=true
  • Этот запрос вернет 201 {status: "created"}, если результаты задания можно забрать. Когда ваша система получает такой отклик, вы можете извлечь данные следующим образом: GET /v3/metrics/jobs/[job_id]
  • Если вы попытаетесь извлечь данные до завершения задания, то получите пустой или неполный отклик.
  • Результаты запроса сохраняются и остаются доступными на протяжении 24 часов, а затем удаляются.
  • В настоящее время единственный поддерживаемый content-type – это application/octet-stream, при котором результаты возвращаются в формате TSV (обратите внимание на то, что файлы TSV по-прежнему будут с расширением .CSV).
  • Методы API: У Chartboost API есть четыре разновидности методов: для аналитики, приложений, кампаний и учетной записи. У каждого метода уникальные конечные точки. Чтобы определить правильную конечную точку для своего запроса, откройте «Проводник API» на панели пользователя или воспользуйтесь одним из перечисленных ниже вариантов.
  • Параметры: Добавляйте параметры и стройте запросы для тестирования. Обязательные параметры помечены на панели пользователя красным цветом.
  • Большая часть аналитических отчетов, которые возвращает наш API, имеет формат JSON. Отчеты по специфическим запросам возвращаются в формате TSV (значения, разделенные табуляцией). Подробнее о форматах ▶
  • Соблюдайте приведенные ниже правила Chartboost API.

▲ К началу

 

Эти рекомендации гарантируют быструю обработку запросов всех наших клиентов. Если вы не станете им следовать, ваш доступ к API будет ограничен.

Работайте с API аккуратно – это нужно не только вам, но и другим пользователям Chartboost.
Разносите запросы во времени. Если вам нужно пять разных отчетов в день, не отправляйте все пять запросов одновременно. Подавайте запросы с промежутком хотя бы в несколько минут. Если запросы будут подаваться чаще одного раза в минуту, ваш доступ к API будет ограничен.
Группируйте свои приложения в один запрос. Вместо того, чтобы подавать отдельный запрос API для каждого приложения, опустите параметр appId – и API вернет вам данные сразу по всем приложениям.

▲ К началу

 

Методы для аналитики Методы для приложений Методы для кампаний Методы для учетной записи

 


Вам может быть интересно...