Request
Request Headers
Header Name |
Type |
Value |
Required |
Description |
Authorization |
String |
Bearer ${access_token} |
Yes |
Send your generated access token in place of ${access_token} for authorization. |
Example: |
|
|
|
|
curl “https://sspi-ext-report.adpopcorn.com/v1/metadata/publisher/media?page=1” -H “Authorization: Bearer test_access_token” -L |
Request Query Parameters
The following table lists parameters you can use to build requests.
Parameter Name |
Type |
Required |
Description |
page |
Integer |
No |
Number of displayed page, Default: 1 |
pageSize |
Integer |
No |
Number of records to be displayed on one page, Default: 50 |
sortBy |
String |
No |
By default, the sort order is ascending. To change descending, prefix a minus sign to the requested field. Example: |
sortBy=-media_key,placement_id |
|
|
|
Response
Header Name |
Type |
Description |
Content-Type |
application/json |
JSON response |
Response Body Parameters
The following table lists parameters returns in API responses.
Body Parameter |
Type |
Description |
alert |
String |
Alert message from server. In most cases, it will be null, Example: “alert”: null |
page |
Integer |
Number of displayed page, |
page_size |
Integer |
Number of records to be displayed on one page |
page_count |
Integer |
|
total_record_count |
Integer |
|
records |
Array of Media |
The main table-like data structure |
Media
Body Parameter |
Type |
Description |
key |
String |
Key of the media |
name |
String |
Name |
type |
Integer |
1: iOS, 2: Android |
status |
Integer |
Status (10: Acticated, 30: Deactivated) |
placements |
Array of Placement |
List of the placement. |
Placement
Body Parameter |
Type |
Description |
id |
String |
ID of the placement. |
name |
String |
Name |
status |
Integer |
Status (10: Activated, 30: Deactivated) |
campaign_type |
Integer |
Type of campaign associated with the ad. (only app publisher) |
(1: Banner, 2: Interstitial, 3: Video, 4: Native) |
|
|
size |
String |
Size label (only campaign_type is 1, 2 or web publisher) |
(eg., 728x90) |
|
|
Sample JSON
{
"alert": null,
"page": 1,
"page_size": 50,
"page_count": 2,
"total_record_count": 71,
"records": [
{
"key": "test_media_key",
"name": "test_media_name",
"status": 10,
"placements": [
{
"id": "test_placement_id",
"name": "test_placement_name",
"status": 10,
"campaign_type": 1,
"size": "728x90"
}
]
}
]
}