英語で読む

次の方法で共有


Bidders - ユーザー サービス

ここで "user" とは、Xandr の API を使用するユーザーまたはグループを指します。 ユーザー サービスを使用すると、Xandr の API にアクセスできるユーザーを管理できます。 ユーザーは、 入札者 または メンバーのユーザーの種類によって分類されます。

  • Bidder ユーザーは、他の入札者ユーザーによって作成できます。
  • bidder-user は、メンバー ユーザーを作成および更新したり、独自のユーザー情報を更新したりできます。
  • メンバー ユーザーは、独自のユーザー情報を更新できます。
  • 特定の入札者に関連付けられている新しいユーザー名はそれぞれ一意である必要があります。

REST API

HTTP メソッド エンドポイント 説明
GET https://api.adnxs.com/user 作成したすべてのユーザーを表示します。
GET https://api.adnxs.com/user/USER_ID 特定のユーザーを表示します。
POST https://api.adnxs.com/user (ユーザー JSON) ユーザーを追加します。
PUT https://api.adnxs.com/user/USER_ID (ユーザー JSON) 既存のユーザーを変更します。

既存のユーザーを削除するには:
DELETE https://api.adnxs.com/user/USER_ID

JSON 構造体

フィールド 必須 説明
id はい (更新時) int ユーザーに関連付けられている内部 ID。
アクティブ いいえ ブール 現在、ユーザーを削除することはできません。 ここでは、active を "false" に設定します
username はい (追加時) string(50) ユーザーの名前 ユーザー名は一意である必要があります。

: ユーザーの作成後、ユーザー名を変更することはできません。
password はい (追加時) string ユーザーのパスワード。
メール 文字列 ユーザーのEmail。 (ユーザーはメールなしで作成できますが、ユーザーを更新しようとすると後で問題が発生することに注意してください)。
user_type はい enum('bidder','member') 追加されるユーザーの種類。
Read_only いいえ ブール型 read_only フィールドが true に設定されているユーザーは、リソースを追加、変更、または削除できません。
entity_id はい (追加時) int ユーザーが属しているエンティティの ID (メンバーまたは入札者)。 user_typeが "bidder" の場合、これは入札者 ID です。 user_typeが "メンバー" の場合、これはメンバー ID です。
entity_name いいえ string ユーザーが属するエンティティの名前 (メンバーまたは入札者)。
first_name いいえ string ユーザーの名
last_name いいえ string ユーザーの姓
phone いいえ string ユーザーの電話連絡先
publisher_id いいえ string このフィールドは Displaywords でのみ使用されます
advertiser_id いいえ string このフィールドは Displaywords でのみ使用されます
advertiser_access いいえ オブジェクトの配列 が の場合user_type"member_advertiser"、ユーザーがアクセスできる広告主。
publisher_access いいえ オブジェクトの配列 が の場合user_type"member_publisher"、ユーザーがアクセスできる発行元。
api_login いいえ ブール型 ユーザーが API にアクセスできる場合は True。 既定値は False です。
これは管理者専用フィールドです。 API アクセスを必要とする新しいユーザーを作成する場合は、カスタマー サポートに問い合わせて、この値を True に設定するように要求します。
custom_data いいえ string ユーザーに関連する情報。
send_safety_budget_notifications いいえ ブール型 の場合 true、ユーザーは、毎日の安全予算のしきい値に近づくと、電子メール通知を受け取ります。 詳細については、メンバー サービスdaily_budgetフィールドを参照してください。
タイムゾーン いいえ string ユーザーのタイムゾーン。
entity_reporting_decimal_type いいえ string レポートで数値をコンマまたは 10 進数で区切るかどうか。 このフィールドが decimal に設定されている場合、返される値は 1234.56 のように書式設定されます。 一方、このフィールドが に comma設定されている場合、返される値は 1234.56 のように書式設定されます。
使用可能な値:
- decimal
- comma
reporting_decimal_type いいえ string レポートで小数点に使用される文字。 使用可能な値:
- "comma"
- "decimal" (期間)
この設定は、レポート レベルでオーバーライドできます (レポート サービスを参照)。reporting_decimal_type
decimal_mark いいえ string 12.7 の値の "ピリオド" など、10 進マークを表すために使用される文字。
thousand_seperator いいえ string 値 1,276 の "コンマ" など、数値の数千を区切るために使用される文字。
last_modified いいえ date ユーザー設定のいずれかが最後に変更された日付。
is_developer いいえ ブール型 読み取り専用。 このフラグは、アプリで使用される Plugin サービスや Plugin Instance サービスなど、開発者向けの特定のサービスにアクセスする権限をユーザーに付与します。 Xandr 管理者がケース バイ ケースで true に設定します。
role_id いいえ int このユーザーに関連付けられているロールの ID。
password_expires_on いいえ date ユーザー パスワードの有効期限が切れる日付。
password_last_changed_on いいえ date ユーザーのパスワードが最後に変更された日付。

認証トークン

API Services を使用する場合、認証は常に最初の手順です。 認証トークンは、後で使用するために Cookie ファイルに書き込むことができます。 詳細な手順については、 認証サービス に関するページを参照してください。

ユーザー プロファイル テキスト ファイルを作成する

"TestUser" へのアクセス権を API に付与するには、ユーザーのユーザー名とパスワードと、このユーザーが属するメンバーまたは入札者の ID を含む JSON 形式のテキスト ファイルを作成します。 次に、"cat" コマンドを使用してユーザー JSON ファイルの例を出力しました。

$ cat user
{
   "user":{
      "username":"TestUser",
      "password":"2323test",
      "entity_id":7,
          "email": "user1@examplecompany.com",
          "user_type": "bidder"
   }
}

パスワードを作成するためのガイドライン

パスワードを作成するときは、次の複雑なパスワードを作成してください。

  • 10 文字以上
  • 64 文字以下
  • 少なくとも 1 つの大文字 (A から Z)
  • 少なくとも 1 つの小文字 (a から z)
  • 少なくとも 1 桁 (0 から 9)
  • 少なくとも 1 つの特殊文字 (#、$、? %、& など)

Imp Bus キャッシュに新しいユーザーを追加する

次に、ユーザー ファイルを入力します。 私たちは、自分自身を認証するためにクッキーを使用しています。

$ curl -b cookies -c cookies -X POST --data-binary @user https://api.adnxs.com/user
{
   "response":{
      "status":"OK",
      "id":59
   }
}

Imp Bus キャッシュからユーザー情報を取得する

上記のコマンドの出力から、先ほど追加したユーザーに Imp Bus によって ID #59 が割り当てられていることがわかっています。 この ID を使用して、この特定のユーザーに関する情報を表示できます。 作成したすべてのユーザーを表示するには、ユーザー ID をオフにします。

$ curl -b cookies -c cookies https://api.adnxs.com/user/59
{
  "response": {
    "status": "OK",
    "count": 1,
    "start_element": null,
    "num_elements": null,
    "user": {
      "id": 59,
      "active": true,
      "first_name": null,
      "last_name": null,
      "phone": null,
      "username": "TestUser",
      "email": "user1@examplecompany.com",
      "user_type": "bidder",
      "read_only": false,
      "api_login": false,
      "entity_id": 7,
      "publisher_id": null,
      "advertiser_id": null,
      "custom_data": null,
      "send_safety_budget_notifications": false,
      "entity_name": "Platform Services Test Bidder",
      "timezone": null,
      "entity_reporting_decimal_type": null,
      "reporting_decimal_type": null,
      "decimal_mark": "period",
      "thousand_separator": "comma",
      "last_modified": "2017-02-16 19:06:47",
      "is_developer": false,
      "role_id": null,
      "languages": null,
      "advertiser_access": null,
      "publisher_access": null
    },
    "dbg": {
                ...
    }
  }
}

API アクセスを要求する

api_login フィールドの上にある返されたコードに注目してください。 このフィールドは、Xandr 管理者のみが変更できます。 ユーザーに API へのアクセス権を付与する最後の手順は、カスタマー サポートに問い合わせ、ユーザーの api_login フラグを true に設定するように要求 することです。 要求にはユーザー名または ID を必ず含めます。

API Services