Discard

Criteo Marketing Solutions API

Advertiser-Level Domain Targeting

Advertiser Level Domain Blocking

🚧

Please Note

In the examples below, we will use {advertiserId} as a placeholder. Please replace this placeholder with your advertiser id.

Retrieve Targeting List

Use this call to retrieve a list of of blocked or allowed domains for your advertiser.

https://api.criteo.com/preview/advertisers/{advertiserId}/targeting/domain-rules

The API will return the type, mode and a corresponding array containing 3 parameters. The array parameters are "value", "readonly" and "active".

  • The value parameter contains the domain.
  • The readonly flag indicates if you can change the rule. Rules added by Criteo are not editable and will always return true.
  • The active flag indicates if the rule is activated and currently being taken into account. Please note that there is a delay between setting-up the rule and this field changing.
{
  "data": {
    "type": "DomainTargetingRule",
    "id": "f4dc0549-e464-46f4-a5e5-6622912ddd07",
    "attributes": {
      "type": "DOMAIN",
      "mode": "BLOCKLIST",
      "data": [
        {
          "value": "first.com",
          "readonly": true,
          "active": false
        },
        {
          "value": "second.com",
          "readonly": false,
          "active": false
        },
        {
          "value": "third.com",
          "readonly": true,
          "active": true
        }
      ]
    }
  }
}

To test this endpoint, please visit the reference section.

 
Add A New Targeting List

Use this endpoint to create a list for the given advertiser. You can specify either a "BLOCKLIST" or "ALLOWLIST" in the payload.

🚧

Warning

If there is already a domain list defined for the advertiser, it will overwrite it. It will not affect the bundle list.

https://api.criteo.com/preview/advertisers/{advertiserId}/targeting/domain-rules

The request body should contain the "mode" and an array of objects containing the domains to block/allow.

  • The mode parameter can be "BLOCKLIST" or "ALLOWLIST".

Please reference the below for a sample payload.

{
    "data": {
        "type": "DomainTargetingRule",
        "attributes": {
            "mode": "BLOCKLIST", // BLOCKLIST or ALLOWLIST
            "type": "domain",
            "data": [
                {
                    "value": "first.com"
                },
                {
                    "value": "second.com"
                }
            ]
        }
    }
}

A successful response will return a similar payload to the get request above. Please reference the below for a sample returned payload.

{
  "data": {
    "type": "DomainTargetingRule",
    "id": "f4dc0549-e464-46f4-a5e5-6622912ddd07",
    "attributes": {
      "mode": "BLOCKLIST",
      "data": [
        {
          "value": "first.com",
          "readonly": false,
          "active": false
        },
        {
          "value": "second.com",
          "readonly": false,
          "active": false
        },
      ],
    }
  }
}

To test this endpoint, please visit the reference section.

 
Add Domains To An Existing List

Use this call to add a domain(s) to the existing list.

https://api.criteo.com/preview/advertisers/{advertiserId}/targeting/domain-rules

The request body should contain an array of objects containing the domain(s) that you want to add.

Please reference the below for a sample payload.

{
    "data": {
        "type": "DomainTargetingRule",
        "attributes": {
            "data": [
                {
                    "value": "first.com"
                },
                {
                    "value": "second.com"
                }
            ]
        }
    }
}

A successful response will return a similar payload to the get request above. Please reference the below for a sample returned payload.

{
  "data": {
    "type": "DomainTargetingRule",
    "id": "f4dc0549-e464-46f4-a5e5-6622912ddd07",
    "attributes": {
      "mode": "BLOCKLIST",
      "data": [
        {
          "value": "first.com",
          "readonly": false,
          "active": false
        },
        {
          "value": "second.com",
          "readonly": false,
          "active": false
        },
      ],
    }
  }
}

To test this endpoint, please visit the reference section.

 
Remove Domains From An Existing List

Use this call remove a domain(s) from an existing list.

https://api.criteo.com/preview/advertisers/{advertiserId}/targeting/domain-rules

The request body should contain an array of objects containing the domain(s) that you want to remove.

Please reference the below for a sample payload.

{
    "data": {
        "type": "DomainTargetingRule",
        "attributes": {
            "data": [
                {
                    "value": "first.com"
                },
                {
                    "value": "second.com"
                }
            ]
        }
    }
}

A successful response will return a similar payload to the get request above. Please reference the below for a sample returned payload.

{
  "data": {
    "type": "DomainTargetingRule",
    "id": "f4dc0549-e464-46f4-a5e5-6622912ddd07",
    "attributes": {
      "mode": "BLOCKLIST",
      "data": [
        {
          "value": "first.com",
          "readonly": false,
          "active": false
        },
        {
          "value": "second.com",
          "readonly": false,
          "active": false
        },
      ],
    }
  }
}

To test this endpoint, please visit the reference section.

Updated 4 months ago


Advertiser-Level Domain Targeting


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.