Ad Account, Assigned Users
Business and system users assigned to this Ad Account.
GET /v21.0/{ad-account-id}/assigned_users 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(
'/{ad-account-id}/assigned_users',
'{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(
"/{ad-account-id}/assigned_users",
function (response) {
if (response && !response.error) {
/* handle the result */
}
}
);
/* make the API call */
new GraphRequest(
AccessToken.getCurrentAccessToken(),
"/{ad-account-id}/assigned_users",
null,
HttpMethod.GET,
new GraphRequest.Callback() {
public void onCompleted(GraphResponse response) {
/* handle the result */
}
}
).executeAsync();
/* make the API call */
FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
initWithGraphPath:@"/{ad-account-id}/assigned_users"
parameters:params
HTTPMethod:@"GET"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection,
id result,
NSError *error) {
// Handle the result
}];
Parameter | Description |
---|---|
business numeric string or integer | The business associated with this Ad Account Required |
Reading from this edge will return a JSON formatted result:
{ "
data
": [], "paging
": {}, "summary
": {} }
data
The following fields will be added to each node that is returned:
Field | Description |
---|---|
permitted_tasks list<string> | Tasks that are assignable on this object |
tasks list<string> | All unpacked roles/tasks of this particular user on this object |
paging
summary
Aggregated information about the edge, such as counts. Specify the fields to fetch in the summary param (like summary=total_count
).
Field | Description |
---|---|
total_count unsigned int32 | Total number of business and system users assigned to this Ad Account |
Error | Description |
---|---|
100 | Invalid parameter |
190 | Invalid OAuth 2.0 Access Token |
368 | The action attempted has been deemed abusive or is otherwise disallowed |
80004 | There have been too many calls to this ad-account. Wait a bit and try again. For more info, please refer to https://developers.facebook.com/docs/graph-api/overview/rate-limiting#ads-management. |
200 | Permissions error |
In v3.1 we introduce the new concept of task-based permissions to substitute for the current role-based permission. This affects access to ad accounts managed by Business Manager API and Pages. Role-based access to ad accounts and Pages is still available but will be deprecated in the future. This impacts the following roles and provides the equivalent tasks for ad accounts:
ADMIN
, Tasks: ['MANAGE', 'ADVERTISE', 'ANALYZE'
- Manage all aspects of ad campaigns, reporting, billing and ad account permissions.GENERAL_USER
, Tasks: ['ADVERTISE', 'ANALYZE']
- Create ads using the funding source associated with the ad account. Run reports.GENERAL_USER
, Tasks: ['ANALYZE']
- Run reports.This replaces the following roles in Business Manager API with these tasks:
MANAGER
, Tasks: ['MANAGE', 'CREATE_CONTENT', 'MODERATE', 'ADVERTISE', 'ANALYZE', 'DRAFT']
CONTENT_CREATOR
, Tasks: ['CREATE_CONTENT', 'MODERATE', 'ADVERTISE', 'ANALYZE', 'DRAFT']
MODERATOR
, Tasks: ['MODERATE', 'ADVERTISE', 'ANALYZE', 'DRAFT']
ADVERTISER
, Tasks: ['ADVERTISE', 'ANALYZE', 'DRAFT']
INSIGHTS_ANALYST
, Tasks: ['ANALYZE', 'DRAFT']
CREATIVE_HUB_MOCKUPS_MANAGER
, Tasks: ['DRAFT']
/act_{ad_account_id}/assigned_users
.Parameter | Description |
---|---|
tasks array<enum {MANAGE, ADVERTISE, ANALYZE, DRAFT, AA_ANALYZE}> | AdAccount permission tasks to assign this user |
user UID | Business user id or system user id Required |
success
: bool, Error | Description |
---|---|
100 | Invalid parameter |
200 | Permissions error |
2620 | Invalid call to update account permissions |
190 | Invalid OAuth 2.0 Access Token |
/act_{ad_account_id}/assigned_users
.Parameter | Description |
---|---|
user UID | Business user id or system user id Required |
success
: bool, Error | Description |
---|---|
3919 | There was an unexpected technical issue. Please try again. |
100 | Invalid parameter |
368 | The action attempted has been deemed abusive or is otherwise disallowed |