Manages data in the Xandr platform.
load:
type: segments
member_id: 12345
conn_id: xandr
mapping:
action: ACTION
id: AUDIENCE_ID
code: AUDIENCE_CODE
short_name: SHORT_NAME
state: STATE
description: DESCRIPTION
expire_minutes: EXPIRE_MINUTES
| property | type | mandatory | description |
|---|---|---|---|
conn_id | string | no | Connection string as handed to you by the Onesecondbefore team. Default is `xandr` |
member_id | integer | yes | Xandr member ID, e.g. 12345 |
type | enumerator(segments, member_data_sharing) | yes | Defines what module of Xandr will be updated. |
mapping | object | yes | Contains the mappings from the dataset to the service. See below for mapping options. |
| mapping | type (of value) | mandatory | description |
|---|---|---|---|
action | enumerator (active, update, delete) | yes | Contains the field name from the query that contains the action to take. Value of the field can only be active (Item will be created when it does not exist and no action is taken when the item already exists), update (item will be updated) or delete (item will be deleted). |
id | string | no | Contains the id of the segment. Only needed when action is update |
advertiser_id | string | no | Use this if you want the segments to be created in a particular advertiser in your member seat. |
description | string | no | Add a description to the segment. |
code | string | no | Contains the audience code. |
short_name | string | yes | Contains the short name of the segment. |
state | enumerator (active, inactive) | yes | If set to active, the segment will be active. If set to inactive, the segment will be inactive. |
expire_minutes | int | no | The amount of minutes in which the users should expire by default. Maximum is 259,200 minutes (=180 days). |
| mapping | type (in dataset) | mandatory | description |
|---|---|---|---|
action | enumerator (put) | yes | Value of the field can only be put (Item will overwrite previous defined member data sharing). |
segment_id | integer | yes | Segment ID. |
record_id | string | yes | Record ID. |
| item | description |
|---|---|
API | Digital Platform API |
To type | Management information upload. |