Partager via

Archived Marketing API Changes 2019

  • Article

Warning

Deprecation Notice
The Marketing Version 202311 (Marketing November 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.

December 2019

General API Updates

  • New metrics available for video posts
    • Who's impacted: Partners using the organizationalEntityShareStatistics endpoint
    • What's happening: The following metrics are now available to measure the performance of a video post: clicks, comments, mentions, engagement, impressions, likes, shares, and more. Learn more.
  • Use company URL to improve company matching
    • Who's impacted: Partners using the Organizations Lookup API.
    • What's happening: Partners that support company targeting, company mentions or Matched Audience can use the new localizedWebsite field to more reliably identify and match target accounts. Learn more.
  • Campaigns using new objectives must use new fields objectiveType and optimizationTargetType to pull bid minimums
    • Who's impacted: All partners using new campaign objectives including: Brand Awareness, Website Visit, Engagement, Video Views, Lead Generation, Website Conversion, Job Applicant, Talent Lead.
    • What's happening:
      • With the launch of Objective-Based Advertising and the new objectives, we implemented new bid minimums based on the objective. To pull the new bid mins, you must use new fields: Objective Type and Optimization Target Type. Learn more.
      • For legacy objectives, continue to use the the AdBudgetPricing endpoint to retrieve bid minimums.
  • LinkedIn Marketing API Program data storage requirements
    • Who's impacted: All LinkedIn Marketing API Program partners
    • What's happening: The LinkedIn Marketing API Program data storage requirements have been updated. Learn more.

Conversions & Reporting

  • Customize your conversion window with 90-day option
    • Who's impacted: All partners
    • What's happening: In August, we released new fields 'postClickAttributionWindowSize' and 'viewThroughAttributionWindowSize' that enable you to customize a 1,7,30-day conversion window for a post-click or view-through conversions. You can now customize a 90-day conversion window, in addition to 1,7,30 days. The default conversion window for view-through is 7 days and post-click is 30 days. Learn more.
  • Use new geographic reporting dimensions, as part of the migration to Bing-geo locations
    • Who's impacted: Partners using the adAnalytics API
    • What's happening: We are adding three new dimensions for demographic reporting: MEMBER_COUNTRY_V2, MEMBER_REGION_V2, and MEMBER_COUNTY. These new pivots will return geo urns as part of the data, so 10 clicks for urn urn:li:geo:1 for example. They will replace MEMBER_COUNTRY and MEMBER_REGION, which are deprecated and will be removed on March 31, 2020. Learn more.
  • Send Sponsored InMail from a company name
    • Who's impacted: Partners that use the InMail API.
    • What's happening: You can now support Sponsored InMail from a company sender via API, previously a sender had to be an individual. Note, this feature is limited to customers that have company sender set up by their LinkedIn rep.
  • Direct Sponsored Content (DSC) posters can now request access control information
    • Who's impacted: Any partner using the Company Pages APIs.
    • What's happening: We are deprecating organizationalEntityAcls API in favor of a new API: organizationAcls. In addition we are now allowing the ability for a direct sponsored content poster to request an ACL via UPDATE method. Organizational Entity ACL API will be removed on February 29, 2020. Learn more.
  • Remove Sponsored Content from campaign
    • Who's impacted: Any partner using the adDirectSponsoredContents API.
    • What's happening: To help you clean up and organize your campaigns, you can now archive Sponsored Content that you no longer want to sponsor by setting the 'status' field of the AdDirectSponsoredContent to ARCHIVED. Learn more.
  • Batch delete creatives capability is not available
    • Who's impacted: Any partner using the adCreativesV2 API
    • What's happening: In our September API update email, we inadvertently communicated the ability to delete multiple creatives from a campaign in batch. This is currently not available, but you can delete single creative from a campaign.

Targeting

  • New Matched Audiences fields to enhance account and contact matching
    • Who's impacted: Partners using the dmpSegments API for user, company and list upload endpoints
    • What's happening: Starting December 12, use these new fields to improve your Matched Audiences account and contact matching rates:
      • For contact matching: Google IDs, mobile IDs, first name, last name, job title, country/region, and company name
      • For account matching: companyPageUrl, stockSymbol, industry, city, state, country/region, and zip code

Migrations

  • Upload images via the new API
    • Who's impacted: Partners using the Rich Media API
    • What's happening: Use a new API to upload images for organic posts and Sponsored Content. The Rich Media API is now deprecated and will be terminated on January 30, 2020. The new API, called Vector, will support higher resolution images and faster image upload times. Refer to this migration guide for additional detail.
  • Geo-location migration reminder
    • Who's impacted: Partners using the Ad Targeting API location facet only. This does not impact Share or UGC Post API.
    • What's happening: In an effort to improve our geo targeting and provide a more comprehensive targeting experience, LinkedIn is migrating to Bing geo data. Refer to this migration guide for additional detail.
    • When: By March 31, 2020, partners should stop using the Locations APIs, and instead integrate with our adTargetingEntities Typeahead and Urns APIs. Starting April 1, 2020, the legacy locations will no longer be accepted in campaign creation.

Migrations

  • ugcOrigin and serviceProvider field deprecated
    • Who's impacted: Partners that use the ugcOrigin field from ugcPosts or serviceProvider field from sharesV2
    • What's happening: ugcOrigin and serviceProvider will be removed, as a part of schema cleanup efforts. These fields will not be replaced.
    • When: The ugcOrigin and serviceProvider field will be removed on January 10, 2020.
  • Removing support for SHA1 hashed emails
    • Who's impacted: Partner using the DMP Segment List Upload and User Streaming API
    • What's happening: We've removed support for a SHA1 emails from contact list matching, with the latest set of security changes. Moving forward, email addresses must be SHA256 hashed before you upload the list and SHA256 or SHA512 hashed to stream a user list.
    • When: Support for SHA1 emails will be removed December 9, 2019.

October 2019

General API Updates

  • UGCPosts thumbnail and originalURL fields must be empty when creating video posts
    • Who's impacted: Partners using the UGC API
    • What's happening: Previously, you may have leveraged the thumbnail or originalURL field when creating a video post. These fields are meant for third-party articles, and not video posts. We did not activate the appropriate validations to prevent such calls. Starting November 28, we will be enforcing these validations, so please ensure thumbnail and originalURL fields are blank when creating video posts, otherwise the call will result in a 400 error.

Migration

  • Upload images via the new API
    • Who's impacted: Partners using the Rich Media API
    • What's happening: Use a new API to upload images for organic posts and Sponsored Content. The Rich Media API is now deprecated and will be terminated on January 30, 2020. The new API, called Vector, will support higher resolution images and faster image upload times. Refer to this migration guide for additional detail.
  • Geo-location migration reminder
    • Who's impacted: Partners using the Ad Targeting API location facet only. This does not impact Share or UGC API.
    • What's happening: In an effort to improve our geo targeting and provide a more comprehensive targeting experience, LinkedIn is migrating to Bing geo data. Refer to this migration guide for additional detail.
    • When: By October 31, 2019, partners should stop using the Locations APIs, and instead integrate with our adTargetingEntities Typeahead and Urns APIs.

Deprecation

  • Matched Audiences: AdAudienceMatch endpoint replaced with DMP Segment List Upload
    • Who's impacted: Partners that use the AdAudienceMatch endpoint.
    • What's happening: If you are currently using the AdAudienceMatch endpoint to create an audience match for companies or members, this endpoint is deprecated and will be removed. The same functionality is available in the DMP Segment List Upload API.
    • When: The AdAudienceMatch endpoint will be removed on January 31, 2020.
  • Rich Media API replaced with a new API to upload images
    • Who's impacted: Partners using the Rich Media API
    • What's happening: We will be deprecating the Rich Media API in favor of a new API, Vector, to upload and host media.
    • When: The Rich Media API will be removed on January 30, 2020.

September 2019

General API Updates

  • Create campaigns on the new set of full-funnel objectives, available with Objective-Based Advertising (OBA)
    • Who's impacted: Partners using the Ad Campaigns and Ad Reporting APIs
    • What's happening: Campaign creation support, in addition to reporting, on the new objectives is now available to all partners. The new objectives are designed to optimize campaigns by showing ads to people most likely to take action and to better measure results based on a marketing objective. If you choose not to integrate OBA, customers will get a different experience on the LinkedIn UI vs. your platform. Learn more.
  • New ads review rejection reasons
    • Who's impacted: Any partner using the adCreativesV2 API
    • What's happening: We've added three new rejection reasons: Lead Gen Form privacy policy missing, inactive job posting, and cryptocurrency, as LinkedIn prohibits ads relating to buying, selling and promoting cryptocurrency. See here for full list of rejection reasons.
  • Create, update, and delete creatives in DRAFT mode
    • Who's impacted: Any partner using the adCreativesV2 API
    • Reminder that starting October 7, DRAFT status is available for all creative types
    • What's happening: Starting October 7, 2019, developers will be able to create, update, and read creatives that are in DRAFT status for all creative types through the Ads API. See August email.
  • After October 7, Remove ad creative
    • What's happening: You now have the ability to delete one or multiple creatives from campaigns. A new API call is available: DELETE creative_id. Note: Creatives must be in draft or under a draft campaign. Learn more.
  • Starting November 1, test and iterate Sponsored InMail in DRAFT status before activating
    • What's happening: You can now test and iterate InMail creatives in DRAFT status before activating. Starting November 1, 2019, Sponsored InMail will default to being created in DRAFT status, enabling you to test your creative before activating, even if creative status is explicitly set to ACTIVE. You will need to make a subsequent call to update a creative status to ACTIVE. Learn more.

Reporting

  • Reporting API Updates - adding additional core LMS metrics
    • Who's impacted: Partners using the Ads Reporting API.
    • What's happening: Four new metrics are available: reactions, viralReactions, sends, and viralCommentLikes. Please refer to the Metrics Available in the API documentation for field descriptions.

Targeting

  • NEW RELEASE: Lookalike Audiences available via API
    • Who's impacted: Partners using /dmpSegments API
    • What's happening: You can now create a DMP lookalike segment through our segments API. A DMP lookalike segment helps you find similar audiences of an existing segment by storing the details of the segment. For example, if your current audience is small, use the lookalike segment to reach a larger group that shares similarities to your existing group. This segment helps you expand or reach new audience types.
  • New status for Matched Audience segments
    • Who's impacted: Partners using the adSegmentsV2 and dmpSegments API
    • What's happening: On October 30, 2019, we will launch new statuses and deprecate or replace existing ones for LinkedIn Matched Audiences. Learn more.
  • Manage your Matched Audiences with the ability to single or bulk delete
    • Who's impacted: Partners using the dmpSegments API
    • What's happening: Manage your Matched Audiences segments more efficiently by removing segments that are outdated or expired. Learn more.
  • Expand targeting facet combinations with the new boolean construct
    • Who's impacted: Partner that use the Ad Targeting API
    • What's happening: Use the new AND / OR construct to expand the ways you can combine different targeting facets and define target audiences in a more effective and efficient manner. Learn more. To leverage this feature, you must migrate to the new targetingCriteria object. Please see the migration guide for more detail.

August 2019

General API Updates

  • Manage your webhooks in the developer portal
    • Who can use this: Any developer using a webhooks API (currently available only for social action notifications on company posts to beta partners)
    • What's happening: We now offer self-serve webhook management. Developers can register and validate their webhook URLs prior to creating push event subscriptions. Learn more.
  • New status for creatives review
    • Who's impacted: Any partner using the adCreativesV2 API
    • What's happening: We've added a new AUTO_REJECTED value to the reviewStatus enum in the adCreativesV2 API. See here for reasons why an ad is rejected. Learn more.
  • Use DRAFT status for all creative types
    • Who's impacted: Any partner using the adCreativesV2 API
    • What's happening: Starting October 7, 2019, developers will be able to create, update, and read creatives that are in DRAFT status for all creative types through the Ads API. This means the search finder for adCreativesV2 will start to include creatives in DRAFT status that match the criteria. To exclude DRAFT creatives in your search, update your code to explicitly specify values for the search.status.values parameter before October 7, 2019.
  • Update your non-standard OAuth 2.0 requests
    • Who's impacted: All partners sending an empty bodied post to our platform.
    • What's happening: Starting November 15, 2019, non-standard HTTP POST requests that have an empty body without content-length header will no longer be supported and will result in a standard 411 status code. Please refer to this documentation for more details.
  • Update your app logo using a square image file
    • Who's impacted: All partners who have previously provided a URL for their app logo.
    • What's happening: Starting September 26, 2019, LinkedIn will no longer accept external URLs to be used as app logos. Users must upload a square image file with at least 100x100 pixels.

Lead Gen Forms

  • New features including: edit forms in draft mode and a new member profile link field
    • Who's impacted: Partners that use the Lead Gen Form API
    • What's happening:
      • Starting August 28, 2019, you can edit Lead Gen Forms (LGF) that are not attached to any creatives or only attached to creatives under a DRAFT campaign. Learn more.
      • Starting September 23, 2019, we're also adding the member profile URL as a new predefined form field option. Please ensure your integration can dynamically handle new predefined field ENUMs or is updated to handle this new value. If you choose not to support this new field, and your customer includes it in their LGF, it will not show up in reports pulled from your platform. Learn more.

Forecasting

  • New metric: maximum potential spend
    • Who's impacted: Partners using the Ad Supply Forecasts API.
    • What's happening: A new value for metricType called MAX_POTENTIAL_BUDGET has been added to the /adSupplyForecastsV2 resource. It enables you to understand total spend hypothetically available, if an advertiser has unlimited daily budget total budget.
  • Take advantage of enhanced forecasting
    • Who's impacted: Partners using the Ad Supply Forecasts API.
    • What's happening: Use new parameters (enableAudienceExpansion, enableAudienceNetwork, and optimizationTarget) to enhance forecasting by understanding the impact of enabling those campaign features. Learn more.
  • New metric types in forecasted results
    • Who's impacted: Partners using the Ad Supply Forecasts API
    • What's happening: New forecasting metrics available including: leads, message sends, video views, and more. Please refer to the updated documentation for the metricType field. Learn more.

Conversions & Insight Tag

  • Select your attribution type with new field attributionType
    • Who's impacted: All partners
    • What's happening: New field attributionType enables you to select your attribution type: multi-campaign or last-click. Last-click is a new attribution type that only counts the conversion towards the single, most recent campaign a member interacted (impression or click) with in the attribution window (1,7,30, 90 days), versus all campaigns. Learn more.
  • Customize your conversion window
    • Who's impacted: All partners
    • What's happening: New fields postClickAttributionWindowSize and viewThroughAttributionWindowSize enables you to customize a 1,7,30, or 90-day conversion window for a post-click or view-through conversions. The default conversion window for view-through is 7 days and post-click is 30 days. Learn more.
  • Conversion tracking through first-party cookies
    • Who's impacted: Any partner who tracks conversions via our Insight Tag.
    • What's happening: New field firstPartyTrackingEnabled offers the ability to track additional conversions through creation of first-party cookie, in addition to a third-party cookie, by sharing click IDs with LinkedIn that will be automatically added to landing page URLs for their ads. Learn more.
  • Auto-populate domains in your ad account
    • Who's impacted: Any partner who uses the Matched Audiences or Conversion Tracking API.
    • What's happening: Domains are now auto-populated in an ad account when a signal is received from the customer's website. You can also allow/block domains from attributing conversions, matched audiences and website demographics. As a result insightTagDomain will be deprecated and replaced with insightTagDomain V2 (see deprecation section below).

Deprecations & Removals

  • insightTagDomain replaced with insightTagDomain V2
    • Who's impacted: Any partner who tracks conversions via our Insight Tag.
    • What's happening: Since we are auto-populating domains (see above), this will eliminate the steps of creating a manual insight tag domain and map it to conversion rules. We recommend partners to move to new endpoint: Insight Tag Domains V2.
    • When: insightTagDomain is deprecated and will be removed November 26, 2019.
  • domainID & urlRules for conversion tracking, replaced with urlMatchRuleExpression
    • Who's impacted: Any partner who uses tracks conversions via our Insight Tag.
    • What's happening: domainID and urlRules fields are being deprecated because our system is no longer matching the domain while processing conversion events. There is no replacement for domainID. urlRules will be replaced with urlMatchRuleExpression that supports AND and OR operations. Learn more.
    • When: domainID and urlRules is deprecated and will be removed November 26, 2019.
  • adSupplyForecasts criteria finder resource has been removed
  • adBudgetPricing criteria finder resource has been removed