Common Services / Common Schemas

Overview

This article contains Common Services and Common Schemas for retrieving the additional resources needed for usage of Publisher API Services.

Common Services

url POST (create) GET (read) PUT (update) DELETE
/common/v1/regions FORBIDDEN
Returns: HTTP 403
list all regions
Returns: HTTP 200 + JSON
Errors: HTTP 403,500 + description
FORBIDDEN
Returns: HTTP 403
FORBIDDEN
Returns: HTTP 403
/common/v1/regions/[REGION_NAME]/countries FORBIDDEN
Returns: HTTP 403
list all countries 
Returns: HTTP 200 + JSON
Errors: HTTP 403,500 + description
FORBIDDEN
Returns: HTTP 403
FORBIDDEN
Returns: HTTP 403
/common/v1/regions/[REGION_NAME]/countries/[COUNTRY_NAME]/states FORBIDDEN
Returns: HTTP 403
list all states
Returns: HTTP 200 + JSON
Errors: HTTP 403,500 + description
FORBIDDEN
Returns: HTTP 403
FORBIDDEN
Returns: HTTP 403
/common/v1/regions/[REGION_NAME]/countries/[COUNTRY_NAME]/states/[STATE_NAME]/cities FORBIDDEN
Returns: HTTP 403
list all cities
Returns: HTTP 200 + JSON
Errors: HTTP 403,500 + description
FORBIDDEN
Returns: HTTP 403
FORBIDDEN
Returns: HTTP 403
/common/v1/isps FORBIDDEN
Returns: HTTP 403
list all isps
Returns: HTTP 200 + JSON
Errors: HTTP 403,500 + description
FORBIDDEN
Returns: HTTP 403
FORBIDDEN
Returns: HTTP 403
/common/v1/device-types FORBIDDEN
Returns: HTTP 403
list all device types
Returns: HTTP 200 + JSON
Errors: HTTP 403,500 + description
FORBIDDEN
Returns: HTTP 403
FORBIDDEN
Returns: HTTP 403
/common/v1/device-types/[DEVICE_TYPE_NAME]/os FORBIDDEN
Returns: HTTP 403
list all device type OS
Returns: HTTP 200 + JSON
Errors: HTTP 403,500 + description
FORBIDDEN
Returns: HTTP 403
FORBIDDEN
Returns: HTTP 403
/common/v1/device-types/[DEVICE_TYPE_NAME]/os/[OS_NAME]/device-models FORBIDDEN
Returns: HTTP 403
list all device models
Returns: HTTP 200 + JSON
Errors: HTTP 403,500 + description
FORBIDDEN
Returns: HTTP 403
FORBIDDEN
Returns: HTTP 403
/common/v2/platform-types FORBIDDEN
Returns: HTTP 403
list all platform types
Returns: HTTP 200 + JSON
Errors: HTTP 403,500 + description
FORBIDDEN
Returns: HTTP 403
FORBIDDEN
Returns: HTTP 403
/common/v2/floor-price-objects/types/[TYPE] FORBIDDEN
Returns: HTTP 403
list all floor-price-objects types
[TYPE] = {publisher, improve}
Returns: HTTP 200 + JSON
Errors: HTTP 403,500 + description
FORBIDDEN
Returns: HTTP 403
FORBIDDEN
Returns: HTTP 403
/common/v2/buying-types FORBIDDEN
Returns: HTTP 403
list all buying types
Returns: HTTP 200 + JSON
Errors: HTTP 403,500 + description
FORBIDDEN
Returns: HTTP 403
FORBIDDEN
Returns: HTTP 403

/common/v1/i18n/[RESOURCE]

List of resources available for this endpoint can be found at Multiple-Language support page (in the section Resources available for internationalization)

FORBIDDEN
Returns: HTTP 403
list all resources
Returns: HTTP 200 + JSON
Errors: HTTP 403,500 + description
FORBIDDEN
Returns: HTTP 403
FORBIDDEN
Returns: HTTP 403
/admin/v1/advertiser-categories FORBIDDEN
Returns: HTTP 403
list all advertiser categories
Returns: HTTP 200 + JSON
Errors: HTTP 403,500 + description
FORBIDDEN
Returns: HTTP 403
FORBIDDEN
Returns: HTTP 403
/admin/v1/business-units FORBIDDEN
Returns: HTTP 403
list allbusiness unit information
Returns: HTTP 200 + JSON
Errors: HTTP 403,500 + description
FORBIDDEN
Returns: HTTP 403
FORBIDDEN
Returns: HTTP 403
/admin/v1/creative-attributes FORBIDDEN
Returns: HTTP 403
get creative attributes
Returns: HTTP 200 + JSON
Errors: HTTP 403,500 + description
FORBIDDEN
Returns: HTTP 403
FORBIDDEN
Returns: HTTP 403
/admin/v1/iab-categories FORBIDDEN
Returns: HTTP 403
get iab categories
Returns: HTTP 200 + JSON
Errors: HTTP 403,500 + description
FORBIDDEN
Returns: HTTP 403
FORBIDDEN
Returns: HTTP 403
/admin/v1/iab-secondary-categories FORBIDDEN
Returns: HTTP 403
get iab secondary categories
Returns: HTTP 200 + JSON
Errors: HTTP 403,500 + description
FORBIDDEN
Returns: HTTP 403
FORBIDDEN
Returns: HTTP 403
/admin/v1/rtb-advertisers FORBIDDEN
Returns: HTTP 403
get rtb advertisers
Returns: HTTP 200 + JSON
Errors: HTTP 403,500 + description
FORBIDDEN
Returns: HTTP 403
FORBIDDEN
Returns: HTTP 403
/admin/v1/users FORBIDDEN
Returns: HTTP 403
get users
Returns: HTTP 200 + JSON
Errors: HTTP 403,500 + description
FORBIDDEN
Returns: HTTP 403
FORBIDDEN
Returns: HTTP 403
/admin/v1/privacies FORBIDDEN
Returns: HTTP 403
get privacies
Returns: HTTP 200 + JSON
Errors: HTTP 403,500 + description
FORBIDDEN
Returns: HTTP 403
FORBIDDEN
Returns: HTTP 403
/admin/v1/text-templates FORBIDDEN
Returns: HTTP 403
get text templates
Returns: HTTP 200 + JSON
Errors: HTTP 403,500 + description
FORBIDDEN
Returns: HTTP 403
FORBIDDEN
Returns: HTTP 403
/admin/v1/currencies FORBIDDEN
Returns: HTTP 403
get currencies
Returns: HTTP 200 + JSON
Errors: HTTP 403,500 + description
FORBIDDEN
Returns: HTTP 403
FORBIDDEN
Returns: HTTP 403
/admin/v1/sizes FORBIDDEN
Returns: HTTP 403
get sizes
Returns: HTTP 200 + JSON
Errors: HTTP 403,500 + description
FORBIDDEN
Returns: HTTP 403
FORBIDDEN
Returns: HTTP 403
/admin/v1/publishers/[PUBLISHER_ID]/documents FORBIDDEN
Returns: HTTP 403
get publisher documents
Returns: HTTP 200 + JSON
Errors: HTTP 403,500 + description
FORBIDDEN
Returns: HTTP 403
FORBIDDEN
Returns: HTTP 403
/admin/v1/publishers/[PUBLISHER_ID]/documents/[DOCUMENT_ID] FORBIDDEN
Returns: HTTP 403
get publisher document
Returns: HTTP 200 + JSON
Errors: HTTP 403,500 + description
FORBIDDEN
Returns: HTTP 403
FORBIDDEN
Returns: HTTP 403
/admin/v1/size-text-options FORBIDDEN
Returns: HTTP 403
get size text options
Returns: HTTP 200 + JSON
Errors: HTTP 403,500 + description
FORBIDDEN
Returns: HTTP 403
FORBIDDEN
Returns: HTTP 403
/admin/v1/document-types FORBIDDEN
Returns: HTTP 403
 get document types
Returns: HTTP 200 + JSON
Errors: HTTP 403,500 + description
FORBIDDEN
Returns: HTTP 403
FORBIDDEN
Returns: HTTP 403
/admin/v1/positions FORBIDDEN
Returns: HTTP 403
get positions
Returns: HTTP 200 + JSON
Errors: HTTP 403,500 + description
FORBIDDEN
Returns: HTTP 403
FORBIDDEN
Returns: HTTP 403
/admin/v1/users/[USER_ID]/password FORBIDDEN
Returns: HTTP 403
FORBIDDEN
Returns: HTTP 403
FORBIDDEN
Returns: HTTP 403
deletes password for a given user. It is allowed to reset password only for agency contacts, advertiser contacts and subublishre contacts.  generates confirmation code and sends mail with it to the user email address
Returns: HTTP 200 + JSON
Errors: HTTP 403,500 + description
/admin/v1/confirmation/[CODE]/password FORBIDDEN
Returns: HTTP 403
FORBIDDEN
Returns: HTTP 403
update user password after is reset/deleted
Returns: HTTP 200 + JSON
Errors: HTTP 403,404 + description
FORBIDDEN
Returns: HTTP 403
/admin/v1/publishers/[PUBLISHER_ID]/history/campaigns/[CAMPAIGN_ID] FORBIDDEN
Returns: HTTP 403
get history for campaigns
Returns: HTTP 200 + JSON
Errors: HTTP 403,500 + description
FORBIDDEN
Returns: HTTP 403
FORBIDDEN
Returns: HTTP 403
/admin/v1/publishers/[PUBLISHER_ID]/history/line-items/[LINEITEM_ID] FORBIDDEN
Returns: HTTP 403
get history for line items
Returns: HTTP 200 + JSON
Errors: HTTP 403,500 + description
FORBIDDEN
Returns: HTTP 403
FORBIDDEN
Returns: HTTP 403
/admin/v1/size-text-options-combo FORBIDDEN
Returns: HTTP 403
get size text options
Returns: HTTP 200 + JSON
Errors: HTTP 403,500 + description
FORBIDDEN
Returns: HTTP 403
FORBIDDEN
Returns: HTTP 403
/admin/v1/buying-entities/[BUYINGENTITY_ID]/buying-entity-offices-combo FORBIDDEN
Returns: HTTP 403
get buying entity offices for a specific buying entity
Returns: HTTP 200 + JSON
Errors: HTTP 403,500 + description
FORBIDDEN
Returns: HTTP 403
FORBIDDEN
Returns: HTTP 403
/admin/v1/buying-entities FORBIDDEN
Returns: HTTP 403

get list of buying entities

Returns: HTTP 200 + JSON
Errors: HTTP 403,500 + description

 

 

FORBIDDEN
Returns: HTTP 403

 FORBIDDEN
Returns: HTTP 403

 

 /admin/v1/buying-entities/[BUYINGENTITY_ID] FORBIDDEN
Returns: HTTP 403

get information about a specific buying entity

Returns: HTTP 200 + JSON
Errors: HTTP 403,500 + description

FORBIDDEN
Returns: HTTP 403
FORBIDDEN
Returns: HTTP 403
/admin/v1/buyers NOT ALLOWED

    Returns: HTTP 403
list all of all buyers

    Returns: HTTP 200 + JSON
    Errors: HTTP 403,500 + description
NOT ALLOWED

    Returns: HTTP 403
NOT ALLOWED

    Returns: HTTP 403
/placements/v1/nativetemplates FORBIDDEN
Returns: HTTP 403

list of native templates

Returns: HTTP 200 + JSON
    Errors: HTTP 403,500 + description

FORBIDDEN
Returns: HTTP 403
FORBIDDEN
Returns: HTTP 403
/placements/v1/nativetemplates/[TEMPLATE_ID] FORBIDDEN
Returns: HTTP 403

single native template with given id

Returns: HTTP 200 + JSON
    Errors: HTTP 403,404,500 + description

FORBIDDEN
Returns: HTTP 403
FORBIDDEN
Returns: HTTP 403
/rtb/v1/technical-providers FORBIDDEN
Returns: HTTP 403

list of technical providers

Returns: HTTP 200 + JSON
    Errors: HTTP 403,500 + description

FORBIDDEN
Returns: HTTP 403
FORBIDDEN
Returns: HTTP 403

 

Common Schemas

url
/schema/common/v1/regions
/schema/common/v1/regions/countries
/schema/common/v1/regions/countries/states
/schema/common/v1/regions/countries/states/cities
/schema/common/v1/isps
/schema/common/v1/device-types
/schema/common/v1/device-types/os
/schema/common/v1/device-types/os/device-models
/schema/common/v1/user-details
/schema/common/v2/platform-types
/schema/common/v2/floor-price-objects
/schema/common/v1/i18n
/schema/admin/v1/advertiser-categories
/schema/admin/v1/business-units
/schema/admin/v1/creative-attributes
/schema/admin/v1/iab-categories
/schema/admin/v1/iab-secondary-categories
/schema/admin/v1/rtb-advertisers
/schema/admin/v1/users 
/schema/admin/v1/privacies
/schema/admin/v1/text-templates
/schema/admin/v1/currencies
/schema/admin/v1/sizes
/schema/admin/v1/publisher-documents
/schema/admin/v1/publisher-documents/publisher-document
/schema/admin/v1/size-text-options
/schema/admin/v1/document-types
/schema/admin/v1/positions
/schema/admin/v1/confirmation/password
/schema/admin/v1/confirmation/code
/schema/admin/v1/publishers/history
/schema/admin/v1/size-text-options-combo
/schema/admin/v1/buying-entity-offices-combo
/schema/placements/v1/nativetemplates
/schema/placements/v1/nativetemplate