Skip to end of metadata
Go to start of metadata

Member Service

Members are integrated into the AppNexus system and managed via the Member Service.

Any entity that has a financial relationship with the AppNexus platform (usually a buyer or seller) needs to be added to the AppNexus system as a "member" before they can conduct transactions. Members can be registered with the Member Service either by a bidder or by AppNexus personnel.

Members and Contracts
Before they can buy or sell ads, a member needs a contract with AppNexus. This contract will establish financial terms and credit facilities (if applicable), and bind the member to the terms and conditions of AppNexus, such as content quality and use of personally identifiable information. Any bidder can create a member at any time, but members will not be able to place bids until their contract has been approved.

Also note:

  • If you are looking for information about other platform members use the Platform Member Service.
  • In bidder sandbox environments, all functionality of the Member Service is available.
  • The Member Service does not grant API access. That is done via the User Service.
On This Page

REST API

To see all your members:

To see a particular member:

The license could not be verified: License Certificate has expired!

JSON Fields

Field

Required

Type

Description

id

yes, on update

int

The ID of the member.

bidder_id

no

int

The bidder that manages bidding for the member. Can be blank for members that only sell inventory.

agent_id

no

string

Used for inventory aggregator members.

code

no

string(100)

Optional way to add an internal identification.

active

no

Boolean

Whether the member can provide and/or bid for inventory.

buyer_credit_limit

no

double

The credit limit for this member when buying inventory through the AppNexus platform. Read only.

billing_name

yes(on add)

string(100)

The billing name (who to write checks to).

billing_address_1

no

string(255)

The first line of the member's address.

billing_address_2

no

string(255)

The second line of the member's address.

billing_city

no

string(100)

The city of the member's address.

billing_region

no

string

The region of the member's address.

billing_postal_code

no

string(50)

The postal code for the member's address.

billing_country

no

string(50)

The country of the member.

email_code

no

string(50)

Email code is a unique value used when TinyTags are processed via our email tag processing tool. Must be an alphanumeric value.

seller_revshare_pct

read-only, for bidder-users and members

double

Percentage amount that AppNexus takes out of seller revenue.

price_buckets

no

array

When using Preemptive Tags, a selling member may require Price Bucket for 3rd party ad server pricing. Depending on the kind of integration a 3rd party adserver requires, the values might be [{"price_bucket": 10}, {"price_bucket": 20}. . . ] or [{"price_bucket": 10, "width": 300, "height":200", "pixel_url": "http://..."}, . . . ].

default_tag_id

no

int

The ID of the creative to serve in the case where tags are being called using unknown codes.

default_ad_profile_id

no

int

If you want to set an ad profile for all TinyTags belonging to a member.

serving_domain

no

array of strings

Used when generating tags for selling members. (i.e. mycompany.adnxs.com instead ib.adnxs.com). "serving_domain": {"cname": null,"type": null} Read only.

timezone

no

string

The member timezone is the default timezone for your reports. Please see Reporting Timezones for possible values. Default is "EST5EDT".  

last_activity

no

timestamp

The timestamp of last modification to this bidder instance.

buyer_clearing_fee_pct

no

double

The percent of the CPM paid for inventory charged as a fee.

dongle

no

string

A password that can be passed into a debug auction (as the "dongle" parameter) that will allow a member access to relevant debug output from their bidder.

platform_exposure

 

 

See below for details.

audit_notify_email

no

string

Each time AppNexus audits a creative belonging to this member, a detailed response is sent to this email address. The response includes the creative's audit status and any reasons why the creative has not passed audit. This field supports multiple comma-separated email addresses.

prioritize_marginnoBooleanIf set to "true" the AppNexus Platform will perform a bid/no bid check for managed campaigns based on line item minimum margin settings.  
 
If set to "false" the AppNexus Platform will not not perform any bid/no bid check for managed campaigns based on the line item minimum.

sherlock_notify_email

no

string

Each time Sherlock, our automated creative scanning system, scans a creative belonging to this member, a response is sent to this email address. The response includes the creative's audit status and any reasons why the creative has not passed audit. For more information, please see Sherlock. This field supports multiple comma-separated email addresses.

contact_email

 

 

This field is not currently used.

allow_ad_profile_override

 

 

This field is not currently used.

Platform Exposure

The platform exposure setting determines how your account is displayed to other members on the platform. There are three values which result in slightly different behaviors as outlined below:

Platform Exposure Value

Behavior

public

Member is displayed using the billing name.

private

Member is displayed as "Member 123" where 123 is the member ID.

hidden

Member is not displayed.

The sample JSON below shows how to set this parameter.

{
  "member": {
    "platform_exposure": "public"
  }
}

The license could not be verified: License Certificate has expired!

Example

Authentication Token
Authentication is always the first step when using the API Services. The authentication token can then be written to our cookie file for future use. Please see Authentication Service for more detailed instructions.

Create a JSON-formatted file describing the member.
The only required fields are billing_name and bidder_id if the member is associated with a bidder, but since a member has a financial relationship with AppNexus, you will probably want to include other billing-related information.

Add the member file to the Imp Bus cache.

Now modify the member via a modified JSON-formatted file.
Note you do not need the member ID in the JSON, but you will need it when making the PUT request.

Update the member information in the Imp Bus cache, using the member ID.

View information about the member.

  • No labels