Skip to end of metadata
Go to start of metadata

Member Service

A member is any entity that has a financial relationship with the AppNexus platform, and each Console client is a single member. Members are registered with the Member Service by AppNexus personnel, and all API activity must be associated with a member. Note that the Member Service does not grant API or UI access. Each member has multiple users who have their own UI and API credentials, and are managed by the User Service .

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.

On This Page

REST API

View your member:

View a particular member, if you have multiple:

Modify an existing member:

Add a new member (Admin-only):

Find out which fields you can filter and sort by:

JSON Fields

Field

Type

Description

Default

Required On

id

int

The ID of the member.

 

PUT, in query string

name

string

The name of the member.

 

POST

reselling_description

string

This description is not currently used in the UI.

  
state

enum

The state of the member. Possible values: "active" or "inactive".

  
no_reselling_priority

int

This value is used to determine whether RTB bids are allowed to compete with your managed campaigns. In order for an RTB bid to be able to compete with a managed bid for an impression, this field's value must be greater than the priority of the managed bid.

For example, let's say you have the following auction and settings:

Bid TypeBid PricePriority
RTB$58 (no_reselling_priority)
Managed$38 (line item or campaign priority)

In this example, the RTB bid will not compete, even though its bid price is higher. In order for RTB to compete on this impression, no_reselling_priority would have to be 9 or higher.

In addition, when reselling is allowed for an impression, the highest priority standard managed demand will be allowed to compete with the highest priority guaranteed demand (as well as with RTB).

 

  

entity_type

enum

Admin-only. A legacy field that may be used in the future. Possible values: "reseller" or "direct" (deprecated).

"reseller"

 

buyer_clearing_fee_pct

double

Admin-only. The percent of the CPM paid for inventory charged as a fee in certain cases. See your contract for more information.

  

app_contract_accepted

Boolean

Not yet supported. Indicates whether the member has agreed to the AppNexus terms of service contract for the AppNexus Marketplace. Non-admin users can only change this field from False to True. In order to set it from True to False, contact your AppNexus representative.

false

 

default_buyer_group_id

int

Currently used for an alpha feature.

  

interface_domain

string(100)

You can change the URL you use to access the AppNexus UI. This is useful for white labeling.

  

interface_domain_beta

string(100)

You can change the URL you use to access the AppNexus Beta UI. This is useful for white labeling.

  

creative_size_minimum_bytes

int

Read-only. The size above which a creative is considered over-sized. The member is charged a creative overage fee for serving an over-sized creative.

  

creative_size_fee_per_gb

float

Read-only. The fee that is charged per GB for a creative that exceeds the creative_size_minimum_bytes.

  

default_ad_profile_id

int

The ID of the default Ad Profile to use. This is required when allow_ad_profile_override is true.

  

email_code

string(50)

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

  

serving_domain

object

Admin-only. The domain through which advertisements are served. The format of the object is {"cname":"ad.domain.com","type":null}

  

reselling_exposure

enum

Whether or not to expose the member's inventory to the platform for reselling in the real-time marketplace. Possible values: "public" or "private".

"private"

 

reselling_exposed_on

string

The date and time at which reselling_exposure was changed to "public"

  

last_modified

timestamp

The timestamp of last modification to this member.

  

standard_sizes

array

The list of sizes which are included in the standard sizes dropdown in the UI when creating creatives. The array is of the following format:

  

buyer_credit_limit

double

Admin-only. The AppNexus credit limit taken into consideration when the member is buying inventory.

  

timezone

enum

The timezone of the member. See API Timezones for details and accepted values. To change the default timezone of an individual advertiser, use the Advertiser Service . If no timezone is specified in the Advertiser Service, advertisers inherit the member's timezone.

"EST5EDT"

 

seller_revshare_pct

int

Admin-only. If this member is a seller and has a revenue sharing agreement with AppNexus, the AppNexus portion of the revenue sharing is indicated here.

  

default_country

array of objects

The objects are:

  • "country_id"
  • "country_name"
  • "country_code"

null

 

dongle

string

A code that is used as a password for a member's AppNexus debug output.

  

platform_exposure

enum

This determines whether and how your member appears in the Buyers tab of the Ad Quality Manager in the UI and in the Platform Member service (Customer login required). Possible values:

  • "public" = Your member name is shown.
  • "private" = Your member ID is shown.
  • "hidden" = Your member does not appear.

Note that primary_type must be either "buyer" or "network" in order for it to appear in the Buyers tab of the Ad Quality Manager in the UI.

"public"

 

audit_notify_email

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. Could also be used for domain audit notification ( see domain_blacklist_email below).

  

sherlock_notify_email

string

Each time Sherlock 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. This email address will also receive object limit notifications , sent when you reach 85, 95, and 100 percent of your limit for an object. This field supports multiple comma-separated email addresses.

  

domain_blacklist_email

string

When AppNexus finds domains belonging to this member to be in violation of the Inventory Standards and Auditing policies (Customer login required), the domains are blacklisted and an email is sent to this email address. The email identifies the domain URL, average daily impressions, and blacklist reason(s) for each domain that averaged at least 10,000 daily impressions over the last 7 days. Blacklisted domains that averaged less than 10,000 daily impressions over the last 7 days are not included in the email.

If no email address is provided here, the email address in the audit_notify_email is used instead.
  

contact_email

string

The email contact for this member.

  

allow_ad_profile_override

Boolean

If true, the ad quality restrictions in default_ad_profile_id will take precedence over ad quality restrictions defined at the placement level. For example, if you restrict Advertiser X in the default ad quality profile at the network level, but do not restrict Advertiser X at the placement level, Advertiser X will still be restricted. If you set this to false , settings at the placement level will take precedence.

If you set this to true, you must set the default_ad_profile_id as well.

true

 

default_currency

string

The default currency for this member. Can be overridden at more granular levels. For possible currency values, please use the Currency Service.

USD
 

use_insertion_orders

Boolean

If true, use insertion orders (an organizational level above line items) for this member. Many members find insertion orders necessary. For details see Working with Insertion Orders. (Customer login required)

false
 

expose_optimization_levers

Boolean

Admin-only. If true, optimization levers are shown in the UI.

false
 

pops_enabled_UI

Boolean

Admin-only. If true, pop ad support is shown in the UI.

false
 

default_accept_supply_partner_usersync

Boolean

We use pixels to sync user IDs between AppNexus and our major non-platform supply partners, such as Google, and third party data providers. This increases our ability to apply frequency and recency caps and segment data across the Internet. You can opt not to participate in user syncing; however this reduces our ability to apply the right information to your campaigns.

true
 

default_accept_data_provider_usersync

Boolean

See default_accept_supply_partner_usersync.

true
 

default_accept_demand_partner_usersync

Boolean

See default_accept_supply_partner_usersync.

true
 

short_name

string

URL-friendly name to be used as needed.

  

expose_eap_ecp_placement_settings

Boolean

Deprecated as of March 2011.

  

daily_imps_verified

int

   

daily_imps_self_audited

int

   

daily_imps_unaudited

int

   

is_iash_compliant

Boolean

Admin-only. If a selling member is IASH compliant, a logo will be placed next to the member's name in the Console UI Partner Center. (Customer login required)

false

 

deal_types

array of objects

 

null

 

allow_non_cpm_payment

Boolean

 
true
 

default_allow_cpc

Boolean

 
true
 

default_allow_cpa

Boolean

 
true
 

visibility_profile_id

int

The ID of the optional visibility profile attached to the member. See the Visibility Profile Service for more details.

null

 

default_campaign_trust

enum

AppNexus reviews a significant portion of inventory and applies quality attributes, and also encourages members who sell on our platform to review their inventory in the same manner. If you would like campaigns to by default run only on AppNexus-reviewed inventory, then set this field to "appnexus". If you wish to default to your seller trust settings, which may include seller-reviewed and unreviewed inventory, set this field to "seller". You can override this with the campaign's profile. Please see Inventory Quality for more information on this concept. (Customer login required)

Possible values:

  • seller
  • appnexus
appnexus
 

default_campaign_allow_unaudited

Boolean

You can choose to apply Inventory Quality criteria to your campaigns (sensitive attributes, intended audience, etc.). If this field is false, then certain inventory quality criteria will be applied by default to each campaign. You can override it at any time in the Campaign Manager or through the campaign's profile. If true, no inventory quality criteria will be applied to your campaigns unless you manually apply it. See Inventory Quality for more information on this concept. (Customer login required)

false
 

website_url

string

The company website for this member. This is used in a number of areas where contact details are displayed.

  

contract_allows_unaudited

Boolean

Admin-only. See default_campaign_trust and default_campaign_allow_unaudited for information about AppNexus-reviewed inventory. If your contract does not allow you to run on non-AppNexus-reviewed inventory for some reason, this will be false.

true
 

reporting_decimal_type

enum

The decimal mark used in reporting. This setting can be overridden at the user and report levels (see "reporting_decimal_type" in the User Service and Report Service). Possible values:

  • "comma"
  • "decimal" (period)
"decimal"
 

plugins_enabled

Boolean

Admin-only. If true, the Apps tab is shown in the UI.

false
 

plugins

array

The plugins that users see on the Apps tab in the UI. See Plugins below for more details.

  

enable_click_and_imp_trackers

Boolean

Admin-only. If true, external click and impression trackers can be created in the UI.

false
 

max_hosted_video_size

int

Admin-only. The maximum file size for hosted in-stream video creatives. In addition to limiting file size, setting this field enables the member to host videos with AppNexus.

  

developer_id

int

Read-only. The ID of the developer, if the member is developing on the AppNexus platform (e.g., for the Apps Marketplace).

  

pitbull_segment_id

int

This field has been deprecated.

  

pitbull_segment_value

int

This field has been deprecated.

  

content_categories

array of objects

A list of available categories that you can apply to publishers, sites, and placements. Can be customized by the member. The array is of the following format:

  

inventory_trust

array of objects

This controls who you buy from and whether AppNexus will use their quality and category information for targeting. See Inventory Trust below for more details.

  
seller_member_groupsarray of objectsAdmin-only. Specifies information about the groups of sellers to which this member belongs. See Seller Member Group below for more information.  

default_content_retrieval_timeout_ms

int

The default timeout, specified in milliseconds, for all placements created by this member. The default value of 0 will mean that mediated content will not be served.

This setting can still be overridden by the content_retrieval_timeout_ms field on the placement itself.

0

 

default_enable_for_mediation

Boolean

Whether placements created by this member are enabled to serve mediation creatives by default. Even if this field is set to false, the enable_for_mediation field on the placement itself can still override the behavior defined here.

false

 
prioritize_marginBooleanIf 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.false 

member_brand_exceptions

array of objects

An array of brand IDs. Creatives associated with these brands will be allowed to serve more than once per page load on your publishers' pages (only on those publishers' pages who have enabled sell-side page caps via the seller_page_cap_enabled field of the Publisher Service). You can also add per-publisher brand exceptions using the publisher_brand_exceptions field of the Publisher Service. See Member Brand Exceptions for the definitions of the objects stored in this array.

 

n/a

thirdparty_pixelsarrayRead-only. An array of third-party pixels associated with the member. You can automatically attach these pixels to all creatives owned by this member using the Third-party Pixel service or attach them individually at the creative level using the Creative Service.null 
floor_optimizationarray of objectsRead-only. Indicates if floor optimization is enabled for this member and provides the bidder ID of a real-time price provider. See Floor Optimization below for the definitions of the objects in this array. May also be set to null to disable the feature.  
mediationarray of objectsRead-only. Indicates whether automatic bid adjustments and reporting sync are enabled for this member. See Mediation below for the definitions of the objects in this array.  
native_custom_keysarray of objects

Some sellers of native advertising require buyers to use "custom keys" to target their inventory. These keys will vary from member to member. This field allows sellers to define what custom values they'd like buyers to pass in via a native creative. For more information, see Native Custom Keys below.

Get a list of a member's native custom keys

You can obtain a list of native custom keys using the read-only Native Custom Key Service.

nullN/A
daily_budgetmoney

The safety budget for your member, in U.S. dollars. The safety budget establishes a member-wide cap for your daily CPM media cost on third-party inventory. This helps limit the risk of unintentional overspend due to trafficking and campaign setup errors. Your safety budget always operates on the timezone of your member and resets each day at 12am.

null 
daily_budget_impsintThe safety budget for your member, in impressions. See daily_budget above for more details.null 
default_placement_idintThe placement ID to be used as a default when an inactive or nonexistent AppNexus tag is called.  

Native Custom Keys

FieldTypeDescription
custom_keystringA seller-defined key that defines what information the seller would like the buyer to pass in via a native creative.

Third-party Pixels

The thirdparty_pixels array contains the fields in the table below. These fields are read-only. To update or create third-party pixels and/or attach third-party pixels to all creatives owned by the member, use the Third-party Pixel service. To attach third-party pixels to individual creatives, use the Creative Service.

Field
Type
Description
idintRead-only. The pixel's ID.
namestringRead-only. The full name of the pixel.
activeBooleanRead-only. The current status of the pixel (true = active).
audit_statusstringRead-only. Audit status of the pixel.

Inventory Trust

Field

Type

Description

members

array

For each selling member, controls banned/eligible for selling to you, whether you trust their inventory audit, and whether you allow unaudited inventory from them.

default_trust

enum

Possible values:

  • appnexus: Campaigns using inventory quality filtering will only buy AppNexus-audited inventory from sellers unless overridden in the members array.
  • seller: inventory quality filtering will allow inventory that has been audited by the selling member in AppNexus.
default_allow_unaudited

Boolean

If true, campaigns using inventory quality filtering will allow unaudited inventory from sellers unless overridden in the members array.

Seller Member Group

All fields in the seller_member_group object can be written by admins only.

Field

Type

Description

display_order

int

Specifies the order in which this seller member group will be displayed in the UI. Default is 5.

id

int

Specifies the unique ID of this seller member group.
name

string

Specifies the name of this seller member group.

descriptionstringSpecifies a description of this seller member group.
last_modified

date

Timestamp that indicates when this seller member group was last modified.

created_ondateTimestamp that indicates when this seller member group was created.

Plugins

Field

Type

Description

Required On

id

int

The ID of the plugin.

 

status

enum

The state of the plugin. If "available" the user has not yet installed the plugin; if "installed", the user has installed the plugin; if "accept_permissions", the user has installed the plugin, but changes to the plugin require the user to explicitly accept the changes before continuing to use it. Possible values:

  • "available"
  • "installed"
  • "accept_permissions"
 

Member Brand Exceptions

Field

Type

Description

Required On

brand_id

int

The ID of the brand whose associated creatives you would like to allow to serve more than once per page load on page-cap-enabled publishers' inventory. This setting will only take effect on those publishers which you've enable for page capping by setting the seller_page_cap_enabled field to true on the Publisher Service. For more information about brands, see the Brand Service.

 

Floor Optimization

Field

Type

Description

Required On

active

Boolean

If true, this member has floor optimization enabled.

 
bidder_idintegerThe ID of an internal real-time price provider that performs the floor optimization. 

Mediation

Field

Type

Description

Required On

auto_bid_adjustment_enabled

Boolean

If true , this member can use the automatic bid adjustment feature, in which AppNexus suggests a bid based on an estimate what the network will pay and automatically updates the bid as conditions change.

 
reporting_sync_enabledBooleanIf true, this member can use the reporting sync feature, in which reporting data from third-party networks can be pulled from that network's servers. This data is used to create daily reports and monitor trends directly from Console. 

Examples

View your member
Update your member

Related Topics