圖形 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.

Error Codes

錯誤	說明
100	Invalid parameter
200	Permissions error

建立中

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

/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}	必填
`is_once_off` boolean
`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

更新中

你可以向 /{ad_rule_id} 提出發佈要求，以更新 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}	必填
`is_once_off` boolean
`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,

}

Error Codes

錯誤	說明
200	Permissions error
2703	Rules that turn off ads can't have cost conditions. You need to change the rule's conditions or action.
100	Invalid parameter
190	Invalid OAuth 2.0 Access Token

刪除中

你可以向 /{ad_rule_id} 提出刪除要求，以刪除 an AdRule 。

參數

這個端點沒有任何參數。

傳回類型

Struct {

success: bool,

}

Error Codes

錯誤	說明
200	Permissions error
368	The action attempted has been deemed abusive or is otherwise disallowed
100	Invalid parameter