AdvertiserAccount Data Object - Customer Management

Defines an advertiser account.

Syntax

<xs:complexType name="AdvertiserAccount" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:sequence>
    <xs:element minOccurs="0" name="BillToCustomerId" nillable="true" type="xs:long" />
    <xs:element minOccurs="0" name="CurrencyCode" nillable="true" type="tns:CurrencyCode" />
    <xs:element minOccurs="0" name="AccountFinancialStatus" nillable="true" type="tns:AccountFinancialStatus" />
    <xs:element minOccurs="0" name="Id" nillable="true" type="xs:long" />
    <xs:element minOccurs="0" name="Language" nillable="true" type="tns:LanguageType" />
    <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="Name" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="Number" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="ParentCustomerId" type="xs:long" />
    <xs:element minOccurs="0" name="PaymentMethodId" nillable="true" type="xs:long" />
    <xs:element minOccurs="0" name="PaymentMethodType" nillable="true" type="tns:PaymentMethodType" />
    <xs:element minOccurs="0" name="PrimaryUserId" nillable="true" type="xs:long" />
    <xs:element minOccurs="0" name="AccountLifeCycleStatus" nillable="true" type="tns:AccountLifeCycleStatus" />
    <xs:element minOccurs="0" name="TimeStamp" nillable="true" type="xs:base64Binary" />
    <xs:element minOccurs="0" name="TimeZone" nillable="true" type="tns:TimeZoneType" />
    <xs:element minOccurs="0" name="PauseReason" nillable="true" type="xs:unsignedByte" />
    <xs:element minOccurs="0" name="ForwardCompatibilityMap" nillable="true" type="q1:ArrayOfKeyValuePairOfstringstring" xmlns:q1="http://schemas.datacontract.org/2004/07/System.Collections.Generic" />
    <xs:element minOccurs="0" name="LinkedAgencies" nillable="true" type="tns:ArrayOfCustomerInfo" />
    <xs:element minOccurs="0" name="SalesHouseCustomerId" nillable="true" type="xs:long" />
    <xs:element minOccurs="0" name="TaxInformation" nillable="true" type="q2:ArrayOfKeyValuePairOfstringstring" xmlns:q2="http://schemas.datacontract.org/2004/07/System.Collections.Generic" />
    <xs:element minOccurs="0" name="BackUpPaymentInstrumentId" nillable="true" type="xs:long" />
    <xs:element minOccurs="0" name="BillingThresholdAmount" nillable="true" type="xs:decimal" />
    <xs:element minOccurs="0" name="BusinessAddress" nillable="true" type="tns:Address" />
    <xs:element minOccurs="0" name="AutoTagType" nillable="true" type="tns:AutoTagType" />
    <xs:element minOccurs="0" name="SoldToPaymentInstrumentId" nillable="true" type="xs:long" />
  </xs:sequence>
</xs:complexType>

Elements

Element Description Data Type
AccountFinancialStatus The financial status of the account. For example, the status can indicate whether the account is in good standing or is past due.

Add: Read-only
Update: Read-only
AccountFinancialStatus
AccountLifeCycleStatus The status of the account. You cannot set the status of the account.

Add: Read-only
Update: Read-only
AccountLifeCycleStatus
AutoTagType Determines whether to append or replace the supported UTM tracking codes.

Bing Ads can automatically add UTM tags to your destination URL so you can use your website analytics tool, for example Google Analytics, to track how people got to your website. Auto-tags are applied for example to expanded text ads, keywords, Bing Shopping Campaigns, and Sitelink Extensions. For details about auto-tagging, please see the Bing Ads help article How do I add UTM tags to my landing page URL?.

Add: Optional. If not specified the default value is Inactive.
Update: Optional. If no value is specified on update, this Bing Ads setting is not changed.
AutoTagType
BackUpPaymentInstrumentId The identifier of a backup payment instrument to use to settle the account. This element is not applicable for invoiced accounts.

Add: Read-only
Update: Optional. If no value is specified on update, this Bing Ads setting is not changed.
long
BillingThresholdAmount A customer specified amount for settling against the selected payment instrument.

Add: Read-only
Update: Optional. If no value is specified on update, this Bing Ads setting is not changed.
decimal
BillToCustomerId The identifier of the customer that is billed for the charges that the account generates. This is either the reseller that manages this account on behalf of the owner or the identifier of the customer that owns the account.

The service sets the identifier based on the owner of the payment instrument identified in the PaymentMethodId element.

Add: Read-only
Update: Read-only
long
BusinessAddress The location where your business is legally registered. If you are an agency working as an agent for your customer, this is the location where your client is legally registered. If you are an agency working as a reseller, this is the legally registered business address of your company. The business address is used to determine your tax requirements.

Add: Required
Update: Optional for accounts that are not billed by monthly invoice. Having said that, if you want to make any changes to the Address then you must set its BusinessName, City, CountryCode, Line1, and StateOrProvince elements (where applicable); Read-only for monthly invoice accounts. To update the BusinessAddress of an invoice account, contact your account manager or support.
Address
CurrencyCode The ISO code for the currency that is used to settle the account.

The service uses the currency information for billing purposes.

Add: Required
Update: Read-only
CurrencyCode
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 identifier of the account.

This is the identifier that you set the AccountId element and CustomerAccountId SOAP header to in many of the campaign requests.

Add: Read-only
Update: Required
long
Language The language used to render the invoice (if you use an invoice as your payment method).

If you specify a language value when signing up a customer, the value is ignored. The signup process instead gets the language value from the Lcid element of the User. If the Lcid element is set to a value such as FrenchCanada, the Language element is set to French.

Add: Read-only
Update: Optional. If no value is specified on update, this Bing Ads setting is not changed.
LanguageType
LastModifiedByUserId The identifier of the last user to update the account's information.

Add: Read-only
Update: Read-only
long
LastModifiedTime The date and time that the account 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
LinkedAgencies The list of agencies linked to this account.

Currently only one agency customer is supported when you add the account. When you retrieve the account all linked agency customer info will be included.

Add: Optional. If the owner manages the account, set to NULL.
Update: Read-only
CustomerInfo array
Name The name of the account. The string can contain between 3 and 100 characters and must be unique among all account names within the customer.

Add: Required
Update: Required
string
Number The system generated account number that is used to identify the account in the Bing Ads web application. The account number has the form xxxxxxxx, where xxxxxxxx is a series of any eight alphanumeric characters.

Add: Read-only
Update: Read-only
string
ParentCustomerId The identifier of the customer that owns the account.

In the campaign requests that require a customer identifier, this is the identifier that you set the CustomerId SOAP header to.

Add: Required
Update: Read-only
long
PauseReason A flag value that indicates who paused the account. The following are the possible values:

1 - The user paused the account.

2 - The billing service paused the account.

4 - The user and billing service paused the account.

Add: Read-only
Update: Read-only
unsignedByte
PaymentMethodId The identifier of the payment instrument to use to settle the account.

Add: Optional for AddAccount; Read-only for SignupCustomer. When you call SignupCustomer set this element to NULL. The service picks up the payment method identifier associated with the reseller's invoice automatically.
Update: Optional. If no value is specified on update, this Bing Ads setting is not changed.
long
PaymentMethodType The type of payment instrument to use to settle the account. You do not have to set this value because the type is determined by the payment instrument corresponding to the PaymentMethodId element.

When you call the GetAccount and SearchAccounts to get the account data, PaymentMethodType is set to NULL, and you cannot determine the payment method that the account uses.

Reserved for internal use.

Add: Read-only
Update: Read-only
PaymentMethodType
PrimaryUserId The identifier of the account manager who is primarily responsible for managing this account.

By default, the value is set to the reseller's user identifier.

Add: Read-only
Update: Optional. If no value is specified on update, this Bing Ads setting is not changed.
long
SalesHouseCustomerId The identifier of the third party that is responsible for a sales lead.

Add: Read-only
Update: Read-only
long
SoldToPaymentInstrumentId The identifier of the payment instrument of your client (the sold-to customer) to use to settle the account.

Add: Required for AddAccount if the BillToCustomerId differs from the ParentCustomerId; Read-only and not applicable for SignupCustomer.
Update: Optional. If no value is specified on update, this Bing Ads setting is not changed.
long
TaxInformation For a list of valid key and value strings for this element, see AdvertiserAccount TaxInformation in the section below.

Add: Optional
Update: Optional. If no value is specified on update, this Bing Ads setting is not changed. To remove a key and value pair, set the key and then set the value to an empty string ("").
KeyValuePairOfstringstring array
TimeStamp The time-stamp value that the system uses internally to reconcile updates when you call the UpdateAccount and DeleteAccount operations.

Add: Read-only
Update: Required
base64Binary
TimeZone The default time-zone value to use for campaigns in this account.

If you do not specify a value when the account is added, the time zone will be set to PacificTimeUSCanadaTijuana by default.

This time-zone value is used by the Bing Ads web application to display the account time zone preference, and does not provide a default time-zone value for campaigns that are created by using the Bulk or Campaign Management API.

Add: Optional
Update: Optional. If no value is specified on update, this Bing Ads setting is not changed.
TimeZoneType

Remarks

AdvertiserAccount TaxInformation

The following is the list of keys that are available for the TaxInformation element of an AdvertiserAccount.

TaxInformation Key Description Countries
TaxId The account's tax identifier The tax identifier must be valid in the country that you specified in the BusinessAddress element. Without a tax identifier, taxes might apply based on your business location.

Add: Required
Update: Read-only
Brazil, Australia, Taiwan
GstInNumber GSTINNumber This number starts with two numbers representing the state code in which the business is registered followed by a maximum of 13 number and letters.

Add: Optional
Update: Read-only
India
NZGSTNumber The NZGSTN Number is an 8 or 9 Digit long TaxID. Without a NZGSTN Number taxes might apply based on your business location.

Add: Optional
Update: Read-only
New Zealand
PanNumber The PAN number.

Add: Required
Update: Read-only
India
TaxType You can indicate the type of tax. Possible values are Business and Personal.

Add: Optional
Update: Optional
All
VATNumber The account's Value Added Tax (VAT) registration number (also known as VAT identifier). This number starts with 2 letters that are specific to each country/region, followed by a maximum of 12 numbers or letters. The VAT number must be valid in the country that you specified in the BusinessAddress element. Without a VAT registration number or exemption certificate, taxes might apply based on your business location.

Add: Optional
Update: Read-only
Austria, Belgium, Bulgaria, Cyprus, Czech Republic, Germany, Denmark, Estonia, Greece, Spain, Finland, France, United Kingdom, Croatia, Hungary, Ireland, Italy, Lithuania, Luxembourg, Latvia, Malta, The Netherlands, Poland, Portugal, Romania, Sweden, Slovenia, Slovakia

Requirements

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

Used By

AddAccount
GetAccount
SearchAccounts
SignupCustomer
UpdateAccount