Версия API Graph

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.

Error Codes

Ошибка	Описание
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

Создание

Вы можете сделать запрос POST к границе adrules_library из этих местоположений:

/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,

}

Error Codes

Ошибка	Описание
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

Обновление

Чтобы обновить an AdRule, отправьте запрос POST на адрес /{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, 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

Тип возврата

Эта конечная точка поддерживает чтение после записи и будет считывать узел, в который вы сделали публикацию.

Struct {

success: bool,

}

Error Codes

Ошибка	Описание
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

Удаление

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

Параметры

Эта конечная точка не содержит параметров.

Тип возврата

Struct {

success: bool,

}

Error Codes

Ошибка	Описание
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.