2.2. ユーザーを管理する

ユーザー一覧を取得する

[URL]
http://api.adlantis.jp/api/user/media/list
http://api.adlantis.jp/api/user/advertiser/list

[メソッド]
GET

[引 数]
id : ユーザーID。

q :  キーワードで結果を絞り込みます。検索対象はユーザー名、氏名、会社名になります。

include_deleted : 削除されたユーザーを検索対象とします。

per_page : 結果を返す際、1ページ毎に最大何個まで表示するかを指定します。

page : 表示する結果のページ番号です。

[戻 り値]
users:
user:
id : ユニークID。

login : ユーザー名(ログインID)。

email : 担当者のメールアドレス。

company : 会社名。

first_name : 姓。

last_name : 名。

site_url : サイトURL。

media_margin_rate : AdExchange経由で支払われた金額のうち、メディアに対して支払うマージン比率。

ユーザー情報を取得する

[URL]
http://api.adlantis.jp/api/user/media/show
http://api.adlantis.jp/api/user/advertiser/show

[メソッド]
GET

[引数]
id: ユーザーID。 管理者がユーザ情報を取得する際に指定する必要。
           指定しない場合は自分(ログインユーザ)の情報を取得します。

[戻り値]
user:
id : ユーザーID。

login : ユーザー名(ログインID)。

email : 担当者のメールアドレス。

company : 会社名。

first_name : 姓。

last_name : 名。

site_url : サイトURL。

media_margin_rate : AdExchange経由で支払われた金額のうち、メディアに対して支払うマージン比率。
                                  情報取得対象ユーザが管理者の場合のみ返される。

ユーザーを新規作成する

[URL]
http://api.adlantis.jp/api/user/media/create
http://api.adlantis.jp/api/user/advertiser/create

[メソッド]
GET

[引数]
login[※] : ユーザー名(ログインID)。

email[※] : 担当者のメールアドレス。

company[※] : 会社名。

company_type : 会社種類。
  • 1 : 法人
  • 2 : 個人

first_name[※] : 姓。

last_name[※] : 名。

site_url[※] : サイトURL。

media_margin_rate[※] : AdExchange経由で支払われた金額のうち、メディアに対して支払うマージン比率。

activated : 「on」を指定した場合はアクティベート済みのアカウントが作成される。

[戻り値]
user:
id : 作成したユーザーのID。

ユーザー情報を更新する

[URL]
http://api.adlantis.jp/api/user/media/update
http://api.adlantis.jp/api/user/advertiser/update

[メソッド]
POST

[引数]
id[※] : 更新対象ユーザのユーザID。

email : 担当者のメールアドレス。

company : 会社名。

first_name : 姓。

last_name : 名。

site_url : サイトURL。

media_margin_rate : AdExchange経由で支払われた金額のうち、メディアに対して支払うマージン比率。
                                  管理者権限を持つユーザに対してのみ変更可能です。

[戻り値]
success:
message : "ユーザー情報を更新しました"
        (引数で指定したものが更新される)

ユーザーを凍結する 

[URL]
http://api.adlantis.jp/api/user/media/deactivate
http://api.adlantis.jp/api/user/advertiser/deactivate

[メソッド]

POST

[引数]
id[※] : ユーザーID。

[戻り値]
success:
message : "ユーザーを無効にしました"

Comments