LinkedIn Ads

App · 14 actions

Read LinkedIn ad accounts, campaign groups, campaigns, creatives and performance; manage draft campaign groups.

Actions

ActionWhat it does
Create campaign groupCreate a draft campaign group.
Delete draft campaignDelete a draft campaign.
Delete draft campaign groupDelete a draft campaign group.
Get ad accountGet ad account in LinkedIn Ads.
Get campaignGet campaign in LinkedIn Ads.
Get campaign analyticsRead campaign performance for an account and date range.
Get campaign groupGet campaign group in LinkedIn Ads.
Get creativeGet creative in LinkedIn Ads.
List ad accountsList ad accounts in LinkedIn Ads.
List campaign groupsList campaign groups in LinkedIn Ads.
List campaignsList campaigns in LinkedIn Ads.
List creativesList creatives in LinkedIn Ads.
Update campaignChange only the supplied fields.
Update campaign groupChange only the supplied fields.

Create campaign group

Create a draft campaign group. It cannot serve ads until its status is changed.

Inputs

Accountaccount_idtextRequired
Account id.
NamenametextRequired
Name.
Start timestart_timedate and timeRequired
Start time.
End timeend_timedate and time
End time.

Outputs

Response.

dataobject
The official API response, including records and response metadata.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation token or offset to pass to the next request.
Example output
{
  "data": {
    "id": "Example"
  },
  "has_more": false,
  "next_cursor": null
}

Delete draft campaign

Delete a draft campaign. Other statuses must use Update to request PENDING_DELETION.

Inputs

Accountaccount_idtextRequired
Account id.
Campaigncampaign_idtextRequired
Campaign id.

Outputs

Response.

dataobject
The official API response, including records and response metadata.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation token or offset to pass to the next request.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

Delete draft campaign group

Delete a draft campaign group. Other statuses must use Update to request PENDING_DELETION.

Inputs

Accountaccount_idtextRequired
Account id.
Campaign groupcampaign_group_idtextRequired
Campaign group id.

Outputs

Response.

dataobject
The official API response, including records and response metadata.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation token or offset to pass to the next request.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

Get ad account

Get ad account in LinkedIn Ads.

Inputs

Accountaccount_idtextRequired
Account id.

Outputs

Response.

dataobject
The official API response, including records and response metadata.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation token or offset to pass to the next request.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

Get campaign

Get campaign in LinkedIn Ads.

Inputs

Accountaccount_idtextRequired
Account id.
Campaigncampaign_idtextRequired
Campaign id.

Outputs

Response.

dataobject
The official API response, including records and response metadata.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation token or offset to pass to the next request.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

Get campaign analytics

Read campaign performance for an account and date range. Request only metrics permitted for your approved Marketing API application.

Inputs

Accountaccount_idtextRequired
Account id.
Start datestart_datedateRequired
Start date.
End dateend_datedateRequired
End date.
Time granularitytime_granularitytextRequired
Time granularity.One of: ALL, DAILY, MONTHLY, YEARLY.
Fieldsfieldslist
Fields.One or more of: impressions, clicks, costInLocalCurrency, externalWebsiteConversions, likes, shares, comments, dateRange, pivotValues.

Outputs

Response.

dataobject
The official API response, including records and response metadata.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation token or offset to pass to the next request.
Example output
{
  "data": {
    "elements": []
  },
  "has_more": false,
  "next_cursor": null
}

Get campaign group

Get campaign group in LinkedIn Ads.

Inputs

Accountaccount_idtextRequired
Account id.
Campaign groupcampaign_group_idtextRequired
Campaign group id.

Outputs

Response.

dataobject
The official API response, including records and response metadata.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation token or offset to pass to the next request.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

Get creative

Get creative in LinkedIn Ads.

Inputs

Accountaccount_idtextRequired
Account id.
Creativecreative_idtextRequired
Creative id.

Outputs

Response.

dataobject
The official API response, including records and response metadata.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation token or offset to pass to the next request.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

List ad accounts

List ad accounts in LinkedIn Ads.

Inputs

Page tokenpage_tokentext
Page token.
Page sizepage_sizenumber
Page size.At least 1.

Outputs

Response.

dataobject
The official API response, including records and response metadata.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation token or offset to pass to the next request.
Example output
{
  "data": {
    "elements": []
  },
  "has_more": false,
  "next_cursor": null
}

List campaign groups

List campaign groups in LinkedIn Ads.

Inputs

Accountaccount_idtextRequired
Account id.
Page tokenpage_tokentext
Page token.
Page sizepage_sizenumber
Page size.At least 1.

Outputs

Response.

dataobject
The official API response, including records and response metadata.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation token or offset to pass to the next request.
Example output
{
  "data": {
    "elements": []
  },
  "has_more": false,
  "next_cursor": null
}

List campaigns

List campaigns in LinkedIn Ads.

Inputs

Accountaccount_idtextRequired
Account id.
Page tokenpage_tokentext
Page token.
Page sizepage_sizenumber
Page size.At least 1.

Outputs

Response.

dataobject
The official API response, including records and response metadata.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation token or offset to pass to the next request.
Example output
{
  "data": {
    "elements": []
  },
  "has_more": false,
  "next_cursor": null
}

List creatives

List creatives in LinkedIn Ads.

Inputs

Accountaccount_idtextRequired
Account id.
Next page tokenpage_tokentext
Token returned by the previous page.
Page sizepage_sizenumber
How many creatives to return, up to 100.From 1 to 100.

Outputs

Response.

dataobject
The official API response, including records and response metadata.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation token or offset to pass to the next request.
Example output
{
  "data": {
    "elements": []
  },
  "has_more": false,
  "next_cursor": null
}

Update campaign

Change only the supplied fields. ACTIVE can start ad spending; PENDING_DELETION schedules deletion.

Inputs

Accountaccount_idtextRequired
Account id.
Campaigncampaign_idtextRequired
Campaign id.
Namenametext
Name.
Statusstatustext
Status.One of: ACTIVE, PAUSED, ARCHIVED, CANCELED, DRAFT, PENDING_DELETION.

Outputs

Response.

dataobject
The official API response, including records and response metadata.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation token or offset to pass to the next request.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

Update campaign group

Change only the supplied fields. ACTIVE can start ad spending; PENDING_DELETION schedules deletion.

Inputs

Accountaccount_idtextRequired
Account id.
Campaign groupcampaign_group_idtextRequired
Campaign group id.
Namenametext
Name.
Statusstatustext
Status.One of: ACTIVE, PAUSED, ARCHIVED, CANCELED, DRAFT, PENDING_DELETION.

Outputs

Response.

dataobject
The official API response, including records and response metadata.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation token or offset to pass to the next request.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

On this page