CustomerRole データ オブジェクト - Customer Management

特定の顧客の代理で行動するユーザーのアカウント アクセス権を定義します。

ユーザーは同じログイン資格情報を使用して複数の顧客のアカウントにアクセスでき、GetUser 操作を使用して 1 人のユーザーに対して複数の CustomerRole オブジェクトを返すことができます。 たとえば、Customer 123 に招待された場合user@contoso.com、2 つの CustomerRole オブジェクトが返され、ユーザーは Customer 234 でリンクされたアカウントを管理することもできます。

個別に取得すると、ユーザーは特定の CustomerRoleCustomerIdAccountId、LinkedAccountIds で同じロールを持ちます。ただし、ユーザーが複数の顧客ロールを持っている場合、有効なアクセス許可は、GetUser によって返される CustomerRoles の完全なセットに依存します。 いくつかの例を以下に示します。

ヒント

例を含む顧客ロールの概要については、 アカウント Hierchy とユーザーのアクセス許可 に関するガイドを参照してください。

構文

<xs:complexType name="CustomerRole" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:sequence>
    <xs:element minOccurs="0" name="RoleId" type="xs:int" />
    <xs:element minOccurs="0" name="CustomerId" type="xs:long" />
    <xs:element xmlns:q7="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="AccountIds" nillable="true" type="q7:ArrayOflong" />
    <xs:element xmlns:q8="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="LinkedAccountIds" nillable="true" type="q8:ArrayOflong" />
    <xs:element minOccurs="0" name="CustomerLinkPermission" nillable="true" type="xs:string" />
  </xs:sequence>
</xs:complexType>

要素

CustomerRole オブジェクトには、AccountIds、CustomerIdCustomerLinkPermissionLinkedAccountIdsRoleId の各要素があります。

要素 説明 データ型
AccountIds ユーザーが顧客でアクセスできるアカウントの一覧。

ユーザーが CID レベルのアクセス権を持っている場合、 AccountID は返されません。 アカウント レベルのアクセスの場合、 アカウント ID は GetUser API の CustomerRole オブジェクトで返されます。
long 配列
Customerid ユーザーがサインアップしているか、アカウント 階層 関係を持つ顧客の識別子。 long
CustomerLinkPermission ユーザーのアカウントへのアクセスが顧客階層 (顧客レベルのクライアント リンク) によって制限されているかどうかを判断します。

使用できる値には、管理、標準、LinkedEntityOnly などがあります。 このフィールドは、nil または空の場合もあります。

このフィールドが nil または空の場合、ユーザーは CustomerId に直接サインアップされます。

このフィールドが "管理" に設定されている場合、ユーザーは管理顧客リンクを介して CustomerId にアクセス できます

このフィールドが "Standard" に設定されている場合、ユーザーは Standard 顧客リンクを介して CustomerId にアクセス できます

このフィールドが "LinkedEntityOnly" に設定されている場合、ユーザーは CustomerId に直接サインアップされますが、広告主アカウントにアクセスできません。 CustomerId は顧客リンク階層の一部であり、ユーザーはその下の他の顧客にアクセスできます。

詳細については、 ユーザー ロール のテクニカル ガイドを参照してください。
string
LinkedAccountIds ユーザーが別の顧客に代わって代理店として CustomerId を介してアクセスできるリンクされたアカウントの一覧。

この要素が nil の場合、ユーザーは CustomerId を介して個別にリンクされた広告主アカウントにアクセスできません。 ユーザーは、他のリンクされた顧客の広告主アカウントにアクセスできる可能性があるため、GetUser によって返されるすべての CustomerRoles を考慮してください。

SignupCustomer を使用してアグリゲーターとして作成されたアカウントも、この要素で返されることに注意してください。 集計アカウントは DeleteAccount を使用して削除できますが、 UpdateClientLinks を使用してリンクを解除することはできません。 SearchClientLinks 操作を呼び出して、どのアカウントをリンク解除できるかを判断するのに役立ちます。
long 配列
RoleId CustomerId を使用して広告主アカウントにアクセスするときにユーザーが持つロール。

以下のいずれかの値を使用できます。
16 - ユーザーは 広告主キャンペーン マネージャー ロールを持ちます。
33 - ユーザーは アグリゲーター ロールを持っています。
41 - ユーザーにスーパー 管理 ロールがあります。
100 - ユーザーは ビューアー ロールを持ちます。
203 - ユーザーは Standard User ロールを持っています。

詳細については、 ユーザー ロール のテクニカル ガイドを参照してください。
int

要件

サービス: CustomerManagementService.svc v13
Namespace: https://bingads.microsoft.com/Customer/v13/Entities

使用ページ

Get-User