Product Catalog Assigned Users

Reading

ProductCatalogAssignedUsers

Permissions

ads_management
catalog_management

Example

 GET /v20.0/{product-catalog-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(
    '/{product-catalog-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(
    "/{product-catalog-id}/assigned_users",
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);

 /* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "/{product-catalog-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:@"/{product-catalog-id}/assigned_users"
                                      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

Parameter	Description
`business` numeric string	The business associated with this catalog Required

Fields

Reading from this edge will return a JSON formatted result:

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

`data`

A list of AssignedUser nodes.

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 Default

`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 ).

Field	Description
`total_count` unsigned int32	Total number of business and system users assigned to this catalog

Error Codes

Error	Description
100	Invalid parameter
368	The action attempted has been deemed abusive or is otherwise disallowed

Creating

You can make a POST request to assigned_users edge from the following paths:

/{product_catalog_id}/assigned_users

When posting to this edge, a ProductCatalog will be created.

Permissions

catalog_management

Parameters

Parameter	Description
`tasks` array<enum {MANAGE, ADVERTISE, MANAGE_AR, AA_ANALYZE}>	Catalog permission tasks to assign this user Required
`user` UID	Business user id or system user id Required

Return Type

This endpoint supports read-after-write and will read the node to which you POSTed.

Struct {

success : bool,

}

Error Codes

Error	Description
100	Invalid parameter
415	Two factor authentication required. User have to enter a code from SMS or TOTP code generator to pass 2fac. This could happen when accessing a 2fac-protected asset like a page that is owned by a 2fac-protected business manager.

Updating

You can't perform this operation on this endpoint.

Deleting

You can dissociate a ProductCatalog from a ProductCatalog by making a DELETE request to /{product_catalog_id}/assigned_users .

Parameters

Parameter	Description
`user` UID	Business user id or system user id Required

Return Type

Struct {

success : bool,

}

Error Codes

Error	Description
200	Permissions error
415	Two factor authentication required. User have to enter a code from SMS or TOTP code generator to pass 2fac. This could happen when accessing a 2fac-protected asset like a page that is owned by a 2fac-protected business manager.
100	Invalid parameter