Graph API Version

CPASAdvertiser Partnership Recommendation

Reading

Returns a recommendation of a single retailer for a specific brand. This endpoint returns a retailer-brand pair and an advertiser who can advertise on behalf of the producer.

This endpoint is mainly for Facebook’s Marketing Partners using Collaborative Ads.

Example

Graph API Explorer
GET /v10.0/{cpas-advertiser-partnership-recommendation-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(
    '/{cpas-advertiser-partnership-recommendation-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(
    "/{cpas-advertiser-partnership-recommendation-id}",
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);
/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "/{cpas-advertiser-partnership-recommendation-id}",
    null,
    HttpMethod.GET,
    new GraphRequest.Callback() {
        public void onCompleted(GraphResponse response) {
            /* handle the result */
        }
    }
).executeAsync();
/* make the API call */
FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
                               initWithGraphPath:@"/{cpas-advertiser-partnership-recommendation-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 the recommendation object.

advertiser_business_id
numeric string

Recommended advertiser for this partnership.

brand_business_id
numeric string

Recommended brand for this partnership.

brands
list<string>

Brands that can be advertised for in this partnership.

countries
list<string>

Countries in which the partnership could run ads.

merchant_business_id
numeric string

Recommended retailer for this partnership.

merchant_categories
list<string>

Categories associated with the retailer's products.

status
enum

Current status of this recommendation based on actions taken on it.

status_reason
enum

Reason why this recommendation has its current status.

Error Codes

ErrorDescription
100Invalid parameter

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.