ユーザー UI サービス

[アーティクル]
02/23/2024

注:

ユーザー UI サービスは現在、限られた一連のクライアントと Microsoft の従業員のみが利用できます。

このサービスは、API 1.15 リリースの一部として、2014 年 6 月下旬に 非推奨となります 。 1.15 は破壊的変更リリースであるため、このサービスは実際には 1.15 (2014 年 8 月下旬) のリリースから 60 日後に終了しません。

ユーザー UI サービスを使用すると、キャンペーンピアの承認がユーザーに必要かどうかを変更できます。

注:

ユーザー UI 設定は、キャンペーンのアクティブ化のためにサービスレイヤーに適用されません。この API サービスは API ロジックと対話しません。サービスは実際にはユーザーピアの承認設定を変更できず、API 内のユーザーによる承認されていないキャンペーンの作成を防ぐことはできません。むしろ、ユーザー UI サービスの目的は、キャンペーンのアクティブ化に関する GUI ユースケースのアクセス許可を維持し、ワークフロー管理を支援することです。

このサービスにアクセスできるのは、次のユーザーの種類のみです。

member
advertiser
member_advertiser

REST API

HTTP メソッド	エンドポイント	説明
`POST`	`https://api.appnexus.com/user-ui` (ユーザー UI JSON)	ユーザーの新しいユーザー UI オブジェクトを作成します。
`PUT`	`https://api.appnexus.com/user-ui?id=ID` (ユーザー UI JSON)	ユーザー UI オブジェクトを使用して設定を変更します。
`GET`	`https://api.appnexus.com/user-ui`	すべてのユーザー UI オブジェクトの設定を表示します。
`GET`	`https://api.appnexus.com/user-ui?id=ID`	特定のユーザー UI オブジェクトの設定を表示します。
`DELETE`	`https://api.appnexus.com/user-ui?id=ID`	ユーザー UI オブジェクトの設定を削除します。
`GET`	`https://api.appnexus.com/user-ui/meta`	フィルター処理および並べ替えの対象となるフィールドを確認します。

JSON フィールド

フィールド	種類	説明
`id`	int	対応するユーザーの ID。同じユーザーの重複エントリは許可されません。クエリ文字列で必要な On:`PUT`/`DELETE`。
`member_id`	int	読み取り専用です。このユーザーが属するメンバーの ID。
`require_campaign_approval`	ブール値	このユーザーが作成したキャンペーンをアクティブにする前に承認が必要かどうか。デフォルト：`false`

例

新しいユーザー UI オブジェクトを作成して、ユーザーのキャンペーン承認要件を追加する

$ cat user-ui.json
{
    "user-ui": {
        "id": "5771",
        "require_campaign_approval": "false"
    }
}

$ curl -b cookies -c cookies -X POST -d @user-ui.json 'https://api.appnexus.com/user-ui'
{
   "response" : {
      "user-ui" : {
         "require_campaign_approval" : false,
         "member_id" : 3897,
         "id" : 5771
      },
      "count" : 1,
      "status" : "OK",
      "id" : 5771
  }
}

ユーザー UI オブジェクトを変更して、ユーザーのキャンペーン承認要件を変更する

$ cat modify-user-ui.json
{
    "user-ui": {
        "id": "5771",
        "require_campaign_approval": "true"
    }
}

$ curl -b cookies -c cookies -X PUT -d @modify-user-ui.json 'https://api.appnexus.com/user-ui?id=393404'
{
   "response" : {
      "user-ui" : {
         "require_campaign_approval" : true,
         "id" : 5771
      },
      "count" : 1,
      "status" : "OK",
      "id" : "5771"
   }
}

特定のユーザーのキャンペーン承認要件を表示する

$ curl -b cookies -c cookies -X GET 'https://api.appnexus.com/user-ui?id=5771'
{
   "response" : {
      "user-ui" : {
         "require_campaign_approval" : true,
         "id" : 5771
      },
      "count" : 1,
      "status" : "OK"
   }
}

ユーザー UI オブジェクトと、それに含まれるキャンペーンの承認要件情報を削除する

$ curl -b cookies -c cookies -X DELETE 'https://api.appnexus.com/user-ui?id=393404'
{
   "response" : {
      "status" : "OK"
   }
   }

次の方法で共有