Version

Ad Account Adrules Library

Updated: Apr 2, 2024

Reading

AdAccountAdRulesLibrary

Example

Select language

GET /v25.0/{ad-account-id}/adrules_library HTTP/1.1
Host: graph.facebook.com

Try it in Graph API Explorer

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 Code	Description
200	Permissions error
100	Invalid parameter
190	Invalid OAuth 2.0 Access Token
80004	There have been too many calls to this ad-account. Wait a bit and try again. For more info, please refer to /docs/graph-api/overview/rate-limiting#ads-management.

Creating

/act_{ad_account_id}/adrules_library

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 Show child parameters `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} Show child parameters Show child parameters
`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 `is_once_off` boolean `execution_options` list<Object> `field` string required `value` numeric, string, boolean, list<>, or object-like arrays required `operator` enum{EQUAL, IN} required Show child parameters Show child parameters
`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> Show child parameters Show child parameters
`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 Code	Description
200	Permissions error
100	Invalid parameter
368	The action attempted has been deemed abusive or is otherwise disallowed
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

Updating

You can't perform this operation on this endpoint.

Deleting

You can't perform this operation on this endpoint.

Did you find this page helpful?