Table of Contents






Overview

Segment uploads are a manual way to import a file containing user information for the purpose of adding users to a segment. Segment uploads support uploading .txt files with user segment data directly from the UI, or as API requests to update user segments. The segment upload object allows uploading a .txt file containing end user-to-segment mappings that contain user ID's followed by a segment key. When the file is uploaded with users mapped to a segment key, the segment is identified and Beeswax will automatically import those users to the identified segment so that it can be used for targeting on line items or campaigns. When uploading a segment upload file, the format must be .txt and each line must contain a user ID and the segment key.


Beeswax supports adding as many segment IDs the user ID qualifies for, as long as each is pipe delimited after the user ID, e.g. <uuid>|<segment_ID1>|<segment_ID2>|<segment_ID3>.

Additionally, a user-segment value may be added which can be used as the value in Types of Bid Modifiers. Values must be specified as a float (number), strings will not be accepted, e.g. <uuid>|<segment_ID1>:<value>|<segment_ID2>:<value>|<segment_ID3>.


Accessing Segment Uploads

To access the Segment Uploads page, navigate to Trafficking > Segment Uploads at the top of the screen.

Segment Uploads List View

List View Fields

Column NameDescription
Name & IDName & ID of created segment upload.
Upload Complete DateCompleted date of upload; displayed with date and time format of 00:00:00.
Upload Message

This is the message displayed identifying the success of the lines submitted during upload. 

Example message: 

{"lines_processed_count": 4, "is_liveramp_derived_idl": 0, "lines_failed_count": 0, "lines_succeed_count": 4, "line_parse_error": 0, "skipped_segment_count": 0, "not_found_alt_ids_for_segment_count": 0, "too_many_segment_per_line": 0, "translated_customer_id_count": 0, "unmappable_customer_id_count": 0, "warning_message": "", "error_message": ""}


Create DateDate of segment upload creation.
Upload Status

Status of the upload:

  • No file uploaded
  • Pending
  • Completed
  • Failed




Create a Segment Upload

  1. Navigate to Trafficking > Segment Uploads > New Segment Upload. Additionally, segment uploads may be created by clicking the button, then clicking Segment Upload at the top right of the UI.

  2. A screen will appear with the following fields to complete:
    *Required

    Field NameDescription
    File Format

    Dropdown displaying the selectable file formats. For information on segment file format, see Segments.

    Segment Key Type
    • Alternative
    • Default

    Choose "DEFAULT" if using the Beeswax segment ID type unless choosing to utilize the alternative ID functionality. If using the alternative ID functionality,  choose "alternative" as the Segment Key Type.

    For more information about the Alternative ID process, see Segments.

    User ID Type*

    Declare whether the User ID Type is Beeswax Cookie-ID ("BEESWAX"), one of the IDFA/Android options, Customer Cookie-ID (requires additional setup) or IP Address. Two options are available to select:

    Users will be able to see first-party ID types that they own or have permission to.

    • Third-Party ID (dropdown)

    • First-Party ID (text field) 
      • For First-Party ID, please ensure that the name is all capital letters and there are no spaces in between. For example, AIDEM_1P_ID.
    File*


    If looking to upload a file larger than 10 MB, multiple files must be created smaller than 10 MB or follow the large segment file upload method via S3 uploads found here: Segment Upload / Segment Update

    The segment file must meet all of the following requirements:

    • .txt file required
    • utf-8 (without BOM - byte-order marks) or ASCII encoded
    • One user ID or IP address per row
    • Hashed emails must be uploaded into the Beeswax platform as lower case.
    • Pipe delimited with the segment IDs in the format <uuid>|<segment_ID1> where:
      •  <uuid> is the user ID 
      • <segment_ID1> is the segment key to be updated in the format <buzz_key>-<id>
    • One user ID type per file such as: 
      • Android Advertising ID
      • Android Advertising ID - hashed with MD5
      • Android Advertising ID - hashed with SHA1
      • Apple IDFA
      • Apple IDFA - hashed with MD5
      • Apple IDFA - hashed with SHA1
      • Beeswax cookie ID
      • Blockgraph ID (BGID)
      • Connected TV
      • Customer ID (requires additional setup)
      • Customer cookie ID (first party)
      • Experian Living Unit ID (LUID) – This ID is FW encoded
      • IP Address (IPV4/IPV6)
      • LiveRamp RampID (formerly IDL) – This ID is FW encoded
      • Other Mobile ID types

    IDs such as  LIVERAMP_IDL and LUID are FreeWheel encoded. To get more details about a particular ID, please contact your account team.


    Example of upload file using Beeswax cookie ID (cookie sync must be setup for Beeswax):

    ABu2g06r-skAAA22gS_t7Q==|buzzkey-5
ADZ3B06uYnQAAGdoLb2Q9Q|buzzkey-16|buzzkey-5
AWnzcE6sI3MAABI-rmQrpw==|buzzkey-23


    Example of upload file for Mobile Device IDs:

    6D92078A-8246-4BA4-AE5B-72104831E7DC|buzzkey-7
DD36038T-83U9-4BC2-B19X-76114961E8DG|buzzkey-2|buzzkey-1
9M3P03KR-62U2-GCD3-C10X-4820261SFGA7|buzzkey-1|buzzkey-5






Segment File Upload via API or S3

The file size limit for uploads via API is 10MB. To upload files larger than 10MB, files may be uploaded directly to Beeswax's AWS S3 bucket. Information on this process can be found in Uploading Segments and Bid Models to S3. For uploading segments to S3, please provide your account manager with the AWS ARN (Amazon Resource Names) so that Beeswax can configure S3 permissions to allow the dropping of large files on Beeswax's cloud.

For instructions on segment file uploads via API, see Segment Upload Segment Update.

Overwriting or Deleting User-Segment Combinations

Removing users from a segment must be done via the API. Details can be found here.

Removing Users From all Beeswax Segments

If a user exercises their GDPR right to be forgotten within Europe and requests removal from both your systems and those of your data processors, the following method can be used to remove them from all Beeswax segments.

Start by creating a file that is line-separated, with a single Device ID, IDFA, or Beeswax Cookie ID per line. For example:

Next, upload this file to Beeswax (detailed instructions are available here).

Ensure that the following parameters are included in the segment_upload API POST:

  • “operation_type”: “REPLACE_ALL_SEGMENTS”
  • For GDPR requests: “continent”: “EMEA”