Universal Campaigns API Reference¶
Note
If you use the APIs provided here, you are subject to the API Terms of Use, and Service Privacy Notice
Note
We’ve introduced API keys, please read Migrating to API Keys
Description¶
AdRoll Universal Campaigns API (v2) 2.0
Create and edit AdRoll strategies with the AdRoll Universal Campaigns API
List of Operations¶
Operations¶
-
GET
/activate/api/v2/adgroup
¶ Fetch adgroup
Parameters:
Query Parameters¶ Name
Required
Type
Description
eid
False
string
EID of requested adgroup
campaign_eid
False
string
Campaign EID of underlying adgroups
apikey
False
string
Required if using Personal Access Tokens (PAT). The value is the Client ID you received when you registered your application on the NextRoll Developer site
Responses:
- 200
A list of adgroups
Schema as JSON:
{ "data": [ { "ad_type": "string", "ads": [ { "eid": "string", "status": "string" } ], "campaign_eid": "string", "created_at": "string", "eid": "string", "end_date": "string", "fb_placements": [ "string" ], "kpi_goal": 0.0, "kpi_metric": "string", "li_audience_network_enabled": true, "name": "string", "objective": "convert", "start_date": "string", "status": "string", "targeting_features": { "negative_segment_eids": [ "string" ], "positive_segment_eids": [ "string" ] } } ] }
-
Schema
- Type
object
-
data
- Type
array of
AdGroupResponse
-
-
POST
/activate/api/v2/adgroup
¶ Create a new adgroup
Parameters:
Query Parameters¶ Name
Required
Type
Description
campaign_eid
True
string
EID of campaign to attach adgroup to
apikey
False
string
Required if using Personal Access Tokens (PAT). The value is the Client ID you received when you registered your application on the NextRoll Developer site
Schema for request body:
AdGroupCreate
{ "ad_type": "string", "ads": [ { "eid": "string", "status": "string" } ], "campaign_eid": "string", "created_at": "string", "eid": "string", "end_date": "string", "fb_placements": [ "string" ], "kpi_goal": 0.0, "kpi_metric": "string", "li_audience_network_enabled": true, "name": "string", "objective": "convert", "start_date": "string", "targeting_features": { "negative_segment_eids": [ "string" ], "positive_segment_eids": [ "string" ] } }
Responses:
- 200
The newly created adgroup
Schema as JSON:
{ "data": { "ad_type": "string", "ads": [ { "eid": "string", "status": "string" } ], "campaign_eid": "string", "created_at": "string", "eid": "string", "end_date": "string", "fb_placements": [ "string" ], "kpi_goal": 0.0, "kpi_metric": "string", "li_audience_network_enabled": true, "name": "string", "objective": "convert", "start_date": "string", "status": "string", "targeting_features": { "negative_segment_eids": [ "string" ], "positive_segment_eids": [ "string" ] } } }
-
Schema
- Type
object
-
data
- Type
-
-
PUT
/activate/api/v2/adgroup
¶ Edit an existing adgroup
Parameters:
Query Parameters¶ Name
Required
Type
Description
eid
True
string
EID of adgroup to edit
apikey
False
string
Required if using Personal Access Tokens (PAT). The value is the Client ID you received when you registered your application on the NextRoll Developer site
Schema for request body:
AdGroupEdit
{ "ads": [ { "eid": "string", "status": "string" } ], "campaign_eid": "string", "created_at": "string", "eid": "string", "end_date": "string", "fb_placements": [ "string" ], "kpi_goal": 0.0, "kpi_metric": "string", "li_audience_network_enabled": true, "name": "string", "objective": "convert", "start_date": "string", "status": "string", "targeting_features": { "negative_segment_eids": [ "string" ], "positive_segment_eids": [ "string" ] } }
Responses:
- 200
The edited adgroup
Schema as JSON:
{ "data": { "ad_type": "string", "ads": [ { "eid": "string", "status": "string" } ], "campaign_eid": "string", "created_at": "string", "eid": "string", "end_date": "string", "fb_placements": [ "string" ], "kpi_goal": 0.0, "kpi_metric": "string", "li_audience_network_enabled": true, "name": "string", "objective": "convert", "start_date": "string", "status": "string", "targeting_features": { "negative_segment_eids": [ "string" ], "positive_segment_eids": [ "string" ] } } }
-
Schema
- Type
object
-
data
- Type
-
-
PUT
/activate/api/v2/adgroup_ad
¶ Edit an adgroup ad
Parameters:
Query Parameters¶ Name
Required
Type
Description
adgroup_eid
True
string
EID of adgroup
ad_eid
True
string
EID of the ad to pause
apikey
False
string
Required if using Personal Access Tokens (PAT). The value is the Client ID you received when you registered your application on the NextRoll Developer site
Schema for request body:
AdgroupAd
{ "eid": "string", "status": "string" }
Responses:
- 200
The edited adgroup ad
Schema as JSON:
{ "data": { "eid": "string", "status": "string" } }
-
Schema
- Type
object
-
data
- Type
-
-
GET
/activate/api/v2/campaign
¶ Fetch campaign
Parameters:
Query Parameters¶ Name
Required
Type
Description
advertisable_eid
False
string
Advertisable EID of requested campaign
eid
False
string
EID of requested campaign
is_draft
False
boolean
Flag indicating whether to pull drafts. true: will return only draft(s). false: will return only non-draft(s). If left out, both draft and non-draft can be returned.
paginate
False
boolean
Flag indicating whether Campaigns will be paginated. If pagination is used, all drafts are returned with the first page of results.
cursor
False
string
Cursor used for paginating results.
apikey
False
string
Required if using Personal Access Tokens (PAT). The value is the Client ID you received when you registered your application on the NextRoll Developer site
Responses:
- 200
A list of Campaign objects
Schema as JSON:
{ "data": [ { "advertisable_eid": "string", "budget": 0.0, "budget_settings": { "budget_type": "string", "current_month_spend": 0.0, "goal": 0.0, "spend": 0.0 }, "created_at": "string", "currency": "string", "draft_eid": "string", "eid": "string", "end_date": "string", "has_special_ad_category": true, "is_draft": true, "name": "string", "objective": "convert", "start_date": "string", "status": "string" } ] }
-
Schema
- Type
object
-
data
- Type
array of
CampaignResponse
-
-
POST
/activate/api/v2/campaign
¶ Create a new campaign.
Parameters:
Query Parameters¶ Name
Required
Type
Description
advertisable_eid
True
string
Advertisable EID to create campaign under
apikey
False
string
Required if using Personal Access Tokens (PAT). The value is the Client ID you received when you registered your application on the NextRoll Developer site
Schema for request body:
CampaignCreate
{ "advertisable_eid": "string", "budget": 0.0, "budget_settings": { "budget_type": "string", "current_month_spend": 0.0, "goal": 0.0, "spend": 0.0 }, "created_at": "string", "currency": "string", "draft_eid": "string", "eid": "string", "has_special_ad_category": true, "is_draft": true, "name": "string", "objective": "convert" }
Responses:
- 200
The newly created campaign
Schema as JSON:
{ "data": { "advertisable_eid": "string", "budget": 0.0, "budget_settings": { "budget_type": "string", "current_month_spend": 0.0, "goal": 0.0, "spend": 0.0 }, "created_at": "string", "currency": "string", "draft_eid": "string", "eid": "string", "end_date": "string", "has_special_ad_category": true, "is_draft": true, "name": "string", "objective": "convert", "start_date": "string", "status": "string" } }
-
Schema
- Type
object
-
data
- Type
-
-
PUT
/activate/api/v2/campaign
¶ Edit an existing campaign.
Parameters:
Query Parameters¶ Name
Required
Type
Description
eid
True
string
Campaign EID
apikey
False
string
Required if using Personal Access Tokens (PAT). The value is the Client ID you received when you registered your application on the NextRoll Developer site
Schema for request body:
CampaignEdit
{ "advertisable_eid": "string", "budget": 0.0, "budget_settings": { "budget_type": "string", "current_month_spend": 0.0, "goal": 0.0, "spend": 0.0 }, "created_at": "string", "eid": "string", "has_special_ad_category": true, "is_draft": true, "name": "string", "objective": "convert", "status": "string" }
Responses:
- 200
The edited campaign
Schema as JSON:
{ "data": { "advertisable_eid": "string", "budget": 0.0, "budget_settings": { "budget_type": "string", "current_month_spend": 0.0, "goal": 0.0, "spend": 0.0 }, "created_at": "string", "currency": "string", "draft_eid": "string", "eid": "string", "end_date": "string", "has_special_ad_category": true, "is_draft": true, "name": "string", "objective": "convert", "start_date": "string", "status": "string" } }
-
Schema
- Type
object
-
data
- Type
-
-
GET
/activate/api/v2/playbooks
¶ Fetch a Playbook
Parameters:
Query Parameters¶ Name
Required
Type
Description
advertisable_eid
False
string
Advertisable EID of requested Playbook
eid
False
string
EID of requested Playbook
verbose
False
boolean
Include all details of each campaign in the Playbook(s)
is_draft
False
boolean
Flag indicating whether to pull drafts. true: will return only draft(s). false: will return only non-draft(s). If left out, both draft and non-draft can be returned.
paginate
False
boolean
Flag indicating whether Playbooks will be paginated. If pagination is used, all drafts are returned with the first page of results.
cursor
False
string
Cursor used for paginating results.
apikey
False
string
Required if using Personal Access Tokens (PAT). The value is the Client ID you received when you registered your application on the NextRoll Developer site
Responses:
- 200
A list of Playbook objects
Schema as JSON:
{ "data": [ { "advertisable_eid": "string", "audience_attributes": {}, "budget": { "budget_type": "string", "currency": "string", "current_month_spend": 0.0, "goal": 0.0, "is_prorated": true, "prorated_goal": 0.0, "spend": 0.0 }, "budget_balancing_automated": true, "bulk_campaigns": [ { "adgroups": [ { "ad_type": "string", "ads": [ { "added_on": "string", "eid": "string", "status": "string" } ], "adwizard_ticket_id": 0, "campaign_eid": "string", "created_at": "string", "eid": "string", "fb_placements": [ "string" ], "high_intent": true, "kpi_goal": 0.0, "kpi_metric": "string", "li_audience_network_enabled": true, "name": "string", "objective": "convert", "status": "string", "sync_strategy_name": true, "targeting_features": { "negative_segment_eids": [ "string" ], "positive_segment_eids": [ "string" ] } } ], "budget_settings": { "budget_type": "string", "current_month_spend": 0.0, "goal": 0.0, "is_prorated": true, "prorated_goal": 0.0, "spend": 0.0 }, "created_at": "string", "dayparting": {}, "domain_frequency_cap": 0.0, "domain_frequency_cap_enabled": true, "draft_eid": "string", "eid": "string", "has_special_ad_category": true, "is_draft": true, "name": "string", "objective": "convert", "rw_excluded_lead_type": "string", "rw_manage_domain_frequency_cap": true, "status": "string", "tactic_type": "string", "template": "universal", "use_case": "string", "user_frequency_cap": 0 } ], "campaigns": [ { "budget": 0.0, "eid": "string" } ], "effective_status": "string", "eid": "string", "end_date": "string", "general_exclusions": [ { "eid": "string", "general_exclusion_type": "string" } ], "name": "string", "playbook_type": "string", "start_date": "string", "status": "string", "tag_eid": "string", "tal_eid": "string" } ] }
-
Schema
- Type
object
-
data
- Type
array of
PlaybookResponseGeneric
-
-
POST
/activate/api/v2/playbooks
¶ Create a new Playbook.
Parameters:
Query Parameters¶ Name
Required
Type
Description
advertisable_eid
True
string
Advertisable EID to create Playbook under
apikey
False
string
Required if using Personal Access Tokens (PAT). The value is the Client ID you received when you registered your application on the NextRoll Developer site
Schema for request body:
PlaybookCreate
{ "advertisable_eid": "string", "audience_attributes": {}, "budget": { "budget_type": "string", "currency": "string", "current_month_spend": 0.0, "goal": 0.0, "is_prorated": true, "prorated_goal": 0.0, "spend": 0.0 }, "budget_balancing_automated": true, "bulk_campaigns": [ { "adgroups": [ { "ad_type": "string", "ads": [ { "added_on": "string", "eid": "string", "status": "string" } ], "adwizard_ticket_id": 0, "campaign_eid": "string", "created_at": "string", "eid": "string", "fb_placements": [ "string" ], "high_intent": true, "kpi_goal": 0.0, "kpi_metric": "string", "li_audience_network_enabled": true, "name": "string", "objective": "convert", "status": "string", "sync_strategy_name": true, "targeting_features": { "negative_segment_eids": [ "string" ], "positive_segment_eids": [ "string" ] } } ], "budget_settings": { "budget_type": "string", "current_month_spend": 0.0, "goal": 0.0, "is_prorated": true, "prorated_goal": 0.0, "spend": 0.0 }, "created_at": "string", "dayparting": {}, "domain_frequency_cap": 0.0, "domain_frequency_cap_enabled": true, "draft_eid": "string", "eid": "string", "has_special_ad_category": true, "is_draft": true, "name": "string", "objective": "convert", "rw_excluded_lead_type": "string", "rw_manage_domain_frequency_cap": true, "status": "string", "tactic_type": "string", "template": "universal", "use_case": "string", "user_frequency_cap": 0 } ], "campaigns": [ { "budget": 0.0, "eid": "string" } ], "effective_status": "string", "eid": "string", "end_date": "string", "general_exclusions": [ { "eid": "string", "general_exclusion_type": "string" } ], "name": "string", "playbook_type": "string", "start_date": "string", "status": "string", "tag_eid": "string", "tal_eid": "string" }
Responses:
- 200
The newly created Playbook
Schema as JSON:
{ "data": { "advertisable_eid": "string", "audience_attributes": {}, "budget": { "budget_type": "string", "currency": "string", "current_month_spend": 0.0, "goal": 0.0, "is_prorated": true, "prorated_goal": 0.0, "spend": 0.0 }, "budget_balancing_automated": true, "bulk_campaigns": [ { "adgroups": [ { "ad_type": "string", "ads": [ { "added_on": "string", "eid": "string", "status": "string" } ], "adwizard_ticket_id": 0, "campaign_eid": "string", "created_at": "string", "eid": "string", "fb_placements": [ "string" ], "high_intent": true, "kpi_goal": 0.0, "kpi_metric": "string", "li_audience_network_enabled": true, "name": "string", "objective": "convert", "status": "string", "sync_strategy_name": true, "targeting_features": { "negative_segment_eids": [ "string" ], "positive_segment_eids": [ "string" ] } } ], "budget_settings": { "budget_type": "string", "current_month_spend": 0.0, "goal": 0.0, "is_prorated": true, "prorated_goal": 0.0, "spend": 0.0 }, "created_at": "string", "dayparting": {}, "domain_frequency_cap": 0.0, "domain_frequency_cap_enabled": true, "draft_eid": "string", "eid": "string", "has_special_ad_category": true, "is_draft": true, "name": "string", "objective": "convert", "rw_excluded_lead_type": "string", "rw_manage_domain_frequency_cap": true, "status": "string", "tactic_type": "string", "template": "universal", "use_case": "string", "user_frequency_cap": 0 } ], "campaigns": [ { "budget": 0.0, "eid": "string" } ], "effective_status": "string", "eid": "string", "end_date": "string", "general_exclusions": [ { "eid": "string", "general_exclusion_type": "string" } ], "name": "string", "playbook_type": "string", "start_date": "string", "status": "string", "tag_eid": "string", "tal_eid": "string" } }
-
Schema
- Type
object
-
data
-
-
PUT
/activate/api/v2/playbooks
¶ Edit an existing Playbook.
Parameters:
Query Parameters¶ Name
Required
Type
Description
eid
True
string
Playbook EID
apikey
False
string
Required if using Personal Access Tokens (PAT). The value is the Client ID you received when you registered your application on the NextRoll Developer site
Schema for request body:
PlaybookEdit
{ "advertisable_eid": "string", "audience_attributes": {}, "budget": { "budget_type": "string", "currency": "string", "current_month_spend": 0.0, "goal": 0.0, "is_prorated": true, "prorated_goal": 0.0, "spend": 0.0 }, "budget_balancing_automated": true, "bulk_campaigns": [ { "adgroups": [ { "ad_type": "string", "ads": [ { "added_on": "string", "eid": "string", "status": "string" } ], "adwizard_ticket_id": 0, "campaign_eid": "string", "created_at": "string", "eid": "string", "fb_placements": [ "string" ], "high_intent": true, "kpi_goal": 0.0, "kpi_metric": "string", "li_audience_network_enabled": true, "name": "string", "objective": "convert", "status": "string", "sync_strategy_name": true, "targeting_features": { "negative_segment_eids": [ "string" ], "positive_segment_eids": [ "string" ] } } ], "budget_settings": { "budget_type": "string", "current_month_spend": 0.0, "goal": 0.0, "is_prorated": true, "prorated_goal": 0.0, "spend": 0.0 }, "created_at": "string", "dayparting": {}, "domain_frequency_cap": 0.0, "domain_frequency_cap_enabled": true, "draft_eid": "string", "eid": "string", "has_special_ad_category": true, "is_draft": true, "name": "string", "objective": "convert", "rw_excluded_lead_type": "string", "rw_manage_domain_frequency_cap": true, "status": "string", "tactic_type": "string", "template": "universal", "use_case": "string", "user_frequency_cap": 0 } ], "campaigns": [ { "budget": 0.0, "eid": "string" } ], "effective_status": "string", "eid": "string", "end_date": "string", "general_exclusions": [ { "eid": "string", "general_exclusion_type": "string" } ], "name": "string", "start_date": "string", "status": "string", "tag_eid": "string", "tal_eid": "string" }
Responses:
- 200
The edited Playbook
Schema as JSON:
{ "data": { "advertisable_eid": "string", "audience_attributes": {}, "budget": { "budget_type": "string", "currency": "string", "current_month_spend": 0.0, "goal": 0.0, "is_prorated": true, "prorated_goal": 0.0, "spend": 0.0 }, "budget_balancing_automated": true, "bulk_campaigns": [ { "adgroups": [ { "ad_type": "string", "ads": [ { "added_on": "string", "eid": "string", "status": "string" } ], "adwizard_ticket_id": 0, "campaign_eid": "string", "created_at": "string", "eid": "string", "fb_placements": [ "string" ], "high_intent": true, "kpi_goal": 0.0, "kpi_metric": "string", "li_audience_network_enabled": true, "name": "string", "objective": "convert", "status": "string", "sync_strategy_name": true, "targeting_features": { "negative_segment_eids": [ "string" ], "positive_segment_eids": [ "string" ] } } ], "budget_settings": { "budget_type": "string", "current_month_spend": 0.0, "goal": 0.0, "is_prorated": true, "prorated_goal": 0.0, "spend": 0.0 }, "created_at": "string", "dayparting": {}, "domain_frequency_cap": 0.0, "domain_frequency_cap_enabled": true, "draft_eid": "string", "eid": "string", "has_special_ad_category": true, "is_draft": true, "name": "string", "objective": "convert", "rw_excluded_lead_type": "string", "rw_manage_domain_frequency_cap": true, "status": "string", "tactic_type": "string", "template": "universal", "use_case": "string", "user_frequency_cap": 0 } ], "campaigns": [ { "budget": 0.0, "eid": "string" } ], "effective_status": "string", "eid": "string", "end_date": "string", "general_exclusions": [ { "eid": "string", "general_exclusion_type": "string" } ], "name": "string", "playbook_type": "string", "start_date": "string", "status": "string", "tag_eid": "string", "tal_eid": "string" } }
-
Schema
- Type
object
-
data
-
-
GET
/activate/api/v2/playbooks/simple
¶ Fetch playbooks with only simple data response
Parameters:
Query Parameters¶ Name
Required
Type
Description
advertisable_eid
True
string
Advertisable EID of requested Playbook
eid
False
string
EID of requested Playbook
apikey
False
string
Required if using Personal Access Tokens (PAT). The value is the Client ID you received when you registered your application on the NextRoll Developer site
Responses:
- 200
A list of Playbook objects
Schema as JSON:
{ "data": [ { "audience_attributes": {}, "effective_status": "string", "eid": "string", "end_date": "string", "general_exclusions": [ { "eid": "string", "general_exclusion_type": "string" } ], "name": "string", "playbook_type": "string", "start_date": "string", "status": "string", "tag_eid": "string", "tal_eid": "string" } ] }
-
Schema
- Type
object
-
data
- Type
array of
PlaybookResponseSimple
-
Definitions¶
-
BudgetSettings
¶ - Type
object
-
spend
Amount spent by this campaign till now, if a lifetime or monthly budget is used.
- Type
number
-
current_month_spend
Amount spent by this Campaign this month, if a monthly budget is used
- Type
number
-
goal
Budget of campaign in the currency specified by the currency field.
- Required
True
- Type
number
-
budget_type
Type of budget
- Required
True
- Type
string
- Enum
daily
,monthly
,lifetime
-
AdgroupAd
¶ - Type
object
-
eid
Ad eid.
- Required
True
- Type
string
-
status
Adgroup ad status
- Required
True
- Type
string
- Enum
live
,paused
,deleted
-
AdgroupTargeting
¶ - Type
object
-
positive_segment_eids
List of segment EIDs being positively targeted by this adgroup.
- Type
array of items
-
negative_segment_eids
List of segment EIDs being negatively targeted by this adgroup.
- Type
array of items
-
AdGroupResponse
¶ - Type
object
-
ads
- Type
array of
AdgroupAd
-
created_at
Datetime of adgroup creation in ISO-8601 in UTC.
- Type
string
- Format
date-time
-
kpi_metric
Metric used to measure KPI.
- Type
string
- Enum
CPA
,CPC
,CPM
-
status
Status of adgroup
- Type
string
- Enum
live
,paused
,deleted
-
ad_type
The type of ads supported by this adgroup. The ad_eids passed in should be of this type.
- Required
True
- Type
string
- Enum
dynamic
,static
-
campaign_eid
EID of campaign this adgroup is in.
- Type
string
- MaxLength
22
- MinLength
22
-
eid
EID of adgroup.
- Type
string
- MaxLength
22
- MinLength
22
-
objective
AdGroup-level objective: attract_lookalike, attract_attribute, convert, rw_linkedin, rw_account_targeting, rw_retargeting. Defaults to convert.
- Type
string
- Default
convert
- Enum
attract_lookalike
,attract_attribute
,convert
,rw_linkedin
,rw_account_targeting
,rw_retargeting
-
name
Name of adgroup.
- Type
string
-
kpi_goal
Value of KPI goal for specified KPI metric (in currency specified by campaign’s
currency
parameter).This must be number greater than 0 or NULL to set an automatic goal.- Type
number
-
targeting_features
- Type
-
li_audience_network_enabled
True if the LinkedIn Audience Network should be enabled for the AdGroup. False otherwise
- Type
boolean
-
end_date
End date of adgroup in ISO-8601 format in UTC.
- Type
string
- Format
date-time
-
start_date
Start date/time of adgroup in ISO-8601 format in UTC.
- Type
string
- Format
date-time
-
fb_placements
List of FB page_types
- Type
array of items
-
AdGroupEdit
¶ - Type
object
-
ads
- Type
array of
AdgroupAd
-
created_at
Datetime of adgroup creation in ISO-8601 in UTC.
- Type
string
- Format
date-time
-
kpi_metric
Metric used to measure KPI.
- Type
string
- Enum
CPA
,CPC
,CPM
-
status
Status of adgroup
- Type
string
- Enum
live
,paused
,deleted
-
campaign_eid
EID of campaign this adgroup is in.
- Type
string
- MaxLength
22
- MinLength
22
-
eid
EID of adgroup.
- Type
string
- MaxLength
22
- MinLength
22
-
objective
AdGroup-level objective: attract_lookalike, attract_attribute, convert, rw_linkedin, rw_account_targeting, rw_retargeting. Defaults to convert.
- Type
string
- Default
convert
- Enum
attract_lookalike
,attract_attribute
,convert
,rw_linkedin
,rw_account_targeting
,rw_retargeting
-
name
Name of adgroup.
- Type
string
-
kpi_goal
Value of KPI goal for specified KPI metric (in currency specified by campaign’s
currency
parameter).This must be number greater than 0 or NULL to set an automatic goal.- Type
number
-
targeting_features
- Type
-
li_audience_network_enabled
True if the LinkedIn Audience Network should be enabled for the AdGroup. False otherwise
- Type
boolean
-
end_date
End date of adgroup in ISO-8601 format in UTC.
- Type
string
- Format
date-time
-
start_date
Start date/time of adgroup in ISO-8601 format in UTC.
- Type
string
- Format
date-time
-
fb_placements
List of FB page_types
- Type
array of items
-
AdGroupCreate
¶ - Type
object
-
ads
- Type
array of
AdgroupAd
-
created_at
Datetime of adgroup creation in ISO-8601 in UTC.
- Type
string
- Format
date-time
-
kpi_metric
Metric used to measure KPI.
- Type
string
- Enum
CPA
,CPC
,CPM
-
ad_type
The type of ads supported by this adgroup. The ad_eids passed in should be of this type.
- Required
True
- Type
string
- Enum
dynamic
,static
-
campaign_eid
EID of campaign this adgroup is in.
- Type
string
- MaxLength
22
- MinLength
22
-
eid
EID of adgroup.
- Type
string
- MaxLength
22
- MinLength
22
-
objective
AdGroup-level objective: attract_lookalike, attract_attribute, convert, rw_linkedin, rw_account_targeting, rw_retargeting. Defaults to convert.
- Type
string
- Default
convert
- Enum
attract_lookalike
,attract_attribute
,convert
,rw_linkedin
,rw_account_targeting
,rw_retargeting
-
name
Name of adgroup.
- Type
string
-
kpi_goal
Value of KPI goal for specified KPI metric (in currency specified by campaign’s
currency
parameter).This must be number greater than 0 or NULL to set an automatic goal.- Type
number
-
targeting_features
- Type
-
li_audience_network_enabled
True if the LinkedIn Audience Network should be enabled for the AdGroup. False otherwise
- Type
boolean
-
end_date
End date of adgroup in ISO-8601 format in UTC.
- Type
string
- Format
date-time
-
start_date
Start date/time of adgroup in ISO-8601 format in UTC.
- Type
string
- Format
date-time
-
fb_placements
List of FB page_types
- Type
array of items
-
CampaignResponse
¶ - Type
object
-
budget_settings
- Type
-
currency
ISO-4217 currency code for budget. This value must match the currency set on the Advertisable’s billing account.
- Required
True
- Type
string
- Enum
USD
,EUR
,AUD
,GBP
,NZD
,JPY
-
budget
Daily budget of campaign in the currency specified by the currency field.
- Type
number
-
created_at
Datetime of campaign creation in ISO-8601 in UTC.
- Type
string
- Format
date-time
-
status
Status of campaign
- Type
string
- Enum
live
,paused
,deleted
-
eid
EID of campaign. 22 characters long.
- Type
string
-
objective
Campaign-level objective: attract_lookalike, attract_attribute, convert, rw_linkedin, rw_account_targeting, rw_retargeting. Defaults to convert.
- Type
string
- Default
convert
- Enum
attract_lookalike
,attract_attribute
,convert
,rw_linkedin
,rw_account_targeting
,rw_retargeting
-
has_special_ad_category
Boolean indicating whether or not the campaign has special ad category.
- Type
boolean
-
name
Campaign Name
- Type
string
- MaxLength
100
-
is_draft
Field indicating whether this is a draft campaign.
- Type
boolean
-
end_date
End date of campaign in ISO-8601 format in UTC.
- Type
string
- Format
date-time
-
draft_eid
EID of draft campaign to publish. 22 characters long.
- Type
string
-
start_date
Start date/time of campaign in ISO-8601 format in UTC.
- Type
string
- Format
date-time
-
advertisable_eid
EID of advertisable campaign is attached to. 22 Characters long.
- Type
string
-
CampaignCreate
¶ - Type
object
-
budget_settings
- Type
-
currency
ISO-4217 currency code for budget. This value must match the currency set on the Advertisable’s billing account.
- Required
True
- Type
string
- Enum
USD
,EUR
,AUD
,GBP
,NZD
,JPY
-
budget
Daily budget of campaign in the currency specified by the currency field.
- Type
number
-
created_at
Datetime of campaign creation in ISO-8601 in UTC.
- Type
string
- Format
date-time
-
eid
EID of campaign. 22 characters long.
- Type
string
-
objective
Campaign-level objective: attract_lookalike, attract_attribute, convert, rw_linkedin, rw_account_targeting, rw_retargeting. Defaults to convert.
- Type
string
- Default
convert
- Enum
attract_lookalike
,attract_attribute
,convert
,rw_linkedin
,rw_account_targeting
,rw_retargeting
-
has_special_ad_category
Boolean indicating whether or not the campaign has special ad category.
- Type
boolean
-
name
Campaign Name
- Type
string
- MaxLength
100
-
is_draft
Field indicating whether this is a draft campaign.
- Type
boolean
-
draft_eid
EID of draft campaign to publish. 22 characters long.
- Type
string
-
advertisable_eid
EID of advertisable campaign is attached to. 22 Characters long.
- Type
string
-
CampaignEdit
¶ - Type
object
-
eid
EID of campaign. 22 characters long.
- Type
string
-
advertisable_eid
EID of advertisable campaign is attached to. 22 Characters long.
- Type
string
-
objective
Campaign-level objective: attract_lookalike, attract_attribute, convert, rw_linkedin, rw_account_targeting, rw_retargeting. Defaults to convert.
- Type
string
- Default
convert
- Enum
attract_lookalike
,attract_attribute
,convert
,rw_linkedin
,rw_account_targeting
,rw_retargeting
-
has_special_ad_category
Boolean indicating whether or not the campaign has special ad category.
- Type
boolean
-
name
Campaign Name
- Type
string
- MaxLength
100
-
is_draft
Field indicating whether this is a draft campaign.
- Type
boolean
-
budget_settings
- Type
-
budget
Daily budget of campaign in the currency specified by the currency field.
- Type
number
-
created_at
Datetime of campaign creation in ISO-8601 in UTC.
- Type
string
- Format
date-time
-
status
Status of campaign
- Type
string
- Enum
live
,paused
,deleted
-
PlaybookGeneralExclusion
¶ - Type
object
-
eid
The segment eid for the exclusion.
- Required
True
- Type
string
-
general_exclusion_type
The general exclusion type of the exclusion.
- Required
True
- Type
string
- Enum
competitors
,coworkers
,customers
-
PlaybookBudget
¶ - Type
object
-
spend
Amount spent by this Playbook till now, if a lifetime or monthly budget is used.
- Type
number
-
is_prorated
When using monthly budgets, this flag will enable prorating if the start date is not the first of the month. Defaults to True.
- Type
boolean
-
current_month_spend
Amount spent by this Playbook this month, if a monthly budget is used
- Type
number
-
currency
ISO-4217 currency code for budget. This value must match the currency set on the Advertisable’s billing account.
- Required
True
- Type
string
- Enum
USD
,EUR
,AUD
,GBP
,NZD
,JPY
-
goal
Budget of Playbook in the currency specified by the currency field.
- Required
True
- Type
number
-
prorated_goal
Budget to be used for the first month of a monthly budget type Playbook. is_prorated must be true
- Type
number
-
budget_type
Type of budget
- Required
True
- Type
string
- Enum
monthly
,lifetime
-
PlaybookCampaign
¶ - Type
object
-
eid
Campaign eid.
- Required
True
- Type
string
-
budget
Budget to assign to the campaign. Set only when budget_balancing_automated is False.
- Type
number
-
PlaybookResponse
¶ - Type
object
-
general_exclusions
General exclusions list. This is a cached value. Changes here do not impact the Playbook.
- Type
array of
PlaybookGeneralExclusion
-
budget
- Required
True
- Type
-
playbook_type
Type of the Playbook
- Required
True
- Type
string
- Enum
pre_opportunity_funnel
,pre_opportunity_funnel_intent
,website_retargeting_basic
,website_retargeting_intermediate
,website_retargeting_advanced
-
audience_attributes
Audience attributes. This is a cached value. Changes here do not impact the Playbook.
- Type
object
-
effective_status
Playbook effective status.
- Type
string
-
start_date
Start date/time of playbook in ISO-8601 format in UTC.
- Type
string
- Format
date-time
-
status
Playbook status.
- Type
string
- Enum
live
,paused
,deleted
-
eid
Playbook eid.
- Required
True
- Type
string
-
budget_balancing_automated
Allow our system to smartly allocate your budget among the Playbook’s campaigns to optimize the Playbook performance. If you have this setting turned off, you’ll have to manually set the budget split of the Playbook’s configured campaigns.
- Type
boolean
- Default
True
-
name
Playbook Name.
- Type
string
- MaxLength
100
-
campaigns
List of Campaigns to attach to the Playbook.
- Type
array of
PlaybookCampaign
-
tal_eid
Target Account List eid. This is a cached value. Changes here do not impact the Playbook.
- Type
string
-
tag_eid
Target Account Group eid. This is a cached value. Changes here do not impact the Playbook.
- Type
string
-
advertisable_eid
EID of advertisable the Playbook is attached to. 22 Characters long.
- Type
string
-
end_date
End date of playbook in ISO-8601 format in UTC.
- Type
string
- Format
date-time
-
PlaybookCampaignBudget
¶ - Type
object
-
spend
Amount spent by this campaign till now, if a lifetime or monthly budget is used.
- Type
number
-
is_prorated
When using monthly budgets, this flag will enable prorating if the start date is not the first of the month. Defaults to True.
- Type
boolean
-
current_month_spend
Amount spent by this Campaign this month, if a monthly budget is used
- Type
number
-
goal
Budget of campaign in the currency specified by the currency field.
- Required
True
- Type
number
-
prorated_goal
Budget to be used for the first month of a monthly budget type campaign. is_prorated must be true
- Type
number
-
budget_type
Type of budget
- Required
True
- Type
string
- Enum
daily
,monthly
,lifetime
-
PlaybookCampaignAdgroupAd
¶ - Type
object
-
eid
Ad eid.
- Required
True
- Type
string
-
status
Adgroup ad status
- Required
True
- Type
string
- Enum
live
,paused
,deleted
-
added_on
Added on Playbook date/time of adgroup in ISO-8601 format in UTC.
- Type
string
- Format
date-time
-
PlaybookCampaignAdgroup
¶ - Type
object
-
adwizard_ticket_id
ID of the adwizard ticket to associate with this adgroup.
- Type
integer
-
ads
Optional list of Ads to create with the Campaign
- Type
array of
PlaybookCampaignAdgroupAd
-
created_at
Datetime of adgroup creation in ISO-8601 in UTC.
- Type
string
- Format
date-time
-
kpi_metric
Metric used to measure KPI.
- Type
string
- Enum
CPA
,CPC
,CPM
-
status
Status of adgroup
- Type
string
- Enum
live
,paused
,deleted
-
ad_type
The type of ads supported by this adgroup. The ad_eids passed in should be of this type.
- Required
True
- Type
string
- Enum
dynamic
,static
-
campaign_eid
EID of campaign this adgroup is in.
- Type
string
- MaxLength
22
- MinLength
22
-
eid
EID of adgroup.
- Type
string
- MaxLength
22
- MinLength
22
-
objective
AdGroup-level objective: attract_lookalike, attract_attribute, convert, rw_linkedin, rw_account_targeting, rw_retargeting. Defaults to convert.
- Type
string
- Default
convert
- Enum
attract_lookalike
,attract_attribute
,convert
,rw_linkedin
,rw_account_targeting
,rw_retargeting
-
name
Name of adgroup.
- Type
string
-
sync_strategy_name
will flush the strategy name to the Inventory campaigns
- Type
boolean
-
kpi_goal
Value of KPI goal for specified KPI metric (in currency specified by campaign’s
currency
parameter).This must be number greater than 0 or NULL to set an automatic goal.- Type
number
-
targeting_features
- Type
-
li_audience_network_enabled
True if the LinkedIn Audience Network should be enabled for the AdGroup. False otherwise
- Type
boolean
-
fb_placements
List of FB page_types
- Type
array of items
-
high_intent
For an adgroup on a campaign with a configured template, use high intent targeting segments.
- Type
boolean
-
PlaybookCampaignFull
¶ - Type
object
-
dayparting
Dayparting schedule to apply to each campaign group under this strategywith web retargeting ads, for RollWorks. Optional, will not appear in dump if null.
- Type
object
-
rw_manage_domain_frequency_cap
RollWorks only - Boolean indicating whether or not frequency cap should be managed by RollWorks
- Type
boolean
-
budget_settings
-
template
Template definition to use when creating adgroups for this campaign.
- Type
string
- Default
universal
- Enum
universal
,blackops_uc
,shopify_uc
,magento_uc
,magento2_uc
,woocommerce_uc
,prestashop_uc
,bigcommerce_uc
,squarespace_uc
-
rw_excluded_lead_type
RollWorks only - Which lead type should be excluded from the targeted audience
- Type
string
- Enum
all
,manual
,content_download
,demo_request
,signup
,other
,contact_us
,webinar_registration
-
domain_frequency_cap
Account-based frequency cap to apply to each campaign group under this strategywith web retargeting ads, for RollWorks. Optional, will not appear in dump if null.
- Type
number
- Maximum
10000
-
created_at
Datetime of campaign creation in ISO-8601 in UTC.
- Type
string
- Format
date-time
-
status
Status of campaign
- Type
string
- Enum
live
,paused
,deleted
-
eid
EID of campaign. 22 characters long.
- Type
string
-
objective
Campaign-level objective: attract_lookalike, attract_attribute, convert, rw_linkedin, rw_account_targeting, rw_retargeting. Defaults to convert.
- Type
string
- Default
convert
- Enum
attract_lookalike
,attract_attribute
,convert
,rw_linkedin
,rw_account_targeting
,rw_retargeting
-
has_special_ad_category
Boolean indicating whether or not the campaign has special ad category.
- Type
boolean
-
name
Campaign Name
- Type
string
- MaxLength
100
-
is_draft
Field indicating whether this is a draft campaign.
- Type
boolean
-
draft_eid
EID of draft campaign to publish. 22 characters long.
- Type
string
-
tactic_type
Campaign Tactic Type
- Required
True
- Type
string
-
user_frequency_cap
User frequency cap to apply to each campaign group under this strategywith web retargeting/prospecting ads.
- Type
integer
- Maximum
100
- Minimum
1
-
use_case
Campaign use case.
- Type
string
- Enum
mixed
,brand_awareness
,browse_abandonment
,cart_abandonment
,loyalty
-
adgroups
Optional list of Adgroups to create with the Campaign
- Type
array of
PlaybookCampaignAdgroup
-
domain_frequency_cap_enabled
Boolean indicating whether or not to apply account-based frequency cap.
- Type
boolean
-
PlaybookResponseGeneric
¶ - Type
object
-
eid
Playbook eid.
- Required
True
- Type
string
-
general_exclusions
General exclusions list. This is a cached value. Changes here do not impact the Playbook.
- Type
array of
PlaybookGeneralExclusion
-
advertisable_eid
EID of advertisable the Playbook is attached to. 22 Characters long.
- Type
string
-
budget_balancing_automated
Allow our system to smartly allocate your budget among the Playbook’s campaigns to optimize the Playbook performance. If you have this setting turned off, you’ll have to manually set the budget split of the Playbook’s configured campaigns.
- Type
boolean
- Default
True
-
name
Playbook Name.
- Type
string
- MaxLength
100
-
campaigns
List of Campaigns to attach to the Playbook.
- Type
array of
PlaybookCampaign
-
bulk_campaigns
List of Campaigns with detailed information to create or edit within the Playbook.
- Type
array of
PlaybookCampaignFull
-
tal_eid
Target Account List eid. This is a cached value. Changes here do not impact the Playbook.
- Type
string
-
tag_eid
Target Account Group eid. This is a cached value. Changes here do not impact the Playbook.
- Type
string
-
end_date
End date of playbook in ISO-8601 format in UTC.
- Type
string
- Format
date-time
-
budget
- Required
True
- Type
-
playbook_type
Type of the Playbook
- Required
True
- Type
string
- Enum
pre_opportunity_funnel
,pre_opportunity_funnel_intent
,website_retargeting_basic
,website_retargeting_intermediate
,website_retargeting_advanced
-
audience_attributes
Audience attributes. This is a cached value. Changes here do not impact the Playbook.
- Type
object
-
start_date
Start date/time of playbook in ISO-8601 format in UTC.
- Type
string
- Format
date-time
-
status
Playbook status.
- Type
string
- Enum
live
,paused
,deleted
-
effective_status
Playbook effective status.
- Type
string
-
PlaybookResponseSimple
¶ - Type
object
-
eid
Playbook eid.
- Required
True
- Type
string
-
general_exclusions
General exclusions list. This is a cached value. Changes here do not impact the Playbook.
- Type
array of
PlaybookGeneralExclusion
-
name
Playbook Name.
- Type
string
- MaxLength
100
-
tal_eid
Target Account List eid. This is a cached value. Changes here do not impact the Playbook.
- Type
string
-
tag_eid
Target Account Group eid. This is a cached value. Changes here do not impact the Playbook.
- Type
string
-
end_date
End date of playbook in ISO-8601 format in UTC.
- Type
string
- Format
date-time
-
playbook_type
Type of the Playbook
- Required
True
- Type
string
- Enum
pre_opportunity_funnel
,pre_opportunity_funnel_intent
,website_retargeting_basic
,website_retargeting_intermediate
,website_retargeting_advanced
-
audience_attributes
Audience attributes. This is a cached value. Changes here do not impact the Playbook.
- Type
object
-
start_date
Start date/time of playbook in ISO-8601 format in UTC.
- Type
string
- Format
date-time
-
status
Status of adgroup
- Type
string
- Enum
live
,paused
-
effective_status
Playbook effective status.
- Type
string
-
PlaybookCreate
¶ - Type
object
-
eid
Playbook eid.
- Required
True
- Type
string
-
general_exclusions
General exclusions list. This is a cached value. Changes here do not impact the Playbook.
- Type
array of
PlaybookGeneralExclusion
-
advertisable_eid
EID of advertisable the Playbook is attached to. 22 Characters long.
- Type
string
-
budget_balancing_automated
Allow our system to smartly allocate your budget among the Playbook’s campaigns to optimize the Playbook performance. If you have this setting turned off, you’ll have to manually set the budget split of the Playbook’s configured campaigns.
- Type
boolean
- Default
True
-
name
Playbook Name.
- Type
string
- MaxLength
100
-
campaigns
List of Campaigns to attach to the Playbook.
- Type
array of
PlaybookCampaign
-
bulk_campaigns
List of Campaigns with detailed information to create or edit within the Playbook.
- Type
array of
PlaybookCampaignFull
-
tal_eid
Target Account List eid. This is a cached value. Changes here do not impact the Playbook.
- Type
string
-
tag_eid
Target Account Group eid. This is a cached value. Changes here do not impact the Playbook.
- Type
string
-
end_date
End date of playbook in ISO-8601 format in UTC.
- Type
string
- Format
date-time
-
budget
- Required
True
- Type
-
playbook_type
Type of the Playbook
- Required
True
- Type
string
- Enum
pre_opportunity_funnel
,pre_opportunity_funnel_intent
,website_retargeting_basic
,website_retargeting_intermediate
,website_retargeting_advanced
-
audience_attributes
Audience attributes. This is a cached value. Changes here do not impact the Playbook.
- Type
object
-
start_date
Start date/time of playbook in ISO-8601 format in UTC.
- Type
string
- Format
date-time
-
status
Playbook status.
- Type
string
- Enum
live
,paused
,deleted
-
effective_status
Playbook effective status.
- Type
string
-
PlaybookEdit
¶ - Type
object
-
general_exclusions
General exclusions list. This is a cached value. Changes here do not impact the Playbook.
- Type
array of
PlaybookGeneralExclusion
-
budget
- Type
-
audience_attributes
Audience attributes. This is a cached value. Changes here do not impact the Playbook.
- Type
object
-
effective_status
Playbook effective status.
- Type
string
-
start_date
Start date/time of playbook in ISO-8601 format in UTC.
- Type
string
- Format
date-time
-
status
Playbook status.
- Type
string
- Enum
live
,paused
,deleted
-
eid
Playbook eid.
- Required
True
- Type
string
-
budget_balancing_automated
Allow our system to smartly allocate your budget among the Playbook’s campaigns to optimize the Playbook performance. If you have this setting turned off, you’ll have to manually set the budget split of the Playbook’s configured campaigns.
- Type
boolean
- Default
True
-
name
Playbook Name.
- Type
string
- MaxLength
100
-
campaigns
List of Campaigns to attach to the Playbook.
- Type
array of
PlaybookCampaign
-
bulk_campaigns
List of Campaigns with detailed information to create or edit within the Playbook.
- Type
array of
PlaybookCampaignFull
-
tal_eid
Target Account List eid. This is a cached value. Changes here do not impact the Playbook.
- Type
string
-
tag_eid
Target Account Group eid. This is a cached value. Changes here do not impact the Playbook.
- Type
string
-
advertisable_eid
EID of advertisable the Playbook is attached to. 22 Characters long.
- Type
string
-
end_date
End date of playbook in ISO-8601 format in UTC.
- Type
string
- Format
date-time