Manage Product Sets¶

Product Sets enable you to target a subset of your product catalog in web and Facebook campaigns.

To use Product Sets, you’ll first need to:

Set up a product feed
Create a product set with a subset of the products in your catalog
Attach a product set to your campaign’s AdGroup

Product Sets¶

Create a Product Set¶

To create a product set, you’ll need to upload a CSV file containing one product ID per line. The file should be compressed using gzip. The product IDs must be available in the product feed.

PRODUCT_1
PRODUCT_4
PRODUCT_6
PRODUCT_3

Once you have the file to upload, you can make a request to POST /api/v1/product_sets/create. You must specify the Advertisable EID that will own the product set and a name for the product set.

curl -H 'Authorization: Token YOUR_TOKEN' \
    --form 'name="Name of the Product Set"' \
    --form 'file=@"/Users/user/Desktop/gzipped-file.csv.gz"' \
    'https://services.adroll.com/api/v1/product_sets/create?apikey=MYAPIKEY&advertisable=MY_ADVERTISABLE_EID'

Edit a Product Set¶

You can update the name and the file for the product set by calling PUT /api/v1/product_sets/edit. When you upload a new file, the file replaces the current list of product IDs in the product set.

curl -H 'Authorization: Token YOUR_TOKEN' \
    --form 'name="Name of the Product Set"' \
    --form 'file=@"/Users/user/Desktop/gzipped-file.csv.gz"' \
    'https://services.adroll.com/api/v1/product_sets/edit?apikey=MYAPIKEY&advertisable=MY_ADVERTISABLE_EID&product_set=YOUR_PRODUCT_SET_EID'

List Product Sets for an Advertisable¶

You can retrieve the the Product Sets that the provided Advertisable EID owns by calling GET /api/v1/product_sets/list.

curl -H 'Authorization: Token YOUR_TOKEN' \
    'https://services.adroll.com/api/v1/product_sets/list?apikey=MYAPIKEY&advertisable=MY_ADVERTISABLE_EID'

Get a Product Set¶

You can retrieve a specific Product Set that an Advertisable owns by calling GET /api/v1/product_sets/get. You must specify both the product set and the Advertisable EID.

curl -H 'Authorization: Token YOUR_TOKEN' \
    'https://services.adroll.com/api/v1/product_sets/get?apikey=MYAPIKEY&advertisable=MY_ADVERTISABLE_EID&product_set=YOUR_PRODUCT_SET_EID'

Delete a Product Set¶

You can delete a product set by calling DELETE /api/v1/product_sets/delete. You must specify both the product set and the Advertisable EID. The request returns true on success.

curl -H 'Authorization: Token YOUR_TOKEN' \
    --request DELETE \
    'https://services.adroll.com/api/v1/product_sets/delete?apikey=MYAPIKEY&advertisable=MY_ADVERTISABLE_EID&product_set=YOUR_PRODUCT_SET_EID'

Use Product Sets with Web Retargeting campaigns¶

To use Product Sets with web retargeting campaigns, you attach the product set to the campaign’s AdGroup. Either when creating the AdGroup or editing it after creation. An AdGroup can only have one Product Set attached.

Attach Product Sets to an AdGroup¶

If you don’t have an AdGroup yet, you can attach a product set when creating the AdGroup when calling POST /api/v1/adgroup/create. Specify the Product Set’s EID in the product_set parameter.

curl -H 'Authorization: Token YOUR_TOKEN' \
    --form 'campaign="YOUR_CAMPAIGN"' \
    --form 'product_set="YOUR_PRODUCT_SET_EID"' \
    --form 'name="Name of the AdGroup"'
    'https://services.adroll.com/api/v1/adgroup/create?apikey=MYAPIKEY'

Edit an AdGroup with a Product Set attached¶

If you already have an AdGroup that you want to use your Product Set with, you can use the PUT /api/v1/adgroup/edit endpoint to attach the product set. Specify the Product Set’s EID in the product_set parameter.

curl -H 'Authorization: Token YOUR_TOKEN' \
    --form 'product_set="YOUR_PRODUCT_SET_EID"' \
    'https://services.adroll.com/api/v1/adgroup/edit?apikey=MYAPIKEY&adgroup=YOUR_ADGROUP'

Remove a Product Set from an AdGroup¶

You can remove a Product Set from an AdGroup by calling PUT /api/v1/adgroup/edit and setting product_set to an empty string.

curl -H 'Authorization: Token YOUR_TOKEN' \
    --form 'product_set=""' \
    'https://services.adroll.com/api/v1/adgroup/edit?apikey=MYAPIKEY&adgroup=YOUR_ADGROUP'

Use Product Sets with Facebook campaigns¶

To use Product Sets with Facebook campaigns, you’ll first create a Product Set and then attach the Product Set to the FB AdSet. Attaching to an AdSet can be done when creating an AdSet or by editing an existing AdSet. A AdSet can only have one Product Set attached.

Attach Product Sets to an AdSet¶

You can attach a Product Set when creating an AdSet by specifying the product_set_eid parameter when calling POST /facebook/adsets/.

curl -H 'Authorization: Token YOUR_TOKEN' \
    --header 'Content-Type: application/json' \
    --data-raw '{
        "name": "Name of the AdSet",
        "campaign_eid": "YOUR_CAMPAIGN",
        "product_set_eid": "YOUR_PRODUCT_SET_EID"
    }'
    'https://services.adroll.com/facebook/adsets/?apikey=MYAPIKEY'

To attach or change the Product Set of an existing AdSet, you can specify the product_set_eid parameter when calling POST /facebook/adsets/(eid)

curl -H 'Authorization: Token YOUR_TOKEN' \
    --header 'Content-Type: application/json' \
    --data-raw '{
        "product_set_eid": "YOUR_PRODUCT_SET_EID"
    }'
    'https://services.adroll.com/facebook/adsets/YOUR_ADSET?apikey=MYAPIKEY'

Remove a Product Set from an AdSet¶

To remove the Product Set from an AdSet, set the product_set_eid parameter to null when calling POST /facebook/adsets/(eid).

curl -H 'Authorization: Token YOUR_TOKEN' \
    --header 'Content-Type: application/json' \
    --data-raw '{
        "product_set_eid": null
    }'
    'https://services.adroll.com/facebook/adsets/YOUR_ADSET?apikey=MYAPIKEY&'