Versione API Graph

Ad Rule

Lettura

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

Parametri

Questo endpoint non dispone di parametri.

Campi

Campo	Descrizione
`id` numeric string	ID of the rule Standard
`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.

Segmenti

Segmento Descrizione

Segmento	Descrizione
`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

Errore	Descrizione
100	Invalid parameter
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

Creazione

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

/act_{ad_account_id}/adrules_library

When posting to this edge, an AdRule will be created.

Parametri

Parametro	Descrizione
`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 Obbligatorio
`evaluation_type` enum{SCHEDULE, TRIGGER}	Obbligatorio
`filters` list<Object>	Obbligatorio
`field` string	Obbligatorio
`value` numeric, string, boolean, list<>, or object-like arrays	Obbligatorio
`operator` enum{GREATER_THAN, LESS_THAN, EQUAL, NOT_EQUAL, IN_RANGE, NOT_IN_RANGE, IN, NOT_IN, CONTAIN, NOT_CONTAIN, ANY, ALL, NONE}	Obbligatorio
`trigger` Object
`type` enum{METADATA_CREATION, METADATA_UPDATE, STATS_MILESTONE, STATS_CHANGE, DELIVERY_INSIGHTS_CHANGE}	Obbligatorio
`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 Obbligatorio
`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}	Obbligatorio
`execution_options` list<Object>
`field` string	Obbligatorio
`value` numeric, string, boolean, list<>, or object-like arrays	Obbligatorio
`operator` enum{EQUAL, IN}	Obbligatorio
`name` string	The friendly name of a rule, optional for inline rules Obbligatorio
`schedule_spec` Object	Specifies the schedule with which a rule will be evaluated
`schedule_type` enum{DAILY, HOURLY, SEMI_HOURLY, CUSTOM}	Obbligatorio
`schedule` list<Object>
`start_minute` int64
`end_minute` int64
`days` list<int64>
`status` enum {ENABLED, DISABLED, DELETED, HAS_ISSUES}	The status of a rule

Tipo di ricavo

This endpoint supports read-after-write and will read the node represented by id in the return type.

Struct {

id: numeric string,

}

Error Codes

Errore	Descrizione
200	Permissions error
100	Invalid parameter
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

Aggiornamento

Puoi aggiornare an AdRule effettuando una richiesta POST a /{ad_rule_id}.

Parametri

Parametro	Descrizione
`evaluation_spec` Object	Defines the evaluation spec upon which a rule will be executed
`evaluation_type` enum{SCHEDULE, TRIGGER}	Obbligatorio
`filters` list<Object>	Obbligatorio
`field` string	Obbligatorio
`value` numeric, string, boolean, list<>, or object-like arrays	Obbligatorio
`operator` enum{GREATER_THAN, LESS_THAN, EQUAL, NOT_EQUAL, IN_RANGE, NOT_IN_RANGE, IN, NOT_IN, CONTAIN, NOT_CONTAIN, ANY, ALL, NONE}	Obbligatorio
`trigger` Object
`type` enum{METADATA_CREATION, METADATA_UPDATE, STATS_MILESTONE, STATS_CHANGE, DELIVERY_INSIGHTS_CHANGE}	Obbligatorio
`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}	Obbligatorio
`execution_options` list<Object>
`field` string	Obbligatorio
`value` numeric, string, boolean, list<>, or object-like arrays	Obbligatorio
`operator` enum{EQUAL, IN}	Obbligatorio
`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}	Obbligatorio
`schedule` list<Object>
`start_minute` int64
`end_minute` int64
`days` list<int64>
`status` enum {ENABLED, DISABLED, DELETED, HAS_ISSUES}	The status of a rule

Tipo di ricavo

Questo endopoint supporta read-after-write e leggerà il nodo in cui hai effettuato una richiesta POST.

Struct {

success: bool,

}

Error Codes

Errore	Descrizione
200	Permissions error
368	The action attempted has been deemed abusive or is otherwise disallowed
100	Invalid parameter
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

Eliminazione

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

Parametri

Questo endpoint non dispone di parametri.

Tipo di ricavo

Struct {

success: bool,

}

Error Codes

Errore	Descrizione
200	Permissions error
368	The action attempted has been deemed abusive or is otherwise disallowed
190	Invalid OAuth 2.0 Access Token
100	Invalid parameter