GuidesAPI ReferenceChangelog
GuidesAPI ReferenceChangelogLog In

Start and Stop Ad Sets

Start an Ad Set

One or more Ad Sets can be set to start delivery by making a POST call to the Start Ad Sets endpoint shown below. The payload should be an array of Ad Sets, specifying their type and id:

 

https://api.criteo.com/2021-01/marketing-solutions/ad-sets/start
{
    "data": [
        {
            "type": "AdSetId",
            "id": "12345"
        },
        {
            "type": "AdSetId",
            "id": "67890"
        }
    ]
}

The API will return an array of Ad Sets representing those Ad Sets which were started successfully:

{
    "data": [
        {
            "type": "AdSetId",
            "id": "12345"
        },
        {
            "type": "AdSetId",
            "id": "67890"
        }
    ],
    "errors": [],
    "warnings": []
}

 

Stop an Ad Set

Similarly, one or more Ad Sets can be set to stop delivery by making a POST call to the Stop Ad Sets endpoint shown below. The payload should be an array of Ad Sets, specifying their type and id:

 

https://api.criteo.com/2021-01/marketing-solutions/ad-sets/stop
{
    "data": [
        {
            "type": "AdSetId",
            "id": "12345"
        }
    ]
}

The API will return an array of Ad Sets representing those Ad Sets which were stopped successfully:

{
    "data": [
        {
            "type": "AdSetId",
            "id": "12345"
        }
    ],
    "errors": [],
    "warnings": []
}

 

Partial Success / Partial Failure

In the same way that Ad Set updates are processed individually, Ad Set activations and deactivations are processed separately. As a result, Ad Set activation changes processed successfully will be returned in the data array of the response, while Ad Sets activation changes that have failed will return as an entry in the errors array of the response.

An example of this can be found at the bottom of the Update Ad Sets page earlier in this section.

A full list of error codes can be found on the Validation Errors page at the end of this section.


What’s Next

Learn about the possible validation errors returned for Ad Sets