Edit

Share via

RefineResponsiveSearchAdRecommendation Service Operation - Campaign Management

  • Article

Reserved.

Request Elements

The RefineResponsiveSearchAdRecommendationRequest 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
ResponsiveSearchAd Reserved. ResponsiveSearchAd
TextRefineOperations Reserved. AdRecommendationTextRefineOperation 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 RefineResponsiveSearchAdRecommendationResponse 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
TextSuggestions Reserved. AdRecommendationTextSuggestion 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">RefineResponsiveSearchAdRecommendation</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>
    <RefineResponsiveSearchAdRecommendationRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <ResponsiveSearchAd i:nil="false">
        <Descriptions i:nil="false">
          <AssetLink>
            <Asset i:nil="false" i:type="-- derived type specified here with the appropriate prefix --">
              <Id i:nil="false">ValueHere</Id>
              <Name i:nil="false">ValueHere</Name>
              <Type i:nil="false">ValueHere</Type>
              <!--This field is applicable if the derived type attribute is set to TextAsset-->
              <Text i:nil="false">ValueHere</Text>
              <!--These fields are applicable if the derived type attribute is set to ImageAsset-->
              <CropHeight i:nil="false">ValueHere</CropHeight>
              <CropWidth i:nil="false">ValueHere</CropWidth>
              <CropX i:nil="false">ValueHere</CropX>
              <CropY i:nil="false">ValueHere</CropY>
              <SubType i:nil="false">ValueHere</SubType>
              <TargetHeight i:nil="false">ValueHere</TargetHeight>
              <TargetWidth i:nil="false">ValueHere</TargetWidth>
              <!--These fields are applicable if the derived type attribute is set to VideoAsset-->
              <SubType i:nil="false">ValueHere</SubType>
              <ThumbnailImage i:nil="false">
                <CropHeight i:nil="false">ValueHere</CropHeight>
                <CropWidth i:nil="false">ValueHere</CropWidth>
                <CropX i:nil="false">ValueHere</CropX>
                <CropY i:nil="false">ValueHere</CropY>
                <SubType i:nil="false">ValueHere</SubType>
                <TargetHeight i:nil="false">ValueHere</TargetHeight>
                <TargetWidth i:nil="false">ValueHere</TargetWidth>
              </ThumbnailImage>
            </Asset>
            <AssetPerformanceLabel i:nil="false">ValueHere</AssetPerformanceLabel>
            <EditorialStatus i:nil="false">ValueHere</EditorialStatus>
            <PinnedField i:nil="false">ValueHere</PinnedField>
          </AssetLink>
        </Descriptions>
        <Domain i:nil="false">ValueHere</Domain>
        <Headlines i:nil="false">
          <AssetLink>
            <Asset i:nil="false" i:type="-- derived type specified here with the appropriate prefix --">
              <Id i:nil="false">ValueHere</Id>
              <Name i:nil="false">ValueHere</Name>
              <Type i:nil="false">ValueHere</Type>
              <!--This field is applicable if the derived type attribute is set to TextAsset-->
              <Text i:nil="false">ValueHere</Text>
              <!--These fields are applicable if the derived type attribute is set to ImageAsset-->
              <CropHeight i:nil="false">ValueHere</CropHeight>
              <CropWidth i:nil="false">ValueHere</CropWidth>
              <CropX i:nil="false">ValueHere</CropX>
              <CropY i:nil="false">ValueHere</CropY>
              <SubType i:nil="false">ValueHere</SubType>
              <TargetHeight i:nil="false">ValueHere</TargetHeight>
              <TargetWidth i:nil="false">ValueHere</TargetWidth>
              <!--These fields are applicable if the derived type attribute is set to VideoAsset-->
              <SubType i:nil="false">ValueHere</SubType>
              <ThumbnailImage i:nil="false">
                <CropHeight i:nil="false">ValueHere</CropHeight>
                <CropWidth i:nil="false">ValueHere</CropWidth>
                <CropX i:nil="false">ValueHere</CropX>
                <CropY i:nil="false">ValueHere</CropY>
                <SubType i:nil="false">ValueHere</SubType>
                <TargetHeight i:nil="false">ValueHere</TargetHeight>
                <TargetWidth i:nil="false">ValueHere</TargetWidth>
              </ThumbnailImage>
            </Asset>
            <AssetPerformanceLabel i:nil="false">ValueHere</AssetPerformanceLabel>
            <EditorialStatus i:nil="false">ValueHere</EditorialStatus>
            <PinnedField i:nil="false">ValueHere</PinnedField>
          </AssetLink>
        </Headlines>
        <Path1 i:nil="false">ValueHere</Path1>
        <Path2 i:nil="false">ValueHere</Path2>
      </ResponsiveSearchAd>
      <TextRefineOperations i:nil="false">
        <AdRecommendationTextRefineOperation>
          <TextField>ValueHere</TextField>
          <TextFieldIndex>ValueHere</TextFieldIndex>
          <TextTone i:nil="false">ValueHere</TextTone>
        </AdRecommendationTextRefineOperation>
      </TextRefineOperations>
    </RefineResponsiveSearchAdRecommendationRequest>
  </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>
    <RefineResponsiveSearchAdRecommendationResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <TextSuggestions d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <ArrayOfAdRecommendationTextSuggestion>
          <AdRecommendationTextSuggestion>
            <Text d4p1:nil="false">ValueHere</Text>
          </AdRecommendationTextSuggestion>
        </ArrayOfAdRecommendationTextSuggestion>
      </TextSuggestions>
    </RefineResponsiveSearchAdRecommendationResponse>
  </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<RefineResponsiveSearchAdRecommendationResponse> RefineResponsiveSearchAdRecommendationAsync(
	ResponsiveSearchAd responsiveSearchAd,
	IList<AdRecommendationTextRefineOperation> textRefineOperations)
{
	var request = new RefineResponsiveSearchAdRecommendationRequest
	{
		ResponsiveSearchAd = responsiveSearchAd,
		TextRefineOperations = textRefineOperations
	};

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

static RefineResponsiveSearchAdRecommendationResponse refineResponsiveSearchAdRecommendation(
	ResponsiveSearchAd responsiveSearchAd,
	ArrayOfAdRecommendationTextRefineOperation textRefineOperations) throws RemoteException, Exception
{
	RefineResponsiveSearchAdRecommendationRequest request = new RefineResponsiveSearchAdRecommendationRequest();

	request.setResponsiveSearchAd(responsiveSearchAd);
	request.setTextRefineOperations(textRefineOperations);

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

static function RefineResponsiveSearchAdRecommendation(
	$responsiveSearchAd,
	$textRefineOperations)
{

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

	$request = new RefineResponsiveSearchAdRecommendationRequest();

	$request->ResponsiveSearchAd = $responsiveSearchAd;
	$request->TextRefineOperations = $textRefineOperations;

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

response=campaignmanagement_service.RefineResponsiveSearchAdRecommendation(
	ResponsiveSearchAd=ResponsiveSearchAd,
	TextRefineOperations=TextRefineOperations)

Requirements

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

Request Url

https://campaign.api.bingads.microsoft.com/CampaignManagement/v13/ResponsiveSearchAdRecommendation/Refine

Request Elements

The RefineResponsiveSearchAdRecommendationRequest 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
ResponsiveSearchAd Reserved. ResponsiveSearchAd
TextRefineOperations Reserved. AdRecommendationTextRefineOperation array

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
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 RefineResponsiveSearchAdRecommendationResponse 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
TextSuggestions Reserved. AdRecommendationTextSuggestion 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 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.

Below is an example that is applicable if the type of Asset is ImageAsset.

{
  "ResponsiveSearchAd": {
    "Descriptions": [
      {
        "Asset": {
          "Id": "LongValueHere",
          "Name": "ValueHere",
          "Type": "ImageAsset",
          "CropHeight": IntValueHere,
          "CropWidth": IntValueHere,
          "CropX": IntValueHere,
          "CropY": IntValueHere,
          "SubType": "ValueHere",
          "TargetHeight": IntValueHere,
          "TargetWidth": IntValueHere
        },
        "AssetPerformanceLabel": "ValueHere",
        "EditorialStatus": "ValueHere",
        "PinnedField": "ValueHere"
      }
    ],
    "Domain": "ValueHere",
    "Headlines": [
      {
        "Asset": {
          "Id": "LongValueHere",
          "Name": "ValueHere",
          "Type": "ImageAsset",
          "CropHeight": IntValueHere,
          "CropWidth": IntValueHere,
          "CropX": IntValueHere,
          "CropY": IntValueHere,
          "SubType": "ValueHere",
          "TargetHeight": IntValueHere,
          "TargetWidth": IntValueHere
        },
        "AssetPerformanceLabel": "ValueHere",
        "EditorialStatus": "ValueHere",
        "PinnedField": "ValueHere"
      }
    ],
    "Path1": "ValueHere",
    "Path2": "ValueHere"
  },
  "TextRefineOperations": [
    {
      "TextField": "ValueHere",
      "TextFieldIndex": IntValueHere,
      "TextTone": "ValueHere"
    }
  ]
}

Response JSON

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

{
  "TextSuggestions": [
    {
      "Text": "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<RefineResponsiveSearchAdRecommendationResponse> RefineResponsiveSearchAdRecommendationAsync(
	ResponsiveSearchAd responsiveSearchAd,
	IList<AdRecommendationTextRefineOperation> textRefineOperations)
{
	var request = new RefineResponsiveSearchAdRecommendationRequest
	{
		ResponsiveSearchAd = responsiveSearchAd,
		TextRefineOperations = textRefineOperations
	};

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

static RefineResponsiveSearchAdRecommendationResponse refineResponsiveSearchAdRecommendation(
	ResponsiveSearchAd responsiveSearchAd,
	ArrayOfAdRecommendationTextRefineOperation textRefineOperations) throws RemoteException, Exception
{
	RefineResponsiveSearchAdRecommendationRequest request = new RefineResponsiveSearchAdRecommendationRequest();

	request.setResponsiveSearchAd(responsiveSearchAd);
	request.setTextRefineOperations(textRefineOperations);

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

static function RefineResponsiveSearchAdRecommendation(
	$responsiveSearchAd,
	$textRefineOperations)
{

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

	$request = new RefineResponsiveSearchAdRecommendationRequest();

	$request->ResponsiveSearchAd = $responsiveSearchAd;
	$request->TextRefineOperations = $textRefineOperations;

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

response=campaignmanagement_service.RefineResponsiveSearchAdRecommendation(
	ResponsiveSearchAd=ResponsiveSearchAd,
	TextRefineOperations=TextRefineOperations)