Skip to end of metadata
Go to start of metadata

Native Layout Service

This service allows the seller to specify the layout for a native creative. Once the layout is in our database, it can be retrieved using the renderer_id, and subsequently the layout_id.

REST API

Create a new layout:

Edit an existing layout:

Delete a layout

 

JSON Fields

Field

Type

Use

renderer

object

The renderer id of the seller. Enter the id in this array. Example:

image_assets

array of objects

Specify the required attributes of each individual image. See Image Assets for more details.

data_assets

array of objects

Attributes of the native creative. See Data Assets below for more details.

Image Assets

The image_assets object includes the following fields:

Field
Type
Description
image_typestring

The format of the image. Possible values include:

  • main_image
  • icon_image
requiredint

Specify if the image is required.

Possible values:

  • 1 - Required

sizes

array of objects

The size of the image. Specify both width and height


Example:

aspect_ratios

array of objects

Define the aspect ratios required for the icon image type. Required values are min_width, ratio_width and ratio_height.

Example:

Data Assets

The data_assets object includes the following fields:

Field
Type
Description
data_typestring

The asset type for the native creative. Possible values:

  • sponsored_by
  • title
  • description
  • rating
  • call_to_action
  • display_url
  • likes

  • downloads

  • price

  • sale_price

  • phone

  • address

  • additional_description

requiredint

If required then the value should be 1.

maximum_lengthintThe maximum length of the data asset

Examples

 Create a new native layout protocol