adCreatives

The LinkedIn ads platform supports a number of ad formats for an ads campaign.  For more information on these formats, please see Advertising Specifications for Sponsored Content and Text Ads .

Use the Ad Creatives API to create and manage creatives for ads campaigns.

Supported Methods

CREATE | GET | FINDERS | UPDATE

Schema

Field Name Sub-Field Name Type Description
campaign   sponsoredCampaignUrn URN identifying the campaign associated with the creative
reference   optional URN A reference URN for this object to an external system, with semantics varying based on the creative type. SSU creative must contain a valid activity/share reference. If the activity/share has an associated company actor, it must match the parent campaign's reference. SSU creative reference cannot be modified after creation. Reference is not applicable and is not set for text ad creative.
status   creativeStatus
  • ACTIVE - Creative creation is complete and creative is available for review and serve
  • PAUSED - Creative creation is complete and creative is current, but should temporarily not be served
  • DRAFT - Creative creation is incomplete and may still be edited
  • ARCHIVED - Creative creation is complete, but creative should not be served and should be separated from non-archived creatives in any UI
  • CANCELED - Creative is permanently canceled Note: Creative status is set independently from parent entity status, but parent entity status overrides creative status in effect. For example, parent entity status may be PAUSED while creative status is ACTIVE, in which case creative is in effect PAUSED, and not served.
type   creativeType
  • TEXT_AD - Text with sponsored link to landing page on your site
  • SPONSORED_STATUS_UPDATE - Sponsored status update from a profile page
variables   creativeVariables Variables for rendering the creative
  clickUri optional URI URI destination to forward on a click
  data Union Data of the creative according to its type Valid values are TextAdCreativeVariables and/or SponsoredUpdateCreativeVariables
servingStatuses   string[] Array of enums that determine whether or not a creative may be served. Unlike status, which is user-managed, the values are controlled by the service. This is a read-only field. Possible values are:
  • RUNNABLE Creative is eligible for serving.
  • STOPPED Creative is stopped by the advertiser.
  • UNDER_REVIEW Creative cannot be served because it has not been reviewed.
  • REJECTED Creative cannot be served because it was reviewed and rejected.
  • FORM_HOLD Creative cannot be served because the creative is associated with a form and the form is currently not eligible to serve.
  • PROCESSING Creative is being processed.
  • PROCESSING_FAILED Creative failed processing. The failure reasons can be found in corresponding CreativeProcessingState::failureReasons.
  • REFERRED_CONTENT_QUALITY_HOLD Creative cannot be served because the creative is associated with an entity (UGC/vector asset etc) that is currently not eligible to serve for quality reasons like spam.
  • JOB_POSTING_ON_HOLD For Single Job Ad, if Job State is in review or suspended, job posting is no longer viewable to members. The associated creatives should be held for serving. This will be saved in servingStatusOnHold column. Once job posting goes back to listed state, this servingStatusOnHold flag will be removed.
  • JOB_POSTING_INVALID For Single Job Ad, if Job State is closed, deleted, member can not apply to the job, single job ad should not be served. This will be saved in servingStatusOnhold column.

TextAdCreativeVariables

Field Name Type Description
text string Body text of the creative.
title string Title of the creative.

SponsoredUpdateCreativeVariables

Field Type Description
activity optionalActivityUrn URN identifying the sponsored activity. This field is read only and is derived from creative reference.
directSponsoredContent boolean, default="false" Indicate whether the creative is a direct sponsored content (DSC) or not. The direct sponsored content allows an advertiser to sponsor content without first publishing the content on a Company Page or Showcase Page. The field is read only.
share optionalShareUrn URN identifying the sponsored share. This field is read only and is derived from creative reference.

CREATE

POST https://api.linkedin.com/v2/adCreativesV2

sample request body

{
    "campaign": "urn:li:sponsoredCampaign:10879951",
    "reference": "urn:li:share:1234567890",
    "status": "ACTIVE",
    "type": "SPONSORED_STATUS_UPDATE",
    "variables": {
        "data": {
            "com.linkedin.ads.SponsoredUpdateCreativeVariables": {}
        }
    }
}

GET

GET https://api.linkedin.com/v2/adCreativesV2/{creative ID}

Parameters

Field Name Description
creative ID Unique numerical identifier for the ad creative

Sample Response

{
    "campaign": "Test campaign",
    "status": "CANCELED",
    "type": "TEXT_AD",
    "variables": {
        "data": {
            "com.linkedin.ads.SponsoredUpdateCreativeVariables": {
                "directSponsoredContent": false
            }
        }
    }
}

FINDERS

SEARCH FINDER

GET https://api.linkedin.com/v2/adCreativesV2?q=search&search.{searchCriteria}.values[0]={searchValue}

Parameters

Field Name Description
search.campaign.value Searches for creatives associated with the provided sponsored campaign URN
search.id.value Searches for creatives with the provided ID
search.reference.value Searches for creatives with the provided activity URN
search.status.value Searches for creatives with the provided status. The possible values are:
  • ACTIVE
  • PAUSED
  • DRAFT
  • ARCHIVED
  • CANCELED
sort Query results can be ordered using the sort param. The sort param supports the following fields:
  • field
  • order
totals Boolean to contols whether or not the total record count is displayed.default="true"

Sample Response

{
  "elements": [
    {
      "reference": "urn:li:share:5927566794888867840",
      "variables": {
        "data": {
          "com.linkedin.ads.SponsoredUpdateCreativeVariables": {
            "directSponsoredContent": false
          }
        }
      },
      "changeAuditStamps": {
        "created": {
          "actor": "urn:li:person:f_12hgd",
          "time": 1413243006876
        },
        "lastModified": {
          "actor": "urn:li:unknown:0",
          "time": 1413243006963
        }
      },
      "review": {
        "reviewStatus": "PENDING"
      },
      "contentTimestamp": 0,
      "campaign": "urn:li:sponsoredCampaign:110901063",
      "id": 21324443,
      "type": "SPONSORED_STATUS_UPDATE",
      "version": {
        "versionTag": "2"
      },
      "status": "ACTIVE"
    },
    ...
   ],
    "paging": {
    "total": 81,
    "count": 10,
    "start": 0,
    "links": [
      {
        "rel": "next",
        "href": "/adCreativesV2?q=search&start=10&count=10&totals=true&fields=reference%2Cvariables%2CchangeAuditStamps%2Creview%2CcontentTimestamp%2Ccampaign%2Cid%2Ctype%2Cversion%2CcallToAction%2Cstatus&search.account.values[0]=urn%3Ali%3AsponsoredAccount%3A502616245",
        "type": "application/json"
      }
    ]
  }

UPDATE

PUT https://api.linkedin.com/v2/adCreativesV2/{creative ID}

Parameters

Field Name Sub-Field Name Description
campaign   URN identifying the campaign associated with the creative
id   Numerical identifier for the creative
review   The current review status of the creative
status  
  • ACTIVE - Creative creation is complete and creative is available for review and serve
  • PAUSED - Creative creation is complete and creative is current, but should temporarily not be served
  • DRAFT - Creative creation is incomplete and may still be edited
  • ARCHIVED - Creative creation is complete, but creative should not be served and should be separated from non-archived creatives in any UI
  • CANCELED - Creative is permanently canceled
type  
  • TEXT_AD - Text with sponsored link to landing page on your site
  • SPONSORED_STATUS_UPDATE - Sponsored status update from a profile page
variables   Variables for rendering the creative
  clickUri URI destination to forward on a click
  data Data of the creative according to its typeValid values are TextAdCreativeVariables and/or  SponsoredUpdateCreativeVariables