GuidesAPI ReferenceChangelogDiscussions
GuidesAPI ReferenceChangelogLog In

📝

A FEW THINGS TO KNOW

1 - A brand is a collection of products marketed & sold under the same umbrella name.
2 - Brands associated with the account determine the products available for an account to promote on retailer sites.
3 - An account may have access to one or more brands, typically managed by Criteo.
4 - Brand attributes are standardized across retailers

 

Endpoint

VerbEndpointDescription
GET /accounts/{accountId}/brandsGet Accounts

 

Brand Attributes

id

    Data Type: string

    Values: int64

    Description: Brand ID

name

    Data Type: string

    Values: 510 char limit

    Description: Brand name

 

Get All Brands

This endpoint lists all brands associated with an account. Results are paginated.

https://api.criteo.com/2022-10/retail-media/accounts/{accountId}/brands

Sample Request

curl -X GET "https://api.criteo.com/2022-10/retail-media/accounts/18446744073709551616/brands" \
    -H "Authorization: Bearer <MY_ACCESS_TOKEN>"
import requests

url = "https://api.criteo.com/2022-07/retail-media/accounts/4/brands"

payload={}
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer <MY_ACCESS_TOKEN>'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();

MediaType mediaType = MediaType.parse("text/plain");

RequestBody body = RequestBody.create(mediaType, "");

Request request = new Request.Builder()
  .url("https://api.criteo.com/2022-07/retail-media/accounts/4/brands")
  .method("GET", body)
  .addHeader("Accept", "application/json")
  .addHeader("Authorization", "Bearer <MY_ACCESS_TOKEN>")
  .build();

Response response = client.newCall(request).execute();
<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('https://api.criteo.com/2022-07/retail-media/accounts/4/brands');
$request->setMethod(HTTP_Request2::METHOD_GET);
$request->setConfig(array(
  'follow_redirects' => TRUE
));
$request->setHeader(array(
  'Accept' => 'application/json',
  'Authorization' => 'Bearer <MY_ACCESS_TOKEN>'
));

try {
  $response = $request->send();
  if ($response->getStatus() == 200) {
    echo $response->getBody();
  }
  
  else {
    echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
    $response->getReasonPhrase();
  }
}

catch(HTTP_Request2_Exception $e) {
  echo 'Error: ' . $e->getMessage();
}

Sample Response

// Sample Response
  
{
    "data": [
        {
            "type": "RetailMediaBrand",
            "id": "7672171780147256541",
            "attributes": {
                "name": "Brand 123"
            }
        },
 
        // ...
 
        {
            "type": "RetailMediaBrand",
            "id": "5979998329674492121",
            "attributes": {
                "name": "Brand 789"
            }
        }
    ],
    "metadata": {
        "totalItemsAcrossAllPages": 15,
        "currentPageSize": 25,
        "currentPageIndex": 0,
        "totalPages": 1,
        "nextPage": null,
        "previousPage": null
    }
}

Responses

ResponseDescriptoin
:large-blue-circle: 200Call executed with success
:red-circle: 403API user does not have the authorization to make requests to the account ID. For an authorization request, follow the authorization request steps

What’s Next