Page tree

Skip to end of metadata
Go to start of metadata

Member Profile Service

The Member Profile Service allows you to establish a single, global profile to limit the countries and domains from which you accept third-party impressions. Your campaigns will not bid on third-party impressions that do not match the requirements of the member profile.

Be sure to align your campaign profiles with your member profile; otherwise, your campaign targeting may not be effective.

Example 1: Your member profile is set to accept third-party impressions from the US and Canada. A campaign is set to target impressions from the US, Canada, and Mexico. In this case, the campaign will never have the chance to target impressions from Mexico because the member profile prevents those impressions from being available for bidding.

Example 2: Your member profile is set to block third-party impressions from domain list 1, which includes apples.com, oranges.com, and pears.com. A campaign is set to target domain list 3, which includes plums.com, bananas.com, and apples.com. Note that apples.com is included in both domain list 1 and domain list 3. In this case, the campaign will never have the chance to target impressions from apples.com because the member profile blocks domain list 1.

On This Page

REST API

Create your member profile:

POST https://api.appnexus.com/member-profile (member-profile JSON)

Update your member profile:

PUT https://api.appnexus.com/member-profile (member-profile JSON)

View your member profile:

GET https://api.appnexus.com/member-profile

Delete your member profile:

DELETE https://api.appnexus.com/member-profile

Find out which fields you can filter and sort by:

GET https://api.appnexus.com/member-profile/meta

Since you have only one member profile, you do not need to include the profile ID in PUT, GET, or DELETE requests.

JSON Fields


Field

Type

Description

Default

Required On

id

int

The ID of the member profile.

 

 

domain_list_action

enum

The action to perform on domain_list_targets. Possible values:   

  • "include" - You will accept third-party impressions only from the domains in the specified domain lists. 
  • "exclude" - You will accept third-party impressions from all domains except those in the specified domain lists.

"exclude"

 

domain_list_targets

array

The domain lists to include or exclude. See the examples below for formatting.

 

 

country_targets

array

The countries from which you will accept third-party impressions. You will accept impressions only from these countries. Note that if you do not specify any countries, you will accept third-party impressions from all countries. See Examples below.  

 

 

last_modified

date

Read-only. The date on which the member profile was last modified.

 

 

inventory_url_list_targetsarray of objects

Contains a list of inventory list IDs (whitelists and/or blacklists). Used to attach a single whitelist and/or one or more blacklists to the profile.

  • The whitelist contains a list of domains or apps to be targeted by the line item using the profile. If a whitelist is included, domains and apps not in the whitelist will not be targeted.
  • Each blacklist contains a list of domains or apps that are to be excluded from targeting by line item that uses the profile.

See Inventory Lists for more details.

  
require_transparency_and_consent_framework_stringboolean
  • If true, only allow associated objects to purchase inventory where valid TCF string is present
  • If false, allow associated objects to purchase any inventory that falls within pre-defined targeting declarations.

    This parameter is only applicable to the traffic coming from territories where GDPR applies.

false

Examples

Creating your member profile

Updating your member profile to accept third-party impressions from an additional country

Viewing your member profile

 Require Transparency and Consent Framework String