Entity-ID-to-name mapping
The entity-ID-to-name mapping feed is a feature that provides a fast and lightweight way to retrieve human-readable names for entity IDs. This provides an automated method to efficiently construct ID-to-name lookup tables in your reporting systems. The output files include entity IDs and their corresponding names and are available in an S3 location hosted by The Trade Desk and are refreshed on a daily cadence. There are also ID-to-Name Mapping API endpoints that you can use in conjunction with the feed to support your ingestion workflow.
Here are a couple of the most common use-cases in which you can use the entity-ID-to-name mapping feed:
- As a partner or advertiser of The Trade Desk, you consume Raw Events Data Stream (REDS), which only includes entity IDs.
- As a Third-party reporting vendor you require this information for your client integrations.
S3 mapping export service
There are 13 feeds available to choose as entity types enabled for delivery. The following table lists the available feeds and the data included.
| Entity Type | ID Field | Name Field |
|---|---|---|
Adgroup |
AdgroupID |
AdgroupName |
Advertiser |
AdvertiserID |
AdvertiserName |
Application |
ApplicationID |
ApplicationName |
Audience |
AudienceID |
AudienceName |
Campaign |
CampaignID |
CampaignName |
Contract |
ContractID |
ContractName |
ContractGroup |
ContractGroupID |
ContractGroupName |
Creative |
CreativeID |
CreativeName |
DataGroup |
DataGroupID |
DataGroupName |
DeliveryProfile |
DeliveryProfileID |
DeliveryProfileName |
GeoSegment |
GeoSegmentID |
GeoSegmentName |
Partner |
PartnerID |
PartnerName |
SupplyVendorPublisher |
SupplyVendorIDSupplyVendorPublisherId |
SupplyVendorNameSellerNameSellerDomain |
IMPORTANT: If the ID mapping feeds for the partner entity have limited or empty files, then you do not have the required permission to access them. For details, contact your Technical Account Manager.
Output and file taxonomy
After the output files are configured, they become available within S3.
Here's what you need to know about the output file taxonomy:
- Files are delivered to an S3 location hosted by The Trade Desk:
thetradedesk-useast-partner-datafeed/{partnerid}/idmapping/. - The results are placed within the specified partner ID and advertiser ID folders. Folder names are IDs pertaining to the Partners or Advertisers.
- Folders include relevant files per entity type.
- File names correspond to the relevant entity type, in the form
EntityType.tsv.gz. For example:AdGroup.tsv.gzandCampaign.tsv.gz.
The following lists the output file specifications:
- The service provides data as
.gzfiles. - Separate files per entity type are delivered.
- Files include headers.
- Files are refreshed every 24 hours.
ID-to-Name Mapping API
The ID-to-Name Mapping API supplements your workflow by providing access to new entity data that may be needed between each daily refresh of the S3 file. Here's what you need to know about this API:
- To reduce call volume and frequency, it is strongly recommended to utilize the relevant Delta endpoints to track changes across the entities whenever possible.
For example, you may have an intraday ETL to process the log data and ID-mapping files; however, there are new entity IDs that were created after the daily ID-mapping files are produced.IMPORTANT: The delta endpoints are strictly rate-limited. Do not use these endpoints for daily bulk-data requests.
- You can use the API to look up new entities that are missing from the daily file so you don't have to wait another day for the next file update to reflect the new entities.
To retrieve the name and identifier of an ID, use the following endpoints that complement the mapping feed.
| ID Type | Endpoint |
|---|---|
| Ad Group | adGroup Query |
| Advertiser | advertiser Query |
| Application | GET /v3/application/name/{applicationId} |
| Audience | audience Query |
| Campaign | campaign Query |
| Creative | creative Query |
| DataGroup | GET /v3/datagroup/name/{dataGroupId} |
| DeliveryProfile | GET /v3/deliveryprofile/name/{deliveryProfileId} |
| GeoSegment | GET /v3/geosegment/name/{geoSegmentId} |
| Partner | partner Query |
| Supply vendor | POST /v3/supplyvendor/query/advertiser NOTE: Use the Result.SupplyVendorId and Result.SupplyVendorName properties in the response. |
| Supply vendor or supply vendor publisher |
GET supplyvendorpublisher/{supplyVendorId}/{supplyVendorPublisherId} |
Here is an example of an API call to the partner-entity service:
curl -H "Content-Type: application/json" -H "TTD-Auth:|Token|" -X GET "https://api.thetradedesk.com/v3/partner/name/tdpartnerid"
A successful response returns the ID and name of the partner entity.
{
"Id": "tdpartnerid",
"Name": "The Trade Desk"
}