Compartir a través de

Servicio de instalación de aplicaciones

  • Artículo

Este servicio permite a los desarrolladores de aplicaciones instalar aplicaciones en sistemas cliente.

API de REST

Método Endpoint Description
GET https://api.appnexus.com/app-installation Visualización de todas las instalaciones
GET https://api.appnexus.com/app-installation?id=ID Visualización de una instalación específica
POST https://api.appnexus.com/app-installation Instalación de una aplicación para un cliente
PUT https://sand.api.appnexus.com/app-installation?id=ID Actualización de una instalación de aplicación
DELETE https://api.appnexus.com/app-installation?id=ID Eliminación de una instalación de aplicación

Campos JSON

Campo Tipo Descripción
accepted_permissions booleano Indica si se recibió el permiso para acceder a las áreas requeridas por la aplicación para su uso.
addendum string Contiene el texto del contrato que aparece cuando un usuario instala la aplicación. Este campo se puede editar mediante el lenguaje de marcado Markdown .
has_payment_access booleano Indica si los términos y las tarifas de pago se pueden aplicar a esta aplicación.
Solo lectura.
Valor predeterminado: true
id Entero Número de identificación único de cada instancia de instalación.
Obligatorio: PUT y DELETE
installed_on Timestamp Fecha y hora en que el usuario instaló esta aplicación.
Solo lectura
installer_user_id Entero Identificación única del usuario con permiso para instalar aplicaciones desde Marketplace de aplicaciones. También es el usuario que puede aceptar o rechazar acuerdos de adición.
Solo lectura
log_level_data_fee Entero La tarifa que se cobra al usuario para consumir datos de nivel de registro.
Solo lectura
permissions matriz de objetos Operaciones que la aplicación puede realizar en nombre del usuario que ha iniciado sesión actualmente. Para obtener más información, vea Permisos a continuación.
plugin_id Entero Número de identificación único del complemento instalado en esta instancia.
Obligatorio: POST
subscriber_email string Dirección de correo electrónico de la persona de contacto especificada en el instalador de la aplicación.
Solo lectura
subscriber_entity_id Entero Número de identificación único del elemento primario del usuario que instaló la aplicación.
Obligatorio: POST
subscriber_entity_type enumeración La organización primaria del usuario que instaló la aplicación. Los valores posibles son "member" o "bidder". Al agregar una instalación, debe elegir la opción correcta para subscriber_entity_id (a continuación).
subscriber_name string Nombre de la persona de contacto en el instalador de la aplicación.
Solo lectura
subscriber_phone string Número de teléfono de la persona de contacto especificada en el instalador de la aplicación.
Solo lectura

Permissions

Cada objeto de la permissions matriz contiene los campos siguientes:

Campo Tipo Descripción
privileges matriz de objetos Los tipos de llamadas que la aplicación puede realizar al servicio de API y los campos específicos que se pueden usar. Vea privileges el ejemplo.
Dentro de cada objeto, method define las llamadas que se pueden realizar al servicio ("get", "post", "put"o "delete"), y fields restringe los permisos a campos concretos del servicio. Si fields es null, los permisos se aplican a todos los campos del servicio. Tenga en cuenta que el uso del "delete" método debe ser aprobado por un representante de Xandr.
service enumeración Nombre del servicio de API que la aplicación puede usar.

privileges Ejemplo

{
"method": "get",
"fields": null
}

Ejemplos

Visualización de todas las instalaciones

$ curl -b cookies -c cookies 'https://api.appnexus.com/app-installation'
{
    "response":{
        "status":"OK",
        "count":1,
        "start_element":0,
        "num_elements":100,
        "app-installations":[
            {
                "id":9,
                "plugin_id":47,
                "addendum":"This is test text to demonstrate the addendum functionality.",
                "subscriber_entity_type":"member",
                "subscriber_entity_id":3754,
                "accepted_permission":false,
                "installed_on":"2013-05-01 20:58:28",
                "installer_user_id":5447,
                "permissions":null,                     
                "has_payment_access":false   
                "log_level_data_fee":5500,
                "subscriber_phone":"",
                "subscriber_email":"zivester@appnexus.com",
                "subscriber_name":"Zach Ivester"
            }
        ],
        "dbg_info":{
            ...
        }
    }
}

Visualización de una instalación específica

$ curl -b cookies -c cookies 's://sand.api.appnexus.com/app-installation?id=868'
{
    "response":{
        "status":"OK",
        "count":1,
        "start_element":null,
        "num_elements":null,
        "app-installation":{
            "id":868,
            "plugin_id":4,
            "entity_type":"bidder",
            "entity_id":226,
            "status":"installed"
        }
    }
}

Instalación de una aplicación en un cliente

$ cat add-app-installation.json
{
    "app-installation":
        {
        "plugin_id": "20",
        "subscriber_entity_type": "member",
        "subscriber_entity_id":  "238"
        }
}
$ curl -b cookies -c cookies -X POST -d @add-app-installation.json 's://api.appnexus.com/app-installation' | json-pp
{
    "response":{
        "status":"OK",
        "count":1,
        "id":18716,
        "start_element":0,
        "num_elements":100,
        "app-installation":{
            "id":18716,
            "plugin_id":20,
            "addendum":null,
            "subscriber_entity_type":"member",
            "subscriber_entity_id":238,
            "accepted_permission":true,
            "installed_on":"2013-05-13 12:54:50",
            "installer_user_id":3052,
            "permissions":null,                     
            "has_payment_access":false   
            "log_level_data_fee":null,
            "subscriber_phone":null,
            "subscriber_email":null,
            "subscriber_name":"Netseer - member 238"
        },
        "dbg_info":{
            ...
        }
    }
}

Actualización de una instalación de aplicación

$ cat update-app-installation.json
{
    "app-installation": 
        {
        "plugin_id": "19",
        "addendum": "www.site.com",
        "accepted_permission": false,
        "log_level_data_fee": "2000",
        "subscriber_phone": "914-555-1212",
        "subscriber_email": "JMS@live.com",
        "subscriber_name": "Ben Smith"
        }
} 
$ curl -b cookies -c cookies -X PUT -d @update-app-installation.json 's://api.appnexus.com/app-installation?id=23'
{
    "response":{
        "status":"OK",
        "count":1,
        "id":"23",
        "start_element":0,
        "num_elements":100,
        "app-installation":{
            "id":23,
            "plugin_id":50,
            "addendum":null,
            "subscriber_entity_type":"member",
            "subscriber_entity_id":185,
            "accepted_permission":false,
            "installed_on":"2013-05-07 15:05:45",
            "installer_user_id":43,
            "permissions":null,                     
            "has_payment_access":false   
            "log_level_data_fee":2500,
            "subscriber_phone":"",
            "subscriber_email":"PQ5ejohnson@appnexus.com",
            "subscriber_name":"Emily HB"
        },
        "dbg_info":{
            ...
        }
    }
}

Eliminación de una instalación de aplicación

$ curl -b cookies -c cookies -X DELETE 'https://api.appnexus.com/app-installation?id=121'
{
    "response":{
        "status":"OK",
        "count":1,
        "start_element":0,
        "num_elements":100,
        "dbg_info":{
            ...
        }
    }
}