Partager via

Campaign Recommendations

  • Article

Warning

Deprecation Notice
The Marketing Version 202310 (Marketing October 2023) and earlier versions (excluding 202306 and 202307) have been sunset. Additionally, the unversioned APIs will be sunset soon. We recommend that you migrate to the versioned APIs as well as migrate to the new Content and Community Management APIs to avoid disruptions. See the Migration page for more details. If you haven’t yet migrated and have questions, submit a request on the LinkedIn Developer Support Portal.

The adCampaignRecommendations and adCampaignInsights APIs let advertisers quickly determine if active LinkedIn campaigns are achieving the desired reach and impact.

The adCampaignRecommendations and adCampaignInsightsV2 APIs let advertisers quickly determine if active LinkedIn campaigns are achieving the desired reach and impact.

  • The Recommendations API offers recommendations for underperforming campaigns and suggests ways to improve performance; including adjusting the creative, bid, audience size, or number of creatives.
  • The Insights API offers analysis of a campaign's budget utilization, and identifies modifications that can be made to a bid, daily budget, or total budget to maximize utilization or impressions.

Results for each API are generated daily, and are available after the campaign has been active for 7 days.

Permissions

Permission Description
rw_ads Manage and read an authenticated member's ad accounts. Restricted to ad accounts in which the authenticated member has one of the following ad account roles.
  • ACCOUNT_BILLING_ADMIN
  • ACCOUNT_MANAGER
  • CAMPAIGN_MANAGER
  • CREATIVE_MANAGER
r_ads Read an authenticated member's ad accounts. Restricted to ad accounts in which the authenticated member has one of the following ad account roles.
  • ACCOUNT_BILLING_ADMIN
  • ACCOUNT_MANAGER
  • CAMPAIGN_MANAGER
  • CREATIVE_MANAGER
  • VIEWER

See Account Access Controls for more information on ad account roles.

Campaign Insights

The adCampaignInsights API requires the q=entities parameter and at least one entities={campaignUrn} parameter with a campaign URN. Multiple campaigns can be provided by chaining multiple entities parameters that each have their own campaign URN.

Paging is not supported for this API. All results are returned on the first page.

Note

  • campaignRelevanceScore is generated daily.
  • Campaign must be active for 7 days before campaignRelevanceScore is generated.
GET https://api.linkedin.com/rest/adCampaignInsights?q=entities&entities={campaign URN 1}&entities={campaign URN 2}

Campaign Insights

The adCampaignInsightsV2 API requires the q=entities parameter and at least one entities={campaignUrn} parameter with a campaign URN. Multiple campaigns can be provided by chaining multiple entities parameters that each have their own campaign URN.

Paging is not supported for this API. All results are returned on the first page.

GET https://api.linkedin.com/v2/adCampaignInsightsV2?q=entities&entities={campaign URN 1}&entities={campaign URN 2}

Parameters

Field Name Required Description
entities Yes SponsoredCampaign URNs for which insights should be returned. Specify multiple entities parameters with additional campaign URNs to request insights for multiple campaigns.

Schema

Field Name Type Description
averageSpend [deprecated] optional MoneyAmount The average spend of the entity (such as SponsoredCampaign and SponsoredCampaignGroup) in the past 7 days in UTC time. Currency code must match that of the parent account.
bidInsight [deprecated] optional BidInsight A prediction of how much additional impressions could be generated from a different bid.
budgetExhaustedAt [deprecated] optional long Date at which the ad entity's TotalBudget will be exhausted, in Unix Epoch time.
campaignRelevanceScore optional int A score between 0 and 10 (inclusive) indicating how relevant this campaign is compared to its competitors. A score of 10 indicates the most relevant content.
dailyBudgetUtilization [deprecated] optional double The average daily budget utilization. Ranges between 0.0 to about 1.2 if there is over delivery.
entity URN The URN of the entity for which these insights apply (sponsoredCampaign URN).
shareOfVoice [deprecated] optional double The fraction of eligible audience this ad entity has reached. Ranges between 0.0 to 1.0.
totalBudgetUtilization [deprecated] optional double The fraction of the total budget this ad entity has spent so far. Ranges between 0.0 to about 1.2 if there is over delivery. Not provided if totalBudget is not set by the advertiser.

Sample Request

The following example shows insights for campaigns urn:li:sponsoredCampaign:12244313 and urn:li:sponsoredCampaign:5466312.

GET https://api.linkedin.com/rest/adCampaignInsights?q=entities&entities=urn:li:sponsoredCampaign:12244313&entities=urn:li:sponsoredCampaign:5466312

GET https://api.linkedin.com/v2/adCampaignInsightsV2?q=entities&entities=urn:li:sponsoredCampaign:12244313&entities=urn:li:sponsoredCampaign:5466312

Sample Response

{
    "paging": {
        "start": 0,
        "count": 10,
        "links": [],
        "total": 1
    },
    "elements": [
        {
            "entity": "urn:li:sponsoredCampaign:12244313",
            "campaignRelevanceScore": 3
        },
        {
            "entity": "urn:li:sponsoredCampaign:5466312",
            "campaignRelevanceScore": 1
        }
    ]
}