2019-12-06 Release

New Audience Management REST API to complement the Pulse Audience Management functionality.

New Audience Management API

Note:

In order to use the Pulse Audience Management functionality, you first need a Data Management Platform (DMP) integration added to your account. Please contact your Account Manager if you want to start using Pulse Audience Management. Your Account Manager initiates the integration project in collaboration with our Professional Services team.

A new Audience Management REST API is available to interact with Pulse. If you are using, or want to use, the Pulse Audience Management functionality, the Audience Management API allows you to manage the audience segmentations and audience segments for your audience providers.

Previously, when initiating the integration project, you had to provide us with the segment identification document, a CSV file identifying each unique targeting segment, and our Professional Services team would set everything up so that Pulse matches the information coming from the audience provider with the targeting segments displayed in Pulse. This also meant you had to contact us for any updates you wanted to make to the existing audience segmentations and audience segments.

Now, when initiating the integration project, our Professional Services team configures the audience provider information, however you can manipulate the audience segmentations and corresponding audience segments using the Audience Management API. The API enables you to:

Data Integration Structure and Limitations

The data integration structure looks as below, with some updates to the audience terminology and names of parameters you can provide and retrieve, but with the same limitations as before.
  • Audience data provider: a provider of demographic data - Data Management Platform (DMP). You can have a maximum of three DMP integrations per account (default setting). You cannot add audience providers yourself. Contact your Account Manager to add a new audience provider for your Pulse account.
    • Audience segmentation: a grouping of related segments, for example Age, Gender, or Interests. You can have a maximum of 200 segmentations per DMP integration. You cannot delete segmentations. Contact Technical Support if you reach the limit and need to have a segmentation deleted.
      • Audience segment: a specific segment in the audience segmentation, for example 10-14 or 55-65 can be segments of the Age segmentation. You can have a maximum of 15 segments per segmentation. Segments cannot be deleted.

The following parameters identify each unique targeting segment, allowing Pulse to match the information coming from the audience provider with the targeting segments displayed to a Pulse user. segmentationId and segmentId are Pulse assigned IDs and cannot be modified.

Parameter Type Description Note
segmentationId Integer Value between 0-199, Pulse assigned ID for a single segmentation (a grouping of segments). Previously Index in Segment Identification CSV file.
segmentationKey String

Your own segmentation key (ID) sent in the async pixel request, used to parse incoming requests. For example, xyz.

You can use up to 255 characters. The following characters are allowed:
  • Letters: A through Z, and a through z
  • Numbers: 0 through 9
  • Other characters: - (hyphen) _ (underscore)
Previously Parameter Name in Segment Identification CSV file.
segmentationName String Segmentation name displayed in the Pulse UI, for example, Age or Gender. You can use up to 255 characters. Previously Key Label in Segment Identification CSV file.
segmentId Integer Value between 1-15, Pulse assigned ID for a single segment. Previously Value in Segment Identification CSV file.
segmentKey String

Your own segment key (ID) sent in the async pixel request, used to parse incoming requests. For example, 123.

You can use up to 255 characters. The following characters are allowed:
  • Letters: A through Z, and a through z
  • Numbers: 0 through 9
  • Other characters: - (hyphen) _ (underscore)
Previously Parameter Value in Segment Identification CSV file.
segmentName String Segment name displayed in the Pulse UI. For example, Male or Female. You can use up to 255 characters. Previously Value Label in Segment Identification CSV file.

Documentation Releases

This release includes the following documentation updates: