User Data Object - Customer Management

Defines personal and business contact information about a Microsoft Advertising user.

Multiple user objects can be assigned to the same person i.e., one user per person per customer. The Name, Lcid, JobTitle, and ContactInfo user settings for the same person will be automatically synchronized with any updates that occur after user consolidation. The LastModifiedByUserId and LastModifiedTime are also in sync across each returned User object, unless you had an old username merged and have not updated any user settings since the consolidation.

Tip

With Microsoft Advertising multi-user credentials you can accept an invitation to manage a separate customer with your existing Microsoft Advertising credentials. For more information, see the Multi-User Credentials technical guide.

Syntax

<xs:complexType name="User" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:sequence>
    <xs:element minOccurs="0" name="ContactInfo" nillable="true" type="tns:ContactInfo" />
    <xs:element minOccurs="0" name="CustomerId" nillable="true" type="xs:long" />
    <xs:element minOccurs="0" name="Id" nillable="true" type="xs:long" />
    <xs:element minOccurs="0" name="JobTitle" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="LastModifiedByUserId" nillable="true" type="xs:long" />
    <xs:element minOccurs="0" name="LastModifiedTime" nillable="true" type="xs:dateTime" />
    <xs:element minOccurs="0" name="Lcid" nillable="true" type="tns:LCID" />
    <xs:element minOccurs="0" name="Name" nillable="true" type="tns:PersonName" />
    <xs:element minOccurs="0" name="Password" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="SecretAnswer" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="SecretQuestion" type="tns:SecretQuestion" />
    <xs:element minOccurs="0" name="UserLifeCycleStatus" nillable="true" type="tns:UserLifeCycleStatus" />
    <xs:element minOccurs="0" name="TimeStamp" nillable="true" type="xs:base64Binary" />
    <xs:element minOccurs="0" name="UserName" nillable="true" type="xs:string" />
    <xs:element xmlns:q6="http://schemas.datacontract.org/2004/07/System.Collections.Generic" minOccurs="0" name="ForwardCompatibilityMap" nillable="true" type="q6:ArrayOfKeyValuePairOfstringstring" />
    <xs:element minOccurs="0" name="AuthenticationToken" nillable="true" type="xs:string">
      <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

The User object has the following elements: AuthenticationToken, ContactInfo, CustomerId, ForwardCompatibilityMap, Id, JobTitle, LastModifiedByUserId, LastModifiedTime, Lcid, Name, Password, SecretAnswer, SecretQuestion, TimeStamp, UserLifeCycleStatus, UserName.

Element	Description	Data Type
AuthenticationToken	The OAuth access token that represents the credentials of the user who has permissions to Microsoft Advertising accounts. For more information see Authentication with OAuth. Update: Read-only	string
ContactInfo	The user's contact information. Update: Optional. If no value is set for the update, this setting is not changed.	ContactInfo
CustomerId	The identifier of the customer for this user to access. Update: Read-only	long
ForwardCompatibilityMap	The list of key and value strings for forward compatibility to avoid otherwise breaking changes when new elements are added in the current API version. Forward compatibility changes will be noted here in future releases. There are currently no forward compatibility changes for this object.	KeyValuePairOfstringstring array
Id	The Microsoft Advertising identifier of the user. Update: Required	long
JobTitle	The user's job title. The title can contain a maximum of 50 characters. Update: Optional. If no value is set for the update, this setting is not changed.	string
LastModifiedByUserId	The identifier of the last user to update the user's information. Update: Read-only	long
LastModifiedTime	The date and time that that the user information was last updated. The value is in Coordinated Universal Time (UTC). The date and time value reflects the date and time at the server, not the client. For information about the format of the date and time, see the dateTime entry in Primitive XML Data Types. Update: Read-only	dateTime
Lcid	The locale to use when sending correspondence to the user by email or postal mail. The default is EnglishUS. Update: Optional. If no value is set for the update, this setting is not changed.	LCID
Name	The name of the user. Update: Optional. If no value is set for the update, this setting is not changed.	PersonName
Password	This element is reserved for internal use and will be removed from a future version of the API. The GetUser operation does not return the password. Update: Read-only	string
SecretAnswer	This element is reserved for internal use and will be removed from a future version of the API. Update: Optional. If no value is set for the update, this setting is not changed.	string
SecretQuestion	This element is reserved for internal use and will be removed from a future version of the API. Update: Optional. If no value is set for the update, this setting is not changed.	SecretQuestion
TimeStamp	A time-stamp value that the system uses internally to reconcile updates when you call UpdateUser or DeleteUser. Update: Required	base64Binary
UserLifeCycleStatus	The status of the user. Update: Read-only	UserLifeCycleStatus
UserName	The logon user name of the user. The email address of the Microsoft Account may differ from the Email element of the ContactInfo object. Update: Read-only	string

Requirements

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

Used By

GetUser
SignupCustomer
UpdateUser