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

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 HTTP Basic Authentication. 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 HTTP Basic Authentication. 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

AdGroupResponse

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 HTTP Basic Authentication. 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

AdGroupResponse

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 HTTP Basic Authentication. 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

AdgroupAd

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

apikey

False

string

Required if using HTTP Basic Authentication. 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",
      "eid": "string",
      "end_date": "string",
      "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 HTTP Basic Authentication. 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",
  "eid": "string",
  "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",
    "eid": "string",
    "end_date": "string",
    "name": "string",
    "objective": "convert",
    "start_date": "string",
    "status": "string"
  }
}
Schema
Type

object

data
Type

CampaignResponse

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 HTTP Basic Authentication. 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",
  "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",
    "eid": "string",
    "end_date": "string",
    "name": "string",
    "objective": "convert",
    "start_date": "string",
    "status": "string"
  }
}
Schema
Type

object

data
Type

CampaignResponse

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)

apikey

False

string

Required if using HTTP Basic Authentication. 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",
      "budget": {
        "budget_type": "string",
        "currency": "string",
        "current_month_spend": 0.0,
        "goal": 0.0,
        "is_prorated": true,
        "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",
              "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,
            "spend": 0.0
          },
          "created_at": "string",
          "dayparting": {},
          "domain_frequency_cap": 0.0,
          "domain_frequency_cap_enabled": true,
          "eid": "string",
          "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",
      "name": "string",
      "playbook_type": "string",
      "start_date": "string",
      "status": "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 HTTP Basic Authentication. 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",
  "budget": {
    "budget_type": "string",
    "currency": "string",
    "current_month_spend": 0.0,
    "goal": 0.0,
    "is_prorated": true,
    "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",
          "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,
        "spend": 0.0
      },
      "created_at": "string",
      "dayparting": {},
      "domain_frequency_cap": 0.0,
      "domain_frequency_cap_enabled": true,
      "eid": "string",
      "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",
  "name": "string",
  "playbook_type": "string",
  "start_date": "string",
  "status": "string"
}

Responses:

200

The newly created Playbook

Schema as JSON:

{
  "data": {
    "advertisable_eid": "string",
    "budget": {
      "budget_type": "string",
      "currency": "string",
      "current_month_spend": 0.0,
      "goal": 0.0,
      "is_prorated": true,
      "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",
            "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,
          "spend": 0.0
        },
        "created_at": "string",
        "dayparting": {},
        "domain_frequency_cap": 0.0,
        "domain_frequency_cap_enabled": true,
        "eid": "string",
        "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",
    "name": "string",
    "playbook_type": "string",
    "start_date": "string",
    "status": "string"
  }
}
Schema
Type

object

data
Type

PlaybookResponseGeneric

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 HTTP Basic Authentication. 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",
  "budget": {
    "budget_type": "string",
    "currency": "string",
    "current_month_spend": 0.0,
    "goal": 0.0,
    "is_prorated": true,
    "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",
          "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,
        "spend": 0.0
      },
      "created_at": "string",
      "dayparting": {},
      "domain_frequency_cap": 0.0,
      "domain_frequency_cap_enabled": true,
      "eid": "string",
      "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",
  "name": "string",
  "start_date": "string",
  "status": "string"
}

Responses:

200

The edited Playbook

Schema as JSON:

{
  "data": {
    "advertisable_eid": "string",
    "budget": {
      "budget_type": "string",
      "currency": "string",
      "current_month_spend": 0.0,
      "goal": 0.0,
      "is_prorated": true,
      "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",
            "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,
          "spend": 0.0
        },
        "created_at": "string",
        "dayparting": {},
        "domain_frequency_cap": 0.0,
        "domain_frequency_cap_enabled": true,
        "eid": "string",
        "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",
    "name": "string",
    "playbook_type": "string",
    "start_date": "string",
    "status": "string"
  }
}
Schema
Type

object

data
Type

PlaybookResponseGeneric

Definitions

BudgetSettings
Type

object

spend

Amount spent by this campaign till now, if a lifetime or monthly budget is used.

Type

number

Format

float

goal

Budget of campaign in the currency specified by the currency field.

Required

True

Type

number

Format

float

current_month_spend

Amount spent by this Campaign this month, if a monthly budget is used

Type

number

Format

float

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

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

Format

float

kpi_metric

Metric used to measure KPI.

Type

string

Enum

CPA, CPC, CPM

eid

EID of adgroup.

Type

string

MaxLength

22

MinLength

22

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

end_date

End date of adgroup in ISO-8601 format in UTC.

Type

string

Format

date-time

li_audience_network_enabled

True if the LinkedIn Audience Network should be enabled for the AdGroup. False otherwise

Type

boolean

targeting_features
Type

AdgroupTargeting

objective

AdGroup-level objective: attract_lookalike, attract_attribute, convert, rw_linkedin, rw_account_targeting. Defaults to convert.

Type

string

Default

convert

Enum

attract_lookalike, attract_attribute, convert, rw_linkedin, rw_account_targeting

fb_placements

List of FB page_types

Type

array of items

ads
Type

array of AdgroupAd

name

Name of adgroup.

Type

string

created_at

Datetime of adgroup creation in ISO-8601 in UTC.

Type

string

Format

date-time

status

Status of adgroup

Type

string

Enum

live, paused, deleted

start_date

Start date/time of adgroup in ISO-8601 format in UTC.

Type

string

Format

date-time

AdGroupEdit
Type

object

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

Format

float

kpi_metric

Metric used to measure KPI.

Type

string

Enum

CPA, CPC, CPM

eid

EID of adgroup.

Type

string

MaxLength

22

MinLength

22

campaign_eid

EID of campaign this adgroup is in.

Type

string

MaxLength

22

MinLength

22

end_date

End date of adgroup in ISO-8601 format in UTC.

Type

string

Format

date-time

li_audience_network_enabled

True if the LinkedIn Audience Network should be enabled for the AdGroup. False otherwise

Type

boolean

targeting_features
Type

AdgroupTargeting

objective

AdGroup-level objective: attract_lookalike, attract_attribute, convert, rw_linkedin, rw_account_targeting. Defaults to convert.

Type

string

Default

convert

Enum

attract_lookalike, attract_attribute, convert, rw_linkedin, rw_account_targeting

fb_placements

List of FB page_types

Type

array of items

ads
Type

array of AdgroupAd

name

Name of adgroup.

Type

string

created_at

Datetime of adgroup creation in ISO-8601 in UTC.

Type

string

Format

date-time

status

Status of adgroup

Type

string

Enum

live, paused, deleted

start_date

Start date/time of adgroup in ISO-8601 format in UTC.

Type

string

Format

date-time

AdGroupCreate
Type

object

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

Format

float

kpi_metric

Metric used to measure KPI.

Type

string

Enum

CPA, CPC, CPM

eid

EID of adgroup.

Type

string

MaxLength

22

MinLength

22

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

end_date

End date of adgroup in ISO-8601 format in UTC.

Type

string

Format

date-time

li_audience_network_enabled

True if the LinkedIn Audience Network should be enabled for the AdGroup. False otherwise

Type

boolean

targeting_features
Type

AdgroupTargeting

objective

AdGroup-level objective: attract_lookalike, attract_attribute, convert, rw_linkedin, rw_account_targeting. Defaults to convert.

Type

string

Default

convert

Enum

attract_lookalike, attract_attribute, convert, rw_linkedin, rw_account_targeting

fb_placements

List of FB page_types

Type

array of items

ads
Type

array of AdgroupAd

name

Name of adgroup.

Type

string

created_at

Datetime of adgroup creation in ISO-8601 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

CampaignResponse
Type

object

budget_settings
Type

BudgetSettings

eid

EID of campaign. 22 characters long.

Type

string

end_date

End date of campaign in ISO-8601 format in UTC.

Type

string

Format

date-time

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

objective

Campaign-level objective: attract_lookalike, attract_attribute, convert, rw_linkedin, rw_account_targeting. Defaults to convert.

Type

string

Default

convert

Enum

attract_lookalike, attract_attribute, convert, rw_linkedin, rw_account_targeting

budget

Daily budget of campaign in the currency specified by the currency field.

Type

number

Format

float

name

Campaign Name

Type

string

MaxLength

100

advertisable_eid

EID of advertisable campaign is attached to. 22 Characters long.

Type

string

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

start_date

Start date/time of campaign in ISO-8601 format in UTC.

Type

string

Format

date-time

CampaignCreate
Type

object

budget_settings
Type

BudgetSettings

eid

EID of campaign. 22 characters long.

Type

string

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

objective

Campaign-level objective: attract_lookalike, attract_attribute, convert, rw_linkedin, rw_account_targeting. Defaults to convert.

Type

string

Default

convert

Enum

attract_lookalike, attract_attribute, convert, rw_linkedin, rw_account_targeting

budget

Daily budget of campaign in the currency specified by the currency field.

Type

number

Format

float

name

Campaign Name

Type

string

MaxLength

100

advertisable_eid

EID of advertisable campaign is attached to. 22 Characters long.

Type

string

created_at

Datetime of campaign creation in ISO-8601 in UTC.

Type

string

Format

date-time

CampaignEdit
Type

object

budget_settings
Type

BudgetSettings

objective

Campaign-level objective: attract_lookalike, attract_attribute, convert, rw_linkedin, rw_account_targeting. Defaults to convert.

Type

string

Default

convert

Enum

attract_lookalike, attract_attribute, convert, rw_linkedin, rw_account_targeting

eid

EID of campaign. 22 characters long.

Type

string

budget

Daily budget of campaign in the currency specified by the currency field.

Type

number

Format

float

name

Campaign Name

Type

string

MaxLength

100

advertisable_eid

EID of advertisable campaign is attached to. 22 Characters long.

Type

string

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

PlaybookBudget
Type

object

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

spend

Amount spent by this Playbook till now, if a lifetime or monthly budget is used.

Type

number

Format

float

goal

Budget of Playbook in the currency specified by the currency field.

Required

True

Type

number

Format

float

current_month_spend

Amount spent by this Playbook this month, if a monthly budget is used

Type

number

Format

float

budget_type

Type of budget

Required

True

Type

string

Enum

monthly, lifetime

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

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

Format

float

PlaybookResponse
Type

object

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

effective_status

Playbook effective status.

Type

string

eid

Playbook eid.

Required

True

Type

string

budget
Required

True

Type

PlaybookBudget

campaigns

List of Campaigns to attach to the Playbook.

Type

array of PlaybookCampaign

name

Playbook Name.

Type

string

MaxLength

100

playbook_type

Type of the Playbook

Required

True

Type

string

Enum

pre_opportunity_funnel, pre_opportunity_funnel_intent

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

status

Playbook status.

Type

string

Enum

live, paused, deleted

start_date

Start date/time of playbook in ISO-8601 format in UTC.

Type

string

Format

date-time

PlaybookCampaignBudget
Type

object

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

spend

Amount spent by this campaign till now, if a lifetime or monthly budget is used.

Type

number

Format

float

goal

Budget of campaign in the currency specified by the currency field.

Required

True

Type

number

Format

float

current_month_spend

Amount spent by this Campaign this month, if a monthly budget is used

Type

number

Format

float

budget_type

Type of budget

Required

True

Type

string

Enum

daily, monthly, lifetime

PlaybookCampaignAdgroupAd
Type

object

eid

Ad eid.

Required

True

Type

string

added_on

Added on Playbook date/time of adgroup in ISO-8601 format in UTC.

Type

string

Format

date-time

status

Adgroup ad status

Required

True

Type

string

Enum

live, paused, deleted

PlaybookCampaignAdgroup
Type

object

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

Format

float

kpi_metric

Metric used to measure KPI.

Type

string

Enum

CPA, CPC, CPM

eid

EID of adgroup.

Type

string

MaxLength

22

MinLength

22

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

li_audience_network_enabled

True if the LinkedIn Audience Network should be enabled for the AdGroup. False otherwise

Type

boolean

targeting_features
Type

AdgroupTargeting

adwizard_ticket_id

ID of the adwizard ticket to associate with this adgroup.

Type

integer

Format

int32

objective

AdGroup-level objective: attract_lookalike, attract_attribute, convert, rw_linkedin, rw_account_targeting. Defaults to convert.

Type

string

Default

convert

Enum

attract_lookalike, attract_attribute, convert, rw_linkedin, rw_account_targeting

fb_placements

List of FB page_types

Type

array of items

ads

Optional list of Ads to create with the Campaign

Type

array of PlaybookCampaignAdgroupAd

name

Name of adgroup.

Type

string

high_intent

For an adgroup on a campaign with a configured template, use high intent targeting segments.

Type

boolean

created_at

Datetime of adgroup creation in ISO-8601 in UTC.

Type

string

Format

date-time

status

Status of adgroup

Type

string

Enum

live, paused, deleted

PlaybookCampaignFull
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
Type

PlaybookCampaignBudget

objective

Campaign-level objective: attract_lookalike, attract_attribute, convert, rw_linkedin, rw_account_targeting. Defaults to convert.

Type

string

Default

convert

Enum

attract_lookalike, attract_attribute, convert, rw_linkedin, rw_account_targeting

user_frequency_cap

User frequency cap to apply to each campaign group under this strategywith web retargeting/prospecting ads.

Type

integer

Format

int32

Maximum

100

Minimum

1

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

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

eid

EID of campaign. 22 characters long.

Type

string

domain_frequency_cap_enabled

Boolean indicating whether or not to apply account-based frequency cap.

Type

boolean

tactic_type

Campaign Tactic Type

Required

True

Type

string

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

Format

float

Maximum

10000

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

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

name

Campaign Name

Type

string

MaxLength

100

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

PlaybookResponseGeneric
Type

object

bulk_campaigns

List of Campaigns with detailed information to create or edit within the Playbook.

Type

array of PlaybookCampaignFull

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

effective_status

Playbook effective status.

Type

string

eid

Playbook eid.

Required

True

Type

string

budget
Required

True

Type

PlaybookBudget

campaigns

List of Campaigns to attach to the Playbook.

Type

array of PlaybookCampaign

name

Playbook Name.

Type

string

MaxLength

100

playbook_type

Type of the Playbook

Required

True

Type

string

Enum

pre_opportunity_funnel, pre_opportunity_funnel_intent

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

status

Playbook status.

Type

string

Enum

live, paused, deleted

start_date

Start date/time of playbook in ISO-8601 format in UTC.

Type

string

Format

date-time

PlaybookCreate
Type

object

bulk_campaigns

List of Campaigns with detailed information to create or edit within the Playbook.

Type

array of PlaybookCampaignFull

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

effective_status

Playbook effective status.

Type

string

eid

Playbook eid.

Required

True

Type

string

budget
Required

True

Type

PlaybookBudget

campaigns

List of Campaigns to attach to the Playbook.

Type

array of PlaybookCampaign

name

Playbook Name.

Type

string

MaxLength

100

playbook_type

Type of the Playbook

Required

True

Type

string

Enum

pre_opportunity_funnel, pre_opportunity_funnel_intent

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

status

Playbook status.

Type

string

Enum

live, paused, deleted

start_date

Start date/time of playbook in ISO-8601 format in UTC.

Type

string

Format

date-time

PlaybookEdit
Type

object

bulk_campaigns

List of Campaigns with detailed information to create or edit within the Playbook.

Type

array of PlaybookCampaignFull

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

effective_status

Playbook effective status.

Type

string

eid

Playbook eid.

Required

True

Type

string

budget
Type

PlaybookBudget

campaigns

List of Campaigns to attach to the Playbook.

Type

array of PlaybookCampaign

name

Playbook Name.

Type

string

MaxLength

100

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

status

Playbook status.

Type

string

Enum

live, paused, deleted

start_date

Start date/time of playbook in ISO-8601 format in UTC.

Type

string

Format

date-time