Partager via

adTargetingEntities

  • Article

The LinkedIn ads platform allows advertisers to target different types of audiences on the professional network.

Use the Ad Targeting Entities API to discover valid values of a targeting type available. Use in conjunction with the Ad Targeting Facets API.

This page should be used for reference purposes only. More comprehensive documentation with sample requests is available in Ad Targeting.

Supported Methods

FINDER

The Ad Targeting Entities API supports the following types of Finder methods:

Schema

Field Type Description
value (legacy) Union [Urn, StaffCountRange,  AgeRange,  Gender, Locale,  ClosedIntRange] URNs or ENUMs that represent a set of member attribute entities being targeted for this facet.
urn adTargetingEntity urn The URN representation of this entity, for use with TargetingCriteria . Optional as the old targeting expression, Targeting' (without the new expanded boolean combinations), will use 'value' instead of this field. 
facetUrn adTargetingFacet urn The URN representation of the facet to which the entity belongs.
name string Name of the entity. This will be formatted according to locale.

List of supported adTargetingFacets in targetingCriteria object can be found here .

FINDER

adTargetingFacet

GET https://api.linkedin.com/v2/adTargetingEntities?q=adTargetingFacet

Parameters

Field Name Field Type Description
facet AdTargetingFacetUrn Retrieves available options for the facet requested (e.g. urn:li:adTargetingFacet:seniorities)
entityType optional AdTargetingEntityType Return results will only contain data that matches type requested (e.g. SENIORITY).
totals boolean, default="true" Boolean parameter indicating whether total results matched should be tallied and returned.
queryVersion QUERY_USES_MIXED QUERY_USES_URNS The default value is QUERY_USES_MIXED. It returns output in the field "value". (legacy). The newer version is QUERY_USES_URNS. It returns output in "urn", "facetName" and "name" fields.
locale.language String A lowercase two-letter language code as defined by ISO-639. Defaults to "en" if no value is provided.
locale.country String An uppercase two-letter country code as defined by ISO-3166. Defaults to "US" if no value is provided.

Sample Response

{
    "elements": [
        {
            "value": {
                "string": "urn:li:seniority:1"
            }
        },
        {
            "value": {
                "string": "urn:li:seniority:2"
            }
        },
        {
            "value": {
                "string": "urn:li:seniority:3"
            }
        },
        {
            "value": {
                "string": "urn:li:seniority:4"
            }
        },
        {
            "value": {
                "string": "urn:li:seniority:5"
            }
        },
        {
            "value": {
                "string": "urn:li:seniority:6"
            }
        },
        {
            "value": {
                "string": "urn:li:seniority:7"
            }
        },
        {
            "value": {
                "string": "urn:li:seniority:8"
            }
        },
        {
            "value": {
                "string": "urn:li:seniority:9"
            }
        },
        {
            "value": {
                "string": "urn:li:seniority:10"
            }
        }
    ]
}

If queryVersion is set to QUERY_USES_URNS, the response is as follows:

Sample Response

{
    "elements": [
        {
            "urn": "urn:li:seniority:1",
            "facetUrn": "urn:li:adTargetingFacet:seniorities",
            "name": "Unpaid"
        },
        {
            "urn": "urn:li:seniority:10",
            "facetUrn": "urn:li:adTargetingFacet:seniorities",
            "name": "Owner"
        },
        {
            "urn": "urn:li:seniority:2",
            "facetUrn": "urn:li:adTargetingFacet:seniorities",
            "name": "Training"
        },
        {
            "urn": "urn:li:seniority:3",
            "facetUrn": "urn:li:adTargetingFacet:seniorities",
            "name": "Entry"
        },
        {
            "urn": "urn:li:seniority:4",
            "facetUrn": "urn:li:adTargetingFacet:seniorities",
            "name": "Senior"
        },
    ..
    ]
}

similarEntities

GET https://api.linkedin.com/v2/adTargetingEntities?q=similarEntities

Parameters

Field Name Field Type Description
facet AdTargetingFacetUrn Retrieves available options for the facet requested (e.g. urn:li:adTargetingFacet:seniorities)
entityType optional AdTargetingEntityType Return results will only contain data that matches type requested (e.g. COMPANY).
totals boolean, default="true" Boolean parameter indicating whether total results matched should be tallied and returned.
queryVersion QUERY_USES_MIXED QUERY_USES_URNS The default value is QUERY_USES_MIXED. It returns output in the field "value". (legacy). The newer version is QUERY_USES_URNS. It returns output in "urn", "facetName" and "name" fields.
locale.language String A lowercase two-letter language code as defined by ISO-639. Defaults to "en" if no value is provided.
locale.country String An uppercase two-letter country code as defined by ISO-3166. Defaults to "US" if no value is provided.

Sample Response

{
    "elements": [
        {
            "value": {
                "string": "urn:li:organization:125999"
            }
        },
        {
            "value": {
                "string": "urn:li:organization:163361"
            }
        },
        {
            "value": {
                "string": "urn:li:organization:10715"
            }
        },
        {
            "value": {
                "string": "urn:li:organization:1004"
            }
        }
    ..
    ]
}

If queryVersion is set to QUERY_USES_URNS, the response is as follows:

Sample Response

{
    "elements": [
        {
            "urn": "urn:li:organization:10675",
            "facetUrn": "urn:li:adTargetingFacet:employers",
            "name": "Plateau Systems"
        },
        {
            "urn": "urn:li:organization:35450",
            "facetUrn": "urn:li:adTargetingFacet:employers",
            "name": "TIBCO StreamBase"
        },
        {
            "urn": "urn:li:organization:66650",
            "facetUrn": "urn:li:adTargetingFacet:employers",
            "name": "ARCHIBUS, Inc."
        },
        {
            "urn": "urn:li:organization:167857",
            "facetUrn": "urn:li:adTargetingFacet:employers",
            "name": "Worklight"
        },
        {
            "urn": "urn:li:organization:165426",
            "facetUrn": "urn:li:adTargetingFacet:employers",
            "name": "Pegasystems"
        }
    ..
    ]
}

typeahead

GET https://api.linkedin.com/v2/adTargetingEntities?q=typeahead

Parameters

Field Name Field Type Description
facet AdTargetingFacetUrn Retrieves available options for the facet requested (e.g. urn:li:adTargetingFacet:seniorities)
entityType optional AdTargetingEntityType Return results will only contain data that matches type requested (e.g. FIELD_OF_STUDY).
totals boolean, default="true" Boolean parameter indicating whether total results matched should be tallied and returned.
queryVersion QUERY_USES_MIXED QUERY_USES_URNS The default value is QUERY_USES_MIXED. It returns output in the field "value". (legacy). The newer version is QUERY_USES_URNS. It returns output in "urn", "facetName" and "name" fields.
locale.language String A lowercase two-letter language code as defined by ISO-639. Defaults to "en" if no value is provided.
locale.country String An uppercase two-letter country code as defined by ISO-3166. Defaults to "US" if no value is provided.

Sample Response

{
    "elements": [
        {
            "value": {
                "string": "urn:li:fieldOfStudy:100990"
            }
        },
        {
            "value": {
                "string": "urn:li:fieldOfStudy:101438"
            }
        }
    ]
}

If queryVersion is set to QUERY_USES_URNS, the response is as follows:

Sample Response

{
    "elements": [
        {
            "urn": "urn:li:fieldOfStudy:100990",
            "facetUrn": "urn:li:adTargetingFacet:fieldsOfStudy",
            "name": "Economics"
        },
        {
            "urn": "urn:li:fieldOfStudy:101438",
            "facetUrn": "urn:li:adTargetingFacet:fieldsOfStudy",
            "name": "Business/Managerial Economics"
        },
        {
            "urn": "urn:li:fieldOfStudy:100994",
            "facetUrn": "urn:li:adTargetingFacet:fieldsOfStudy",
            "name": "International Economics"
        },
        {
            "urn": "urn:li:fieldOfStudy:100993",
            "facetUrn": "urn:li:adTargetingFacet:fieldsOfStudy",
            "name": "Development Economics and International Development"
        },
        {
            "urn": "urn:li:fieldOfStudy:100991",
            "facetUrn": "urn:li:adTargetingFacet:fieldsOfStudy",
            "name": "Applied Economics"
        },
    ..
    ]
}

urns

GET https://api.linkedin.com/v2/adTargetingEntities?q=urns

Parameters

Field Name Field Type Description
urns List of URNs List of URNs for which information is required. urn:li:fieldOfStudy:100990, urn:li:organization:1035, urn:li:seniority:9
fetchType SINGLE_NODE (default) LAZY The fetch type determines how much of the descendant tree (from the urns passed in) is returned. SINGLE_NODE will only resolve and return the entities corresponding to the urn values passed in and no descendants. LAZY will resolve and return all entities except those with a large taxonomy size.
totals boolean, default="true" Boolean parameter indicating whether total results matched should be tallied and returned.
queryVersion QUERY_USES_MIXED QUERY_USES_URNS QUERY_USES_MIXED returns output in the field "value". (legacy). The default version is QUERY_USES_URNS. It returns output in "urn", "facetName" and "name" fields.
locale.language String A lowercase two-letter language code as defined by ISO-639. Defaults to "en" if no value is provided.
locale.country String An uppercase two-letter country code as defined by ISO-3166. Defaults to "US" if no value is provided.

Sample Response

{
    "elements": [
        {
            "facetUrn": "urn:li:adTargetingFacet:fieldsOfStudy",
            "name": "Economics",
            "urn": "urn:li:fieldOfStudy:100990"
        },
        {
            "facetUrn": "urn:li:adTargetingFacet:employersPast",
            "name": "Microsoft",
            "urn": "urn:li:organization:1035"
        },
        {
            "facetUrn": "urn:li:adTargetingFacet:employers",
            "name": "Microsoft",
            "urn": "urn:li:organization:1035"
        },
        {
            "facetUrn": "urn:li:adTargetingFacet:employersAll",
            "name": "Microsoft",
            "urn": "urn:li:organization:1035"
        },
        {
            "facetUrn": "urn:li:adTargetingFacet:firstDegreeConnectionCompanies",
            "name": "Microsoft",
            "urn": "urn:li:organization:1035"
        },
        {
            "facetUrn": "urn:li:adTargetingFacet:followedCompanies",
            "name": "Microsoft",
            "urn": "urn:li:organization:1035"
        },
        {
            "facetUrn": "urn:li:adTargetingFacet:contextualCompanies",
            "name": "Microsoft",
            "urn": "urn:li:organization:1035"
        },
        {
            "facetUrn": "urn:li:adTargetingFacet:seniorities",
            "name": "Partner",
            "urn": "urn:li:seniority:9"
        }
    ],
    "paging": {
        "count": 2147483647,
        "links": [],
        "start": 0
    }
}