Digital Platform API - Member service

A member is any entity that has a financial relationship with Xandr, and each client is a single member. Members are registered with the Member Service by Xandr 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 Xandr. This contract will establish financial terms and credit facilities (if applicable), and bind the member to the terms and conditions of Xandr, such as content quality and use of personally identifiable information.

REST API

HTTP Method	Endpoint	Description
`GET`	`https://api.appnexus.com/member`	View your member
`GET`	`https://api.appnexus.com/member?id=MEMBER_ID`	View a particular member, if you have multiple
`GET`	`https://api.appnexus.com/member/meta`	Find out which fields you can filter and sort by
`PUT`	`https://api.appnexus.com/member?id=MEMBER_ID`	Modify an existing member
`POST`	`https://api.appnexus.com/member`	Add a new member (Admin-only)

JSON fields

Field	Type	Description
`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. Note: If you set this to `true`, you must set the `default_ad_profile_id` as well. Default: `true`
`allow_non_cpm_payment`	Boolean	Default: `true`
`app_contract_accepted`	Boolean	Not yet supported. Indicates whether the member has agreed to the Xandr terms of service contract for Xandr's exchange. Non-admin users can only change this field from `False` to `True`. In order to set it from `True` to `False`, contact your Xandr representative. Default: `false`
`audit_notify_email`	string	Each time Xandr 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_blocklist_email` below).
`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.
`buyer_credit_limit`	double	Admin-only. The credit limit with Xandr taken into consideration when the member is buying inventory.
`contact_email`	string	The email contact for this member.
`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 this format.
`contract_allows_unaudited`	Boolean	Admin-only. See `default_campaign_trust` and `default_campaign_allow_unaudited` for information about Xandr-reviewed inventory. If your contract does not allow you to run on non-Xandr-reviewed inventory for some reason, this will be `false`. Default: `true`
`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`.
`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.
`daily_budget`	money	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. To control who receives email notifications when your safety budget is approached, use the `send_safety_budget_notifications` field on the User Service. Default: `null`
`daily_budget_imps`	int	The safety budget for your member, in impressions. See `daily_budget` above for more details. Default: `null`
`daily_imps_self_audited`	int
`daily_imps_unaudited`	int
`daily_imps_verified`	int
`deal_types`	array of objects	Default: `null`
`default_accept_data_provider_usersync`	Boolean	See `default_accept_supply_partner_usersync`. Default: `true`
`default_accept_deals`	Boolean	If `true`, the `acceptance_status` field of the Deal Buyer Setting Service defaults to `active`, if `false`, the `acceptance_status` defaults to `pending`. Default: `true`
`default_accept_demand_partner_usersync`	Boolean	See `default_accept_supply_partner_usersync`. Default: `true`
`default_accept_supply_partner_usersync`	Boolean	We use pixels to sync user IDs between Xandr 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. Default: `true`
`default_ad_profile_id`	int	The ID of the default Ad Profile to use. This is required when `allow_ad_profile_override` is `true`.
`default_allow_cpa`	Boolean	Default: `true`
`default_allow_cpc`	Boolean	Default: `true`
`default_buyer_group_id`	int	Currently used for an alpha feature.
`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. Default: `false`
`default_campaign_trust`	enum	Xandr 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 Xandr-reviewed inventory, then set this field to `"appnexus"`. If you want 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. Possible values: - `seller` - `appnexus` Default: `appnexus`
`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. Note: This setting can still be overridden by the `content_retrieval_timeout_ms` field on the placement itself. Default: `0`
`default_country`	array of objects	The objects are: - `"country_id"` - `"country_name"` - `"country_code"` Default: `null`
`default_currency`	string	The default currency for this member. Can be overridden at more granular levels. For possible currency values, use the Currency Service. Default: `USD`
`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. Default: `false`
`default_placement_id`	int	The placement ID to be used as a default when an inactive or nonexistent seller tag is called.
`developer_id`	int	Read-only. The ID of the developer, if the member is developing on Xandr's platform (e.g., for the Apps Marketplace).
`domain_blocklist_email`	string	When Xandr finds domains belonging to this member to be in violation of its standards and auditing policies, the domains are put into a blocklist, and an email is sent to this email address. The email identifies the domain URL, average daily impressions, and blocklist reason(s) for each domain that averaged at least 10,000 daily impressions over the last 7 days. Blocked domains that averaged less than 10,000 daily impressions over the last 7 days are not included in the email. Note: If no email address is provided here, the email address in the `audit_notify_email` is used instead.
`dongle`	string	A code that is used as a password for a member's debug output.
`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.