Graph API Version

Ad Account Adrules Library

Reading

AdAccountAdRulesLibrary

Example

GET /v21.0/{ad-account-id}/adrules_library 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}/adrules_library',
    '{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}/adrules_library",
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);

/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "/{ad-account-id}/adrules_library",
    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}/adrules_library"
                                      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": {}
}

`data`

A list of AdRule nodes.

`paging`

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

Error Codes

Error	Description
100	Invalid parameter
190	Invalid OAuth 2.0 Access Token
200	Permissions error

Creating

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

/act_{ad_account_id}/adrules_library

When posting to this edge, an AdRule will be created.

Parameters

Parameter	Description
`account_id` numeric string	Ad Account ID. This is inferred from the path.
`evaluation_spec` Object	Defines the evaluation spec upon which a rule will be executed Required
`evaluation_type` enum{SCHEDULE, TRIGGER}	Required
`filters` list<Object>	Required
`field` string	Required
`value` numeric, string, boolean, list<>, or object-like arrays	Required
`operator` enum{GREATER_THAN, LESS_THAN, EQUAL, NOT_EQUAL, IN_RANGE, NOT_IN_RANGE, IN, NOT_IN, CONTAIN, NOT_CONTAIN, ANY, ALL, NONE}	Required
`trigger` Object
`type` enum{METADATA_CREATION, METADATA_UPDATE, STATS_MILESTONE, STATS_CHANGE, DELIVERY_INSIGHTS_CHANGE}	Required
`field` string
`value` numeric, string, boolean, list<>, or object-like arrays
`operator` enum{GREATER_THAN, LESS_THAN, EQUAL, NOT_EQUAL, IN_RANGE, NOT_IN_RANGE, IN, NOT_IN, CONTAIN, NOT_CONTAIN, ANY, ALL, NONE}
`execution_spec` Object	Defines the execution spec upon which a rule will be executed Required
`execution_type` enum{DCO, PING_ENDPOINT, NOTIFICATION, PAUSE, REBALANCE_BUDGET, CHANGE_BUDGET, CHANGE_BID, ROTATE, UNPAUSE, CHANGE_CAMPAIGN_BUDGET, ADD_INTEREST_RELAXATION, ADD_QUESTIONNAIRE_INTERESTS, INCREASE_RADIUS, UPDATE_CREATIVE, UPDATE_LAX_BUDGET, UPDATE_LAX_DURATION, AUDIENCE_CONSOLIDATION, AUDIENCE_CONSOLIDATION_ASK_FIRST, AD_RECOMMENDATION_APPLY}	Required
`execution_options` list<Object>
`field` string	Required
`value` numeric, string, boolean, list<>, or object-like arrays	Required
`operator` enum{EQUAL, IN}	Required
`name` string	The friendly name of a rule, optional for inline rules Required
`schedule_spec` Object	Specifies the schedule with which a rule will be evaluated
`schedule_type` enum{DAILY, HOURLY, SEMI_HOURLY, CUSTOM}	Required
`schedule` list<Object>
`start_minute` int64
`end_minute` int64
`days` list<int64>
`status` enum {ENABLED, DISABLED, DELETED, HAS_ISSUES}	The status of a rule

Return Type

This endpoint supports read-after-write and will read the node represented by id in the return type.

Struct {

id: numeric string,

}

Error Codes

Error	Description
200	Permissions error
100	Invalid parameter
2703	Rules that turn off ads can't have cost conditions. You need to change the rule's conditions or action.
190	Invalid OAuth 2.0 Access Token
368	The action attempted has been deemed abusive or is otherwise disallowed

Updating

You can't perform this operation on this endpoint.

Deleting

You can't perform this operation on this endpoint.