Marketing API Version

Placements

Provides operations to create, read, update and delete Placements.

Read Placements

Permissions

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

Fields

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

Read Placement

You can get details of placements by making an HTTP GET request.

An example of the request and response:

Request:

https://graph.facebook.com/<API_VERSION>/<PLACEMENT_ID>

Response:

{
  "alias": "", 
  "campaign_id": "11002200631200", 
  "created_date": "2014-09-04T17:12:32+0000", 
  "flight_dates": {
    "begin_date": "2014-09-04T00:00:00-0400", 
    "end_date": "2014-10-03T23:59:59-0400", 
    "time_zone": "America/New_York"
  }, 
  "height": "600", 
  "id": "11002200632400", 
  "is_coppa_sensitive": false, 
  "last_modified_date": "2014-09-09T17:33:31+0000", 
  "name": "TestPlacement", 
  "publisher_id": "11002200632400", 
  "site_id": "11002200633000", 
  "type": "display", 
  "url": "", 
  "version": "2", 
  "width": "300"
}

Curl Example

A curl example to get placement details:

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

Read Campaign Placement

You can get details of placements associated with a campaign by making an HTTP GET request.

An example of the request and response:

Request:

https://graph.facebook.com/v2.0/<CAMPAIGN_ID>/placements

Response:

{
  "data": [
    {
      "alias": "", 
      "campaign_id": "11002200631200", 
      "created_date": "2014-09-04T17:12:32+0000", 
      "flight_dates": {
        "begin_date": "2014-09-04T00:00:00-0400", 
        "end_date": "2014-10-03T23:59:59-0400", 
        "time_zone": "America/New_York"
      }, 
      "height": "600", 
      "id": "11002200632400", 
      "is_coppa_sensitive": false, 
      "last_modified_date": "2014-09-09T17:33:31+0000", 
      "name": "TestPlacement", 
      "publisher_id": "11002200632400", 
      "site_id": "11002200633000", 
      "type": "display", 
      "url": "", 
      "version": "2", 
      "width": "300"
    }
  ]
}

Curl Example

A curl example to get details of placements associated with a campaign:

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

Create AtlasCampaign Placements

Permissions

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

Fields

Publishing this endpoint returns a single or an array of [Placement] (/docs/atlas-api/reference/objects/placement) objects.

Create Campaign Placement

You can create placements for a campaign by making an HTTP POST request. It will update the placement if it already exists.

An example of the request and response:

Request:

https://graph.facebook.com/<API_VERSION>/<CAMPAIGN_ID>/placements?placements=[{"site_id":"11002200633000","name":"TestPlacement","height":123,"width":234,"url":"http://www.facebook.com"}]

Response:

{
  "data": [
    {
      "id": "11002200632400", 
      "success": true
    }
  ]
}

Curl Example

A curl example to create placements for a campaign:


curl \ -F 'placements=[{"site_id":"11002200633000","name":"TestPlacement","height":123,"width":234,"url":"http://www.facebook.com"}]' \ -F 'access_token=<ACCESS_TOKEN>' \ https://graph.facebook.com/v2.0/<CAMPAIGN_ID>/atlasplacements

Delete Atlas Placements

Permissions

A user access token with Atlas API capability is required to delete placements.

Delete Placement

You can delete placements by making an HTTP DELETE request.

An example of the request and response:

Request:

https://graph.facebook.com/<API_VERSION>/<PLACEMENT_ID>

Response:

{
  "data": [
    {
      "placement": {
        "id": "11002200632400", 
        "created_by": "1444052100", 
        "created_date": "2014-09-11T12:59:31-07:00", 
        "last_modified_by": "1444052100", 
        "last_modified_date": "2014-09-11T12:59:31-07:00", 
        "is_deleted": false, 
        "version": "1", 
        "name": "TestPlacement", 
        "height": "123", 
        "width": "234", 
        "url": "http://www.facebook.com", 
        "alias": "", 
        "site_id": "11002200633000", 
        "campaign_id": "11002200631200", 
        "is_coppa_sensitive": false, 
        "type": "tracking", 
        "flight_dates": {
          "time_zone": "America/New_York"
        }, 
        "publisher_id": "11002200632400"
      }
    }
  ]
}

Curl Example

A curl example to delete placement:

curl -XDELETE \
  -F 'access_token=<ACCESS_TOKEN>' \
https://graph.facebook.com/<API_VERSION>/<PLACEMENT_ID>

Connections or Related Endpoints of AtlasPlacements (Edges)

NameDescription

/placement_ad_sets

Atlas assignments associated with the placement

/placement_ads

Placement ads associated with the placement

/atlasplacementadoverridess

PlacementAd Override represents association between an ad, adset and placement