Register segments using a taxonomy file

Before you begin: Grant Index access to your Amazon S3 bucket or your Google Cloud Storage bucket.

Register all your segments in the Index ecosystem. If the segment data file contains any new segments, you must first register them using a taxonomy file. The taxonomy file has a maximum size of 30 kB. If all segments cannot fit within this limit, we recommend using multiple taxonomy files. Both the externalSegmentID and externalSegmentName are limited to 255 characters and must use UTF-8 encoding.

You can also include a fee for each segment in the taxonomy file. When a segment includes a terms.standardFee object, Index creates the fee for that segment when it registers the segment, so you won’t need to configure the fee separately afterward.

1. Create the taxonomy file using the valid taxonomy file structure. Taxonomy files must be valid JSON and follow this structure:

   {
       "version": "2.0", // The version which must be "2.0"
       "segments": [
           {
               "externalSegmentID": "segment_id_1", // The external-facing segment identifier
               "externalSegmentName": "Segment Name 1", // The human-readable name
               "accountID": 1234567, // The Index generated account ID for the owner of the segment.
               "description": "Example segment", // Optional. A segment description of up to 500 characters.
               "terms": { // Optional. Omit to register the segment without a fee.
                   "standardFee": {
                       "calculationType": "C", // The fee calculation type, where 'C' is for a fixed CPM and 'P' is % of media
                       "value": 1.20, // The fee amount
                       "currency": "USD", // The currency of the fee
                       "cpmCap": 5.00, // An optional CPM cap for a percentage-based fee
                       "vendorAccountID": 1234567, // The Index generated account ID of the vendor receiving the fee
                       "description": "Example segment fee" // Optional. A human-readable description of the segment fee
                   }
               }
           },
           {
               "externalSegmentID": "segment_id_2", // The external-facing segment identifier
               "externalSegmentName": "Segment Name 2", // The human-readable name
               "accountID": 2345678 // The Index generated account ID for the owner of the segment.
           }
       ]
   }

   Note: The taxonomy file must be a single JSON document, with all segments inside the segments array. Newline-delimited JSON (JSON Lines, or .jsonl, where each line is a separate JSON object) is not supported.

2. Upload the taxonomy file to your designated bucket and the specific metafiles/ folder.

   After you finish: Create the segment data files to upload.