Ad Segments

An Ad segment is a collection of entities (such as members or companies) to which ads can be targeted. Ad Segments are created automatically after DMP Segments are matched with LinkedIn members.

Permissions

There are two conditions for successful requests:

• Scope permission accessibility for:

  • rw_ads (read/write)
  • r_ads (read-only)

• The authenticated Ad Account user that provides consent has one of the following roles on the Ad Account:

  • ACCOUNT_BILLING_ADMIN
  • ACCOUNT_MANAGER
  • CAMPAIGN_MANAGER
  • CREATIVE_MANAGER
  • VIEWER (read-only, even with rw_ads scope)

For more information on Ad Account roles and permissions:

• Ad Account User Role Definitions
• Create and Manage Ad Account Users

Supported Methods

Update Ad Segment | Find Ad Segments by Ad Account | Get Ad Segment

Schema

AdSegmentStatus

AdSegmentType

Get Ad Segment

Fetch an existing ad segment by its ID.

Parameters

Sample Request

GET https://api.linkedin.com/rest/adSegments/{id}

curl --location 'https://api.linkedin.com/rest/adSegments/{id}\
--header 'X-Restli-Protocol-Version: 2.0.0'\
--H 'Linkedin-Version: {version number in the format YYYYMM}' \
--H 'Authorization: Bearer {INSERT_TOKEN}'

GET https://api.linkedin.com/v2/adSegmentsV2/{id}

curl --location 'https://api.linkedin.com/v2/adSegments/{id}\
--H 'Authorization: Bearer {INSERT_TOKEN}'

Sample Response

{
   "created": {
       "actor": "urn:li:unknown:0",
       "time": 1678259032000
   },
   "name": "Bulk AdSegment created by self service, and go through state transitions",
   "description": "description for AdSegment Bulk",
   "versionTag": "108105253952",
   "lastModified": {
       "actor": "urn:li:unknown:0",
       "time": 1678259032000
   },
   "id": 16182906,
   "type": "RETARGETING",
   "account": "urn:li:sponsoredAccount:509090297",
   "status": "READY"
}

Update Ad Segment

Partial update fields such as name on the existing ad segment by its ID.

Parameters

Sample Request

POST https://api.linkedin.com/rest/adSegments/{id}

{
   "patch": {
       "$set": {
           "name": "Retargeting AdSegment",
           "status": "ARCHIVED"
       }
   }
}

curl --location 'https://api.linkedin.com/rest/adSegments/{id} \
--H 'X-Restli-Protocol-Version: 2.0.0' \
--H 'Linkedin-Version: {version number in the format YYYYMM}'\
--H 'X-Restli-Method: PARTIAL_UPDATE'\
--H 'Authorization: Bearer {INSERT_TOKEN}'\
--H 'Content-Type: application/json'\
--data '{
   "patch": {
       "$set": {
           "name": "Retargeting AdSegment",
           "status": "ARCHIVED"
       }
   }
}'

POST https://api.linkedin.com/v2/adSegmentsV2/{id}

{
   "patch": {
       "$set": {
           "name": "Retargeting AdSegment",
           "status": "ARCHIVED"
       }
   }
}

curl --location 'https://api.linkedin.com/v2/adSegments/{id} \
--H 'X-Restli-Method: PARTIAL_UPDATE'
--H 'Authorization: Bearer {INSERT_TOKEN}'
--H 'Content-Type: application/json'\
--data '{
   "patch": {
       "$set": {
           "name": "Retargeting AdSegment",
           "status": "ARCHIVED"
       }
   }
}'

Sample Response

A successful response returns a 204 No Content HTTP status.

Find Ad Segments by Ad Account

Query ad segments by advertiser account:

Parameters

Sample Request

https://api.linkedin.com/rest/adSegments?q=accounts&accounts=List(urn%3Ali%3AsponsoredAccount%3A{{sponsoredaccount_id}})&start=0&count=5

curl --location 'https://api.linkedin.com/rest/adSegments?q=accounts&start=0&count=5&accounts=List(urn%253Ali%253AsponsoredAccount%253A509090297)&types=(value:List(BULK))&statuses=(value:List(EXPIRED))'\
--H 'X-Restli-Protocol-Version: 2.0.0'\
--H 'Linkedin-Version: {version number in the format YYYYMM}'\
--H 'Authorization: Bearer {INSERT_TOKEN}' 

GET https://api.linkedin.com/v2/adSegmentsV2?q=accounts&accounts=urn:li:sponsoredAccount:511910281&start=0&count=5

curl --location 'https://api.linkedin.com/v2/adSegments?q=accounts&start=0&count=5&accounts=List(urn%253Ali%253AsponsoredAccount%253A509090297)&types=(value:List(BULK))&statuses=(value:List(EXPIRED))'\
--H 'Authorization: Bearer {INSERT_TOKEN}'

Sample Response

{
   "elements": [
       {
           "approximateMemberCount": 230000,
           "created": {
               "actor": "urn:li:unknown:0",
               "time": 1651129031000
           },
           "name": "DMP Segment 1",
           "versionTag": "81433811311",
           "id": 11422166,
           "lastModified": {
               "actor": "urn:li:unknown:0",
               "time": 1654271097000
           },
           "type": "MARKET_AUTOMATION",
           "account": "urn:li:sponsoredAccount:509090297",
           "status": "ARCHIVED"
       },
       {
           "approximateMemberCount": 0,
           "created": {
               "actor": "urn:li:unknown:0",
               "time": 1651486505000
           },
           "name": "DMP segment for CSV uploads",
           "versionTag": "78913777069",
           "id": 11462646,
           "lastModified": {
               "actor": "urn:li:unknown:0",
               "time": 1651972148000
           },
           "type": "BULK",
           "account": "urn:li:sponsoredAccount:509090297",
           "status": "READY"
       },
       {
           "approximateMemberCount": 0,
           "created": {
               "actor": "urn:li:unknown:0",
               "time": 1657199237000
           },
           "name": "Bulk AdSegment created by self service, and go through state transitions",
           "description": "description for AdSegment Bulk",
           "versionTag": "84646462865",
           "id": 12554466,
           "lastModified": {
               "actor": "urn:li:unknown:0",
               "time": 1657238293000
           },
           "type": "RETARGETING",
           "account": "urn:li:sponsoredAccount:509090297",
           "status": "READY"
       }
   ]
}