SmartXSP
  • Welcome to SmartXSP
  • How to create your first campaign
  • SmartPulse
    • Advanced Tracking
  • Transition Effects
  • Social Generator
  • Ad Serving
    • Getting Started for Publishers
      • [ENG] Publishers : Testing Guide
      • [FRA] Editeurs : Manuel d'intégration
  • Settings
    • Site custom settings
    • Macro in Creative URL
  • API Documentation
    • Starter Guide
    • Campaign
    • Creative
    • Account
  • Looker Studio Connector
    • Looker Studio : what is this connector
    • Support
  • Register SmartXSP
  • Terms & conditions
    • Privacy
    • Terms
  • Troubleshooting
    • No URL
Powered by GitBook
On this page
  • Properties description
  • Get creative
  • Get campaign details
  • Create creative
  • Create a new creative
  • Update creative
  • Update an existing creative
  • JSON Templates samples
  • Halfpage Vertical Products
  1. API Documentation

Creative

Creatives are the visual elements of your campaign. You can have several creative associated to one campaign.

Properties description

Property
Type
Description

id

Integer

Creative unique identification.

name

String

Creative name defined par user during creation

created_at

Datetime

Creation date of the creative, GMT timezone

updated_at

Datetime

Last update of the creative, GMT timezone

deleted_at

Datetime

Field used for softdeleting the campaign. This property is null for active creative.

Get creative

Get campaign details

GET https://api.smartxsp.io/creatives/{creative_id}

Retrieves campaign details.

Path Parameters

Name
Type
Description

creative_id*

String

The numeric id of the creative

Headers

Name
Type
Description

Authorization*

String

The Bearer token you get during login process.

{
    "success":true,
    "data":{
        "id":1,
        "name":"My first creative",
        "created_at":"2023-04-26T15:24:05.000000Z",
        "updated_at":"2023-05-02T12:37:06.000000Z",
        "deleted_at":null
    },
    "message":"Creative retrieved successfully."
}

Create creative

Create a new creative

POST https://api.smartxsp.io/creatives/

Create a new creative associated to a campaign with template initializationCreate a new creative associated to a campaign based on JSON string

Query Parameters

Name
Type
Description

campaign_id*

Integer

The campaign associated to the creative.

name*

String

The campaign name

json_template

String

sub_product_id*

Integer

Headers

Name
Type
Description

Authorization*

String

The Bearer token you get during login process.

Update creative

Update an existing creative

PATCH https://api.smartxsp.io/creatives/{creative_id}

Generaly used to regenerate the visual part of the creative based on the JSON string.

Path Parameters

Name
Type
Description

creative_id

Integer

The ID of the creative to update

Query Parameters

Name
Type
Description

name

String

The new name of the creative, no modification if null or empty

json_template

String

The new version of the JSON stream used to create the visual part of the creative.

JSON Templates samples

Halfpage Vertical Products

{
    "inputs":{    
        "company":{
            "value":"My super customer"
        },
        "company_sub":{
            "value":"Whatever you want"
        },
        "company_logo":{
            "media_url":"https://cdn.edgequery.io/prd/creatives/7625/5/company_logo_80.jpg"
        },
        "cta_text":{
            "value":"Read more"
        },
        "slides":{
            "elements":{
                "idx1":{
                    "slide_title":{
                        "value":"My first product"
                    },
                    "slide_text":{
                        "value":"Maybe the brand"
                    },
                 "slide_subtext":{
                        "value":"Long description<br/>On many lines."
                    },
                    "slide_price":{
                        "value":349
                    },
                    "slide_price_unit":{
                        "value":"Sub price text"
                    },
                    "slide_image":{
                        "media_url":"https://cdn.edgequery.io/prd/creatives/7625/4/slide_300x300_1.jpg"
                    },
                    "slide_background":{
                        "value":"#FF0000"
                    },
                    "slide_color":{
                        "value":"#FFFFFF"
                    }
                },
                "idx2":{
                    "slide_title":{
                        "value":"My second product"
                    },
                    "slide_text":{
                        "value":"Maybe the brand"
                    },
                    "slide_subtext":{
                        "value":"Long description<br/>On many lines."
                    },
                    "slide_price":{
                        "value":49.95
                    },
                    "slide_price_unit":{
                        "value":"Sub price text"
                    },
                    "slide_image":{
                        "media_url":"https://cdn.edgequery.io/prd/creatives/7625/7/slide_300x300_2.jpg"
                    },
                    "slide_background":{
                        "value":"#FFFF00"
                    },
                    "slide_color":{
                        "value":"#000000"
                    }
                },
                "idx3":{
                    "slide_title":{
                        "value":"My last product"
                    },
                    "slide_text":{
                        "value":"Maybe the brand"
                    },
                    "slide_subtext":{
                        "value":"Long description<br/>On many lines."
                    },
                    "slide_price":{
                        "value":199.99
                    },
                    "slide_price_unit":{
                        "value":"Sub price text"
                    },
                    "slide_image":{
                        "media_url":"https://cdn.edgequery.io/prd/creatives/7625/9/slide_300x300_4.png"
                    },
                    "slide_background":{
                        "value":"#FFFF00"
                    },
                    "slide_color":{
                        "value":"#000000"
                    }
                }
            }
        }
    },
    "url":"https://oursblanc.io",
    "pixel":"https://oursblanc.io/pixel",
    "name":"Custom name of my creative"
}
PreviousCampaignNextAccount

Last updated 1 year ago

The JSON stream used to create the visual part of the creative. Please look at .

Id of the Sub Product, it's the template used to create the visual. It must be a sub product of the product defined in

samples below
the campaign.