图谱 API 版

Ad Rule

读取

A Rule that will be triggered based on certain criteria defined on ad objects, and perform custom actions.

参数

这个端点不包含任何参数。

字段

字段	描述
`id` numeric string	ID of the rule 默认
`account_id` numeric string	ID of the ad account that owns the rule
`created_by` User	The user who created the rule
`created_time` datetime	Time when the rule was created
`disable_error_code` int32	error_code explaining why this rule is disabled with issues
`name` string	The friendly name of a rule, optional for inline rules
`schedule_spec` AdRuleScheduleSpec	Specifies the schedule with which a rule will be evaluated
`status` string	The status of a rule
`updated_time` datetime	The time when the rule was last updated.

连线

连线描述

连线	描述
`history` Edge<AdRuleHistory>	The execution history associated with this rule. Each entry represents a distinct run of the rule and provides any actions that may have been taken on any ad objects.

history

Edge<AdRuleHistory>

The execution history associated with this rule. Each entry represents a distinct run of the rule and provides any actions that may have been taken on any ad objects.

错误代码

错误	描述
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

创建

你可以通过下列路径向 adrules_library 连线发出 POST 请求：

/act_{ad_account_id}/adrules_library

发布到这个连线会创建 an AdRule 。

参数

参数	描述
`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 必填
`evaluation_type` enum{SCHEDULE, TRIGGER}	必填
`filters` list<Object>	必填
`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}	必填
`trigger` Object
`type` enum{METADATA_CREATION, METADATA_UPDATE, STATS_MILESTONE, STATS_CHANGE, DELIVERY_INSIGHTS_CHANGE}	必填
`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 必填
`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}	必填
`execution_options` list<Object>
`field` string	必填
`value` numeric, string, boolean, list<>, or object-like arrays	必填
`operator` enum{EQUAL, IN}	必填
`name` string	The friendly name of a rule, optional for inline rules 必填
`schedule_spec` Object	Specifies the schedule with which a rule will be evaluated
`schedule_type` enum{DAILY, HOURLY, SEMI_HOURLY, CUSTOM}	必填
`schedule` list<Object>
`start_minute` int64
`end_minute` int64
`days` list<int64>
`status` enum {ENABLED, DISABLED, DELETED, HAS_ISSUES}	The status of a rule

返回类型

这个端点支持先写后读，并会读取返回类型中 id 代表的节点。

Struct {

id: numeric string,

}

错误代码

错误	描述
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

更新

你可以向 /{ad_rule_id} 发出 POST 请求，以更新 an AdRule 。

参数

参数	描述
`evaluation_spec` Object	Defines the evaluation spec upon which a rule will be executed
`evaluation_type` enum{SCHEDULE, TRIGGER}	必填
`filters` list<Object>	必填
`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}	必填
`trigger` Object
`type` enum{METADATA_CREATION, METADATA_UPDATE, STATS_MILESTONE, STATS_CHANGE, DELIVERY_INSIGHTS_CHANGE}	必填
`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
`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}	必填
`execution_options` list<Object>
`field` string	必填
`value` numeric, string, boolean, list<>, or object-like arrays	必填
`operator` enum{EQUAL, IN}	必填
`name` string	The friendly name of a rule, optional for inline rules
`schedule_spec` Object	Specifies the schedule with which a rule will be evaluated
`schedule_type` enum{DAILY, HOURLY, SEMI_HOURLY, CUSTOM}	必填
`schedule` list<Object>
`start_minute` int64
`end_minute` int64
`days` list<int64>
`status` enum {ENABLED, DISABLED, DELETED, HAS_ISSUES}	The status of a rule

返回类型

这个端点支持先写后读，并会读取接收你的 POST 请求的节点。

Struct {

success: bool,

}

错误代码

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

删除

你可以向 /{ad_rule_id} 发出“删除”请求来删除 an AdRule 。

参数

这个端点不包含任何参数。

返回类型

Struct {

success: bool,

}

错误代码

错误	描述
368	The action attempted has been deemed abusive or is otherwise disallowed
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 https://developers.facebook.com/docs/graph-api/overview/rate-limiting#ads-management.