次の方法で共有

アプリ インストール サービス

  • [アーティクル]

このサービスを使用すると、アプリ開発者はクライアント システムにアプリをインストールできます。

REST API

メソッド エンドポイント 説明
GET https://api.appnexus.com/app-installation すべてのインストールを表示する
GET https://api.appnexus.com/app-installation?id=ID 特定のインストールを表示する
POST https://api.appnexus.com/app-installation クライアント用のアプリをインストールする
PUT https://sand.api.appnexus.com/app-installation?id=ID アプリのインストールを更新する
DELETE https://api.appnexus.com/app-installation?id=ID アプリのインストールを削除する

JSON フィールド

フィールド 種類 説明
accepted_permissions ブール値 アプリが使用するために必要な領域にアクセスするためのアクセス許可を受け取ったかどうかを示します。
addendum string これには、ユーザーがアプリをインストールしたときに表示される契約のテキストが含まれます。 このフィールドは、 Markdown マークアップ言語を使用して編集できます。
has_payment_access ブール値 このアプリに支払い条件と料金を適用できるかどうかを示します。
読み取り専用。
既定値: true
id int 各インストール インスタンスの一意の識別番号。
必須: PUT と DELETE
installed_on timestamp このアプリがユーザーによってインストールされた日付と時刻。
読み 取り 専用
installer_user_id int Apps Marketplace からアプリをインストールするアクセス許可を持つユーザーの一意の識別。 これは、補遺契約を承諾または拒否できるユーザーでもあります。
読み 取り 専用
log_level_data_fee int ログ レベルのデータを使用するためにユーザーに請求される料金。
読み 取り 専用
permissions オブジェクトの配列 現在ログインしているユーザーに代わってアプリが実行できる操作。 詳細については、以下の 「アクセス許可」を 参照してください。
plugin_id int このインスタンスにインストールされているプラグインの一意の識別番号。
必須: POST
subscriber_email string アプリ インストーラーで指定した連絡先のメール アドレス。
読み 取り 専用
subscriber_entity_id int アプリをインストールしたユーザーの親の一意の識別番号。
必須: POST
subscriber_entity_type 列挙 アプリをインストールしたユーザーの親organization。 指定できる値には、 または が"bidder"含まれます"member"。 インストールを追加するときは、 (以下) の正しいオプションを選択する subscriber_entity_id 必要があります。
subscriber_name string アプリ インストーラーの連絡先の名前。
読み 取り 専用
subscriber_phone string アプリ インストーラーで指定した連絡先の電話番号。
読み 取り 専用

アクセス許可

配列内の permissions 各オブジェクトには、次のフィールドが含まれています。

フィールド 種類 説明
privileges オブジェクトの配列 アプリが API サービスに対して行うことができる呼び出しの種類と、使用できる特定のフィールド。 例を参照してくださいprivileges。
各オブジェクト内で、methodサービス ("get"、、または"delete") に対して実行できる呼び出しを定義しfields、"post""put"アクセス許可をサービス内の特定のフィールドに制限します。 が のnull場合fields、アクセス許可はサービス内のすべてのフィールドに適用されます。 メソッドの使用は "delete" 、Xandr 担当者によって承認される必要があることに注意してください。
service 列挙 アプリで使用が許可されている API サービスの名前。

privileges 例

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

例

すべてのインストールを表示する

$ 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":{
            ...
        }
    }
}

特定のインストールを表示する

$ 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"
        }
    }
}

クライアントにアプリをインストールする

$ 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":{
            ...
        }
    }
}

アプリのインストールを更新する

$ 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":{
            ...
        }
    }
}

アプリのインストールを削除する

$ 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":{
            ...
        }
    }
}