Export (0) Print
Expand All

SignupCustomer Service Operation

Signs up a customer with Bing Ads.

Request | Response

Error Codes

Service: CustomerManagementService.svc v9 | Namespace: https://bingads.microsoft.com/Customer/v9

SignupCustomerRequest Message

Request Body

The SignupCustomerRequest object defines the elements of the request’s body. The elements must be in the same order as shown in the SOAP example.

Element

Description

Data Type

Required

Account

An Account object that specifies the details of the customer’s primary account.

System_CLiX_note Note

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

Account

Yes

ApplicationScope

Determines whether the customer is an advertiser or publisher. The default is Advertiser.

The scope of this customer and the scope of the parent customer must be the same; in other words, they must both be advertisers or both be publishers.

ApplicationType

No

Customer

A Customer object that specifies the details of the customer that you are adding.

Customer

Yes

ParentCustomerId

The customer identifier of the reseller that will manage this customer.

long

Yes

Request Header

For information about the values you set the DeveloperToken, Password, and UserName elements to, see Getting Started With the Bing Ads API.

Element

Description

Data Type

ApplicationToken

The application-access token. This header element is not used and should be null.

string

AuthenticationToken

The OAuth access token used to manage Bing Ads accounts linked to a Microsoft Account. For more information, see Managing User Authentication with OAuth.

string

DeveloperToken

The client application's developer access token.

string

Password

The Bing Ads user's sign-in password.

string

UserName

The Bing Ads user's sign-in user name. You may not set this element to a Microsoft account.

string

Request SOAP

The following example shows the complete request envelope.

<s:Envelope xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header xmlns="https://bingads.microsoft.com/Customer/v9">
    <Action mustUnderstand="1">SignupCustomer</Action>
    <ApplicationToken i:nil="false"></ApplicationToken>
    <AuthenticationToken i:nil="false"></AuthenticationToken>
    <DeveloperToken i:nil="false"></DeveloperToken>
    <Password i:nil="false"></Password>
    <UserName i:nil="false"></UserName>
  </s:Header>
  <s:Body>
    <SignupCustomerRequest xmlns="https://bingads.microsoft.com/Customer/v9">
      <Customer xmlns:e25="https://bingads.microsoft.com/Customer/v9/Entities" i:nil="false">
        <e25:CustomerAddress i:nil="false">
          <e25:City i:nil="false"></e25:City>
          <e25:CountryCode i:nil="false"></e25:CountryCode>
          <e25:Id i:nil="false"></e25:Id>
          <e25:Line1 i:nil="false"></e25:Line1>
          <e25:Line2 i:nil="false"></e25:Line2>
          <e25:Line3 i:nil="false"></e25:Line3>
          <e25:Line4 i:nil="false"></e25:Line4>
          <e25:PostalCode i:nil="false"></e25:PostalCode>
          <e25:StateOrProvince i:nil="false"></e25:StateOrProvince>
          <e25:TimeStamp i:nil="false"></e25:TimeStamp>
        </e25:CustomerAddress>
        <e25:CustomerFinancialStatus i:nil="false"></e25:CustomerFinancialStatus>
        <e25:Id i:nil="false"></e25:Id>
        <e25:Industry i:nil="false"></e25:Industry>
        <e25:LastModifiedByUserId i:nil="false"></e25:LastModifiedByUserId>
        <e25:LastModifiedTime i:nil="false"></e25:LastModifiedTime>
        <e25:MarketCountry i:nil="false"></e25:MarketCountry>
        <ForwardCompatibilityMap xmlns:e26="http://schemas.datacontract.org/2004/07/System.Collections.Generic" i:nil="false">
          <e26:KeyValuePairOfstringstring>
            <e26:key i:nil="false"></e26:key>
            <e26:value i:nil="false"></e26:value>
          </e26:KeyValuePairOfstringstring>
        </ForwardCompatibilityMap>
        <e25:MarketLanguage i:nil="false"></e25:MarketLanguage>
        <e25:Name i:nil="false"></e25:Name>
        <e25:ServiceLevel i:nil="false"></e25:ServiceLevel>
        <e25:CustomerLifeCycleStatus i:nil="false"></e25:CustomerLifeCycleStatus>
        <e25:TimeStamp i:nil="false"></e25:TimeStamp>
        <e25:Number i:nil="false"></e25:Number>
      </Customer>
      <Account xmlns:e27="https://bingads.microsoft.com/Customer/v9/Entities" i:nil="false" i:type="-- specify derived type here with the appropriate prefix --">
        <e27:AccountType></e27:AccountType>
        <e27:BillToCustomerId i:nil="false"></e27:BillToCustomerId>
        <e27:CountryCode i:nil="false"></e27:CountryCode>
        <e27:CurrencyType i:nil="false"></e27:CurrencyType>
        <e27:AccountFinancialStatus i:nil="false"></e27:AccountFinancialStatus>
        <e27:Id i:nil="false"></e27:Id>
        <e27:Language i:nil="false"></e27:Language>
        <ForwardCompatibilityMap xmlns:e28="http://schemas.datacontract.org/2004/07/System.Collections.Generic" i:nil="false">
          <e28:KeyValuePairOfstringstring>
            <e28:key i:nil="false"></e28:key>
            <e28:value i:nil="false"></e28:value>
          </e28:KeyValuePairOfstringstring>
        </ForwardCompatibilityMap>
        <e27:LastModifiedByUserId i:nil="false"></e27:LastModifiedByUserId>
        <e27:LastModifiedTime i:nil="false"></e27:LastModifiedTime>
        <e27:Name i:nil="false"></e27:Name>
        <e27:Number i:nil="false"></e27:Number>
        <e27:ParentCustomerId></e27:ParentCustomerId>
        <e27:PaymentMethodId i:nil="false"></e27:PaymentMethodId>
        <e27:PaymentMethodType i:nil="false"></e27:PaymentMethodType>
        <e27:PrimaryUserId i:nil="false"></e27:PrimaryUserId>
        <e27:AccountLifeCycleStatus i:nil="false"></e27:AccountLifeCycleStatus>
        <e27:TimeStamp i:nil="false"></e27:TimeStamp>
        <e27:TimeZone i:nil="false"></e27:TimeZone>
        <e27:PauseReason i:nil="false"></e27:PauseReason>
        <!--Keep these fields if you set the i:type attribute to AdvertiserAccount-->
        <e27:AgencyContactName i:nil="false"></e27:AgencyContactName>
        <e27:AgencyCustomerId i:nil="false"></e27:AgencyCustomerId>
        <e27:SalesHouseCustomerId i:nil="false"></e27:SalesHouseCustomerId>
        <e27:TaxId i:nil="false"></e27:TaxId>
        <e27:TaxType i:nil="false"></e27:TaxType>
        <e27:BackUpPaymentInstrumentId i:nil="false"></e27:BackUpPaymentInstrumentId>
        <e27:BillingThresholdAmount i:nil="false"></e27:BillingThresholdAmount>
      </Account>
      <ParentCustomerId i:nil="false"></ParentCustomerId>
      <ApplicationScope></ApplicationScope>
    </SignupCustomerRequest>
  </s:Body>
</s:Envelope>

SignupCustomerResponse Message

Response Body

System_CLiX_note Note

Identifiers returned in the response may not be immediately available . As a best practice, you should not use customer and account identifiers in subsequent service calls until 10-30 seconds after receiving the response from SignupCustomer.

Element

Description

Data Type

AccountId

A system-generated account identifier if you specified an account object in the request; otherwise, NULL.

Use this identifier with operation requests that require an AccountId element and a CustomerAccountId SOAP header element.

long

AccountNumber

A system-generated account number that is used to identify the account in the Bing Ads web application. The account number has the form, Xnnnnnnn, where nnnnnnn is a series of digits.

CreateTime

The date and time that the account was added. 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

CustomerId

A system-generated customer identifier.

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

long

CustomerNumber

A system-generated customer number that is used in the Bing Ads web application. The customer number is of the form, Cnnnnnnn, where nnnnnnn is a series of digits.

string

Response Header

Element

Description

Data Type

TrackingId

The identifier of the log entry that contains the details of the API call.

string

Response SOAP

The following example shows the complete response envelope.

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header xmlns="https://bingads.microsoft.com/Customer/v9">
    <TrackingId p4:nil="false" xmlns:p4="http://www.w3.org/2001/XMLSchema-instance"></TrackingId>
  </s:Header>
  <s:Body>
    <SignupCustomerResponse xmlns="https://bingads.microsoft.com/Customer/v9">
      <CustomerId></CustomerId>
      <CustomerNumber p4:nil="false" xmlns:p4="http://www.w3.org/2001/XMLSchema-instance"></CustomerNumber>
      <AccountId p4:nil="false" xmlns:p4="http://www.w3.org/2001/XMLSchema-instance"></AccountId>
      <AccountNumber p4:nil="false" xmlns:p4="http://www.w3.org/2001/XMLSchema-instance"></AccountNumber>
      <CreateTime></CreateTime>
    </SignupCustomerResponse>
  </s:Body>
</s:Envelope>

Error Codes

If the service operation fails, it throws a FaultException exception, which contains one or more of the Bing Ads API error data objects. For information about the fault detail objects, see Customer Management Error Data Objects and Handling Service Errors and Exceptions.

The following are example error codes that the error objects can include when using this service operation. For all documented error codes, please see Bing Ads Operation Error Codes.

Code

105

310

Community Additions

ADD
Show:
© 2014 Microsoft