API reference

Client

class appnexus.client.AppNexusClient(username=None, password=None, test=False, representation=None, token_file=None)

Represents an active connection to the AppNexus API

append(service_name, json, **kwargs)

property base_url

check_errors(response, data)

Check for errors and raise an appropriate error if needed

connect(username, password, test=None, representation=None, token_file=None)

connect_from_file(filename)

create(service_name, json, **kwargs)

Create a new AppNexus object

delete(service_name, *ids, **kwargs)

Delete an AppNexus object

error_codes = {'RATE_EXCEEDED': <class 'appnexus.exceptions.RateExceeded'>}

error_ids = {'NOAUTH': <class 'appnexus.exceptions.NoAuth'>}

find(service_name, arguments=None, representation=None, **kwargs)

get(service_name, **kwargs)

Retrieve data from AppNexus API

load_token(token_file=None)

meta(service_name)

Retrieve meta-informations about a service

modify(service_name, json, **kwargs)

Modify an AppNexus object

save_token()

test_url = 'https://api-test.appnexus.com/'

update_token()

Request a new token and store it for future use

url = 'https://api.appnexus.com/'

appnexus.client.connect(username, password, test=None, representation=None, token_file=None)

appnexus.client.find(service_name, arguments=None, representation=None, **kwargs)

Cursor

class appnexus.cursor.Cursor(client, service_name, representation, **specs)

Represents a cursor on collection of AppNexus objects

batch_size = 100

clone()

common_keys = {'count', 'dbg_info', 'num_elements', 'start_element', 'status'}

count()

Returns the number of elements matching the specifications

extract_data(page)

Extract the AppNexus object or list of objects from the response

property first

Extract the first AppNexus object present in the response

get_page(start_element=0, num_elements=None)

Get a page (100 elements) starting from start_element

iter_pages(skip_elements=0)

Iterate as much as needed to get all available pages

limit(number)

Limit the cursor to retrieve at most number elements

size()

Return the number of elements of the cursor with skip and limit

skip(number)

Skip the first number elements of the cursor

Exceptions

exception appnexus.exceptions.AppNexusException(response=None)

Represents a generic AppNexus Exception

exception appnexus.exceptions.BadCredentials(response=None)

Exception raised when wrong credentials are provided

exception appnexus.exceptions.NoAuth(response=None)

Exception raised when the client’s authentication expired

exception appnexus.exceptions.RateExceeded(response=None)

Exception raised when the client reached the rate limit

Model

class appnexus.model.Model(*args, **kwargs)

Generic model for AppNexus data

client = <appnexus.client.AppNexusClient object>

classmethod connect(username, password)

classmethod constructor(client, service_name, obj)

classmethod count(**kwargs)

classmethod create(payload, **kwargs)

classmethod delete(*args, **kwargs)

classmethod find(**kwargs)

classmethod find_one(**kwargs)

classmethod meta()

classmethod modify(payload, **kwargs)

save(**kwargs)

service_name = 'model'

Services

class appnexus.model.AccountRecovery(*args, **kwargs)

class appnexus.model.AdProfile(*args, **kwargs)

class appnexus.model.AdQualityRule(*args, **kwargs)

class appnexus.model.Adserver(*args, **kwargs)

class appnexus.model.Advertiser(*args, **kwargs)

class appnexus.model.BatchSegment(*args, **kwargs)

class appnexus.model.Brand(*args, **kwargs)

class appnexus.model.Broker(*args, **kwargs)

class appnexus.model.Browser(*args, **kwargs)

class appnexus.model.BudgetSplitter(*args, **kwargs)

class appnexus.model.Campaign(*args, **kwargs)

class appnexus.model.Carrier(*args, **kwargs)

class appnexus.model.Category(*args, **kwargs)

class appnexus.model.ChangeLog(*args, **kwargs)

class appnexus.model.ChangeLogDetail(*args, **kwargs)

class appnexus.model.City(*args, **kwargs)

class appnexus.model.ContentCategory(*args, **kwargs)

class appnexus.model.Country(*args, **kwargs)

class appnexus.model.Creative(*args, **kwargs)

class appnexus.model.CreativeFormat(*args, **kwargs)

class appnexus.model.CreativeVast(*args, **kwargs)

class appnexus.model.Currency(*args, **kwargs)

class appnexus.model.CustomModel(*args, **kwargs)

class appnexus.model.CustomModelHash(*args, **kwargs)

class appnexus.model.CustomModelLUT(*args, **kwargs)

class appnexus.model.CustomModelLogit(*args, **kwargs)

class appnexus.model.CustomModelParser(*args, **kwargs)

class appnexus.model.DMA(*args, **kwargs)

class appnexus.model.Deal(*args, **kwargs)

class appnexus.model.DealBuyerAccess(*args, **kwargs)

class appnexus.model.DealFromPackage(*args, **kwargs)

class appnexus.model.DeviceMake(*args, **kwargs)

class appnexus.model.DeviceModel(*args, **kwargs)

class appnexus.model.DomainAuditStatus(*args, **kwargs)

class appnexus.model.DomainList(*args, **kwargs)

class appnexus.model.ExternalInvCode(*args, **kwargs)

class appnexus.model.IPRangeList(*args, **kwargs)

class appnexus.model.InsertionOrder(*args, **kwargs)

class appnexus.model.InventoryAttribute(*args, **kwargs)

class appnexus.model.InventoryResold(*args, **kwargs)

class appnexus.model.Label(*args, **kwargs)

class appnexus.model.Language(*args, **kwargs)

class appnexus.model.LineItem(*args, **kwargs)

class appnexus.model.LineItemModel(*args, **kwargs)

class appnexus.model.Lookup(*args, **kwargs)

class appnexus.model.ManualOfferRanking(*args, **kwargs)

class appnexus.model.MediaSubtype(*args, **kwargs)

class appnexus.model.MediaType(*args, **kwargs)

class appnexus.model.Member(*args, **kwargs)

class appnexus.model.MemberProfile(*args, **kwargs)

class appnexus.model.MobileApp(*args, **kwargs)

class appnexus.model.MobileAppInstance(*args, **kwargs)

class appnexus.model.MobileAppInstanceList(*args, **kwargs)

class appnexus.model.MobileAppStore(*args, **kwargs)

class appnexus.model.NativeCustomKey(*args, **kwargs)

class appnexus.model.ObjectLimit(*args, **kwargs)

class appnexus.model.OperatingSystem(*args, **kwargs)

class appnexus.model.OperatingSystemExtended(*args, **kwargs)

class appnexus.model.OperatingSystemFamily(*args, **kwargs)

class appnexus.model.OptimizationZone(*args, **kwargs)

class appnexus.model.Package(*args, **kwargs)

class appnexus.model.PackageBuyerAccess(*args, **kwargs)

class appnexus.model.PaymentRule(*args, **kwargs)

class appnexus.model.Pixel(*args, **kwargs)

class appnexus.model.Placement(*args, **kwargs)

class appnexus.model.PlatformMember(*args, **kwargs)

class appnexus.model.PostalCode(*args, **kwargs)

class appnexus.model.Profile(*args, **kwargs)

class appnexus.model.ProfileSummary(*args, **kwargs)

class appnexus.model.Publisher(*args, **kwargs)

class appnexus.model.Region(*args, **kwargs)

class appnexus.model.Report(*args, **kwargs)

download(retry_count=3, **kwargs)

property is_ready

class appnexus.model.ReportStatus(*args, **kwargs)

class appnexus.model.Search(*args, **kwargs)

class appnexus.model.Segment(*args, **kwargs)

class appnexus.model.Site(*args, **kwargs)

class appnexus.model.TechnicalAttribute(*args, **kwargs)

class appnexus.model.Template(*args, **kwargs)

class appnexus.model.ThirdpartyPixel(*args, **kwargs)

class appnexus.model.User(*args, **kwargs)

class appnexus.model.UsergroupPattern(*args, **kwargs)

class appnexus.model.VisibilityProfile(*args, **kwargs)

Representations

appnexus.representations.raw(client, service, obj)

Utils

class appnexus.utils.classproperty(fget=None, fset=None, fdel=None, doc=None)

appnexus.utils.normalize_service_name(service_name, delimiter='-')