AdvertiserAccount
Collapse the table of content
Expand the table of content

AdvertiserAccount Data Object

 

Defines an advertiser account.

<xs:complexType name="AdvertiserAccount">
  <xs:complexContent mixed="false">
    <xs:extension base="tns:Account">
      <xs:sequence>
        <xs:element minOccurs="0" name="AgencyContactName" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="AgencyCustomerId" nillable="true" type="xs:long" />
        <xs:element minOccurs="0" name="SalesHouseCustomerId" nillable="true" type="xs:long" />
        <xs:element minOccurs="0" name="TaxId" nillable="true" type="xs:string">
          <xs:annotation>
            <xs:appinfo>
              <DefaultValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/" EmitDefaultValue="false"/>
            </xs:appinfo>
          </xs:annotation>
        </xs:element>
        <xs:element minOccurs="0" name="TaxType" nillable="true" type="tns:TaxType">
          <xs:annotation>
            <xs:appinfo>
              <DefaultValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/" EmitDefaultValue="false"/>
            </xs:appinfo>
          </xs:annotation>
        </xs:element>
        <xs:element minOccurs="0" name="BackUpPaymentInstrumentId" nillable="true" type="xs:long" />
        <xs:element minOccurs="0" name="BillingThresholdAmount" nillable="true" type="xs:long" />
        <xs:element minOccurs="0" name="TaxIdStatus" nillable="true" type="tns:TaxIdStatus">
          <xs:annotation>
            <xs:appinfo>
              <DefaultValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/" EmitDefaultValue="false"/>
            </xs:appinfo>
          </xs:annotation>
        </xs:element>
        <xs:element minOccurs="0" name="BusinessAddress" nillable="true" type="tns:Address">
          <xs:annotation>
            <xs:appinfo>
              <DefaultValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/" EmitDefaultValue="false"/>
            </xs:appinfo>
          </xs:annotation>
        </xs:element>
      </xs:sequence>
    </xs:extension>
  </xs:complexContent>
</xs:complexType>

The AdvertiserAccount object derives from the Account object. For a list of the inherited elements, see Inherited Elements below.

ElementDescriptionData TypeSignup CustomerUpdate Account
AgencyContactNameThe name of the person to contact regarding this account. The name can contain a maximum of 100 characters.

Note: This is an informational field whose name may not resolve to an actual user defined on the system.
stringRead-onlyOptional
AgencyCustomerIdThe identifier of the agency that manages an account on behalf of the owner of that account.

If the owner manages the account, set to NULL.
longOptionalRead-only
BackUpPaymentInstrumentIdThe identifier of a backup payment instrument to use to settle the account. This element is not applicable for invoiced accounts.longRead-onlyOptional
BillingThresholdAmountA customer specified amount for settling against the selected payment instrument.decimalRead-onlyOptional
BusinessAddressThe 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.

Note: To update the BusinessAddress or TaxId of an invoice account, contact your account manager or support.
AddressOptionalRead-only
SalesHouseCustomerIdThe identifier of the third party that is responsible for a sales lead.longRead-onlyRead-only
TaxIdThe account's Value Added Tax (VAT) registration number (also known as VAT identifier). This identifier starts with 2 letters that are specific to each country/region, followed by a maximum of 12 numbers or letters. The VAT identifier 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.

Note: To update the BusinessAddress or TaxId of an invoice account, contact your account manager or support.
stringOptionalRead-only
TaxIdStatusThe status of the account's Value Added Tax (VAT) identifier.TaxIdStatusRead-onlyRead-only
TaxTypeFor internal use only.TaxTypeNot applicable.Not applicable.

The AdvertiserAccount object derives from the Account object, and inherits the following elements.

ElementDescriptionData TypeSignup CustomerUpdate Account
AccountFinancialStatusThe financial status of the account. For example, the status can indicate whether the account is in good standing or is past due.AccountFinancialStatusRead-onlyRead-only
AccountLifeCycleStatusThe status of the account. You cannot set the status of the account.AccountLifeCycleStatusRead-onlyRead-only
AccountTypeThe type of the account. For example, whether the account is an advertiser account.AccountTypeRead-onlyRead-only
BillToCustomerIdThe 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.
longRead-onlyRead-only
CountryCodeThe 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 Common Market Values.

Note: 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.
stringRead-onlyRead-only
CurrencyTypeThe type of currency that is used to settle the account. The service uses the currency information for billing purposes.CurrencyTypeRequiredRead-only
ForwardCompatibilityMapFor a list of valid key and value strings for this element, see Account ForwardCompatibilityMap in the section below.KeyValuePairOfstringstring arrayOptionalOptional
IdThe 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.
longRead-onlyRequired
LanguageThe 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.
LanguageTypeRead-onlyOptional
LastModifiedByUserIdThe identifier of the last user to update the account’s information.longRead-onlyRead-only
LastModifiedTimeThe date and time that the account was last updated. The value is in Coordinated Universal Time (UTC).

Note: 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.
dateTimeRead-onlyRead-only
NameThe name of the account. The name can contain a maximum of 100 characters and must be unique within the customer.stringRequiredRequired
NumberThe 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.stringRead-onlyRead-only
ParentCustomerIdThe 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.
longRequiredRead-only
PauseReasonA 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.
unsignedByteRead-onlyRead-only
PaymentMethodIdThe 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.
longRead-onlyOptional
PaymentMethodTypeThe 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.

Note: Reserved for internal use.
PaymentMethodTypeRead-onlyRead-only
PrimaryUserIdThe 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.
longRead-onlyOptional
TimeStampThe time-stamp value that the system uses internally to reconcile updates when you call the UpdateAccount and DeleteAccount operations.base64BinaryRead-onlyRequired
TimeZoneThe 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.

Note: 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.
TimeZoneTypeOptionalOptional

The following is the list of keys that are available for the ForwardCompatibilityMap element of an Account.

Note: An Advertiser Campaign Manager user can only update the TrackingUrlTemplate and AutoTag values in the ForwardCompatibilityMap element. The Id, Name and TimeStamp properties are read-only and required for the update; however, all other properties of the Account object are read-only and will be ignored.

AutoTag

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 to text ads, keywords, Bing Shopping Campaigns , Image Extensions, and Sitelink Extensions. For details about auto-tagging, please see the Bing Ads help article How can I automatically add UTM tags (auto-tagging) to my destination URL.

The AutoTag key and value pair is an account level setting that determines whether to append or replace the supported UTM tracking codes. Tracking codes are inserted dynamically when each ad is shown, and the URL that you set up and stored in Bing Ads is not updated.

The possible values for the AutoTag key are as follows. If the AutoTag key is not specified, the default value is 0.

  • 0 - Bing Ads will not append any UTM tracking codes to your ad or keyword final 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 final 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 final URL.

TrackingUrlTemplate

The tracking template to use as a default for all URLs in your account. The value of the TrackingUrlTemplate key can be set to any valid string as described below.

System_CAPS_ICON_note.jpg Note

Resellers should not specify the TrackingUrlTemplate key when calling SignupCustomer, because the new customer and account are not added to the Upgraded URLs pilot. Subsequent calls to UpdateAccount with TrackingUrlTemplate will fail. Resellers who are interested in joining the Upgraded URLs pilot should contact their account manager.

The following validation rules apply to tracking templates.

  • Tracking templates defined for lower level entities e.g. keyword override those set for higher level entities e.g. campaign. For more information, see Entity Hierarchy and Limits.

  • The length of the tracking template is limited to 2,048 characters.

    Note: The HTTP or HTTPS protocol string does count towards the 2,048 character limit.

  • The tracking template must be a well-formed URL beginning with one of the following: http://, https://, {lpurl}, or {unescapedlpurl}.

  • You must include at least one of the following landing page URL parameters: {lpurl}, {lpurl+2}, {lpurl+3}, {unescapedlpurl}, {escapedlpurl}. Additionally, you can use any dynamic parameter supported by Bing Ads. For a list of supported parameters, see the Available parameters sections within the Bing Ads help article Set up a tracking template.

  • Bing Ads does not validate whether custom parameters exist. If you use custom parameters in your tracking template and they do not exist, then the final URL will include the key and value placeholders of your custom parameters without substitution. For example if your tracking template is for example http://tracker.example.com/?season={_season}&promocode={_promocode}&u={lpurl}, and neither {_season} or {_promocode} are defined at the campaign, ad group, keyword, or ad level, then the final URL will be the same.

CustomerManagementService.svc v9

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

Account

Community Additions

ADD
Show:
© 2016 Microsoft