REST Resource: users

リソース: User

ディスプレイ &ビデオ 360 の 1 人のユーザー。

JSON 表現 
{
  "name": string,
  "userId": string,
  "email": string,
  "displayName": string,
  "assignedUserRoles": [
    {
      object (AssignedUserRole)
    }
  ]
}
フィールド
name

string

出力のみ。ユーザーのリソース名。
userId

string (int64 format)

出力のみ。ユーザーの一意の ID。システムによって割り当てられます。
email

string

必須。変更不可。ユーザーの識別に使用されるメールアドレス。
displayName

string

必須。ユーザーの表示名。

UTF-8 でエンコードし、最大サイズが 240 バイトである必要があります。
assignedUserRoles[]

object (AssignedUserRole)

割り当てられているユーザー役割。

users.create では必須です。出力は users.patch でのみ行われます。users.bulkEditAssignedUserRoles からのみ更新できます。

AssignedUserRole

割り当てられる単一のユーザー役割で、指定したパートナーや広告主とのユーザーとのやり取りが定義されます。

JSON 表現 
{
  "assignedUserRoleId": string,
  "userRole": enum (UserRole),

  // Union field entity_id can be only one of the following:
  "partnerId": string,
  "advertiserId": string
  // End of list of possible types for union field entity_id.
}
フィールド
assignedUserRoleId

string

出力のみ。割り当てられているユーザー役割の ID。
userRole

enum (UserRole)

必須。エンティティのユーザーに割り当てるユーザー役割。

共用体フィールド entity_id。必須。

割り当てられたユーザー役割が適用されるエンティティの ID。entity_id は次のいずれかになります。
partnerId

string (int64 format)

割り当てられたユーザー役割が適用されるパートナーの ID。
advertiserId

string (int64 format)

割り当て先のユーザー役割が適用される広告主の ID。

UserRole

選択できるユーザー役割。

列挙型
USER_ROLE_UNSPECIFIED このバージョンでユーザーロールが指定されていないか不明な場合のデフォルト値。
ADMIN エンティティのキャンペーン、クリエイティブ、広告掲載オーダー、広告申込情報、レポートを管理できます。お支払い情報の表示と編集、ユーザーの作成と変更、エクスチェンジの有効化と無効化を行うことができます。このロールは、パートナー エンティティにのみ割り当てることができます。
ADMIN_PARTNER_CLIENT エンティティのキャンペーン、クリエイティブ、広告掲載オーダー、広告申込情報、レポートを管理できます。他の ADMIN_PARTNER_CLIENT ユーザーを作成、変更したり、お支払い情報を表示したりできます。収益モデルやマークアップなど、再販業者が関係するその他のフィールドは表示できません。このロールは、パートナー エンティティにのみ割り当てることができます。
STANDARD エンティティのキャンペーン、クリエイティブ、広告掲載オーダー、広告申込情報、レポートを管理できます。ユーザーの作成と変更、お支払い情報の表示はできません。
STANDARD_PLANNER 費用データを含む、エンティティのすべてのキャンペーン、クリエイティブ、広告掲載オーダー、広告申込情報、レポートを表示できます。プランや在庫など、プランニング関連の機能を作成、変更できます。
STANDARD_PLANNER_LIMITED エンティティのすべてのキャンペーン、クリエイティブ、広告掲載オーダー、広告申込情報、レポートを表示できます。プランや在庫など、プランに関連する機能を作成、変更できます。費用データにはアクセスできず、ディールの開始、承認、交渉を行うことはできません。
STANDARD_PARTNER_CLIENT エンティティのキャンペーン、クリエイティブ、広告掲載オーダー、広告申込情報、レポートを管理できます。他のユーザーを作成、変更したり、お支払い情報を表示したりすることはできません。収益モデルやマークアップなど、再販業者が関係するその他のフィールドは表示できません。この役割は、広告主エンティティにのみ割り当てることができます。
READ_ONLY エンティティに関するレポートの作成とデータの閲覧のみ可能です。
REPORTING_ONLY このユーザーはレポートの作成と管理のみを行うことができます。
LIMITED_REPORTING_ONLY このユーザーが作成および管理できるのは、クライアント保護レポート（全般、オーディエンスのパフォーマンス、クロスパートナー、キーワード、オーダー ID、カテゴリ、第三者データ提供元）のみです。
CREATIVE 共同作業に必要なメディアプランの情報は表示できますが、費用関連のデータやマーケットプレイスを閲覧することはできません。
CREATIVE_ADMIN 共同作業に必要なメディアプランの情報は表示できますが、費用関連のデータやマーケットプレイスを閲覧することはできません。また、他のクリエイティブ管理者やクリエイティブ ユーザーをエンティティに追加することもできます。

Methods

bulkEditAssignedUserRoles

 ユーザーのユーザー役割を一括編集します。

create

 新しいユーザーを作成します。

delete

 ユーザーを削除します。

get

 ユーザーを取得します。

list

 現在のユーザーがアクセスできるユーザーを一覧表示します。

patch

 既存のユーザーを更新します。