CustomerRole Data Object - Customer Management

Defines the role a user has for one customer or list of accounts within a customer.

If a user has access to multiple customers, then multiple CustomerRole objects are returned via the GetUser operation.

Important

The CustomerRole objects that represent the user's permissions for agency-linked accounts will not be returned by default when you call the GetUser service operation. In other words by default the GetUser operation will only return CustomerRole objects for customers that the user can directly access without agency linking. To retrieve CustomerRole objects that represent the user's permissions for agency-linked accounts you must set the optional IncludeLinkedAccountIds element to True when calling the GetUser operation.

Syntax

<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 minOccurs="0" name="AccountIds" nillable="true" type="q5:ArrayOflong" xmlns:q5="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
    <xs:element minOccurs="0" name="LinkedAccountIds" nillable="true" type="q6:ArrayOflong" xmlns:q6="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <xs:annotation>
        <xs:appinfo>
          <DefaultValue EmitDefaultValue="false" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" />
        </xs:appinfo>
      </xs:annotation>
    </xs:element>
  </xs:sequence>
</xs:complexType>

Elements

Element Description Data Type
AccountIds The list of accounts that the user can access in the customer.

If this element is nil, the user has access to all of the accounts (current and future) in the customer.
long array
CustomerId The identifier of the Customer that the user can access. long
LinkedAccountIds The list of linked accounts that the user can access as an agency on behalf of another customer.

This element is not returned in the CustomerRole object by default (not even a nil element in the response message). To retrieve this element you must set the optional IncludeLinkedAccountIds element to True when calling the GetUser operation.

Furthermore, the CustomerRole objects that represent the user's permissions for agency-linked accounts will not be returned by default when you call the GetUser service operation. In other words by default the GetUser operation will only return CustomerRole objects for customers that the user can directly access without agency linking. To retrieve CustomerRole objects that represent the user's permissions for agency-linked accounts you must set the optional IncludeLinkedAccountIds element to True when calling the GetUser operation.
long array
RoleId The role that the user has for each customer or list of accounts.

Possible values include the following:
16 - The user has the Advertiser Campaign Manager role.
33 - The user has the Aggregator role.
41 - The user has the Super Admin role.
100 - The user has the ClientViewer role.
203 - The user has the Standard role.

For more information, see the User Roles technical guide.
int

Requirements

Service: CustomerManagementService.svc v12
Namespace: https://bingads.microsoft.com/Customer/v12/Entities

Used By

GetUser