Categories API

{
    "items": [
        {
            "id": 322463,
            "name": "Self-Classification",
            "parentCategory": {
                "id": 322462
            },
            "partner": {
                "id": 2208
            },
            "verticalName": "Private DMP - Test Partner",
            "isPublicFlag": false,
            "isForNavigationOnlyFlag": true,
            "ownershipType": "thirdParty",
            "isLeafFlag": true,
            "pathFromRoot": {
                "ids": [
                    344,
                    322462,
                    322463
                ],
                "names": [
                    "ROOT",
                    "Test Partner - Private",
                    "Self-Classification"
                ]
            },
            "status": "active",
            "links": []
        },
        {
            "id": 322462,
            "name": "Test Partner - Private",
            "parentCategory": {
                "id": 344
            },
            "partner": {
                "id": 2208
            },
            "verticalName": "Private DMP - Test Partner",
            "isPublicFlag": false,
            "isForNavigationOnlyFlag": true,
            "ownershipType": "thirdParty",
            "isLeafFlag": false,
            "pathFromRoot": {
                "ids": [
                    344,
                    322462
                ],
                "names": [
                    "ROOT",
                    "Test Partner - Private"
                ]
            },
            "status": "active",
            "links": []
        }
    ],
    "totalResults": 2,
    "limit": 2,
    "offset": 0,
    "count": 2,
    "hasMore": false
}

{
  "items" : [ {
    "id" : 369765,
    "name" : "Television",
    "parentCategory" : {
      "id" : 344
    },
    "description" : "This vertical contains viewership data aggregated at the household level across TV show, viewing frequency, daypart, and genre.",
    "notes" : "",
    "partner" : {
      "id" : 0
    },
    "vertical" : {
      "name" : "Television"
    },
    "isPublicFlag" : true,
    "isForNavigationOnlyFlag" : false,
    "ownershipType" : "thirdParty",
    "isLeafFlag" : false,
    "pathFromRoot" : {
      "ids" : [ 344, 369765 ],
      "names" : [ "ROOT", "Television" ]
    },
    "status" : "active",
    "links" : [ ]
  }, {
    "id" : 1,
    "name" : "Geographic",
    "parentCategory" : {
      "id" : 344
    },
    "description" : "This category contains people whose geographic location was either self-declared or determined from their IP address. Locations in the United States are organized on the basis of U.S. Census Bureau Core Based Statistical Areas.",
    "partner" : {
      "id" : 0
    },
    "vertical" : {
      "name" : "Geographic"
    },
    "isPublicFlag": true,
    "isForNavigationOnlyFlag" : false,
    "ownershipType" : "thirdParty",
    "isLeafFlag" : false,
    "pathFromRoot" : {
      "ids" : [ 344, 1 ],
      "names" : [ "ROOT", "Geographic" ]
    },
    "status" : "active",
    "links" : [ ]
  }, {
    "id" : 3,
    "name" : "In-Market",
    "parentCategory" : {
      "id" : 344
    },
    "description" : "This category contains people who have demonstrated intent to make purchases in several key verticals. Intent is demonstrated by activities like searching for particular products, reading product specifications, adding items to a shopping cart, placing bids in online auctions, and requesting quotes for goods and services.",
    "notes" : "DO NOT EDIT THIS CATEGORY UNTIL QUALIFIED IN-MARKET IS PUBLIC",
    "partner" : {
      "id" : 0
    },
    "vertical" : {
      "name" : "Private - Default"
    },
    "isPublicFlag": true,
    "isForNavigationOnlyFlag" : false,
    "ownershipType" : "thirdParty",
    "isLeafFlag" : false,
    "pathFromRoot" : {
      "ids" : [ 344, 3 ],
      "names" : [ "ROOT", "In-Market" ]
    },
    "status" : "active",
    "links" : [ ]
  }, {
    "id" : 43876,
    "name" : "Past Purchases",
    "parentCategory" : {
      "id" : 344
    },
    "description" : "This category contains people who are likely to have made various purchases.",
    "notes" : "",
    "partner" : {
      "id" : 0
    },
    "vertical" : {
      "name" : "Past Purchases"
    },
    "isPublicFlag": true,
    "isForNavigationOnlyFlag" : false,
    "ownershipType" : "thirdParty",
    "isLeafFlag" : false,
    "pathFromRoot" : {
      "ids" : [ 344, 43876 ],
      "names" : [ "ROOT", "Past Purchases" ]
    },
    "status" : "active",
    "links" : [ ]
    }, 
  
    ...
    {
    "id" : 802803,
    "name" : "West Midlands",
    "parentCategory" : {
      "id" : 802654
    },
    "description" : "Targetable profiles > CACI Limited > UK Towns > West Midlands",
    "partner" : {
      "id" : 4521
    },
    "vertical" : {
      "name" : "Branded Data - CACI Limited"
    },
    "isPublicFlag": true,
    "isForNavigationOnlyFlag" : false,
    "ownershipType" : "thirdParty",
    "isLeafFlag" : false,
    "pathFromRoot" : {
      "ids" : [ 344, 24148, 801846, 802654, 802803 ],
      "names" : [ "ROOT", "Branded Data", "CACI Limited", "UK Towns", "West Midlands" ]
    },
    "status" : "active",
    "links" : [ ]
  } ],
  "count" : 12518
}

{
    "name": "Test node",
    "parentCategory": {
        "id": 410579
    },
    "partner": {
        "id": 2362
    }
}

{
    "id": 420063,
    "name": "Test node",
    "parentCategory": {
        "id": 410579,
        "name": "Child2"
    },
    "links": {
        "self": "https://taxonomy.bluekai.com/taxonomy/categories/420063",
        "parent": "https://taxonomy.bluekai.com/taxonomy/categories/410579"
    }
}

[
    {
        "name": "Test node1",
        "parentCategory": {
            "id": 322463
        },
        "partner": {
            "id": 2208
        }
    },
    {
        "name": "Test node2",
        "parentCategory": {
            "id": 322463
        },
        "partner": {
            "id": 2208
        }
    }
]

{
    "items": [
        {
            "httpStatusCode": 200,
            "item": {
                "id": 3,
                "name": "In-Market",
                "parentCategory": {
                    "id": 344,
                    "name": "ROOT"
                },
                "links": {
                    "self": "https://taxonomy.bluekai.com/taxonomy/categories/3",
                    "parent": "https://taxonomy.bluekai.com/taxonomy/categories/344"
                }
            }
        },
        {
            "httpStatusCode": 200,
            "item": {
                "id": 17,
                "name": "Autos",
                "parentCategory": {
                    "id": 3,
                    "name": "In-Market"
                },
                "links": {
                    "self": "https://taxonomy.bluekai.com/taxonomy/categories/17",
                    "parent": "https://taxonomy.bluekai.com/taxonomy/categories/3"
                }
            }
        }
    ],
    "size": 2
}

#! /usr/bin/env python -B

# -*- coding: utf-8 -*-

import sys, requests, json, argparse, unittest, hmac, base64, urllib, urlparse, hashlib

def cli_options():

parser = argparse.ArgumentParser(description='Demo for Category REST API')

parser.add_argument('-u','--url', default='https://localhost:8080/', help='Web service base URL')

parser.add_argument('-p','--partnerid', help='Partner id to use with this request')

parser.add_argument('-i','--bkuid', default='', help='UID')

parser.add_argument('-k','--bksecretkey', default='', help='Secret key')

parser.add_argument('-v','--verbose', default=0, action='count', help='Prints additional information')

return parser.parse_args()

args = cli_options()

URL = args.url.strip()

PARTNERID = args.partnerid

BKUID = args.bkuid

BKSECRETKEY = args.bksecretkey

VERBOSITY = args.verbose

USER_AGENT = {'User-Agent':'Mozilla/5.0 (Macintosh; Intel Mac OS X 10.8; rv:22.0) Gecko/20100101 Firefox/22.0'}

JSON_HEADERS = {'Content-Type': 'multipart/form-data', 'Accept':'application/json'}

COMMON_HEADERS = dict(USER_AGENT.items() + JSON_HEADERS.items())

class CategoryRest():

 

res = False

def info(self, message, verbosityLevel = 1):

if VERBOSITY >= verbosityLevel:

if not isinstance(message, basestring):

print json.dumps(message, indent=4)

else:

print message

 

def prepare_headers(self, headers = None):

if headers is None:

return COMMON_HEADERS.copy()

else:

return dict(COMMON_HEADERS.items() + headers.items())

def parse_query_params(self, query):

parameterList = query.split('&')

params = {}

if len(parameterList) > 0:

for entry in parameterList:

kvPair = entry.split('=')

params[kvPair[0]] = kvPair[1] if len(kvPair) > 1 else '';

return params

def prepare_request(self, endpoint, method = 'GET', params = None, data = None, headers = None, files = None, sign=True):

if files is not None:

headers.pop('Content-Type', None)

req = requests.Request(method, URL + endpoint, data = data, headers = headers, files = files)

prepared = req.prepare()

if sign:

if params is None:

params = {}

parsedUrl = urlparse.urlparse(URL)

parsedEndpoint = urlparse.urlparse(endpoint)

servletPath = "" if parsedEndpoint.path.strip().startswith("/") else "taxonomy/"

urlPath = parsedUrl.path.strip('/')

if urlPath:

urlPath = urlPath + '/'

fullPath = '/'+ urlPath + servletPath + parsedEndpoint.path.strip('/')

stringToSign = method + fullPath

params = dict(params.items() + self.parse_query_params(parsedUrl.query).items() + self.parse_query_params(parsedEndpoint.query).items())

queryParameterStr = '';

for key in params.keys():

if len(key) > 0:

if isinstance(params[key], list):

for listItem in params[key]:

value = urllib.quote(str(listItem))

stringToSign += value

queryParameterStr += urllib.quote(key) + '=' + value + '&'

else:

value = urllib.quote(str(params[key]))

stringToSign += value

queryParameterStr += urllib.quote(key) + '=' + value + '&'

if prepared.body is not None:

stringToSign += prepared.body

h = hmac.new(BKSECRETKEY, stringToSign.strip(), hashlib.sha256)

s = base64.standard_b64encode(h.digest())

signature = urllib.quote_plus(s)

finalURL = parsedUrl.scheme + '://' + parsedUrl.netloc + fullPath + '?' + queryParameterStr + 'bkuid=' + BKUID + '&bksig=' + signature

else:

finalURL = URL + endpoint

self.info('Sending %s request to: %s' %(method, finalURL))

prepared.url = finalURL

if VERBOSITY >=4:

print "Request object:"

for key, value in prepared.headers.iteritems():

print "%s: %s" % (key, value)

if prepared.body is not None and len(prepared.body)>0:

print ""

print prepared.body

return prepared

def post(self, endpoint, payload = None, params = None, headers = None, files = None):

if payload is not None:

data = payload if isinstance(payload, basestring) else json.dumps(payload)

else:

data = None

self.res = requests.Session().send(self.prepare_request(endpoint, method = 'POST', params = params, data = data, files = files, headers = self.prepare_headers(headers)), verify = False)

return self

def test_bulk_category_rest_create(self):

files = {'categoryFile': open('category_import.tsv', 'rb')}

created_categories = self.post('categories/import', files = files, params={'partner.id':PARTNERID}).res.json()

self.info(created_categories, 2)

instance=CategoryRest()

instance.test_bulk_category_rest_create()

{
    "id": 322463,
    "name": "Self-Classification - xyz",
    "parentCategory": {
        "id": 322462
    },
    "partner": {
        "id": 2208,
        "name": "Example Partner"
    },
    "vertical": {
        "id": 336,
        "name": "Private DMP - Example Vertical"
    },
    "isPublicFlag": false,
    "isForNavigationOnlyFlag": true,
    "ownershipType": "thirdParty",
    "isLeafFlag": false,
    "pathFromRoot": {
        "ids": [
            344,
            322462,
            322463
        ],
        "names": [
            "ROOT",
            "Example Partner - Private",
            "Self-Classification"
        ]
    },
    "status": "active",
    "links": []
}		

{
    "id": 322463,
    "name": "Self-Classification - xyz",
    "parentCategory": {
        "id": 322462,
        "name": "Example Partner - Private"
    },
    "links": {
        "self": "https://taxonomy.bluekai.com/taxonomy/categories/322463",
        "parent": "https://taxonomy.bluekai.com/taxonomy/categories/322462"
    }
}

[
    {
        "id": 489266,
        "name": "Test node1",
        "parentCategory": {
            "id": 322463
        },
        "description": "This is a sample category in our private taxonomy.",
        "notes": "change 33",
        "partner": {
            "id": 2208,
            "name": "Example Partner"
        },
        "vertical": {
            "id": 336,
            "name": "Private DMP - Example Vertical"
        },
        "isPublicFlag": true,
        "isForNavigationOnlyFlag": false,
        "ownershipType": "thirdParty",
        "isLeafFlag": false,
        "pathFromRoot": {
            "ids": [
                344,
                322463,
                489266
            ],
            "names": [
                "ROOT",
                "Example Partner - Private",
                "Self-Classification - xyz",
                "Test node1"
            ]
        },
        "status": "active",
        "links": []
    },
    {
        "id": 489267,
        "name": "Test node2",
        "parentCategory": {
            "id": 322463
        },
        "description": "This is a sample category in our private taxonomy.",
        "notes": "change 33",
        "partner": {
            "id": 2208,
            "name": "Example Partner"
        },
        "vertical": {
            "id": 336,
            "name": "Private DMP - Example Vertical"
        },
        "isPublicFlag": true,
        "isForNavigationOnlyFlag": false,
        "ownershipType": "thirdParty",
        "isLeafFlag": false,
        "pathFromRoot": {
            "ids": [
                344,
                322463,
                489267
            ],
            "names": [
                "ROOT",
                "Example Partner - Private",
                "Self-Classification - xyz",
                "Test node2"
            ]
        },
        "status": "active",
        "links": []
    }
]

{
    "items": [
        {
            "httpStatusCode": 201,
            "item": {
                "id": 489266,
                "name": "Test node1",
                "parentCategory": {
                    "id": 322463,
                    "name": "Self-Classification - xyz"
                },
                "links": {
                    "self": "https://taxonomy.bluekai.com/taxonomy/categories/489266",
                    "parent": "https://taxonomy.bluekai.com/taxonomy/categories/322463"
                }
            }
        },
        {
            "httpStatusCode": 201,
            "item": {
                "id": 489267,
                "name": "Test node2",
                "parentCategory": {
                    "id": 322463,
                    "name": "Self-Classification - xyz"
                },
                "links": {
                    "self": "https://taxonomy.bluekai.com/taxonomy/categories/489267",
                    "parent": "https://taxonomy.bluekai.com/taxonomy/categories/322463"
                }
            }
        }
    ],
    "size": 2
}