GetAccountProperties Service Operation - Campaign Management

Article
03/20/2023

Gets account level properties by name.

Request Elements

The GetAccountPropertiesRequest 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
AccountPropertyNames	The names of account properties that you want to get. For example, determine whether or not Microsoft Click Id auto-tagging is enabled, include the MSCLKIDAutoTaggingEnabled value in your request.	AccountPropertyName array

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 GetAccountPropertiesResponse 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
AccountProperties	An array of account properties. For each account property name specified in the request, an AccountProperty object is returned.	AccountProperty array
PartialErrors	An array of BatchError objects that contain details for any request items that were not successful. The list of errors do not correspond directly to the list of items in the request. The list can be empty if there were no errors, or can include one or more error objects corresponding to each unsuccessful list item in the request.	BatchError 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">GetAccountProperties</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>
    <GetAccountPropertiesRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <AccountPropertyNames i:nil="false">
        <AccountPropertyName>ValueHere</AccountPropertyName>
      </AccountPropertyNames>
    </GetAccountPropertiesRequest>
  </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>
    <GetAccountPropertiesResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <AccountProperties d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <AccountProperty>
          <Name>ValueHere</Name>
          <Value d4p1:nil="false">ValueHere</Value>
        </AccountProperty>
      </AccountProperties>
      <PartialErrors d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <BatchError d4p1:type="-- derived type specified here with the appropriate prefix --">
          <Code>ValueHere</Code>
          <Details d4p1:nil="false">ValueHere</Details>
          <ErrorCode d4p1:nil="false">ValueHere</ErrorCode>
          <FieldPath d4p1:nil="false">ValueHere</FieldPath>
          <ForwardCompatibilityMap xmlns:e100="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
            <e100:KeyValuePairOfstringstring>
              <e100:key d4p1:nil="false">ValueHere</e100:key>
              <e100:value d4p1:nil="false">ValueHere</e100:value>
            </e100:KeyValuePairOfstringstring>
          </ForwardCompatibilityMap>
          <Index>ValueHere</Index>
          <Message d4p1:nil="false">ValueHere</Message>
          <Type d4p1:nil="false">ValueHere</Type>
          <!--These fields are applicable if the derived type attribute is set to EditorialError-->
          <Appealable d4p1:nil="false">ValueHere</Appealable>
          <DisapprovedText d4p1:nil="false">ValueHere</DisapprovedText>
          <Location d4p1:nil="false">ValueHere</Location>
          <PublisherCountry d4p1:nil="false">ValueHere</PublisherCountry>
          <ReasonCode>ValueHere</ReasonCode>
        </BatchError>
      </PartialErrors>
    </GetAccountPropertiesResponse>
  </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<GetAccountPropertiesResponse> GetAccountPropertiesAsync(
	IList<AccountPropertyName> accountPropertyNames)
{
	var request = new GetAccountPropertiesRequest
	{
		AccountPropertyNames = accountPropertyNames
	};

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

static GetAccountPropertiesResponse getAccountProperties(
	ArrayOfAccountPropertyName accountPropertyNames) throws RemoteException, Exception
{
	GetAccountPropertiesRequest request = new GetAccountPropertiesRequest();

	request.setAccountPropertyNames(accountPropertyNames);

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

static function GetAccountProperties(
	$accountPropertyNames)
{

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

	$request = new GetAccountPropertiesRequest();

	$request->AccountPropertyNames = $accountPropertyNames;

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

response=campaignmanagement_service.GetAccountProperties(
	AccountPropertyNames=AccountPropertyNames)

Requirements

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

Share via