Skip to end of metadata
Go to start of metadata

App Installation Service

This service allows app developers to install apps on client systems.

On This Page

REST API

View all installations

GET https://api.appnexus.com/app-installation

View a specific installation

GET https://api.appnexus.com/app-installation?id=ID

Install an app for a client

POST https://api.appnexus.com/app-installation
(add-app-installation.json)

Update an app installation
PUT http://sand.api.appnexus.com/app-installation?id=ID
(update-app-installation.json)

Delete an app installation 
DELETE https://api.appnexus.com/app-installation?id=ID

JSON Fields

Field

Type

Description

Default

Required On

id

int

The unique identification number of each installation instance.

 

PUT and DELETE in query string

plugin_id

int

The unique identification number of the plugin installed in this instance.

 

POST

addendum

string

This contains the text of the agreement that appears when a user installs the app. This field can be edited using the Markdown markup language.

  

subscriber_entity_type

enum

The parent organization of the user that installed the app. Possible values include "member" or "bidder". When adding an installation, you must choose the correct option for the subscriber_entity_id (below).

 

POST

subscriber_entity_id

int

The unique identification number of the parent of the user that installed the app.

 

POST

accepted_permissions

boolean

Indicates whether permission was received to access the areas required by the app for use.

  

installed_on

timestamp

Read-only. The date and time that this app was installed by the user.

  

installer_user_id

int

Read-only. The unique identification of the user with permission to install apps from the Apps Marketplace. This is also the user who can accept or reject addendum agreements.

  

permissions

array of objects

The operations that the app can perform on behalf of the currently logged in user. For more information, see Permissions below.

null

 

has_payment_access

boolean

Read-only. Indicates whether payment terms and fees can be applied to this app.

true

 

log_level_data_fee

int

Read-only. The fee being charged to the user to consume log-level data.

  

subscriber_phone

string

Read-only. The phone number of the specified contact person at the app installer.

  

subscriber_email

string

Read-only. The email address of the specified contact person at the app installer.

  

subscriber_name

string

Read-only. The name of the contact person at the app installer.

  

Permissions

Each object in the permissions array contains the following fields:

Field

Type

Description

Default

Required On

service

enum

The name of the API service that the app is permitted to use.

  

privileges

array of objects

The types of calls that the app can make to the API service and the specific fields that can be used.

Within each object, method defines the calls that can be made to the service ("get", "post", "put", or "delete"), and fields restricts the permissions to particular fields in the service. If fields is null, the permissions apply to all fields in the service. Note that use of the "delete" method must be approved by a Xandr representative.

  

Examples

View all installations
View a specific installation
Install an app to a client
Update an app installation
Delete an app installation

Related topics

Apps Marketplace Services

  • No labels