Ad Segment Sources

  • Article

Used for retargeting advertiser's website visitors, an adSegmentSource object associates an adPageSet to an adSegment.

Supported Methods

UPDATE | GET | FINDER

Schema

Field Name Type Description
account optional SponsoredAccountUrn The sponsored account Urn that owns this adSegmentSource. Should be the same as the owner of the referenced adSegment and source. 
changeAuditStamps ChangeAuditStamps Audit change stamps including creation timestamp and last updated timestamp
segment AdSegmentUrn Associated segment URN, part of the key
source Urn The resource defining the membership of the associated segment.
version VersionTag The version tag of the campaign record

UPDATE

PUT https://api.linkedin.com/v2/adSegmentSources/source={urn}&segment={urn}

Parameters

Field Name Type Description
account optional SponsoredAccountUrn Urn identifying the advertising account associated with the segment. This field is immutable.
segment AdSegmentUrn Associated segment URN, part of the key
source Urn The resource defining the membership of the associated segment.

Example

PUT https://api.linkedin.com/v2/adSegmentSources/source=urn:li:adPageSet:10001&segment=urn:li:adSegment:10001

Sample request

{
    "account": "urn:li:sponsoredAccount:511910281",
    "segment": "urn:li:adSegment:10001",
    "source": "urn:li:adPageSet:10001"
}

GET

GET https://api.linkedin.com/v2/adSegmentSources/source={urn}&segment={urn}

Parameters

Field Name Type Description
segment AdSegmentUrn Associated segment URN, part of the key
source Urn The resource defining the membership of the associated segment.

Example

GET https://api.linkedin.com/v2/adSegmentSources/source=urn:li:adPageSet:10001&segment=urn:li:adSegment:89671

Sample Response

{
    "changeAuditStamps": {
        "created": {
            "actor": "foo",
            "time": 7
        },
        "lastModified": {
            "actor": "baz",
            "time": 2
        }
    },
    "created": 7,
    "lastModified": 2,
    "segment": "foo",
    "source": "bar",
    "version": {}
}

FINDER

GET https://api.linkedin.com/v2/adSegmentSources/?q=account

The adSegmentSources API supports the following types of finder methods:

Account

GET https://api.linkedin.com/v2/adSegmentSources/?q=account

Parameters

Field Name Type Description
account SponsoredAccountUrn Look up adSegmentSources associated with this account
totals boolean, default="true" Boolean parameter indicating whether total results matched should be tallied and returned.

Example

GET https://api.linkedin.com/v2/adSegmentSources?q=account&account=urn:li:sponsoredAccount:511726460&start=0&count=5

Sample Response

{
    "account": "urn:li:sponsoredAccount:511726460",
    "created": 1464992650000,
    "lastModified": 1464992650000,
    "segment": "urn:li:adSegment:10031",
    "source": "urn:li:adPageSet:10001",
    "versionTag": "1"
}

Segments

GET https://api.linkedin.com/v2/adSegmentSources/?q=segments

Parameters

Field Name Type Description
segments AdSegmentUrn[] Look up adSegmentSources associated with these AdSegments
totals boolean, default="true" Boolean parameter indicating whether total results matched should be tallied and returned.

Sources

GET https://api.linkedin.com/v2/adSegmentSources/?q=sources

Parameters

Field Name Type Description
sources Urn[] Look up adSegmentSources associated with these source Urns
totals boolean, default="true" Boolean parameter indicating whether total results matched should be tallied and returned.