Skip to end of metadata
Go to start of metadata

Plugin Instance Service

When you develop an app for the AppNexus Apps Marketplace (customer login required), you build an umbrella app and then one or more specific app instances that plug into the AppNexus workflow in different places. The Plugin Instance Service allows you to create and control these instances. For information about creating and managing an umbrella app, see the Plugin Service.

On This Page

REST API

There are three different user roles, two of which that can make calls to this service:

  • App Providers - Members who develop apps in the App Marketplace
  • App Subscribers - Members who subscribe to and use apps
  • Non-member Developers - These app developers are not associated to members and cannot make calls to this service

Certain roles are restricted from making one or more calls. The roles that can make the calls specified in the Rest API section (below) are listed below each call.

Add an app:
POST https://api.appnexus.com/plugin-instance
(plugin-instance JSON)

  • App Providers
  • App Subscribers

Modify an app:
PUT https://api.appnexus.com/plugin-instance?id=PLUGIN_INSTANCE_ID
(plugin-instance JSON)

  • App Providers

View all app instances:
GET https://api.appnexus.com/plugin-instance

  • App Providers
  • App Subscribers (will only see instances to which they are associated)

View a specific app instance:
GET https://api.appnexus.com/plugin-instance?id=PLUGIN_INSTANCE_ID

  • App Providers
  • App Subscribers (will only see an instance if they are associated to it)

Delete an app instance:
DELETE https://api.appnexus.com/plugin-instance?id=PLUGIN_INSTANCE_ID

  • App Providers

View all apps installed by a subscriber:
DELETE https://api.appnexus.com/plugin?id=PLUGIN_INSTANCE_ID

View all apps created by a developer:
DELETE https://api.appnexus.com/plugin-instance?id=PLUGIN_INSTANCE_ID

JSON Fields

Field

Type

Description

Default

Required On

id

int

The ID of the app instance.

Auto-generated number

PUT/DELETE, in query string

plugin_id

int

The ID of the app that the instance belongs to.

POST

flavor

enum

The location where the app is integrated into the AppNexus workflow. Possible values:

  • "standalone" - The app is available to network users in the main Apps tab.

     Click for a screenshot

  • "creative_action" - The app is available to network users directly from the Creative Manager screen. For more details about this flavor of app, see Creative Flavor App (Customer login required).

     Click for a screenshot

  • "advertiser_menu" - The app is available to advertiser users in the Advertisers tab.
  • "publisher_menu" - The app is available to publisher users in the Publishers tab.
  • "conversion_pixel" - The app uses a tracking pixel to count the number of downloads of this app.

POST

iframe_url

string

The URL pointing to the content of the app.

POST

name

string

The name that is displayed with the app instances.

 Click for screenshots


POST

description

string

The tooltip that displays when you hover over the app instance.

 Click for a screenshot

null

icon_url

string

The url of the icon that is displayed with the app instance.

 Click for screenshots


null

proxy_url

string

The URL of the proxy.html file. This proxy file allows for cross-frame communication between the Console UI and your app. It must be uploaded to a URL on the same domain as your app.

POST

Examples

Add an app
Modify an app
View all apps
View a specific app
Delete an app
  • No labels