Export (0) Print
Expand All

Account Data Object

Defines an account. This is the base object from which the advertising accounts derive.


<xs:complexType name="Account">
  <xs:sequence>
    <xs:element minOccurs="0" name="AccountType" type="tns:AccountType" />
    <xs:element minOccurs="0" name="BillToCustomerId" nillable="true" type="xsd:long" />
    <xs:element minOccurs="0" name="CountryCode" nillable="true" type="xsd:string" />
    <xs:element minOccurs="0" name="CurrencyType" nillable="true" type="tns:CurrencyType" />
    <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="ForwardCompatibilityMap" xmlns:q2="http://schemas.datacontract.org/2004/07/System.Collections.Generic" nillable="true" type="q2:ArrayOfKeyValuePairOfstringstring" />
    <xs:element minOccurs="0" name="LastModifiedByUserId" nillable="true" type="xsd:long" />
    <xs:element minOccurs="0" name="LastModifiedTime" nillable="true" type="xsd:dateTime" />
    <xs:element minOccurs="0" name="Name" nillable="true" type="xsd:string" />
    <xs:element minOccurs="0" name="Number" nillable="true" type="xsd:string" />
    <xs:element minOccurs="0" name="ParentCustomerId" type="xsd:long" />
    <xs:element minOccurs="0" name="PauseReason" nillable="true" type="xs:unsignedByte" />
    <xs:element minOccurs="0" name="PaymentMethodId" nillable="true" type="xsd:long" />
    <xs:element minOccurs="0" name="PaymentMethodType" nillable="true" type="tns:PaymentMethodType" />
    <xs:element minOccurs="0" name="PrimaryUserId" nillable="true" type="xsd:long" />
    <xs:element minOccurs="0" name="AccountLifeCycleStatus" nillable="true" type="tns:AccountLifeCycleStatus" />
    <xs:element minOccurs="0" name="TimeStamp" nillable="true" type="xsd:base64Binary" />
    <xs:element minOccurs="0" name="TimeZone" nillable="true" type="tns:TimeZoneType" />
    <xs:element minOccurs="0" name="PauseReason" nillable="true" type="xs:unsignedByte" />
  </xs:sequence>
</xs:complexType>

Elements

Element

Description

Data Type

Signup Customer

Update Account

AccountFinancialStatus

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

AccountFinancialStatus

Read-only

Read-only

AccountLifeCycleStatus

The status of the account. You cannot set the status of the account.

AccountLifeCycleStatus

Read-only

Read-only

AccountType

The type of the account. For example, whether the account is an advertiser account.

AccountType

Read-only

Read-only

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.

long

Read-only

Read-only

CountryCode

The code that identifies the country/region in which the account operates. The service uses the country/region information for billing purposes.

For a list of country code values, see Geographical Location Codes.

System_CLiX_noteNote

If you specify a country code value when signing up a customer, the value is ignored. The signup process instead gets the country code value from the CountryCode element of the customer’s address. For more information, see the CustomerAddress element of the Customer object.

string

Read-only

Read-only

CurrencyType

The type of currency that is used to settle the account. The service uses the currency information for billing purposes.

CurrencyType

Required

Read-only

ForwardCompatibilityMap

The following list of key and value strings are available for forward compatibility.

Key

Value

Description

AutoTag

The possible values are as follows.

  • 0 - Bing Ads will not append any UTM tracking codes to your ad or keyword destination URL.

  • 1 - Bing Ads will automatically append the supported UTM tracking codes, and preserve any existing UTM tracking codes that you added to your ad or keyword's destination URL.

  • 2 - Bing Ads will automatically append the supported UTM tracking codes, and replace any of the existing and supported UTM tracking codes that you added to your ad or keyword's destination URL.

If not specified, the default value is 0.

An account level setting that determines whether to append or replace the supported UTM tracking codes within the destination URL of ads delivered. Tracking codes are appended dynamically when each ad is shown, and the destination URL that you set up and stored in Bing Ads is not updated.

System_CLiX_noteNote

Implementing UTM tracking codes is only applicable if you place Google Analytics tracking tags on your Web site pages.

The destination URL of a TextAd or MobileAd would be dynamically appended when the ad is shown for broad, phrase, or exact search matches. The destination URL of ads shown on the content network are not appended. Appending the URL of other features is not currently supported, for example in the destination URL of site links.

Bing Ads will substitute tags from top to bottom in the order shown below until the maximum length of the destination URL would be exceeded. For more information, please see TextAd, MobileAd, Keyword, and Dynamic Text for Text and Mobile Ad Destination URL.

The table below describes supported UTM tracking codes and default values. If your ad or keyword destination URL contains other UTM tracking codes, they will not be affected regardless of the AutoTag value.

Tracking Code

Description

utm_source

Used to identify the origin of this visit, such as Bing or Google.

When automatically added by Bing Ads, this value will be set to bing.

System_CLiX_noteNote

If you import your campaign from AdWords, be aware of the following: If your AdWords campaign uses the utm_source parameter and that parameter value is Google, AdWords, or any variant of those (such as googleshopping or AdWordsIndia), the value will be replaced by bing. This will prevent your imported campaigns from reporting incorrect source information.

utm_medium

Used to identify the channel that delivered this visit, such as paid search or display ad.

When automatically added by Bing Ads, this value will be set to cpc.

utm_term

Used to identify which keyword or terms triggered this traffic.

When automatically added by Bing Ads, this value will be set to {Keyword}.

utm_campaign

Used to identify the campaign that generated this visit, such as the name of the campaign or ad group.

When automatically added by Bing Ads, this value will be set to the name of the corresponding campaign.

For example if the campaign's name is Winter and the Bing search term is 'gloves', the appended tracking codes and substituted values will be &utm_source=bing&utm_medium=cpc&utm_term=gloves&utm_campaign=Winter.

KeyValuePairOfstringstring array

Optional

Optional

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.

long

Read-only

Required

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 object. If the Lcid element is set to a value such as FrenchCanada, the Language element is set to French.

LanguageType

Read-only

Optional

LastModifiedByUserId

The identifier of the last user to update the account’s information.

long

Read-only

Read-only

LastModifiedTime

The date and time that the account was last updated. The value is in Coordinated Universal Time (UTC).

System_CLiX_noteNote

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.

dateTime

Read-only

Read-only

Name

The name of the account. The name can contain a maximum of 100 characters and must be unique within the customer.

string

Required

Optional

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.

string

Read-only

Read-only

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.

long

Read-only

Read-only

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.

unsignedByte

Read-only

Read-only

PaymentMethodId

The identifier of the payment instrument to use to settle the account.

When signing up a customer, set this element to NULL. The service picks up the payment method identifier associated with the reseller’s invoice automatically.

long

Read-only

Optional

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 that you specify in the PaymentMethodId element.

PaymentMethodType

Read-only

Read-only

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.

long

Read-only

Optional

TimeStamp

The time-stamp value that the system uses internally to reconcile updates when you call the UpdateAccount or DeleteAccount operation.

base64Binary

Read-only

Required

TimeZone

The default time-zone value to use for campaigns in this account.

System_CLiX_noteNote

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 Campaign Management API.

TimeZoneType

Read-only

Read-only

Do not instantiate the Account data object. Instead, instantiate the AdvertiserAccount object that derives from the Account data object.

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

Requirements

CustomerManagementService.svc v9

Namespace: https://bingads.microsoft.com/Customer/v9

Community Additions

ADD
Show:
© 2014 Microsoft