グラフ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

このエッジにPOSTする場合、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

戻り値の型

This endpoint supports read-after-write and will read the node to which you POSTed.

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

削除中です

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

パラメーター

このエンドポイントにはパラメーターがありません。

戻り値の型

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.