SSP-moderation (en)

🚧

Draft

The document is at the draft stage.

This document describes the moderation of creatives.

1.General information

SSP allows to show only proved creatives in order to eliminate the possibility of discrepancies between advertising materials and the publisher’s requirements. The process of obtaining permission to rotate the creatives is called moderation. During the moderation, the SSP checks if the creative meets all the requirements and if it is properly classified.

2. API

2.1. Sending for moderation

This method enables to transfer the creative and a part of the basic settings to the SSP.

URL Template for request sending
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 Response

JSON

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

Name	Value	Description
version	1.1.0	The current version of the API which the client is using. If the major versions are different, an error will be issued.
creative	object	The section where the creatives are described

Name	Value	Description
crid	{CREATIVE_ID}	Identifier of the creative in the external DSP
type	banner	Creative type
subtype	1	Creative subtype, “1” means an arbitrary html.
IAB	IAB2-1	The IAB category classifies an advertiser and a company
data	object	This section describes creative data
geo	"ro","hu"	The list of countries in which this Ad will be demonstrated.

Name	Value	Description
htmlbasesafe64		Web safe banner code representation
img	https://example.com/img.png	Link to the teaser image
text	example text	Teaser text
redirectURL	https://example.com/	Link to domain present in DSP response
finalURL	https://google.com/	The final page address to which the user will be finally redirected.

2.1. Getting a creative status

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. For the work with the API the user needs a key which is available in the user account.
2. The next step is sending of the creative for the moderation.
3. After sending of the creative for moderation, it is possible to get its status, and when the status is "approved", the creative can run