Edit

Share via

GetTextAssetSuggestionsByFinalUrls Service Operation - Ad Insight

  • Article

Gets text asset suggestions by final URLs.

Request Elements

The GetTextAssetSuggestionsByFinalUrlsRequest 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
FinalUrls The last or final URL where a user is ultimately taken, whether or not the click to final URL path included any redirects.

The maximum array limit of FinalUrls for each request is 5.		 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 GetTextAssetSuggestionsByFinalUrlsResponse 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
TextAssetSuggestions The suggested string value to use for the text asset. TextAssetSuggestions 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">GetTextAssetSuggestionsByFinalUrls</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>
    <GetTextAssetSuggestionsByFinalUrlsRequest xmlns="https://bingads.microsoft.com/AdInsight/v13">
      <FinalUrls i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <a1:string>ValueHere</a1:string>
      </FinalUrls>
    </GetTextAssetSuggestionsByFinalUrlsRequest>
  </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>
    <GetTextAssetSuggestionsByFinalUrlsResponse xmlns="https://bingads.microsoft.com/AdInsight/v13">
      <TextAssetSuggestions d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <TextAssetSuggestions>
          <FinalUrl d4p1:nil="false">ValueHere</FinalUrl>
          <TextAssets d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <a1:string>ValueHere</a1:string>
          </TextAssets>
        </TextAssetSuggestions>
      </TextAssetSuggestions>
      <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>
    </GetTextAssetSuggestionsByFinalUrlsResponse>
  </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<GetTextAssetSuggestionsByFinalUrlsResponse> GetTextAssetSuggestionsByFinalUrlsAsync(
	IList<string> finalUrls)
{
	var request = new GetTextAssetSuggestionsByFinalUrlsRequest
	{
		FinalUrls = finalUrls
	};

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

static GetTextAssetSuggestionsByFinalUrlsResponse getTextAssetSuggestionsByFinalUrls(
	ArrayOfstring finalUrls) throws RemoteException, Exception
{
	GetTextAssetSuggestionsByFinalUrlsRequest request = new GetTextAssetSuggestionsByFinalUrlsRequest();

	request.setFinalUrls(finalUrls);

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

static function GetTextAssetSuggestionsByFinalUrls(
	$finalUrls)
{

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

	$request = new GetTextAssetSuggestionsByFinalUrlsRequest();

	$request->FinalUrls = $finalUrls;

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

response=adinsight_service.GetTextAssetSuggestionsByFinalUrls(
	FinalUrls=FinalUrls)

Requirements

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

Request Url

https://adinsight.api.bingads.microsoft.com/AdInsight/v13/TextAssetSuggestions/QueryByFinalUrls

Request Elements

The GetTextAssetSuggestionsByFinalUrlsRequest 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
FinalUrls The last or final URL where a user is ultimately taken, whether or not the click to final URL path included any redirects.

The maximum array limit of FinalUrls for each request is 5.		 string 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 GetTextAssetSuggestionsByFinalUrlsResponse 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
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
TextAssetSuggestions The suggested string value to use for the text asset. TextAssetSuggestions 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.

{
  "FinalUrls": [
    "ValueHere"
  ]
}

Response JSON

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

{
  "TextAssetSuggestions": [
    {
      "FinalUrl": "ValueHere",
      "TextAssets": [
        "ValueHere"
      ]
    }
  ],
  "PartialErrors": [
    {
      "Code": IntValueHere,
      "Details": "ValueHere",
      "ErrorCode": "ValueHere",
      "Index": IntValueHere,
      "Message": "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<GetTextAssetSuggestionsByFinalUrlsResponse> GetTextAssetSuggestionsByFinalUrlsAsync(
	IList<string> finalUrls)
{
	var request = new GetTextAssetSuggestionsByFinalUrlsRequest
	{
		FinalUrls = finalUrls
	};

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

static GetTextAssetSuggestionsByFinalUrlsResponse getTextAssetSuggestionsByFinalUrls(
	ArrayOfstring finalUrls) throws RemoteException, Exception
{
	GetTextAssetSuggestionsByFinalUrlsRequest request = new GetTextAssetSuggestionsByFinalUrlsRequest();

	request.setFinalUrls(finalUrls);

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

static function GetTextAssetSuggestionsByFinalUrls(
	$finalUrls)
{

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

	$request = new GetTextAssetSuggestionsByFinalUrlsRequest();

	$request->FinalUrls = $finalUrls;

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

response=adinsight_service.GetTextAssetSuggestionsByFinalUrls(
	FinalUrls=FinalUrls)