SetAutoApplyOptInStatus Service Operation - Ad Insight

Article
03/20/2023

Set the auto-apply recommendations opt-in status for a single account.

Request Elements

The SetAutoApplyOptInStatusRequest 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
AutoApplyOptInStatusInputs	A string array which identifies auto-apply opt-in status of the given recommendation types in the request. Duplicated input keys are not allowed in the same call. This field includes the list of recommendation types with the auto-apply opt-in status to be specified. The existing key and value pairs are as follows (case sensitive): ResponsiveSearchAdsOpportunity = false MultiMediaAdsOpportunity = true RemoveConflictingNegativeKeywordOpportunity = false FixConversionGoalSettingsOpportunity = false CreateConversionGoalOpportunity = false . If the value of a key is set to true, then the account will opt-in auto-apply of the corresponding recommendation type. You may specify a maximum of 100 input elements.	string 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 SetAutoApplyOptInStatusResponse 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
PartialErrors	An array BatchError 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/AdInsight/v13">
    <Action mustUnderstand="1">SetAutoApplyOptInStatus</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>
    <SetAutoApplyOptInStatusRequest xmlns="https://bingads.microsoft.com/AdInsight/v13">
      <AutoApplyOptInStatusInputs i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <a1:string>ValueHere</a1:string>
      </AutoApplyOptInStatusInputs>
    </SetAutoApplyOptInStatusRequest>
  </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/AdInsight/v13">
    <TrackingId d3p1:nil="false" xmlns:d3p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</TrackingId>
  </s:Header>
  <s:Body>
    <SetAutoApplyOptInStatusResponse xmlns="https://bingads.microsoft.com/AdInsight/v13">
      <PartialErrors d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <BatchError>
          <Code>ValueHere</Code>
          <Details d4p1:nil="false">ValueHere</Details>
          <ErrorCode d4p1:nil="false">ValueHere</ErrorCode>
          <Index>ValueHere</Index>
          <Message d4p1:nil="false">ValueHere</Message>
        </BatchError>
      </PartialErrors>
    </SetAutoApplyOptInStatusResponse>
  </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<SetAutoApplyOptInStatusResponse> SetAutoApplyOptInStatusAsync(
	IList<string> autoApplyOptInStatusInputs)
{
	var request = new SetAutoApplyOptInStatusRequest
	{
		AutoApplyOptInStatusInputs = autoApplyOptInStatusInputs
	};

	return (await AdInsightService.CallAsync((s, r) => s.SetAutoApplyOptInStatusAsync(r), request));
}

static SetAutoApplyOptInStatusResponse setAutoApplyOptInStatus(
	ArrayOfstring autoApplyOptInStatusInputs) throws RemoteException, Exception
{
	SetAutoApplyOptInStatusRequest request = new SetAutoApplyOptInStatusRequest();

	request.setAutoApplyOptInStatusInputs(autoApplyOptInStatusInputs);

	return AdInsightService.getService().setAutoApplyOptInStatus(request);
}

static function SetAutoApplyOptInStatus(
	$autoApplyOptInStatusInputs)
{

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

	$request = new SetAutoApplyOptInStatusRequest();

	$request->AutoApplyOptInStatusInputs = $autoApplyOptInStatusInputs;

	return $GLOBALS['AdInsightProxy']->GetService()->SetAutoApplyOptInStatus($request);
}

response=adinsight_service.SetAutoApplyOptInStatus(
	AutoApplyOptInStatusInputs=AutoApplyOptInStatusInputs)

Requirements

Service: AdInsightService.svc v13
Namespace: https://bingads.microsoft.com/AdInsight/v13

Share via