Graph API Version

Offline Conversion Data Set Agencies

Reading

Shows all partner businesses the offline event set is shared to

Example

Graph API Explorer
GET /v4.0/{offline-conversion-data-set-id}/agencies 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(
    '/{offline-conversion-data-set-id}/agencies',
    '{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(
    "/{offline-conversion-data-set-id}/agencies",
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);
/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "/{offline-conversion-data-set-id}/agencies",
    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:@"/{offline-conversion-data-set-id}/agencies"
                                      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

Reading from this edge will return a JSON formatted result:

{ "data": [], "paging": {}, "summary": {} }

data

A list of Business nodes.

The following fields will be added to each node that is returned:

FieldDescription
permitted_roles
list<string>

Roles that are assignable to users on this asset

paging

For more details about pagination, see the Graph API guide.

summary

Aggregated information about the edge, such as counts. Specify the fields to fetch in the summary param (like summary=total_count).

FieldDescription
total_count
int32

Total number of objects on this edge

Validation Rules

ErrorDescription
200Permissions error

Creating

You can make a POST request to agencies edge from the following paths:
When posting to this edge, a Business will be created.

Parameters

ParameterDescription
business
numeric string or integer

SELF_EXPLANATORY

Required
other_relationship
string

SELF_EXPLANATORY

permitted_roles
list<enum {ADMIN, UPLOADER, ADVERTISER}>

Permitted roles the agency can assign to users

relationship_type
array<enum {AD_MANAGER, AUDIENCE_MANAGER, AGENCY, OTHER}>

Relationship type for sharing

Return Type

This endpoint supports read-after-write and will read the node to which you POSTed.
Struct {
success: bool,
share_status: enum,
}

Validation Rules

ErrorDescription
100Invalid parameter

Updating

You can't perform this operation on this endpoint.

Deleting

You can't perform this operation on this endpoint.