LinkedIn Ads
App · 14 actions
Read LinkedIn ad accounts, campaign groups, campaigns, creatives and performance; manage draft campaign groups.
Actions
| Action | What it does |
|---|---|
| Create campaign group | Create a draft campaign group. |
| Delete draft campaign | Delete a draft campaign. |
| Delete draft campaign group | Delete a draft campaign group. |
| Get ad account | Get ad account in LinkedIn Ads. |
| Get campaign | Get campaign in LinkedIn Ads. |
| Get campaign analytics | Read campaign performance for an account and date range. |
| Get campaign group | Get campaign group in LinkedIn Ads. |
| Get creative | Get creative in LinkedIn Ads. |
| List ad accounts | List ad accounts in LinkedIn Ads. |
| List campaign groups | List campaign groups in LinkedIn Ads. |
| List campaigns | List campaigns in LinkedIn Ads. |
| List creatives | List creatives in LinkedIn Ads. |
| Update campaign | Change only the supplied fields. |
| Update campaign group | Change only the supplied fields. |
Create campaign group
Create a draft campaign group. It cannot serve ads until its status is changed.
Inputs
- Account
account_idtextRequired - Account id.
- Name
nametextRequired - Name.
- Start time
start_timedate and timeRequired - Start time.
- End time
end_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
- Account
account_idtextRequired - Account id.
- Campaign
campaign_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
- Account
account_idtextRequired - Account id.
- Campaign group
campaign_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
- Account
account_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
- Account
account_idtextRequired - Account id.
- Campaign
campaign_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
- Account
account_idtextRequired - Account id.
- Start date
start_datedateRequired - Start date.
- End date
end_datedateRequired - End date.
- Time granularity
time_granularitytextRequired - Time granularity.One of:
ALL,DAILY,MONTHLY,YEARLY. - Fields
fieldslist - 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
- Account
account_idtextRequired - Account id.
- Campaign group
campaign_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
- Account
account_idtextRequired - Account id.
- Creative
creative_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 token
page_tokentext - Page token.
- Page size
page_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
- Account
account_idtextRequired - Account id.
- Page token
page_tokentext - Page token.
- Page size
page_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
- Account
account_idtextRequired - Account id.
- Page token
page_tokentext - Page token.
- Page size
page_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
- Account
account_idtextRequired - Account id.
- Next page token
page_tokentext - Token returned by the previous page.
- Page size
page_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
- Account
account_idtextRequired - Account id.
- Campaign
campaign_idtextRequired - Campaign id.
- Name
nametext - Name.
- Status
statustext - 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
- Account
account_idtextRequired - Account id.
- Campaign group
campaign_group_idtextRequired - Campaign group id.
- Name
nametext - Name.
- Status
statustext - 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
}