Graph API Version

Business Unit

Reading

Represents a group of certain types of Business objects in a Business. Will be used by Measurement Hub initially with more usage coming later on.

Example

Graph API Explorer
GET /v5.0/{business-unit-id} HTTP/1.1
Host: graph.facebook.com
/* PHP SDK v5.0.0 */
/* make the API call */
try {
  // Returns a `Facebook\FacebookResponse` object
  $response = $fb->get(
    '/{business-unit-id}',
    '{access-token}'
  );
} catch(Facebook\Exceptions\FacebookResponseException $e) {
  echo 'Graph returned an error: ' . $e->getMessage();
  exit;
} catch(Facebook\Exceptions\FacebookSDKException $e) {
  echo 'Facebook SDK returned an error: ' . $e->getMessage();
  exit;
}
$graphNode = $response->getGraphNode();
/* handle the result */
/* make the API call */
FB.api(
    "/{business-unit-id}",
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);
/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "/{business-unit-id}",
    null,
    HttpMethod.GET,
    new GraphRequest.Callback() {
        public void onCompleted(GraphResponse response) {
            /* handle the result */
        }
    }
).executeAsync();
// For more complex open graph stories, use `FBSDKShareAPI`
// with `FBSDKShareOpenGraphContent`
/* make the API call */
FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
                               initWithGraphPath:@"/{business-unit-id}"
                                      parameters:params
                                      HTTPMethod:@"GET"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection,
                                      id result,
                                      NSError *error) {
    // Handle the result
}];
If you want to learn how to use the Graph API, read our Using Graph API guide.

Parameters

This endpoint doesn't have any parameters.

Fields

FieldDescription
id
numeric string

Id of business unit.

business

The owner business of this business unit.

creation_time
datetime

The creation time of this business unit.

currency
string

Default currency

excluded_sources
AtlasBlacklistedSources

The blacklisted sources for the business unit

is_enabled_for_measurement
bool

is_enabled_for_measurement

name
string

The name of business unit.

time_zone
string

The default time zone for the business unit

visits_available_date
int32

visits_available_date

Edges

EdgeDescription

The ad account assigned to this business unit.

Ad platforms being tracked in Atlas for the business unit.

List of sales access requests with status

The measurement campaigns associated with the business unit

The measurement FB conversion events associated with the business unit

The conversion paths for the business unit

The dimension groups associated with the business unit

The diagnostics associated with the business unit.

Import file with the advertiser

Publishers associated with the advertiser

Users who are permitted to use this business unit.

Validation Rules

ErrorDescription
100Invalid parameter
270This Ads API request is not allowed for apps with development access level (Development access is by default for all apps, please request for upgrade). Make sure that the access token belongs to a user that is both admin of the app and admin of the ad account
200Permissions error
278Reading advertisements requires an access token with the extended permission ads_read

Creating

You can't perform this operation on this endpoint.

Updating

You can't perform this operation on this endpoint.

Deleting

You can't perform this operation on this endpoint.