Partager via

Service de disposition native

Ce service permet au vendeur de spécifier la disposition d’un créatif natif. Une fois la disposition dans notre base de données, elle peut être récupérée à l’aide de renderer_id, puis de layout_id.

API REST

HTTP, méthode Endpoint Description
POST https://api.appnexus.com/native-layout?member_id=456 Create une nouvelle disposition.
PUT https://api.appnexus.com/native-layout?id=16&member_id=456 Modifier une disposition existante.
DELETE https://api.appnexus.com/native-layout?id=123&member_id=456 Supprimer une disposition.

Champs JSON

Champ Type Description
data_assets tableau d’objets Attributs de la création native. Pour plus d’informations , consultez Ressources de données ci-dessous.
image_assets tableau d’objets Spécifiez les attributs requis de chaque image individuelle. Pour plus d’informations, consultez Ressources d’image .
renderer objet ID du renderer du vendeur. Entrez dans id ce tableau. Exemple :
"renderer":{"id":1}

Ressources d’image

L’objet image_assets inclut les champs suivants :

Champ Type Description
aspect_ratios tableau d’objets Définissez les proportions requises pour le type d’image icon . Les valeurs requises sont min_width, ratio_width et ratio_height. Consultez l’exemple.
image_type string Format de l’image. Les valeurs admises sont les suivantes :
- main_image
- icon_image
required int Spécifiez si l’image est requise.
Valeurs possibles : 1 - Obligatoire
sizes tableau d’objets Taille de l’image. Spécifiez et widthheight. Consultez l’exemple.

Exemple pour aspect_ratios

"aspect_ratios": [
{
"min_width" : 100,
"ratio_width": 1,
"ratio_height": 2
}
]

Exemple pour sizes

Example:
"sizes": [
{
"width": 300,
"height": 500
}
]

Ressources de données

L’objet data_assets inclut les champs suivants :

Champ Type Description
data_type string Type de ressource pour la création native. Valeurs possibles :
- sponsored_by
- title
- description
- rating
- call_to_action
- display_url
- likes
- downloads
- price
- sale_price
- phone
- address
- additional_description
required int Si nécessaire, la valeur doit être 1.
maximum_length int Longueur maximale de la ressource de données.

Exemples

Create un nouveau protocole de disposition natif

$ cat native_layout

{
    "native-layout": {
        "renderer": {
            "id": 1
        },
        "image_assets":[
            {
                "image_type": "main_image", //depends on api.native_asset_image_type.name
                "required": 1,
                "sizes": [
                    {
                        "width": 300,
                        "height": 500
                    }
                ]
            },
            {
                "image_type": "icon_image",
                "aspect_ratios": [
                    {
                        "minimum_width" : 100,
                        "ratio_width": 1,
                        "ratio_height": 2
                    }
                ]
            }
        ],
        "data_assets": [
            {
                "data_type": "title", //depends on api.native_asset_data_type.name
                "required": 1,
                "maximum_length": 100
            }
        ]
    }
} 

$ curl -b cookies -c cookies -X POST -d @native_layout 'https://api.appnexus.com/native-layout?member_id=456'

{
    "response": {
        "status": "OK",
        "start_element": 0,
        "num_elements": 100,
        "native-layout": {
            "id": 2,
            "member_id": 7,
            "renderer": {
                "id": 1
            },
            "data_assets": [
                {
                    "required": true,
                    "data_type": "title",
                    "maximum_length": 100
                }
            ],
            "image_assets": [
                {
                    "required": true,
                    "image_type": "main_image",
                    "sizes": [
                        {
                            "width": 300,
                            "height": 500
                        }
                    ],
                    "aspect_ratios": null
                },
                {
                    "required": false,
                    "image_type": "icon_image",
                    "sizes": null,
                    "aspect_ratios": [
                        {
                            "minimum_width": 100,
                            "ratio_width": 1,
                            "ratio_height": 2
                        }
                    ]
                }
            ]
        },
        ...
    }
}
  • Last updated on