Edit

Customer Data Object - Customer Management

  • Article

Defines a customer object that contains one or more Microsoft Advertising accounts.

Syntax

<xs:complexType name="Customer" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:sequence>
    <xs:element minOccurs="0" name="CustomerFinancialStatus" nillable="true" type="tns:CustomerFinancialStatus" />
    <xs:element minOccurs="0" name="Id" nillable="true" type="xs:long" />
    <xs:element minOccurs="0" name="Industry" nillable="true" type="tns:Industry" />
    <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="MarketCountry" nillable="true" type="xs:string" />
    <xs:element xmlns:q4="http://schemas.datacontract.org/2004/07/System.Collections.Generic" minOccurs="0" name="ForwardCompatibilityMap" nillable="true" type="q4:ArrayOfKeyValuePairOfstringstring" />
    <xs:element minOccurs="0" name="MarketLanguage" nillable="true" type="tns:LanguageType" />
    <xs:element minOccurs="0" name="Name" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="ServiceLevel" nillable="true" type="tns:ServiceLevel" />
    <xs:element minOccurs="0" name="CustomerLifeCycleStatus" nillable="true" type="tns:CustomerLifeCycleStatus" />
    <xs:element minOccurs="0" name="TimeStamp" nillable="true" type="xs:base64Binary" />
    <xs:element minOccurs="0" name="Number" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="CustomerAddress" nillable="true" type="tns:Address" />
  </xs:sequence>
</xs:complexType>

Elements

The Customer object has the following elements: CustomerAddress, CustomerFinancialStatus, CustomerLifeCycleStatus, ForwardCompatibilityMap, Id, Industry, LastModifiedByUserId, LastModifiedTime, MarketCountry, MarketLanguage, Name, Number, ServiceLevel, TimeStamp.

Element Description Data Type
CustomerAddress The customer's business address.

This property is not used by Microsoft Advertising, and you must set the account business address instead.

Add: Optional
Update: Optional		 Address
CustomerFinancialStatus The financial status of the customer. For example, the status indicates whether the customer is in good standing or one or more of the accounts are past due.

Add: Read-only
Update: Read-only		 CustomerFinancialStatus
CustomerLifeCycleStatus The status of the customer. When you create the customer, the status is set to Active. You cannot change the status.

Add: Read-only
Update: Read-only		 CustomerLifeCycleStatus
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 system-generated customer identifier.

Use this identifier with operation requests that require a CustomerId SOAP header element.

Add: Read-only
Update: Required		 long
Industry The primary business segment of the customer, for example, automotive, food, or entertainment.

Add: Required
Update: Required		 Industry
LastModifiedByUserId The identifier of the last user to update the customer's information.

Add: Read-only
Update: Read-only		 long
LastModifiedTime The date and time that the customer 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.

Add: Read-only
Update: Read-only		 dateTime
MarketCountry The primary country where the customer operates. For a list of customer market country code values, see Product Language.

Add: Required
Update: Read-only		 string
MarketLanguage The primary language that the customer uses. Your customer market language determines the language of the Microsoft Advertising interface. For a list of customer market language code values, see Product Language.

Add: Required
Update: Read-only		 LanguageType
Name The name of the customer.

The name can contain a maximum of 90 characters.

Add: Required
Update: Required		 string
Number A system-generated customer number that is used in the Microsoft Advertising web application.

The customer number has the form xxxxxxxxxx, where xxxxxxxxxx is a series of any ten alphanumeric characters.

Add: Read-only
Update: Read-only		 string
ServiceLevel For internal use only. If this element is set when calling SignupCustomer an error will be returned. If this element is set when calling UpdateCustomer the element will be ignored.

Add: Read-only
Update: Read-only		 ServiceLevel
TimeStamp A time-stamp value that the system uses internally to reconcile updates when you call the UpdateCustomer and DeleteCustomer operations.

Add: Read-only
Update: Required		 base64Binary

Requirements

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

Used By

GetCustomer
SearchCustomers
SignupCustomer
UpdateCustomer