Marketing API Version

CustomDimensions

Provides operations to create, read, update and delete Atlas custom dimensions.

Read CustomDimensions

Permissions

A user access token with Atlas API capability is required to request custom dimensions details.

Fields

Reading this endpoint returns a single or an array of CustomDimension objects with the same fields as the node.

Read Atlas CustomDimensions

Read Advertiser CustomDimensions

You can get details of custom dimensions associated with an advertiser by making an HTTP GET request.

An example of the request and response:

Request:

https://graph.facebook.com/<API_VERSION>/<ADVERTISER_ID>/atlascustomdimensions

Response:

{
  "data": [
    {
      "width": "111", 
      "height": "111", 
      "name": "Test Dimension"
    }
 ]
}

Curl Example

A curl example to get custom dimensions for an advertiser:

curl -G \
  -d 'access_token=<ACCESS_TOKEN>' \
https://graph.facebook.com/<API_VERSION>/<ADVERTISER_ID>/atlascustomdimensions

Create Atlas CustomDimensions

Permissions

A user access token with Atlas API capability is required to create custom dimension details.

Fields

Publishing this endpoint returns a single or an array of CustomDimension objects.

Create Advertiser CustomDimensions

You can create custom dimensions for an advertiser by making an HTTP POST request.

An example of the request and response:

Request:

https://graph.facebook.com/<API_VERSION>/<ADVERTISER_ID>atlascustomdimensions?custom_dimensions=[{"width" : "111", "height" : "111" , "name" : "Test Dimension" }]

Response:

{
  "data": [
    {
      "custom_dimension": {
        "width": "111", 
        "height": "111", 
        "name": "TestDimension"
      }
    }
  ]
}

Curl Example

A curl example to create custom dimension for an advertiser:


curl \ -F 'custom_dimensions=[{"width" : "111", "height" : "111" , "name" : "Test Dimension' \ -F 'access_token=<ACCESS_TOKEN>' \ https://graph.facebook.com/<API_VERSION>/<ADVERTISER_ID>atlascustomdimensions