Skip to end of metadata
Go to start of metadata

Visibility Profile Service

If you resell your inventory, the Visibility Profile Service enables you to control the level of detail you pass to buyers in your bid requests. Specifically, you can expose or hide publisher IDs and names, placement IDs and names, publisher-provided age and gender data, the universal and custom categorization of your inventory, inventory URLs, location information, and more.

The default settings in your profile (i.e., expose_age_default, expose_gender_default, and so on) apply to all platform buyers and external bidders, but you can override the default settings for specific platform buyers and external bidders using the buyer_members and bidders arrays. For example, you might hide inventory data by default and then expose data only to specific buying members with whom you have a special business relationship. Alternately, you might expose inventory data to everyone except specific buying members whom you deem to be competitors.

In addition to affecting the data that buyers see in your bid requests, visibility settings affect the data that buyers see when they report on impressions bought from you. For example, if you hide publisher IDs and names from a buyer, that buyer won't see your publisher IDs and names in reporting.

Although you can create multiple visibility profiles, you can attach only one to your member (see the visibility_profile_id field in the Member Service). If you are interested in attaching visibility profiles directly to publishers, please speak with your Account Representative.

On This Page

REST API

Add a visibility profile:

Modify a visibility profile:

Delete a visibility profile:

View all of your visibility profiles:

View a specific visibility profile:

View multiple visibility profiles by ID using a comma-separated list:

Find out which fields you can filter and sort by:

JSON Fields

Field

Type

Description

Default

Required On

id

int

Read-only. The ID of the visibility profile.

Auto-generated number (i.e., 123)

PUT, in query string

member_id

int

Read-only. The ID of the member that owns the visibility profile.

 

 

name

string

The name of the visibility profile.

 

POST

notes

string

Additional information about the visibility profile.

 

 

expose_publishers_default

Boolean

Do Not Use.

Not available to all clients. If true, publisher IDs are passed in your bid requests. This applies to all platform members and bidders not set separately in the buyer_members and bidders arrays below.

true

 

expose_tags_default

Boolean

Do Not Use.

Not available to all clients. If true, placement IDs are passed in your bid requests. This applies to all platform members and bidders not set separately in the buyer_members and bidders arrays below.

true

 

expose_age_default

Boolean

If true, publisher-provided age data is passed in your bid requests. This applies to all platform members and bidders not set separately in the buyer_members and bidders arrays below.

true

 

expose_gender_default

Boolean

If true, publisher-provided gender data is passed in your bid requests. This applies to all platform members and bidders not set separately in the buyer_members and bidders arrays below.

true

 

expose_universal_categories_default

Boolean

Do Not Use. This field is ignored.

true

 

expose_custom_categories_default

enum

The visibility of your custom content categories in your bid requests. Possible values:

  • none - No custom categories are passed in your bid requests
  • all - All custom categories are passed in your bid requests
  • list - The custom categories listed in the custom_categories array are passed in your bid requests

none

 

url_exposure_default

enum

The visibility of inventory URLs in your bid requests. Possible values:

  • full - Full URLs are passed in your bid requests
  • domain - Only domains of URLs are passed in your bid requests
  • hidden - URLs are not passed in your bid requests

full

 

expose_bid_requests_default

Boolean

Do Not Use. This field is ignored.

true

 

expose_auction_id_default

Boolean

Do Not Use. This field is ignored.

true

 

expose_locale_default

Boolean

Do Not Use. This field is ignored.

true

 

expose_ecp_default

Boolean

Do Not Use. This field is ignored.

true

 

expose_reserve_price_default

Boolean

If true, the publisher-provided reserve prices are passed in your bid requests. This applies to all platform members and bidders not set separately in the buyer_members and bidders arrays below.

true

 

expose_user_id_default

Boolean

If true, publisher-provided user IDs are passed in your bid requests. This applies to all platform members and bidders not set separately in the buyer_members and bidders arrays below.

true

 

expose_ip_default

Boolean

If true, publisher-provided IP addresses are passed in your bid requests. This applies to all platform members and bidders not set separately in the buyer_members and bidders arrays below.

true

 

expose_venue_id_default

Boolean

Do Not Use. This field is ignored.

true

 

expose_user_agent_default

Boolean

If true, publisher-provided user agents are passed in your bid requests. This applies to all platform members and bidders not set separately in the buyer_members and bidders arrays below.

true

 

expose_city_default

Boolean

Do Not Use. This field is ignored.

true

 

expose_state_default

Boolean

Do Not Use. This field is ignored.

true

 

expose_dma_default

Boolean

Do Not Use. This field is ignored.

true

 

expose_postal_code_default

Boolean

If true, publisher-provided postal codes are passed in your bid requests. This applies to all platform members and bidders not set separately in the buyer_members and bidders arrays below.

true

 

expose_geo_lat_lon_default

Boolean

If true, publisher-provided latitude and longitude information is passed in your bid requests. This applies to all platform members and bidders not set separately in the buyer_members and bidders arrays below.

true

 

expose_device_id_default

Boolean

If true, publisher-provided device IDs are passed in your bid requests. This applies to all platform members and bidders not set separately in the buyer_members and bidders arrays below.

true

 

expose_device_model_id_default

Boolean

Do Not Use. This field is ignored.

true

 

expose_querystring_default

Boolean

If true, publisher-provided query strings are passed in your bid requests. This applies to all platform members and bidders not set separately in the buyer_members and bidders arrays below.

true

 

expose_application_id_default

Boolean

If true, publisher-provided Android or iOS mobile application IDs are passed in your bid requests. This applies to all platform members and bidders not set separately in the buyer_members and bidders arrays below.

true

 

expose_site_id_default

Boolean

If true, publisher-provided placement group (site) IDs are passed in your bid requests. This applies to all platform members and bidders not set separately in the buyer_members and bidders arrays below.

true

 

expose_datetime_default

Boolean

Do Not Use. This field is ignored.

true

 

buyer_members

array of objects

The visibility rules for specific AppNexus platform members. See Buyer Members below for more details.

 

 

bidders

array of objects

The visibility rules for specific external bidders and/or contextual data providers. See Bidders below for more details.

 

 

custom_categories

array of objects

The custom content categories that are passed in your bid requests. See Custom Categories below for more details.

 

POST, if expose_custom_categories_default is list

last_modified

timestamp

Read-only. The date and time when the visibility profile was last modified.

 

 

Custom Categories

If expose_custom_categories_default is set to list, you use this array to specify the custom categories that you want to pass in your bid requests. Each object in the array represents a single custom category and contains the following fields. See the examples below for formatting.

You can use the Content Category Service to get the IDs of your custom content categories.

Field

Type

Description

Default

Required On

id

int

The ID of the custom content category that is passed in your bid requests.

 

 

name

string

Read-only. The name of the custom content category.

 

 

Buyer Members

You use this array to define visibility rules for specific AppNexus platform members. Each object in the array represents a single member and contains the following fields. See the examples below for formatting.

You can can use the Platform Member Service to get the IDs of AppNexus platform members.

Field

Type

Description

Default

Required On

id

int

The ID of the AppNexus platform member to which you want to apply specific visibility rules.

 

POST

name

string

Read-only. The name of the AppNexus platform member.

 

 

expose_publishers 

Boolean

Do Not Use. This field is ignored.

For select customers: If true, publisher IDs are passed in your bid requests to the member. 

true

 

expose_tags

Boolean

Do Not Use. This field is ignored.

For select customers: If true, placement IDs are passed in your bid requests to the member.

true

 

expose_age

Boolean

If true, age data is passed in your bid requests to the member.

true

 

expose_gender

Boolean

If true, gender data is passed in your bid requests to the member.

true

 

expose_universal_categories

Boolean

Do Not Use. This field is ignored.

true

 

expose_custom_categories

enum

The visibility of your custom content categories in your bid requests to the member. Possible values:

  • none - No custom categories are passed in your bid requests
  • all - All custom categories are passed in your bid requests
  • list - The custom categories listed in the custom_categories array are passed in your bid requests

none

 

custom_categories

array of objects

The custom content categories that are passed in your bid requests to the member. See Custom Categories above for the fields in this array.

 

POST, if expose_custom_categories_default is list

url_exposure

enum

The visibility of inventory URLs in your bid requests to the member. Possible values:

  • full - Full URLs are passed in your bid requests
  • domain - Only domains of URLs are passed in your bid requests
  • hidden - URLs are not passed in your bid requests

full

 

expose_bid_requests

Boolean

Do Not Use. This field is ignored.

true

 

expose_auction_id

Boolean

Do Not Use. This field is ignored.

true

 

expose_locale

Boolean

Do Not Use. This field is ignored.

true

 

expose_ecp

Boolean

Do Not Use. This field is ignored.

true

 

expose_reserve_price

Boolean

If true, reserve prices are exposed to the owning member.

true

 

expose_user_id

Boolean

If true, user IDs are exposed to the owning member.

true

 

expose_ip

Boolean

If true, IP addresses are exposed to the owning member.

true

 

expose_venue_id

Boolean

Do Not Use. This field is ignored.

true

 

expose_user_agent

Boolean

If true, user agents are exposed to the owning member.

true

 

expose_city

Boolean

Do Not Use. This field is ignored.

true

 

expose_state

Boolean

Do Not Use. This field is ignored.

true

 

expose_dma

Boolean

Do Not Use. This field is ignored.

true

 

expose_postal_code

Boolean

If true, postal codes are exposed to the owning member.

true

 

expose_geo_lat_lon

Boolean

If true, latitude and longitude information is exposed to the owning member.

true

 

expose_device_id

Boolean

If true, device IDs are exposed to the owning member.

true

 

expose_device_model_id

Boolean

Do Not Use. This field is ignored.

true

 

expose_querystring

Boolean

If true, query strings are exposed to the owning member.

true

 

expose_application_id

Boolean

If true, Android or iOS mobile application IDs are exposed to the owning member.

true

 

expose_site_id

Boolean

If true, placement group (site) IDs are exposed to the owning member.

true

 

expose_datetime

Boolean

Do Not Use. This field is ignored.

true

 

Bidders

You use this array to define visibility rules for specific external bidders and/or contextual data providers. Each object in the array represents a single bidder and contains the following fields. See the examples below for formatting.

There is no service for directly getting external bidder IDs; however, the Platform Member Service gets you information about platform members, including the bidders that they are using.

Field

Type

Description

Default

Required On

id

int

The ID of the external bidder to which you want to apply specific visibility rules.

 

POST

name

string

Read-only. The name of the external bidder.

 

 

expose_publishers

Boolean

Do Not Use. This field is ignored.

For select customers: If true, publisher IDs are passed in your bid requests to the bidder.

true

 

expose_tags

Boolean

Do Not Use. This field is ignored.

For select customers: If true, placement IDs are passed in your bid requests to the bidder.

true

 

expose_age

Boolean

If true, age data is passed in your bid requests to the bidder.

true

 

expose_gender

Boolean

If true, gender data is passed in your bid requests to the bidder.

true

 

expose_universal_categories

Boolean

Do Not Use. This field is ignored.

true

 

expose_custom_categories 

enum

The visibility of your custom content categories in your bid requests to the bidder. Possible values:

  • none - No custom categories are passed in your bid requests
  • all - All custom categories are passed in your bid requests
  • list - The custom categories listed in the custom_categories array are passed in your bid requests

none

 

custom_categories

array of objects

The custom content categories that are passed in your bid requests to the bidder. See Custom Categories above for the fields in this array.

 

POST, if expose_custom_categories_default is list

url_exposure

enum

The visibility of inventory URLs in your bid requests to the bidder. Possible values:

  • full - Full URLs are passed in your bid requests
  • domain - Only domains of URLs are passed in your bid requests
  • hidden - URLs are not passed in your bid requests

full

 

expose_bid_requests

Boolean

Do Not Use. This field is ignored.

true

 

expose_auction_id

Boolean

Do Not Use. This field is ignored.

true

 

expose_locale

Boolean

Do Not Use. This field is ignored.

true

 

expose_ecp

Boolean

Do Not Use. This field is ignored.

true

 

expose_reserve_price

Boolean

If true, reserve prices are passed in your bid requests to the bidder.

true

 

expose_user_id

Boolean

If true, user IDs are passed in your bid requests to the bidder.

true

 

expose_ip

Boolean

If true, IP addresses are passed in your bid requests to the bidder.

true

 

expose_venue_id

Boolean

Do Not Use. This field is ignored.

true

 

expose_user_agent

Boolean

If true, user agents passed in your bid requests to the bidder.

true

 

expose_city

Boolean

Do Not Use. This field is ignored.

true

 

expose_state

Boolean

Do Not Use. This field is ignored.

true

 

expose_dma

Boolean

Do Not Use. This field is ignored.

true

 

expose_postal_code

Boolean

If true, postal codes are passed in your bid requests to the bidder.

true

 

expose_geo_lat_lon

Boolean

If true, latitude and longitude information is passed in your bid requests to the bidder.

true

 

expose_device_id

Boolean

If true, device IDs are passed in your bid requests to the bidder.

true

 

expose_device_model_id

Boolean

Do Not Use. This field is ignored.

true

 

expose_querystring

Boolean

If true, query strings are passed in your bid requests to the bidder.

true

 

expose_application_id

Boolean

If true, Android or iOS mobile application IDs are passed in your bid requests to the bidder.

true

 

expose_site_id

Boolean

If true, placement group (site) IDs are passed in your bid requests to the bidder.

true

 

expose_datetime

Boolean

Do Not Use. This field is ignored.

true

 

Examples

Add a visibility profile - show inventory data to all buyers except member 9
Add a visibility profile - hide inventory data from all buyers except member 9
Modify visibility profile 1818
View all of your visibility profiles
View visibility profile 1818