Supported Attributes for DCS API Calls
- Topics:
- DCS
Lists and describes the syntax and supported attributes (or key-value pairs) you can pass in to the Data Collection Servers (DCS). This information can help you format your DCS requests and understand the parameters returned by this system.
Attribute Prefixes
The DCS relies on specific prefixes added to the keys in key-value pairs to classify the type of data you’re passing in.
c_
d_
h_
p_
Private, customer-defined attributes.
The DCS accepts your own, private data when the key has a p_
prefix. Private data is used for trait evaluation, but it will not be logged or stored in our system. For example, lets say you have a trait defined as customers = p_age<25
and you pass in p_age=23
in an event call. Given these conditions, the user who meets the age-based qualification criteria qualifies for the trait, but the key-value pair is dropped after Audience Manager receives the request and is not logged.
d_ Attributes
All of these are optional, unless you want a response from the DCS. If you want the DCS to return a response, then d_rtbd=json
is required.
d_caller
d_cb
d_cid
Contains one or more pairs of data provider IDs ( DPID
) and data provider user IDs ( DPUUID
) assigned by Audience Manager. If you use multiple pairs of DPID
s and DPUUID
s, separate each pair with the non-printing character %01
. For example: DPID%01DPUUUID
.
d_cid
replaces d_dpid
and d_dpuuid
, which are deprecated but still supported. See CID Replaces DPID and DPUUID.
d_cid_ic
Contains an integration code and an associated unique user ID in a single key-value pair.
d_cid_ic
replaces d_dpid
and d_dpuuid
, which are deprecated but still supported. See CID Replaces DPID and DPUUID.
d_coppa
idSyncDisable3rdPartySyncing
configuration. See COPPA Support in the Adobe Experience Platform Identity Service.d_cts=1
d_cts=2
Optional. Enabled on customer request. Contact your Adobe Audience Manager consultant or Customer Care.
Indicates that traits and segments should be returned inside the JSON
response.
-
d_cts=1
returns legacy segment IDs for the segments. -
d_cts=2
returns segment IDs for the segments.
A sample response could look like the one below:
{ "stuff": [], "uuid": "07955261652886032950143702505894272138", "dcs_region": 7, "traits": [420020, 5421506], "segments": [984263, 985264], "tid": "ss3OTqPiQp0=" }
d_dpid
d_cid
and d_cid_ic
.d_dpuuid
d_cid
and d_cid_ic
.d_dst=1
JSON
response.d_dst_filter
d_dst_filter
is a reserved attribute, used in the integration between Adobe Analytics and Audience Manager.
We advise against creating traits that use reserved attributes. Adobe may change reserved attributes at any time.
d_jsonv=1|0
JSON
version to use in the response. Normally, you should set this to d_jsonv=1
. Setting d_jsonv=0
disables ID syncs.d_mid
d_nsid
d_ptfm
Allows Audience Manager to distinguish mobile requests from desktop requests. Supported values include:
ios
android
browser
all
d_rs
Deprecated. d_rs
is a reserved attribute, used in the legacy integration between Adobe Analytics and Audience Manager.
We advise against creating traits that use reserved attributes. Adobe may change reserved attributes at any time.
d_rtbd=json
Required if you want a JSON
response from the DCS.
- If you omit this, the DCS returns a pixel in the header.
- If you include this, the DCS returns a
JSON
object in the body of the response. See the example below. Your response could be more complex.
{ "stuff": [], "uuid": "22920112968019678612904394744954398990", "dcs_region": 7, "tid": "ss3OTqPiQp0=" }
d_sid
SID
stands for score ID. This is a unique ID for a trait or a segment.d_tdpid
Passes a data source for trait evaluation. Only traits from this data source are evaluated.
For example, say you have:
- Trait T1 with:
- Trait rule: "
key1 == val1
" - Data Source ( DPID): 1
- DPID integration code: ic1
- Trait T2 with:
- Trait rule: "
key2 == val2
" - Data Source (DPID): 2
- DPID integration code: ic2
In a sample call, yourcompany.demdex.net/event?key1=val1&key2=val2&d_tdpid=1
, only trait T1 is returned.
d_tdpid_ic
The purpose is identical to the d_tdpid
parameter described above. However, in this case, the data source is passed using the integration code.
Keeping the traits described above, consider the sample call:
For yourcompany.demdex.net/event?key1=val1&key2=val2&d_tdpid_ic=ic2
, only trait T2 is returned.
d_uuid
h_ Attributes
These headers contain information like requests for data and responses in an HTTP call.
h_host
host name .demdex.net
. See Understanding Calls to the Demdex Domain.h_user-agent
User-Agent
header value.h_accept-language
Accept-Language
header value.h_referer
Referer
header value.h_referrer
Referrer
header value.h_date
Date
header value.