‏API التسويق‏
إصدار ‏‎Graph 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

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.

‎Error Codes‎

خطأالوصف
100Invalid parameter
80004There 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.
200Permissions error

إنشاء

‎You can make a POST request to adrules_library edge from the following paths: ‎
‎When posting to this edge, an AdRule will be created.‎

المعلمات

معلمةالوصف
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}

مطلوب
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

‎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‎

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

جارٍ التحديث

‎You can update an AdRule by making a POST request to /{ad_rule_id}.‎

المعلمات

معلمةالوصف
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}

مطلوب
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

‎Return Type‎

‎This endpoint supports ‎read-after-write‎ and will read the node to which you POSTed.‎
Struct {
success: bool,
}

‎Error Codes‎

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

جارٍ الحذف

‎You can delete an AdRule by making a DELETE request to /{ad_rule_id}.‎

المعلمات

لا تحتوي نقطة النهاية هذه على أي معلمات.

‎Return Type‎

Struct {
success: bool,
}

‎Error Codes‎

خطأالوصف
200Permissions error
368The action attempted has been deemed abusive or is otherwise disallowed
190Invalid OAuth 2.0 Access Token
100Invalid parameter