Edit

Share via

GetCustomer Service Operation - Customer Management

  • Article

Gets the details of a customer.

Request Elements

The GetCustomerRequest object defines the body and header elements of the service operation request. The elements must be in the same order as shown in the Request SOAP.

Note

Unless otherwise noted below, all request elements are required.

Request Body Elements

Element Description Data Type
CustomerId The identifier of the customer whose information you want to get. long

Request Header Elements

Element Description Data Type
AuthenticationToken The OAuth access token that represents the credentials of a user who has permissions to Microsoft Advertising accounts.

For more information see Authentication with OAuth.		 string
DeveloperToken The developer token used to access the Bing Ads API.

For more information see Get a Developer Token.		 string
Password This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials. string
UserName This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials. string

Response Elements

The GetCustomerResponse object defines the body and header elements of the service operation response. The elements are returned in the same order as shown in the Response SOAP.

Response Body Elements

Element Description Data Type
Customer A Customer object that contains information about the customer. Customer

Response Header Elements

Element Description Data Type
TrackingId The identifier of the log entry that contains the details of the API call. string

Request SOAP

This template was generated by a tool to show the order of the body and header elements for the SOAP request. For supported types that you can use with this service operation, see the Request Body Elements reference above.

<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/v13">
    <Action mustUnderstand="1">GetCustomer</Action>
    <AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
    <DeveloperToken i:nil="false">ValueHere</DeveloperToken>
  </s:Header>
  <s:Body>
    <GetCustomerRequest xmlns="https://bingads.microsoft.com/Customer/v13">
      <CustomerId>ValueHere</CustomerId>
    </GetCustomerRequest>
  </s:Body>
</s:Envelope>

Response SOAP

This template was generated by a tool to show the order of the body and header elements for the SOAP response.

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header xmlns="https://bingads.microsoft.com/Customer/v13">
    <TrackingId d3p1:nil="false" xmlns:d3p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</TrackingId>
  </s:Header>
  <s:Body>
    <GetCustomerResponse xmlns="https://bingads.microsoft.com/Customer/v13">
      <Customer xmlns:e489="https://bingads.microsoft.com/Customer/v13/Entities" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <e489:CustomerFinancialStatus d4p1:nil="false">ValueHere</e489:CustomerFinancialStatus>
        <e489:Id d4p1:nil="false">ValueHere</e489:Id>
        <e489:Industry d4p1:nil="false">ValueHere</e489:Industry>
        <e489:LastModifiedByUserId d4p1:nil="false">ValueHere</e489:LastModifiedByUserId>
        <e489:LastModifiedTime d4p1:nil="false">ValueHere</e489:LastModifiedTime>
        <e489:MarketCountry d4p1:nil="false">ValueHere</e489:MarketCountry>
        <e489:ForwardCompatibilityMap xmlns:e490="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
          <e490:KeyValuePairOfstringstring>
            <e490:key d4p1:nil="false">ValueHere</e490:key>
            <e490:value d4p1:nil="false">ValueHere</e490:value>
          </e490:KeyValuePairOfstringstring>
        </e489:ForwardCompatibilityMap>
        <e489:MarketLanguage d4p1:nil="false">ValueHere</e489:MarketLanguage>
        <e489:Name d4p1:nil="false">ValueHere</e489:Name>
        <e489:ServiceLevel d4p1:nil="false">ValueHere</e489:ServiceLevel>
        <e489:CustomerLifeCycleStatus d4p1:nil="false">ValueHere</e489:CustomerLifeCycleStatus>
        <e489:TimeStamp d4p1:nil="false">ValueHere</e489:TimeStamp>
        <e489:Number d4p1:nil="false">ValueHere</e489:Number>
        <e489:CustomerAddress d4p1:nil="false">
          <e489:City d4p1:nil="false">ValueHere</e489:City>
          <e489:CountryCode d4p1:nil="false">ValueHere</e489:CountryCode>
          <e489:Id d4p1:nil="false">ValueHere</e489:Id>
          <e489:Line1 d4p1:nil="false">ValueHere</e489:Line1>
          <e489:Line2 d4p1:nil="false">ValueHere</e489:Line2>
          <e489:Line3 d4p1:nil="false">ValueHere</e489:Line3>
          <e489:Line4 d4p1:nil="false">ValueHere</e489:Line4>
          <e489:PostalCode d4p1:nil="false">ValueHere</e489:PostalCode>
          <e489:StateOrProvince d4p1:nil="false">ValueHere</e489:StateOrProvince>
          <e489:TimeStamp d4p1:nil="false">ValueHere</e489:TimeStamp>
          <e489:BusinessName d4p1:nil="false">ValueHere</e489:BusinessName>
        </e489:CustomerAddress>
      </Customer>
    </GetCustomerResponse>
  </s:Body>
</s:Envelope>

Code Syntax

The example syntax can be used with Bing Ads SDKs. See Bing Ads API Code Examples for more examples.

public async Task<GetCustomerResponse> GetCustomerAsync(
	long customerId)
{
	var request = new GetCustomerRequest
	{
		CustomerId = customerId
	};

	return (await CustomerManagementService.CallAsync((s, r) => s.GetCustomerAsync(r), request));
}

static GetCustomerResponse getCustomer(
	java.lang.Long customerId) throws RemoteException, Exception
{
	GetCustomerRequest request = new GetCustomerRequest();

	request.setCustomerId(customerId);

	return CustomerManagementService.getService().getCustomer(request);
}

static function GetCustomer(
	$customerId)
{

	$GLOBALS['Proxy'] = $GLOBALS['CustomerManagementProxy'];

	$request = new GetCustomerRequest();

	$request->CustomerId = $customerId;

	return $GLOBALS['CustomerManagementProxy']->GetService()->GetCustomer($request);
}

response=customermanagement_service.GetCustomer(
	CustomerId=CustomerId)

Requirements

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

Request Url

https://clientcenter.api.bingads.microsoft.com/CustomerManagement/v13/Customer/Query

Request Elements

The GetCustomerRequest object defines the body and header elements of the service operation request.

Note

Unless otherwise noted below, all request elements are required.

Request Body Elements

Element Description Data Type
CustomerId The identifier of the customer whose information you want to get. long

Request Header Elements

Element Description Data Type
Authorization The OAuth access token that represents the credentials of a user who has permissions to Microsoft Advertising accounts. Please ensure that the token is prefixed with "Bearer ", this is necessary for proper authentication.

For more information see Authentication with OAuth.		 string
DeveloperToken The developer token used to access the Bing Ads API.

For more information see Get a Developer Token.		 string
Password This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials. string
UserName This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials. string

Response Elements

The GetCustomerResponse object defines the body and header elements of the service operation response. The elements are returned in the same order as shown in the Response JSON.

Response Body Elements

Element Description Data Type
Customer A Customer object that contains information about the customer. Customer

Response Header Elements

Element Description Data Type
TrackingId The identifier of the log entry that contains the details of the API call. string

Request JSON

This template was generated by a tool to show the body and header elements for the JSON request. For supported types that you can use with this service operation, see the Request Body Elements reference above.

{
  "CustomerId": "LongValueHere"
}

Response JSON

This template was generated by a tool to show the body and header elements for the JSON response.

{
  "Customer": {
    "CustomerAddress": {
      "BusinessName": "ValueHere",
      "City": "ValueHere",
      "CountryCode": "ValueHere",
      "Id": "LongValueHere",
      "Line1": "ValueHere",
      "Line2": "ValueHere",
      "Line3": "ValueHere",
      "Line4": "ValueHere",
      "PostalCode": "ValueHere",
      "StateOrProvince": "ValueHere",
      "TimeStamp": "ValueHere"
    },
    "CustomerFinancialStatus": "ValueHere",
    "CustomerLifeCycleStatus": "ValueHere",
    "ForwardCompatibilityMap": [
      {
        "key": "ValueHere",
        "value": "ValueHere"
      }
    ],
    "Id": "LongValueHere",
    "Industry": "ValueHere",
    "LastModifiedByUserId": "LongValueHere",
    "LastModifiedTime": "ValueHere",
    "MarketCountry": "ValueHere",
    "MarketLanguage": "ValueHere",
    "Name": "ValueHere",
    "Number": "ValueHere",
    "ServiceLevel": "ValueHere",
    "TimeStamp": "ValueHere"
  }
}

Code Syntax

To call REST API through SDKs, you need to upgrade SDK to a certain version and configure the system parameters.The example syntax can be used with Bing Ads SDKs. See Bing Ads API Code Examples for more examples.

public async Task<GetCustomerResponse> GetCustomerAsync(
	long customerId)
{
	var request = new GetCustomerRequest
	{
		CustomerId = customerId
	};

	return (await CustomerManagementService.CallAsync((s, r) => s.GetCustomerAsync(r), request));
}

static GetCustomerResponse getCustomer(
	java.lang.Long customerId) throws RemoteException, Exception
{
	GetCustomerRequest request = new GetCustomerRequest();

	request.setCustomerId(customerId);

	return CustomerManagementService.getService().getCustomer(request);
}

static function GetCustomer(
	$customerId)
{

	$GLOBALS['Proxy'] = $GLOBALS['CustomerManagementProxy'];

	$request = new GetCustomerRequest();

	$request->CustomerId = $customerId;

	return $GLOBALS['CustomerManagementProxy']->GetService()->GetCustomer($request);
}

response=customermanagement_service.GetCustomer(
	CustomerId=CustomerId)