DMP Segments

  • Commodity
  • six minutes to read

Try in Postman

DMP Segments act equally staging entities, which can take in user information from a third-political party provider, map them to LinkedIn member profiles, and output Ad Segments, which can so be used with other LinkedIn ads APIs. A DMP segment is tied to a sponsored account.

The use of this API is restricted to those developers canonical past LinkedIn and subject to applicable data restrictions in their agreements. All API requests are represented in protocol ii.0.0 and require the header:

              X-Restli-Protocol-Version: 2.0.0

Permissions

Permission Description
rw_dmp_segments Admission an authenticated fellow member'south DMP Segments. Can manage and read audience DMP segments. This permission belongs to the Audiences programme and is not granted automatically every bit part of the Marketing Developer Platform.

Pagination

The dmpSegments API implements pagination using the start and count parameters for finding DMP Segments by account.

For more than data, run into Pagination.

Create DMP Segment

Creates an empty DMP Segment.

Schema

Field Name Blazon Description
accessPolicy PRIVATE The default admission policy of this DMP segment.
account urn The sponsored account urn that this DMP segment belongs to. Refer hither to search for sponsored accounts that tin can be used.
description string (optional) A description for this DMP segment.
destinations See DMP Segment Destinations The destinations and various metadata that the content of this segment will be onboarded to. Currently, the only accepted value isLINKEDIN.
name string The proper name of this DMP segment.
sourcePlatform string The source platform from where users profiles are being imported. A dedicated ENUM will be provided to approved partners when they are granted access to these APIs.
sourceSegmentId cord (optional) The foreign key on the source platform. This is an optional field that will exist indexed and tin can be used past the source platform to find their segments.
type USER, Company, LIST_UPLOAD The content type of the profiles being imported into this DMP segment. Possible values are USER, COMPANY, or LIST_UPLOAD.

Sample Request

  • http
  • coil 
                  POST https://api.linkedin.com/v2/dmpSegments                                  
                  {    "proper noun":"DMP Segment 1",    "sourcePlatform":"DMP_PARTNER_PLATFORM", // Name will be provided.    "account":"urn:li:sponsoredAccount:516848833",    "accessPolicy":"PRIVATE",    "blazon":"USER",    "destinations":[       {          "destination":"LINKEDIN"       }    ] }

A successful response returns a 201 Created HTTP status code and the segment ID in the 10-linkedin-id response header.

Get DMP Segment

Think details of a DMP segment using the segment ID. The response returns all the fields listed for the create request and the post-obit boosted fields.

Schema

Field Proper name Type Description
created, lastModified long creation timestamp and concluding updated timestamp.
id long The DMP segment id.
inputCount long (optional) The number of input entities (companies or users) that the source platform has pushed to this segment.
destinations Please refer destinations segment info to run across additional fields returned.

Sample Request

  • http
  • curl 
                  Become https://api.linkedin.com/v2/dmpSegments/11204

Sample Response

              {    "created":1505229479000,    "destinations":[       {          "created":1505229479000,          "lastModified":1505229479000,          "status":"BUILDING",          "destinationSegmentId": "urn:li:adSegment:848336"       }    ],    "proper name":"Test DMP Segment 2",    "sourcePlatform":"DMP_PARTNER_PLATFORM", // Name will exist provided,    "accessPolicy":"Individual",    "id":11204,    "lastModified":1505229479000,    "type":"USER",    "account":"urn:li:sponsoredAccount:516848833" }

Get Multiple DMP Segments

Fetch information on multiple DMP segments in one request.

Sample Request

  • http
  • whorl 
                  GET https://api.linkedin.com/v2/dmpSegments?ids=Listing(10804,10814)

Sample Response

              {     "statuses": {},     "results": {         "10804": {             "created": 1505229200000,             "destinations": [                 {                     "created": 1505229200000,                     "lastModified": 1505229200000,                     "status": "BUILDING",                     "destinationSegmentId": "urn:li:adSegment:848336"                 }             ],             "name": "Exam DMP Segment 1",             "sourcePlatform": "DMP_PARTNER_PLATFORM", // Proper name volition be provided,             "accessPolicy": "PRIVATE",             "id": 10804,             "lastModified": 1505229200000,             "blazon": "USER",             "business relationship": "urn:li:sponsoredAccount:516848833"         },         "10814": {             "created": 1505229479000,             "destinations": [                 {                     "created": 1505229479000,                     "lastModified": 1505229479000,                     "status": "BUILDING",                     "destinationSegmentId": "urn:li:adSegment:999336"                 }             ],             "name": "Test DMP Segment 2",             "sourcePlatform": "DMP_PARTNER_PLATFORM", // Proper noun will exist provided,             "accessPolicy": "Individual",             "id": 10814,             "lastModified": 1505229479000,             "type": "USER",             "account": "urn:li:sponsoredAccount:516848833"         }     },     "errors": {} }

This request always returns a 200 OK HTTP condition. If some of the IDs in the request are invalid, the results for the other IDs are returned. If none of the IDs in the batch are valid, the empty response {  "statuses": {},  "results": {},  "errors": {}} is returned.

Update DMP Segment

Perform partial updates to some of the fields of a DMP Segment. Only accessPolicy , proper name , description , and sourceSegmentId tin can be modified.

Sample Asking

  • http
  • curl 
                  POST https://api.linkedin.com/v2/dmpSegments/10804                                  
                  {     "patch": {         "$set": {             "name": "New Name"         }     } }

A successful response returns a 204 No Content HTTP status code.

Find DMP Segments by Business relationship

Use the q=business relationship parameter and the account URN to find DMP segments by the associated sponsored account. For more granular results, add sourcePlatform and sourceSegmentId query parameters to the query.

Sample Asking

  • http
  • scroll 
                  Get https://api.linkedin.com/v2/dmpSegments?q=business relationship&business relationship=urn:li:sponsoredAccount:516848833

Sample Response

              {     "elements": [         {             "accessPolicy": "PRIVATE",             "business relationship": "urn:li:sponsoredAccount:516848833",             "created": 1505229200000,             "destinations": [                 {                     "created": 1505229200000,                     "destinationSegmentId": "urn:li:adSegment:848336",                     "lastModified": 1505229200000,                     "condition": "BUILDING"                 }             ],             "id": 10804,             "lastModified": 1505229200000,             "name": "Test DMP Segment 1",             "sourcePlatform": "DMP_PARTNER_PLATFORM",             "type": "USER"         },         {             "accessPolicy": "Private",             "account": "urn:li:sponsoredAccount:516848833",             "created": 1505229479000,             "destinations": [                 {                     "created": 1505229479000,                     "destinationSegmentId": "urn:li:adSegment:999336",                     "lastModified": 1505229479000,                     "status": "Building"                 }             ],             "id": 10814,             "lastModified": 1505229479000,             "name": "Test DMP Segment 2",             "sourcePlatform": "DMP_PARTNER_PLATFORM",             "type": "USER"         }     ],     "paging": {         "count": 10,         "links": [],         "start": 0,         "total": ii     } }

Delete DMP Segment

Delete a DMP segment using the segment ID. The response returns 204 No Content if the deletion succeeds. Everything related to this DMP segment will be deleted altogether as well, including the DMP segment destinations, the corresponding Advertizement segment, the DMP segment list (if in that location is any). Yous must have write access to the sponsored account that owns the dmp segment to be able to delete it. Otherwise, you volition go a 403 Forbidden error response.

Sample Request

  • http
  • curl 
                  DELETE https://api.linkedin.com/v2/dmpSegments/10000

Sample Response

With http header enabled, you should see the post-obit response.

              HTTP/2 204 etag: W/"21" x-restli-protocol-version: 2.0.0

Batch Delete DMP Segments

Delete a batch of DMP segments using segment ID'south. Annotation that all the DMP segments must exist under the same account. The response returns a 204 No Content for each segment that has been deleted successfully. Or an fault with error message for each segment that has failed to be deleted. For each batch delete request, all the segments must belong to the aforementioned sponsored account. Also, you lot must have write admission to the sponsored account that owns the dmp segments. Otherwise, you will become a 403 Forbidden fault response for those segments. All API requests are represented in protocol ii.0.0 and require the header:

              X-Restli-Protocol-Version: 2.0.0

Sample Asking

  • http
  • curl 
                  DELETE https://api.linkedin.com/v2/dmpSegments?ids=List(10001,10002)

Sample Response

              {     "results": {         "10001": {             "status": 204         },         "10002": {             "status": 204         }     },     "errors": {} }

Common Validation errors for DELETE Operation

The tabular array beneath lists commonly encountered errors deleting a dmpSegment.

Code Message Description
400 Bad asking Malformed requests, such as if the input dmp segment ID is not a number.
400 Error deleting AdSegments for dmp destination {dmpSegment ID}. AdSegment is being used in active campaigns.
403 No WRITE admission to {sponsored account URN}. Viewer is not present or user is not authorized to delete the dmp segment.
404 Entity with key {adSegment ID} is non institute. DMP segment of the provided ID in the path doesn't exist.