SSP-moderation

🚧

Draft

Документация находится в стадии черновика.

Документ описывает модерацию креативов.

1. Общая часть

SSP допускает к показу только проверенные креативы, чтобы исключить возможность несоответствия рекламных материалов и требований паблишера. Процесс получения разрешения на ротацию креативов называется модерацией. В ходе модерации SSP проверяет, соответствует ли креатив требованиям, и корректно ли он классифицирован.

2. API

2.1. Отправка креатива на модерацию

Метод, позволяющий передать креатив и часть базовых настроек в SSP.

Шаблон URL для отправки запросов
https://api.aray.com/dsp/moderation/?metod=add&dsp=DSPName&key=XXXX-XXXX-XXXX-XXXX

Banner

{
	"version": "1.1.0",
	"creative": {
		"crid": "{CREATIVE_ID}",
		"type": "banner",
		"subtype": 1,
		"IAB": "IAB2-1",
		"data": {
			"htmlbasesafe64": "PGh0bWw_PGltZz48L2ltZz48L2h0bWw_",
			"redirectURL": "https://example.com/",
			"finalURL": "https://google.com/"
		},
		"geo": ["ro", "hu"]
	}
}

Native

{
	"version": "1.1.0",
	"creative": {
		"crid": "{CREATIVE_ID}",
		"type": "native",
		"subtype": 1,
		"IAB": "IAB2-1",
		"data": {
      "img": "https://example.com/img.png",
      "text": "example text",
			"redirectURL": "https://example.com/",
			"finalURL": "https://google.com/"
		},
		"geo": ["ro", "hu"]
	}
}

Ответ API.

JSON

{
	"version": "1.1.0",
	"crid": "{CREATIVE_ID}",
	"status": {
		"result": "OK",
		"text": "creative was received"
	}
}

Название	Значение	Описание
version	1.1.0	Текущая версия API, на которой работает клиент, при различии мажорных версий, будет сгенерирована ошибка.
creative	объект	Секция, описывающая креатив

Название	Значение	Описание
crid	{CREATIVE_ID}	Идентификатор креатива во внешней DSP.
type	banner	Тип креатива
subtype	1	Подтип креатива, "1" означает произвольный html.
IAB	IAB2-1	IAB категория, классифицирующая рекламодателя, кампанию.
data	объект	Секция, описывающая данные креатива
geo	"ro","hu"	Перечисление стран, в которых будет показываться данная реклама.

Название	Значение	Описание
htmlbasesafe64		Web safe представление кода баннера.
img	https://example.com/img.png	Ссылка на изображение тизера
text	example text	Текст тизера
redirectURL	https://example.com/	Ссылка на домен, который будет присутствовать в выдаче DSP
finalURL	https://google.com/	Адрес финальной страницы, на которую будет переадресован пользователь после всех редиректов.

2.1. Получение статуса креатива

https://api.aray.com/dsp/moderation/?metod=status&dsp=DSPName&key=XXXX-XXXX-XXXX-XXXX

{
	"version": "1.1.0",
	"crid": "{CREATIVE_ID}"
}

JSON

{
	"version": "1.1.0",
	"crid": "{CREATIVE_ID}",
	"status": {
		"result": "OK",
		"text": "approved",
		"exired": 1491549099
	}
}

3. Workflow

1. Для работы с API необходим ключ, который можно взять в личном кабинете.
2. Следующий шаг - отправка креатива на модерацию.
3. После того, как креатив отправлен на модерацию, можно получить его статус, и когда статус будет "approved", можно бидить этим креативом.