次の方法で共有


Digital Platform API - ユーザー サービス

"ユーザー" とは、または API にログインできるユーザーまたはグループを指します。 ユーザーは、アクセスできる情報の種類を決定する user_typeによって分類されます。 このサービスを使用すると、メンバー レベルのユーザーが他のユーザーを作成したり、既存のユーザーに関する情報を変更および取得したりできます。

ユーザーの種類

注:

ユーザーが作成されると、 user_type を変更することはできません。 ユーザーに新しい user_typeを付与するには、そのユーザーの新しいユーザーを作成する必要があります。 また、 を使用してユーザーを作成する場合、 api_login フィールドは既定で false に設定されます (つまり、そのユーザーは API にアクセスできません)。 ユーザーの api_login フィールドの値は、API を介してのみ変更できます。

ユーザーの種類 説明
member メンバーのアカウントのすべての側面 (広告主、パブリッシャー、アプリなど) にアクセスできるネットワーク レベルのユーザー。
member_advertiser 広告主のサブセットにアクセスできるネットワーク レベルのユーザーが少し限られています。 Xandr ポリシーによる API アクセスがありません。
member_publisher パブリッシャーのサブセットへのアクセス権を持つやや制限されたネットワーク レベルのユーザー。 Xandr ポリシーによる API アクセスがありません。
advertiser 1 人の広告主にアクセスできる非常に限られたユーザー (主にレポート用、API と API の両方で使用できます)。 このユーザーを作成するときは、 advertiser_id を指定する必要があります。
publisher 1 つの発行元へのアクセス権を持つ非常に限られたユーザー (主にレポート用、API と API の両方で使用できます)。 このユーザーを作成するときは、 publisher_id を指定する必要があります。

UI 用語と API 用語のマッピング

UI 用語の詳細については、アプリケーションのドキュメントを参照してください。

UI ユーザー ロール API user_type Read_only
Network member false
ネットワーク オブザーバー member true
ネットワーク広告主マネージャー member_advertiser false
Network Publisher Manager member_publisher false
広告 主 advertiser false
Publisher publisher false

REST API

HTTP メソッド エンドポイント 説明
POST https://api.appnexus.com/user
(ユーザー JSON)
新しいユーザーを追加する。
PUT https://api.appnexus.com/user?id=user_id
(ユーザー JSON)
既存のユーザーを変更します。
GET https://api.appnexus.com/user このメンバーに関連付けられているすべてのユーザーを表示します。
GET https://api.appnexus.com/user?id=user_id 特定のユーザーを表示します。
GET https://api.appnexus.com/user?id=1,2,3 コンマ区切りリストを使用して、ID で複数のユーザーを表示します。
GET https://api.appnexus.com/user?current 現在のユーザーを表示します。
GET https://api.appnexus.com/user/meta フィルター処理および並べ替えの対象となるフィールドを確認します。

JSON フィールド

フィールド 種類 説明
id int ユーザーに関連付けられている内部 ID。
クエリ文字列で必要な On:PUT
state string ユーザーの状態。
使用可能な値:
- "active"
- "inactive"
デフォルト:"active"
username string ユーザーのログイン名。
必須:POST

手記: ユーザー名には、$、#、および " などの特殊文字を含めないようにしてください。 さらに、ユーザーが作成された後、ユーザー名を変更することはできません。
password string ユーザーの認証に使用されるパスワード。 GET要求には表示されません。
必須:POST
email string ユーザーの電子メール アドレス。
必須:POST
first_name string ユーザーの名。
必須:POST
last_name string ユーザーの姓。
必須:POST
custom データ string ユーザーに関連する情報は、ここに入力できます。
phone string ユーザーの連絡先電話番号。
user_type 列挙 ユーザーの種類。 使用可能な値:
- "member"
- "bidder"
- "publisher"
- "advertiser"
- "member_advertiser"
- "member_publisher"

各ユーザーの種類の詳細については、上記の 「ユーザーの種類 」の表を参照してください。
必須:POST

手記: このフィールドは、 PUTでは変更できません。 ユーザーの user_typeを変更するには、新しいユーザーを追加する必要があります。
read_only ブール値 true場合、ユーザーは API を介して変更を加えることはできません。
デフォルト:false
api_login ブール値 管理者専用。 true場合、ユーザーは API にアクセスして使用できます。
デフォルト:false
entity_id int ユーザーが属するエンティティ (メンバーまたは入札者) の ID。

手記:entity_idは、他のサービスで使用されるmember_idと同じです。
必須のオン:POST ( user_type"member"の場合)。
entity_name string ユーザーが属するエンティティ (メンバーまたは入札者) の名前。
publisher_id int ユーザーが関連付けられている発行元の ID ( user_type"publisher"されている場合)。
必須のオン:POST ( user_type"publisher"の場合)。
advertiser_id int ユーザーが関連付けられている広告主の ID ( user_type"advertiser"されている場合)。
必須のオン:POST ( user_type"advertiser"の場合)。
advertiser_access 配列 user_type"member_advertiser"されている場合、ユーザーがアクセスできる広告主。
必須のオン:POST ( user_type"member_advertiser"の場合)。
publisher_access 配列 ユーザーがアクセスできる発行元 ( user_type"member_publisher"されている場合)。
必須のオン:POST ( user_type"member_advertiser"の場合)。
reporting_decimal_type 列挙 レポートで小数点に使用される文字。
使用可能な値:
- "comma"
- "decimal" (期間)
この設定は、レポート レベルでオーバーライドできます (「レポート サービスreporting_decimal_type」を参照してください)。
Default:reporting_decimal_typeメンバーから。
decimal_mark 列挙 整数部分を数値の小数部から分離する文字。
使用可能な値:
- "period"
- "comma"
この文字は、 thousand_separatorに使用される文字とは異なる必要があります。

既定値: "period"

手記: このフィールドは、ユーザーが数値のみを入力して表示する方法を制御します。 API の数値には影響しません。
thousand_separator 列挙 数字の数字グループを区切る文字。 使用可能な値:
- "comma"
- "space"
- "period"
この文字は、 decimal_markに使用される文字とは異なる必要があります。

デフォルト:"comma"

手記: この設定は、ユーザーが数字グループのみを入力して表示する方法を制御します。 API の数字グループには影響しません。
send_safety_budget_notifications ブール値 true場合、毎日の安全予算のしきい値に近づくと、ユーザーは電子メール通知を受け取ります。 詳細については、メンバー サービスdaily_budget フィールドを参照してください。
デフォルト:"false"
is_developer ブール値 読み取り専用です。 このフラグは、アプリで使用される Plugin サービスや Plugin Instance サービスなど、開発者向けの特定のサービスにアクセスする権限をユーザーに付与します。 これは、ケース バイ ケースで Xandr 管理者によって true に設定されます。
デフォルト:"false"
last_modified timestamp ユーザーが最後に変更された日時。
timezone string ユーザーのタイムゾーン。
password_expires_on timestamp ユーザーのパスワードの有効期限が切れた場合。
entity_reporting_decimal_type 列挙 レポートで数値をコンマまたは 10 進数で区切るかどうか。 このフィールドが decimal に設定されている場合、返される値は次のように書式設定されます: 1234.56。 一方、このフィールドが comma に設定されている場合、返される値は次のように書式設定されます: 1234.56
使用可能な値:
- decimal
- comma
デフォルト:"decimal"

ネットワーク ユーザーを追加する

$ cat user
{
    "user":{
        "username":"testuser",
        "password":"testpassword",
        "user_type":"member",
        "entity_id":123,
        "first_name":"Test",
        "last_name":"User",
        "email":"test@testuser.com"
    }
}
$ curl -b cookies -X POST -d @user 'https://api.appnexus.com/user'
{
    "response":{
        "status":"OK",
        "id":258
    }
}

ネットワーク オブザーバー ユーザーを追加する

$ cat user
{
    "user":{
        "username":"testuser",
        "password":"testpassword",
        "user_type":"member",
        "entity_id":123,
        "first_name":"Test",
        "last_name":"User",
        "email":"test@testuser.com",
        "read_only": true
    }
}
$ curl -b cookies -X POST -d @user 'https://api.appnexus.com/user'
{
    "response":{
        "status":"OK",
        "id":259
    }
}

パブリッシャー ユーザーを追加する

$ cat user
{
    "user":{
        "username":"testuser",
        "password":"testpassword",
        "user_type":"publisher",
        "publisher_id":1234,
        "first_name":"Test",
        "last_name":"User",
        "email":"test@testuser.com"
    }
}
$ curl -b cookies -X POST -d @user 'https://api.appnexus.com/user'
{
    "response":{
        "status":"OK",
        "id":260
    }
}

広告主ユーザーを追加する

$ cat user
{
    "user":{
        "username":"testuser",
        "password":"testpassword",
        "user_type":"advertiser",
        "advertiser_id":1234,
        "first_name":"Test",
        "last_name":"User",
        "email":"test@testuser.com"
    }
}
$ curl -b cookies -X POST -d @user 'https://api.appnexus.com/user'
{
    "response":{
        "status":"OK",
        "id":261
    }
}

現在のユーザーを表示する

$ curl -b cookies 'https://api.appnexus.com/user?current'
{
    "response": {
        "status": "OK",
        "count": 1,
        "start_element": 0,
        "num_elements": 100,
        "user": {
            "id": 2513,
            "first_name": "Ron",
            "last_name": "Jacob",
            "phone": "",
            "username": "rjacob",
            "email": "rjacob@example.com",
            "user_type": "member",
            "read_only": false,
            "api_login": true,
            "entity_id": 1446,
            "publisher_id": null,
            "advertiser_id": null,
            "custom_data": null,
            "send_safety_budget_notifications": false,
            "entity_name": "Test Member",
            "timezone": "EST5EDT",
            "entity_reporting_decimal_type": "decimal",
            "reporting_decimal_type": null,
            "decimal_mark": "period",
            "thousand_separator": "comma",
            "last_modified": "2012-06-27 21:53:38",
            "is_developer": false,
            "state": "active",
            "advertiser_access": null,
            "publisher_access": null
        }
    }
}