GetBMCStoresByCustomerId Service Operation - Campaign Management

Article
03/20/2023

Gets the Microsoft Merchant Center stores for the specified customer.

Note

The list of stores in the response includes global stores.

Request Elements

The GetBMCStoresByCustomerIdRequest 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
ReturnAdditionalFields	The list of additional stores that you want included. The additional field values enable you to get the latest features using the current version of Campaign Management API, and in the next version the corresponding elements will be included by default. This request element is optional.	BMCStoreAdditionalField

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
CustomerAccountId	The identifier of the ad account that owns or is associated with the entities in the request. This header element must have the same value as the AccountId body element when both are required. This element is required for most service operations, and as a best practice you should always set it. For more information see Get Your Account and Customer IDs.	string
CustomerId	The identifier of the manager account (customer) the user is accessing or operating from. A user can have access to multiple manager accounts. This element is required for most service operations, and as a best practice you should always set it. For more information see Get Your Account and Customer IDs.	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 GetBMCStoresByCustomerIdResponse 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
BMCStores	The list of Microsoft Merchant Center stores for the specified customer.	BMCStore array

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/CampaignManagement/v13">
    <Action mustUnderstand="1">GetBMCStoresByCustomerId</Action>
    <AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
    <CustomerAccountId i:nil="false">ValueHere</CustomerAccountId>
    <CustomerId i:nil="false">ValueHere</CustomerId>
    <DeveloperToken i:nil="false">ValueHere</DeveloperToken>
  </s:Header>
  <s:Body>
    <GetBMCStoresByCustomerIdRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <ReturnAdditionalFields i:nil="false">ValueHere</ReturnAdditionalFields>
    </GetBMCStoresByCustomerIdRequest>
  </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/CampaignManagement/v13">
    <TrackingId d3p1:nil="false" xmlns:d3p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</TrackingId>
  </s:Header>
  <s:Body>
    <GetBMCStoresByCustomerIdResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <BMCStores d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <BMCStore>
          <HasCatalog>ValueHere</HasCatalog>
          <Id>ValueHere</Id>
          <IsActive>ValueHere</IsActive>
          <IsProductAdsEnabled>ValueHere</IsProductAdsEnabled>
          <Name d4p1:nil="false">ValueHere</Name>
          <StoreUrl d4p1:nil="false">ValueHere</StoreUrl>
          <SubType d4p1:nil="false">ValueHere</SubType>
        </BMCStore>
      </BMCStores>
    </GetBMCStoresByCustomerIdResponse>
  </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<GetBMCStoresByCustomerIdResponse> GetBMCStoresByCustomerIdAsync(
	BMCStoreAdditionalField? returnAdditionalFields)
{
	var request = new GetBMCStoresByCustomerIdRequest
	{
		ReturnAdditionalFields = returnAdditionalFields
	};

	return (await CampaignManagementService.CallAsync((s, r) => s.GetBMCStoresByCustomerIdAsync(r), request));
}

static GetBMCStoresByCustomerIdResponse getBMCStoresByCustomerId(
	ArrayList<BMCStoreAdditionalField> returnAdditionalFields) throws RemoteException, Exception
{
	GetBMCStoresByCustomerIdRequest request = new GetBMCStoresByCustomerIdRequest();

	request.setReturnAdditionalFields(returnAdditionalFields);

	return CampaignManagementService.getService().getBMCStoresByCustomerId(request);
}

static function GetBMCStoresByCustomerId(
	$returnAdditionalFields)
{

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

	$request = new GetBMCStoresByCustomerIdRequest();

	$request->ReturnAdditionalFields = $returnAdditionalFields;

	return $GLOBALS['CampaignManagementProxy']->GetService()->GetBMCStoresByCustomerId($request);
}

response=campaignmanagement_service.GetBMCStoresByCustomerId(
	ReturnAdditionalFields=ReturnAdditionalFields)

Requirements

Service: CampaignManagementService.svc v13
Namespace: https://bingads.microsoft.com/CampaignManagement/v13

Share via