Udostępnij za pośrednictwem

Archived Marketing API Changes 2021

  • Artykuł

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.

November and December 2021

For this release, we are happy to share our perspective on the changing privacy landscape and our privacy-first approach to B2B digital advertising. First, we are introducing new approaches that help provide online consistency across channels and devices, all while limiting or even eliminating the use of third-party personal data. We’re beginning to test Group Identity for B2B leveraging our first-party data to group members together based on shared professional identity attributes, such as seniority and industry. Second, reaching your audience is only one part of effective digital advertising - B2B measurement must evolve, too. As part of the many paths that we’re exploring, we also are applying technologies to measure campaign success including: collecting conversions using first-party cookies, using artificial intelligence to measure conversions, and attributing offline conversions.These are a few of the solutions we’re testing, and we’ll continue to update you through this monthly newsletter.

Platform

  • Save time with the new OAuth Token Generator tool
    • Who’s impacted: All partners
    • What’s happening: The new OAuth token generator tool configures your app and generates access tokens for you, saving you time and allowing you to jump straight into exploring our APIs. Learn more.

Campaign Management

  • Try the new Video API open beta
    • Who’s impacted: All partners.
    • What’s happening: Video is the most engaging format on LinkedIn. And we’ve launched a new Video API open beta to make it easier to create video posts and ads, with thumbnails and captions capabilities. The API also now supports the ability to post on behalf of a member, and not just a company page. Learn how to create videos that deliver results on LinkedIn with these recommendations.. Please submit any feedback through Zendesk.
  • Sponsored Messaging EU Targeting Restrictions
    • Who’s impacted: Partners using the Message Ads API or Conversation Ads API
    • What’s happening: We are stopping the display of Message and Conversations Ads to EU members effective starting January 10, 2022 for new and existing campaigns. New and existing Message or Conversation Ads campaigns targeting EU members will fail with a 400 error. This only affects targeting members based in the EU. Targeting members outside the EU are not impacted.
  • Changes to conversion tracking on LinkedIn
    • Who’s impacted: Partner using the Insight Tag API
    • What’s happening: In light of changing regulations on privacy, we are asking customers to enable “enhanced conversion tracking” for all LinkedIn Campaign Manager accounts. “Enhanced conversion tracking” allows first-party cookie tracking to minimize impact to their campaign performance due to privacy changes. If a customer uses LinkedIn Insight Tags, we recommend they enable “enhanced conversion tracking” in Campaign Manager. If a customer uses site-wide image pixels, we recommend they switch to Insight Tag and enable “enhanced conversion tracking”. There is no impact to your integration. More information can be found in this help center article.

Page Management

  • [reminder] School mentions now require an organization ID
    • Who’s impacted: Partners using the Shares or UGC API to mention a School
    • What’s happening: If you are using a school URN (urn:li:school:{id}) to mention a school, starting November 30, 2021, you will be required to use an organization ID (urn:li:organization:{id}) to mention a school. After this date, you will get an error response when using the Share API with CREATE operations and a school URN is mentioned. Learn more.

Breaking Changes

  • [reminder] School Mentions for Shares and UGC API
    • Who’s impacted: Partners using the Shares or UGC API to mention a School
    • What’s happening: See Page Management section above
    • When: Starting November 30, 2021
  • [reminder] OAuth 2.0 scopes enforcement
    • Who’s impacted: All partners
    • What’s happening: LinkedIn will sunset all legacy OAuth permissions on December 31, 2021. To ensure that your integration’s OAuth flow is not impacted, your authorization request should only include permissions listed in your application settings. The complete permission list is under the “Auth” tab under “OAuth 2.0 scopes”. Existing access tokens and refresh tokens are not impacted.
    • When: December 31, 2021

October 2021

Platform

  • LinkedIn Marketing APIs now available on the Postman API Network
  • All access and refresh token requests should be made using only the POST method
    • Who’s impacted: All partners
    • What’s happening: Reminder that access and refresh token requests should be made using only the POST method with the request header “Content-Type”: “x-www-form-urlencoded” and all required parameters in the request body.

Reporting & ROI

  • Upcoming Reach & Frequency metric changes
    • Who’s impacted: Partners using the Ad Analytics API
    • What’s happening: In Q1 2022, we will announce the availability of 9 new metrics on the AdAnalyticsV2 API that will replace the existing approximateUniqueImpressions metric. These new metrics will approximate reach, frequency, and cost per 1,000 reached for three fixed time ranges: previous day, last 7 days, and last 30 days. You’ll be able to pull these metrics for any day. For example, you can pull the “average last 7-day reach” for October 25, (which covers October 18 - October 25), for October 24 (which covers October 17 - October 24), and selecting October 24 - October 25 will average the two individual last 7-day counts. Please plan accordingly to have time to migrate to these new metrics. The exact date for removal of the existing reach metric will be announced when the replacement metrics are available.

Page Management

  • [reminder] School mentions now require an organization ID
    • Who’s impacted: Partners using the Shares or UGC API to mention a School
    • What’s happening: If you are using a school URN (urn:li:school:{id}) to mention a school, starting November 30, 2021, you will be required to use an organization ID (urn:li:organization:{id}) to mention a school. After this date, you will get an error response when using the Share API with CREATE operations and a school URN is mentioned. Learn more.
  • [reminder] Companies endpoint sunset
    • Who’s impacted: Partners using the /v2/companies endpoint.
    • What’s happening: The /companies endpoint will be sunset and should be replaced with the Organization Lookup API. An example scenario is: /v2/companies?ids=123456&projection=(results*(organizationalEntity)) will become /v2/organizationsLookup?ids=123456
  • [reminder] Organization Entity ACL API sunset
    • Who's impacted: Any partner using Organization Entity ACLS API
    • What's happening: We are sunsetting the organizationalEntityAcls API in favor of the organizationAcls API. organizationalEntityAcls API will be removed on October 30, 2021. Learn more.

Breaking Changes

  • [reminder] New API call length requirements
    • Who’s impacted: All partners
    • What’s happening: To improve our network infrastructure and API traffic, we now require all API calls to meet the new length requirements. Requests exceeding the new length requirements will be rejected. To avoid calls being rejected, we recommend using query tunneling. See migration guide here.
    • When: Starting October 30, 2021
  • [reminder] Companies endpoint sunset
    • Who’s impacted: Partners using the /v2/companies endpoint
    • What’s happening: See Page Management section above
    • When: Starting October 30, 2021
  • [reminder] Organization Entity ACL API sunset
    • Who's impacted: Any partner using Organization Entity ACLS API
    • What’s happening: See Page Management section above
    • When: Starting October 30, 2021
  • [reminder] School Mentions for Shares and UGC API
    • Who’s impacted: Partners using the Shares or UGC API to mention a School
    • What’s happening: See Page Management section above
    • When: Starting November 30, 2021
  • [reminder] OAuth 2.0 scopes enforcement
    • Who’s impacted: All partners
    • What’s happening: LinkedIn will sunset all legacy OAuth permissions on December 31, 2021. To ensure that your integration’s OAuth flow is not impacted, your authorization request should only include permissions listed in your application settings. The complete permission list is under the “Auth” tab under “OAuth 2.0 scopes”. Existing access tokens and refresh tokens are not impacted.
    • When: December 31, 2021

September 2021

Campaign Management

  • Text Ads top rail sunset
    • Who’s impacted: Partners that support text ads
    • What’s happening: We have decided to shift the focus of our Text Ad engagement from the top rail to the desktop right rail experience exclusively to create a better member experience. Starting December 15, 2021, the top rail placement above all other pages will be removed. As a result, your customers may see a decrease in Text Ad campaign pacing and delivery.
  • Target companies based on company revenue
    • Who’s impacted: Partners using the adTargetingFacets and adTargetingEntities endpoints
    • What’s happening: We expanded our targeting functionality to include company revenue of the member’s primary employer(s) as a new facet. Learn More.
  • Engagement Retargeting
    • Who’s impacted: All partners
    • What’s happening: With the new Engagement Retargeting API, you can retarget an audience based on content engagement or member actions, such as video viewers or article reads. Learn more.
  • Updated API error messages for adSupplyForecasts to provide the most relevant information
    • Who’s impacted: Partners using the Ad Supply Forecasts API
    • What’s happening: Some of our error messages are updated (using standardized error schema, which includes new error details) to provide the specific information to make it easier to use our APIs. Use this information to create more specific forecasting error messages. Learn more.
  • New field for Ad Page Sets API: urlMatchRuleExpression
    • Who’s impacted: Partners using the Ad Page Sets API
    • What’s happening: A new field, urlMatchRuleExpression, will be available for /adPageSets, used to determine if a page view event matches and will replace the existing field matchRules. Learn more.

Audiences

  • Website Retargeting segments will now show a new state: ARCHIVED
    • Who’s impacted: Partners using Matched Audience website retargeting segments
    • What’s happening: Website retargeting segments that have not been updated or used in the last 30 days will be archived and can be identified with the new state, ARCHIVED. This will not impact your campaigns. Learn more.
  • Member interests and Matched Audiences lists targeting combination re-enabled
    • Who’s impacted: Partners who target member interest & traits AND with Matched Audiences of types contact list, marketing automation contact list and website retargeting.
    • What's happening: In March, we disabled the ability to include or exclude a contact list, contact marketing automation or website segment with a member interest or trait targeting, due to Apple’s App Tracking legal terms. Now, we’ve made changes to the member interest and traits to make them compliant, and we re-enabled the ability to create the above targeting combination in new campaigns.

Page Management

  • New lifecycle state field: ARCHIVED
    • Who’s impacted: Partners using the UGC API
    • What’s happening: A new ARCHIVED value has been added to the existing lifecycleState enum. Posts with this value will not be visible on LinkedIn. Posts with the lifecycleState field set to ARCHIVED may be retrieved.
  • School Mentions for Shares and UGC API
    • Who’s impacted: Partners using the Shares API to mention a School
    • What’s happening: If you are using a school URN (urn:li:school:{id}) to mention a school, starting November 30, 2021, you will be required to use an organization ID (urn:li:organization:{id}) to mention a school. After this date, you will get an error response when using the Share API with CREATE operations and a school URN is mentioned. Learn more.
  • [reminder] Companies endpoint sunset
    • Who’s impacted: Partners using the https://api.linkedin.com/v2/companies endpoint
    • What’s happening: The /companies endpoint will be sunset and should be replaced with the Organization Lookup API. An example scenario is: /v2/companies?ids=123456&projection=(results*(organizationalEntity)) will become /v2/organizationsLookup?ids=123456
  • [reminder] Organization Entity ACL API sunset
    • Who's impacted: Any partner using Organization Entity ACLS API
    • What's happening: We are sunsetting the organizationalEntityAcls API in favor of the organizationAcls API. organizationalEntityAcls API will be removed on October 30, 2021. Learn more.
  • [reminder] Geo-location migration for Shares and UGC APIs
    • Who’s impacted: Partners using Share Distribution Target or UGC Target Audience APIs
    • What’s happening: Similar to the Bing geo migration that migrated location data to a new geo data source for ads targeting, we are deprecating the locations field on Sept 30, 2021 and migrating to the new geoLocations field (already available) for organic (non-sponsored) targeted company Shares or UGC posts. Please use the Geo Typeahead API to get respective geoUrns to be used in the new geoLocations field. Learn more.

Breaking Changes

  • OAuth 2.0 scopes enforcement
    • Who’s impacted: All partners
    • What’s happening: LinkedIn will sunset all legacy OAuth permissions on December 31, 2021. To ensure that your integration’s OAuth flow is not impacted, your authorization request should only include permissions listed in your application settings. The complete permission list is under the “Auth” tab under “OAuth 2.0 scopes”. Existing access tokens and refresh tokens are not impacted.
    • When: December 31, 2021
  • [reminder] The legacy adBudgetPricing criteria finder will be sunset
    • Who’s impacted: Partners who use the criteria finder for adBudgetPricing to get insights on pricing metrics
    • What’s happening: The API will be sunset and criteriaV2 should be used instead.
    • When: Starting September 30, 2021
  • [reminder] Geo-location migration for Shares and UGC APIs
  • [reminder] Change to response header names
    • Who’s impacted: All partners
    • What’s happening: LinkedIn is changing how we generate our API HTTP response headers, and as a result headers will be all lowercase. Although RFC-2616 specifies that HTTP headers are case-insensitive, your software may be case-sensitive. Please ensure that your handling of LinkedIn headers is done without expecting a case-sensitive match so your integration doesn’t break.
    • When: Starting September 30, 2021, all APIs will return headers in lower case.
  • [reminder] New API call length requirements
    • Who’s impacted: All partners
    • What’s happening: To improve our network infrastructure and API traffic, we now require all API calls to meet the new length requirements. Requests exceeding the new length requirements will be rejected. To avoid calls being rejected, we recommend using Query Tunneling. See the query tunneling migration guide here.
    • When: Starting October 30, 2021
  • [reminder] Companies endpoint sunset
    • Who’s impacted: Partners using the https://api.linkedin.com/v2/companies endpoint
    • What’s happening: See Page Management section above
    • When: Starting October 30, 2021
  • [reminder] Organization Entity ACL API sunset
    • Who's impacted: Any partner using Organization Entity ACLS API
    • What’s happening: See Page Management section above
    • When: Starting October 30, 2021
  • School Mentions for Shares and UGC API
    • Who’s impacted: Partners using the Shares or UGC API to mention a School
    • What’s happening: See Page Management section above
    • When: Starting November 30, 2021

August 2021

Campaign Management

  • unitCost field required for manual or target-cost bidding campaigns
    • Who’s impacted: Partners using the Ad Campaign API
    • What’s happening: As a reminder, if you create a campaign using manual or target-cost bidding, ensure that the unitCost field is present and has a non-zero value. If the field is set to zero (0), the campaign will not deliver. Learn more.
  • Delete campaigns or campaign groups in draft mode
    • Who’s impacted: Partners using the Ad Campaign API and Campaign Group API
    • What’s happening: You can now delete campaigns or campaign groups that are in DRAFT status. Once deleted, these campaigns and campaign groups cannot be retrieved or recovered. Learn more about Campaign and Campaign Group changes.
  • [reminder] iOS device member trait sunset
    • Who’s impacted: Partners that enable targeting by iOS device
    • What’s happening: With Apple’s App Tracking Transparency (ATT) framework changes in place, we plan to sunset the iPhone user member trait starting August 31, 2021. New campaigns created with the iOS device segment will fail with a 400 error INVALID_VALUE_FOR_FIELD. Existing campaigns targeting the iOS device segment before August 31, 2021 can continue to run their campaigns without disruption. However, any campaign editing operations will fail with the validation error.

Reporting & ROI

  • Reach & Frequency Privacy Impact
    • Who’s impacted: Partners using the approximateUniqueImpressions metric from the Ad Analytics API
    • What’s happening: Due to the evolving privacy landscape, we can’t monitor the unique reach of member accounts using the same methodologies as before. As we work towards a better reach and frequency experience that embraces these new privacy initiatives, please note that a small portion of LinkedIn Audience Network traffic will be excluded from the current reach metric, so it may be slightly underestimated for Audience Network campaigns. Consequently, average frequency and cost per 1,000 member accounts reached may be slightly overestimated when using approximateUniqueImpressions in the calculations.
  • Brand Lift Testing Privacy Impact
    • Who’s impacted: Partners using the Brand Lift Testing API.
    • What’s happening: Due to industry-wide privacy changes, a small amount of traffic from the LinkedIn Audience Network is currently excluded from Brand Lift Tests. If your test includes campaigns that run on our Audience Network, then that portion of traffic won’t be reflected in your results.

Page Management

  • Companies endpoint sunset
    • Who’s impacted: Partners using the https://api.linkedin.com/v2/companies endpoint
    • What’s happening: The /companies endpoint will be sunset and should be replaced with the Organization Lookup API. An example scenario is: /v2/companies?ids=123456&projection=(results*(organizationalEntity)) will become /v2/organizationsLookup?ids=123456
  • Organization Entity ACL API sunset
    • Who's impacted: Any partner using Organization Entity ACLS API
    • What's happening: We are sunsetting the organizationalEntityAcls API in favor of the organizationAcls API. organizationalEntityAcls API will be removed on October 30, 2021. Learn more.
  • [reminder] Geo-location migration for Shares and UGC APIs
    • Who’s impacted: Partners using Share Distribution Target or UGC Target Audience APIs
    • What’s happening: Similar to the Bing geo migration that migrated location data to a new geo data source for ads targeting, we are deprecating the locations field on Sept 30, 2021 and migrating to the new geoLocations field (already available) for organic (non-sponsored) targeted company Shares or UGC posts. Please use the Geo Typeahead API to get respective geoUrns to be used in the new geoLocations field. Learn more.
  • [reminder] New API for company search
    • Who’s impacted: Partners who search companies using industry, location, or other company facets.
    • What’s happening: If you are currently using the /search?q=companiesV2 endpoint to find companies with industry, location, and other criteria, this endpoint will be deprecated and replaced with a new endpoint: /companySearch?q=search API. The old endpoint will be removed on August 31, 2021. Learn more.

Breaking Changes

  • [reminder] New API for company search
    • Who’s impacted: Partners who search companies using industry, location, or other company facets
    • What’s happening: See Page Management section above
    • When: Starting August 31, 2021
  • [reminder] iOS device member trait sunset
    • Who’s impacted: Partners that enable targeting by iOS device
    • What’s happening: See Campaign Management section above
    • When: Starting August 31, 2021
  • The legacy adBudgetPricing criteria finder will be sunset
    • Who’s impacted: Partners who use the criteria finder for adBudgetPricing to get insights on pricing metrics
    • What’s happening: The API will be sunset and criteriaV2 should be used instead.
    • When: Starting September 30, 2021
  • [reminder] Geo-location migration for Shares and UGC APIs
  • Change to response header names
    • Who’s impacted: All partners
    • What’s happening: LinkedIn is changing how we generate our API HTTP response headers, and as a result headers will be all lowercase. Although RFC-2616 specifies that HTTP headers are case-insensitive, your software may be case-sensitive. Please ensure that your handling of LinkedIn headers is done without expecting a case-sensitive match so your integration doesn’t break.
    • When: Starting September 30, 2021, all APIs will return headers in lower case.
  • [reminder] New API call length requirements
    • Who’s impacted: All partners
    • What’s happening: To improve our network infrastructure and API traffic, we now require all API calls to meet the new length requirements. Requests exceeding the new length requirements will be rejected. To avoid calls being rejected, we recommend using query tunneling. See migration guide here.
    • When: Starting October 30, 2021
  • Companies endpoint sunset
    • Who’s impacted: Partners using the /v2/companies endpoint
    • What’s happening: See Page Management section above
    • When: Starting October 30, 2021
  • Organization Entity ACL API sunset
    • Who's impacted: Any partner using Organization Entity ACLS API
    • What’s happening: See Page Management section above
    • When: Starting October 30, 2021

July 2021

Campaign Management

  • Change to default campaign group name.

    • Who’s impacted: Partners using the Ad Campaign Group API.
    • What’s happening: Whenever an ad account is created, a campaign group is automatically created. Previously, it was called "default campaign group" and now it's called "new campaign group". When searching for the campaign group, make sure to use the new campaign group name.

  • iOS device member trait sunset

    • Who’s impacted: Partners that enable targeting by iOS device.
    • What’s happening: With Apple’s App Tracking Transparency (ATT) framework changes in place, we plan to sunset the iPhone user member trait starting August 31, 2021. New campaigns created with the iOS device segment will fail with a 400 error INVALID_VALUE_FOR_FIELD. Existing campaigns targeting the iOS device segment before August 31, 2021 can continue to run their campaigns without disruption. However, any campaign editing operations will fail with the validation error.

Reporting & ROI

  • Schedule field now required to run a Brand Lift test
    • Who’s impacted: Partners using the Ad Lift Test API.
    • What’s happening: When calling the budget validation endpoint, you are now required to provide the schedule field to indicate how long the lift test will be running.

Page Management

  • [reminder] Geo-location migration for Shares and UGC APIs
    • Who’s impacted: Partners using Share Distribution Target or UGC Target Audience APIs.
    • What’s happening: Similar to the Bing geo migration that migrated location data to a new geo data source for ads targeting, we are deprecating the locations field on Sept 30, 2021 and migrating to the new geoLocations field (already available) for organic (non-sponsored) targeted company Shares or UGC posts. Please use the Geo Typeahead API to get respective geoUrns to be used in the new geoLocations field. Learn more.
  • [reminder] New API for company search
    • Who’s impacted: Partners who search companies using industry, location, or other company facets.
    • What’s happening: If you are currently using the /search?q=companiesV2 endpoint to find companies with industry, location, and other criteria, this endpoint will be deprecated and replaced with a new endpoint: /companySearch?q=search API. The old endpoint will be removed on August 31, 2021. Learn more.
  • Changes to certain fields used in company search API filters
    • Who’s impacted: Partners who search companies using country region, followers range, location projection.
    • What’s happening: Field companyCountryRegion is no longer supported in the filter. followersRange is renamed to followersSize with updated valid values and location projection is renamed to locations. Learn more.
  • Commentary length limit increase
    • Who’s impacted: Partner using the Shares or UGC API.
    • What’s happening: UGC (shareCommentary.text field) and Share (text field) APIs increased the maximum text length limit from 1,300 to 3,000 characters.

Breaking Changes

  • [reminder] New API for company search
    • Who’s impacted: Partners who search companies using industry, location, or other company facets.
    • What’s happening: See Page Management section above.
    • When: The old endpoint will be removed on August 31, 2021.
  • iOS device member trait sunset
    • Who’s impacted: Partners that enable targeting by iOS device.
    • What’s happening: See Campaign Management section above.
    • When: iPhone user member trait will be removed on August 31, 2021.
  • [reminder] Geo-location migration for Shares and UGC APIs
  • [reminder] New API call length requirements
    • Who’s impacted: All partners.
    • What’s happening: To improve our network infrastructure and API traffic, we now require all API calls to meet the new length requirements. Requests exceeding the new length requirements will be rejected. To avoid calls being rejected, we recommend using query tunneling. See migration guide here.
    • When: Starting October 30, 2021, we will reject calls that do not meet the new requirements.

June 2021

Reporting & ROI

  • Get a demographic breakdown for your Brand Lift tests
    • Who’s impacted: Partners using the new Ad Lift Test API
    • What’s happening: You can now see raw survey results and lift metrics broken down by member demographic for your LinkedIn Brand Lift tests with these new fields: adLiftTestSurveyResponseMemberDemographicBreakdowns and adLiftTestResultMetricMemberDemographicBreakdowns. Learn more. Note: we are making this feature available via the API first; it will appear in the LinkedIn UI soon.
  • Standardized error codes for Brand Lift Tests
    • Who’s impacted: Partners using the Ad Lift Test API
    • What’s happening: The Ad Lift Test API will now return robust error messages and service-level error codes including the complete metadata of what fields are causing the errors and actions required to help you troubleshoot. Learn more.

Page Management

  • [breaking change] Geo-location migration for Shares and UGC APIs
    • Who’s impacted: Partners using Share Distribution Target or UGC Target Audience APIs
    • What’s happening: Similar to the Bing geo migration that migrated location data to a new geo data source for ads targeting, we are deprecating the locations field on Sept 30, 2021 and migrating to the new geoLocations field (already available) for organic (non-sponsored) targeted company Shares or UGC posts. Please use the Geo Typeahead API to get respective geoUrns to be used in the new geoLocations field.
  • [reminder] New API for company search
    • Who’s impacted: Partners who search companies using industry, location, or other company facets.
    • What’s happening: If you are currently using the /search?q=companiesV2 endpoint to find companies with industry, location, and other criteria, this endpoint will be deprecated and replaced with a new endpoint: /companySearch?q=search API. The old endpoint will be removed on August 31, 2021. Learn more.

Breaking Changes

  • [reminder] New error response schema
    • Who’s impacted: Partners using the adAccountsV2 API
    • What’s happening: Last year, we introduced new error response fields (errorDetailType and errorDetails) and updated HTTP status codes for the adCampaignsGroups and adCampaigns API. Now, we are introducing the same changes for the adAccounts API. Make sure to check if you have parsed these fields and update your error parsing logic to account for the new error fields and the updated HTTP codes, as necessary. Learn more.
    • When: These changes will be implemented on July 24, 2021. Please make sure your parsing logic accounts for the changes. *[reminder] New API for company search
    • Who’s impacted: Partners who search companies using industry, location, or other company facets
    • What’s happening: See Page Management section above
    • When: The old endpoint will be removed on August 31, 2021
  • Geo-location migration for Shares and UGC APIs

May 2021

Reporting & ROI

  • Increased daily retention for campaign metrics
    • Who’s impacted: Partners using the adAnalyticsV2 API
    • What’s happening: Historically, when querying for campaign performance and engagement data by member attributes (e.g. MEMBER_JOB_TITLE, MEMBER_COMPANY, etc.) we have offered 6 months of retention for queries using the DAILY time granularity and 2 years of retention for the MONTHLY and YEARLY granularities. Today, we will begin ramping a consistent 2 years retention regardless of the time granularity used.

Page Management

  • Introducing Roles & Permissions
    • Who’s impacted: Partners using the Organization Access Control API
    • What’s happening: New Roles & Permissions on LinkedIn Pages make it easier than ever for teams to work remotely and collaboratively. Now admins can take one of three new roles within an organic hierarchy to access their Page and maintain distributed access with increased security. Through this new API, partners will check permissions for each user and match the user’s access level determined by their assigned role on the Page. Learn more
    • There are three new roles introduced in Organization Access Control API, including:
      • Content admin – has permission to create and manage Page content, including updates (as well as boosting updates), Events, Stories, and jobs.
      • Curator – has permission to view Content Suggestions, create recommended content, and view and * export Page analytics.
      • Analyst – has permission to monitor the Page’s performance through analytics to help drive goals.
    • The new Organization Authorizations API (/organizationAuthorizations) can be used to implement the same permission checks as the Organization Access Control API (/organizationsAcls). Please refer to the Role to Permission Mapping table in Getting Started, or see the Overview Page to learn more.
  • [breaking change] New API for company search
    • Who’s impacted: Partners who search companies using industry, location, or other company facets.
    • What’s happening: If you are currently using the /search?q=companiesV2 endpoint to find companies with industry, location, and other criteria, this endpoint will be deprecated and replaced with a new endpoint /companySearch?q=search API. The old endpoint will be removed on August 31, 2021. Learn more.
  • Video Posts can now be created on member feeds
    • Who’s impacted: Partners using the UGC API
    • What’s happening: You can now use the UGC API to create video posts on behalf of a member and be posted on their member profile. Make sure the author references a member urn and not an organization. Learn more.
  • [reminder] Shares and UGC Posts Article Type Posts
    • Who’s impacted: Partners using the Shares and UGC Posts APIs
    • What’s happening: Starting May 31, 2021, for article type posts the description, title, and thumbnail will be set from LinkedIn’s URL Preview of the URL only if the description, title, and thumbnail are not provided from the API call. Prior to this change, each field was set from LinkedIn’s URL Preview if the specific field was not set. If a specific representation of the post is desired, set the description, title, or thumbnail fields, rather than rely on automatic preview. Use the Post Inspector tool to determine what the LinkedIn URL Preview looks like.

Breaking Changes

  • New error response schema
    • Who’s impacted: Partners using the adAccountsV2 API
    • What’s happening: Last year, we introduced new error response fields (errorDetailType and errorDetails) and updated HTTP status codes for the adCampaignsGroups and adCampaigns API. Now, we are introducing the same changes for the adAccounts API. Make sure to check if you have parsed these fields and update your error parsing logic to account for the new error fields and the updated HTTP codes, as necessary. Learn more.
    • When: These changes will be implemented on July 24, 2021. Please make sure your parsing logic accounts for the changes.
  • New API for company search
    • Who’s impacted: Partners who search companies using industry, location, or other company facets
    • What’s happening: See Page Management section above
    • When: The old endpoint will be removed on August 31, 2021
  • [reminder] Shares and UGC Posts Article Type Posts
    • Who’s impacted: Partners using the Shares and UGC Posts APIs
    • What’s happening: See Page Management section above
    • When: Starting May 31, 2021

April 2021

Reporting & ROI

  • Introducing LinkedIn Brand Lift Testing
    • What’s happening: Use the new Ad Lift Test API to create a brand lift test and gauge the impact of your ads on brand metrics that you care about: awareness, consideration, familiarity, favorability, and more. Better measure your brand marketing efforts and optimize for future brand value. Learn more.
  • Use the Ads Review Information API to check the status of a Brand Lift test
    • Who’s impacted: Partners using the new Ad Lift Test API
    • What’s happening: Use this new API to understand if a Brand Lift test has been approved or rejected and potential rejection reasons to better troubleshoot. Before calling the endpoint, make sure to obtain the brandLiftTest urn and the reviewVersionTag of the specific version of the entity being tested. Learn more.
  • Metrics grouped by member demographics now require longer processing time
    • Who’s impacted: Partners using the adAnalyticsV2 API
    • What’s happening: Metrics grouped by member demographics, such as company size and job function, will now be available in 12-24 hours. Historically this data was available within a few hours. The change is a first step towards scaling our systems to provide greater value. There is no change to performance metrics, such as those reported by creative, campaign or account, which will continue to be near real-time.

Page Management

  • [Reminder] Shares and UGC Posts Article Type Posts
    • Who’s impacted: Partners using the Shares and UGC Posts APIs
    • What’s happening: Starting May 31, 2021, for article type posts the description, title, and thumbnail will be set from LinkedIn’s URL Preview of the URL only if the description, title, and thumbnail are not provided from the API call. Prior to this change, each field was set from LinkedIn’s URL Preview if the specific field was not set. If a specific representation of the post is desired, set the description, title, or thumbnail fields, rather than rely on automatic preview. Use the Post Inspector tool to determine what the LinkedIn URL Preview looks like.

Audiences

  • [Reminder] New API rate limits for DMP streaming
    • Who’s impacted: Partners using the DMP streaming API
    • What’s happening: Starting April 30, 2021, we will be introducing granular rate limits for our DMP streaming APIs Users & Companies to prevent abuse, ensure service stability, and consistent API availability. These limits will be enforced in addition to your current daily limits, which can be found through Developer Portal > My Apps > App > Analytics > Quotas and usage.

Breaking Changes

  • [Reminder] New API rate limits for DMP streaming
    • Who’s impacted: Partners using the DMP streaming API
    • What’s happening: See Audiences section above
    • When: Starting April 30, 2021, we will be introducing granular rate limits for our DMP streaming APIs.
  • [Reminder] Shares and UGC Posts Article Type Posts
    • Who’s impacted: Partners using the Shares and UGC Posts APIs
    • What’s happening: See Page Management section above
    • When: Starting May 31, 2021

Developer Platform

  • Use the new API product endpoint catalog to know what you have access to
    • Who’s impacted: All partners
    • What’s happening: Use this new Developer Portal tool to get a holistic view of the endpoints and permissions your application has access to. Easily view, sort, and filter through all the endpoints associated with an API product. Get started by visiting the Products tab under any application and select view endpoints for any product. Learn more.

March 2021

Campaign Management

  • Sharing an update on our plans for IDFA
    • One of the bigger industry shifts is Apple’s upcoming changes to Identifier for Advertising (IDFA), which companies use for tracking and ad targeting. We are committed to privacy-by-design principles that deliver value to our shared customers. As such, we have decided to stop our iOS apps’ collection of IDFA data for now. Although this change affects the LinkedIn Audience Network (LAN), Conversion Tracking and Matched Audiences, we expect limited impact to campaign performance. Our plan is to leverage our first-party data to help marketers reach buyer groups, which are critical for success in B2B marketing. We’ll update you next quarter on our progress and will share what we’ve learned along the way. Learn more.
  • Change to ad review rejection reasons
    • Who’s impacted: Partners using the Ad Creatives and Ad Forms API
    • What’s happening: LinkedIn does not allow ads that could capitalize from, exploit or sensationalize the currently monitored sensitive event. Therefore, we've added two new rejection reasons: prohibited political content and current sensitive events. We have also deprecated the existing reasons: prohibited political or religious content. Learn more.

Page Management

  • For the first time, get real-time notifications for social actions, now including mentions.
    • Who’s impacted: All partners
    • What’s happening: Organization social actions webhooks enables you to receive real time notification on engagement with a LinkedIn Page or post. Use it to receive real-time activity for likes, comments, shares and mentions. Learn more.
  • Shares and UGC Posts Article Type Posts
    • Who’s impacted: Partners using the Shares and UGC Posts APIs
    • What’s happening: Starting May 31, 2021, for article type posts the description, title, and thumbnail fields will be set from LinkedIn’s URL Preview of the URL only if the description, title, and thumbnail are not provided from the API call. Prior to this change, each field was set from LinkedIn’s URL Preview if the specific field was not set. This feature has always been the best effort and when fields are not present in the URL Preview, then it will not be set. If a specific representation of the post is desired, then it is recommended that partners set the description, title, or thumbnail fields rather than rely on automatic preview from this feature. LinkedIn provides Post Inspector, a tool to determine what LinkedIn’s URL Preview looks like. The tool uses slightly different naming. The three fields can be found under Properties with description and title named the same and Image corresponding to thumbnails.
  • [Reminder] Shares and UGC Posts Article Thumbnails
    • Who’s impacted: Partners using the Shares and UGC Posts APIs
    • What’s happening: Starting March 31, 2021, only the first thumbnail will be kept per content entity or share media. Any thumbnails beyond the first will be removed. The specific fields impacted are thumbnails in the ShareMedia of UGC Posts and thumbnails in ShareContent of Shares. If the first thumbnail does not have the required url field set and thus is invalid then this will result in no thumbnail regardless of if there are any thumbnails beyond the first.
  • [Reminder] Shares and UGC Posts Validations
    • Who’s impacted: Partners using the Shares and UGC Posts APIs
    • What’s happening: Starting March 31, 2021, the following length validations will be added to the following String fields in Shares and UGC Posts APIs. Posts that violate these validations will be rejected with a 422 HTTP error code and message indicating the field that is out of range along with the valid range.
      • The following length validations will be added to UGC Posts:
        • ShareContent primaryLandingPageUrl: 2000 length limit
        • ShareMedia landingPage.landingPageUrl: 2000 length limit
        • ShareMedia originalUrl: 8192 length limit
        • ShareMedia thumbnail.altText: 4086 length limit
        • ShareMedia thumbnail.url: 8192 length limit
      • The following length validations will be added to Shares:
        • Share Content landingPageUrl: 2000 length limit
        • Share Content contentEntities[i].landingPageUrl: 2000 length limit
        • Share Content contentEntities[i].entityLocation: 8192 length limit
        • Share Content contentEntities[i].thumbnails[j].resolvedUrl: 8192 length limit

Audiences

  • Changes to targeting combination due to Apple’s App Tracking terms
    • Who’s impacted: Partners who target member interest & traits AND with Matched Audiences of types contact list, marketing automation contact list and website retargeting.
    • What’s happening: As per Apple’s App Tracking (ATT) legal terms we cannot link information inferred from user activity data on iOS app with any third party data for the purposes of ad targeting. With this, we are preventing customers from including or excluding a contact list, contact marketing automation or website segment with a member interest or trait targeting segments.
    • What does this mean for your application?
      • New campaigns created with the targeting combination mentioned above will fail with the following error:
      • Error code: INCOMPATIBLE_TARGETING_COMBINATION_FOR_ APP_TRACKING_TRANSPARENCY
      • Error message format: Facet {field1} with value(s) {value1} cannot be AND'ed together with {field2} to comply with app tracking transparency requirements.
        • field1: the targeting facet being checked
        • value1: the targeting facet value corresponding to field1
        • field2: the facets that are incompatible with field1
      • Please refer to the API documentation for the list of incompatible combinations.
    • Existing campaigns created prior to March 29, 2021 will continue to serve as before. However, any updates to targeting criteria with incompatible combinations post March 29 will fail with the error mentioned above.
  • [Reminder] New API rate limits for DMP streaming
    • Who’s impacted: Partners using the DMP streaming API
    • What’s happening: Starting April 30, 2021, we will be introducing granular rate limits for our DMP streaming APIs Users & Companies to prevent abuse, ensure service stability, and consistent API availability. These limits will be enforced in addition to your current daily limits, which can be found through Developer Portal > My Apps > App > Analytics > Quotas and usage.
      • What does this mean for my application? If your application calls /dmpSegments/users or /dmpSegments/companies, you may get a HTTP 429 response if calling the endpoints too frequently, indicating that you are exceeding the rate limits.
      • How do I handle API calls that are throttled? Your application should be catching errors when making calls to /dmpSegment/users and /dmpSegment/companies and retry after a minimum of 1 second whenever you receive an HTTP 429 response.
      • Can I get the limits increased for my application? No, the limits we intend to enforce will not be customizable at an application level. However the limits will be enforced such that there is minimal interruption to existing applications.
      • My application creates a significant amount of automated API calls (eg. one time full data dump or weekly data pushes with large volumes followed by smaller traffic that contains diffs throughout the week). Will this rate limit affect my throughput ? If the volume of your automated traffic exceeds tens of millions, then you can expect to see frequent throttling. While this might affect the throughput of your API calls, you will not see any differences in the matched audience processing SLA.

Breaking Changes

  • Changes to targeting combination due to Apple’s App Tracking terms
    • Who’s impacted: Partners who target member interest & traits AND with Matched Audiences of types contact list, marketing automation contact list and website retargeting.
    • What’s happening: See Audiences section above
    • When: Starting March 29, 2021
  • Shares and UGC Posts Article Type Posts
    • Who’s impacted: Partners using the Shares and UGC Posts APIs
    • What’s happening: See Page Management section above
    • When: Starting May 31, 2021
  • [Reminder] Shares and UGC Posts Validations
    • Who’s impacted: Partners using the Shares and UGC Posts APIs
    • What’s happening: See Page Management section above
    • When: Starting March 31, 2021
  • [Reminder] New API call length requirements
    • Who’s impacted: All partners
    • What’s happening: To improve our network infrastructure and API traffic, we now require all API calls to meet the new length requirements. Requests exceeding the new length requirements will be rejected. To avoid calls being rejected, we recommend using query tunneling. See migration guide here.
    • When: Starting March 31, 2021, we will reject calls that do not meet the new requirements.
  • [Reminder] New API rate limits for DMP streaming
    • Who’s impacted: Partners using the DMP streaming API
    • What’s happening: See Audiences section above
    • When: Starting April 30, 2021, we will be introducing granular rate limits for our DMP streaming APIs.

February 2021

Campaign Management

  • [Reminder] Support for additional currencies
    • Who’s impacted: Partners using the adAccountsV2 API
    • What’s happening: The account creation endpoint adAccountsV2 will support creating ad accounts with 14 new currencies. Learn more.

Page Management

  • Shares and UGC Posts Article Thumbnails
    • Who’s impacted: Partners using the Shares and UGC Posts APIs
    • What’s happening: Starting March 31, 2021, only the first thumbnail will be kept. Any thumbnails beyond the first will be removed. The specific fields impacted are thumbnails in the ShareMedia of UGC Posts and thumbnails in ShareContent of Shares. If the first thumbnail does not have the required url field set and thus is invalid then this will result in no thumbnail regardless of if there are any thumbnails beyond the first.
  • Shares and UGC Posts Validations
    • Who’s impacted: Partners using the Shares and UGC Posts APIs
    • What’s happening: Starting March 31, 2021, the following length validations will be added to the following String fields in Shares and UGC Posts APIs. Posts that violate these validations will be rejected with a 422 HTTP error code and message indicating the field that is out of range along with the valid range.
      • The following length validations will be added to UGC Posts:
        • ShareContent primaryLandingPageUrl: 2000 length limit
        • ShareMedia landingPage.landingPageUrl: 2000 length limit
        • ShareMedia originalUrl: 8192 length limit
        • ShareMedia thumbnail.altText: 4086 length limit
        • ShareMedia thumbnail.url: 8192 length limit
      • The following length validations will be added to Shares:

Audiences

  • [Reminder] Returning Organization Urn in AdTargetingEntities API school typeahead results
    • Who’s impacted: Partners using the AdTargetingEntities API to identify targeting school segments using the typeahead finder
    • What’s happening: Starting March 1, 2021, we return an Organization Urn (E.g.:urn:li:organization:1646 for Harvard University) in place of a School Urn (E.g.:urn:li:school:18483 for Harvard University). No schema change is involved. The only change is the entity type and ID of each urn. To convert a saved school urn to an organization urn, call the Find Entities by Typeahead finder with the same school entity name to get the corresponding organization urn. Learn more.
  • [Reminder] New API rate limits for DMP streaming
    • Who’s impacted: Partners using the DMP streaming API What’s happening: Starting March 31, 2021, we will be introducing granular rate limits for our DMP streaming APIs Users & Companies to prevent abuse, ensure service stability, and consistent API availability. These limits will be enforced in addition to your current daily limits, which can be found through Developer Portal > My Apps > App > Analytics > Quotas and usage.
      • What does this mean for my application? If your application calls /dmpSegments/users or /dmpSegments/companies, you may get a HTTP 429 response if calling the endpoints too frequently, indicating that you are exceeding the rate limits.
      • How do I handle API calls that are throttled? Your application should be catching errors when making calls to /dmpSegment/users and /dmpSegment/companies and retry after a minimum of 1 second whenever you receive an HTTP 429 response.
      • Can I get the limits increased for my application? No, the limits we intend to enforce will not be customizable at an application level. However the limits will be enforced such that there is minimal interruption to existing applications.
      • My application creates a significant amount of automated API calls (eg. one time full data dump or weekly data pushes with large volumes followed by smaller traffic that contains diffs throughout the week). Will this rate limit affect my throughput ? If the volume of your automated traffic exceeds tens of millions, then you can expect to see frequent throttling. While this might affect the throughput of your API calls, you will not see any differences in the matched audience processing SLA.

Breaking Changes

  • Shares and UGC Posts Validations
    • Who’s impacted: Partners using the Shares and UGC Posts APIs
    • What’s happening: See Page Management section above
    • When: Starting March 31, 2021
  • [Reminder] New API call length requirements
    • Who’s impacted: All partners
    • What’s happening: To improve our network infrastructure and API traffic, we now require all API calls to meet the new length requirements. Requests exceeding the new length requirements will be rejected. To avoid calls being rejected, we recommend using query tunneling. See migration guide here.
    • When: Starting March 31, 2021, we will reject calls that do not meet the new requirements.
  • [Reminder] New API rate limits for DMP streaming
    • Who’s impacted: Partners using the DMP streaming API
    • What’s happening: See Audiences section above
    • When: Starting March 31, 2021, we will be introducing granular rate limits for our DMP streaming APIs.

January 2021

Campaign Management

  • New optimization target to maximize reach
    • Who’s impacted: Partners using the Ad Supply Forecasts and adCampaignsV2 APIs to create new campaigns optimizing for unique member accounts.
    • What’s happening: A new optimization target (MAX_REACH) will be available under the Brand Awareness objective that aims to maximize the number of unique member accounts reached. The new OptimizationTargetType is usable specifically for the Brand Awareness objective and a new metric type (Reach & Reach per Million Impressions) under forecasting to show predicted number of new members reached, as well as the frequency they see an ad. Learn more.

Audiences

  • Returning Organization Urn in AdTargetingEntities API school typeahead results
    • Who’s impacted: Partners using the AdTargetingEntities API to identify targeting school segments using the typeahead finder
    • What’s happening: Starting March 1, 2021, we return an Organization Urn (E.g.:urn:li:organization:1646 for Harvard University) in place of a School Urn (E.g.:urn:li:school:18483 for Harvard University). No schema change is involved. The only change is the entity type and ID of each urn. To convert a saved school urn to an organization urn, call the Find Entities by Typeahead finder with the same school entity name to get the corresponding organization urn. Learn more.
  • [reminder] New API rate limits for DMP streaming
    • Who’s impacted: Partners using the DMP streaming API What’s happening: Starting March 31, 2021, we will be introducing granular rate limits for our DMP streaming APIs (Users & Companies) to prevent abuse, ensure service stability, and consistent API availability. These limits will be enforced in addition to your current daily limits, which can be found through Developer Portal > My Apps > App > Analytics > Quotas and usage.
      • What does this mean for my application? If your application calls /dmpSegments/users or /dmpSegments/companies, you may get a HTTP 429 response if calling the endpoints too frequently, indicating that you are exceeding the rate limits.
      • How do I handle API calls that are throttled? Your application should be catching errors when making calls to /dmpSegment/users and /dmpSegment/companies and retry after a minimum of 1 second whenever you receive an HTTP 429 response.
      • Can I get the limits increased for my application? No, the limits we intend to enforce will not be customizable at an application level. However the limits will be enforced such that there is minimal interruption to existing applications.
      • My application creates a significant amount of automated API calls (eg. one time full data dump or weekly data pushes with large volumes followed by smaller traffic that contains diffs throughout the week). Will this rate limit affect my throughput ? If the volume of your automated traffic exceeds tens of millions, then you can expect to see frequent throttling. While this might affect the throughput of your API calls, you will not see any differences in the matched audience processing SLA.

Breaking Changes

  • [reminder] New API call length requirements
    • Who’s impacted: All partners
    • What’s happening: To improve our network infrastructure and API traffic, we now require all API calls to meet the new length requirements. Requests exceeding the new length requirements will be rejected. To avoid calls being rejected, we recommend using query tunneling. See migration guide here.
    • When: Starting March 31, 2021, we will reject calls that do not meet the new requirements.
  • [reminder] New API rate limits for DMP streaming
    • Who’s impacted: Partners using the DMP streaming API
    • What’s happening: See Audiences section above
    • When: Starting March 31, 2021, we will be introducing granular rate limits for our DMP streaming APIs.