Opération de service GetTextAssetSuggestionsByFinalUrls - Ad Insight

Article
11/14/2024

Obtient des suggestions de ressources de texte par URL finales.

Éléments de demande

L’objet GetTextAssetSuggestionsByFinalUrlsRequest définit les éléments body et header de la demande d’opération de service. Les éléments doivent être dans le même ordre que celui indiqué dans la requête SOAP.

Remarque

Sauf indication contraire ci-dessous, tous les éléments de requête sont requis.

Éléments du corps de la requête

Élément	Description	Type de données
FinalUrls	Dernière URL ou dernière URL où un utilisateur est finalement pris, que le chemin d’accès clic vers l’URL finale inclue ou non des redirections. La limite de tableau maximale de FinalUrls pour chaque requête est de 5.	tableau de chaînes

Éléments d’en-tête de requête

Élément	Description	Type de données
AuthenticationToken	Jeton d’accès OAuth qui représente les informations d’identification d’un utilisateur disposant d’autorisations sur les comptes Microsoft Advertising. Pour plus d’informations, consultez Authentification avec OAuth.	chaîne
CustomerAccountId	Identificateur du compte publicitaire qui possède ou est associé aux entités dans la demande. Cet élément d’en-tête doit avoir la même valeur que l’élément de corps AccountId lorsque les deux sont nécessaires. Cet élément est requis pour la plupart des opérations de service et, à titre de bonne pratique, vous devez toujours le définir. Pour plus d’informations, consultez Obtenir votre compte et ID de client.	chaîne
CustomerId	Identificateur du compte de responsable (client) auquel l’utilisateur accède ou à partir duquel il opère. Un utilisateur peut avoir accès à plusieurs comptes de gestionnaire. Cet élément est requis pour la plupart des opérations de service et, à titre de bonne pratique, vous devez toujours le définir. Pour plus d’informations, consultez Obtenir votre compte et ID de client.	chaîne
DeveloperToken	Jeton de développeur utilisé pour accéder à l’API Bing Ads. Pour plus d’informations, consultez Obtenir un jeton de développeur.	chaîne
Mot de passe	Cet élément est réservé à un usage interne et sera supprimé d’une version ultérieure de l’API. Vous devez utiliser l’élément AuthenticationToken pour définir les informations d’identification de l’utilisateur.	chaîne
UserName	Cet élément est réservé à un usage interne et sera supprimé d’une version ultérieure de l’API. Vous devez utiliser l’élément AuthenticationToken pour définir les informations d’identification de l’utilisateur.	chaîne

Éléments Response

L’objet GetTextAssetSuggestionsByFinalUrlsResponse définit les éléments body et header de la réponse de l’opération de service. Les éléments sont retournés dans le même ordre que celui indiqué dans la réponse SOAP.

Response Body, éléments

Élément	Description	Type de données
PartialErrors	Tableau BatchError qui contient des détails pour tous les éléments de requête qui n’ont pas réussi. La liste des erreurs ne correspond pas directement à la liste des éléments de la demande. La liste peut être vide s’il n’y a pas d’erreur, ou peut inclure un ou plusieurs objets d’erreur correspondant à chaque élément de liste ayant échoué dans la demande.	Tableau BatchError
TextAssetSuggestions	Valeur de chaîne suggérée à utiliser pour la ressource de texte.	Tableau TextAssetSuggestions

Éléments d’en-tête de réponse

Élément	Description	Type de données
TrackingId	Identificateur de l’entrée de journal qui contient les détails de l’appel d’API.	chaîne

Requête SOAP

Ce modèle a été généré par un outil pour afficher l’ordre des éléments body et header pour la requête SOAP. Pour connaître les types pris en charge que vous pouvez utiliser avec cette opération de service, consultez la référence Éléments du corps de la demande ci-dessus.

<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>

Soap de réponse

Ce modèle a été généré par un outil pour afficher l’ordre des éléments de corps et d’en-tête pour la réponse SOAP.

<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>

Syntaxe du code

L’exemple de syntaxe peut être utilisé avec les Kits de développement logiciel (SDK) Bing Ads. Pour plus d’exemples, consultez Exemples de code de l’API Bing Ads .

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)

Configuration requise

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

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

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

Éléments de demande

L’objet GetTextAssetSuggestionsByFinalUrlsRequest définit les éléments body et header de la demande d’opération de service.

Remarque

Sauf indication contraire ci-dessous, tous les éléments de requête sont requis.

Éléments du corps de la requête

Élément	Description	Type de données
FinalUrls	Dernière URL ou dernière URL où un utilisateur est finalement pris, que le chemin d’accès clic vers l’URL finale inclue ou non des redirections. La limite de tableau maximale de FinalUrls pour chaque requête est de 5.	tableau de chaînes

Éléments d’en-tête de requête

Élément	Description	Type de données
Autorisation	Jeton d’accès OAuth qui représente les informations d’identification d’un utilisateur disposant d’autorisations sur les comptes Microsoft Advertising. Vérifiez que le jeton est précédé de « Porteur », ce qui est nécessaire pour une authentification appropriée. Pour plus d’informations, consultez Authentification avec OAuth.	chaîne
CustomerAccountId	Identificateur du compte publicitaire qui possède ou est associé aux entités dans la demande. Cet élément d’en-tête doit avoir la même valeur que l’élément de corps AccountId lorsque les deux sont nécessaires. Cet élément est requis pour la plupart des opérations de service et, à titre de bonne pratique, vous devez toujours le définir. Pour plus d’informations, consultez Obtenir votre compte et ID de client.	chaîne
CustomerId	Identificateur du compte de responsable (client) auquel l’utilisateur accède ou à partir duquel il opère. Un utilisateur peut avoir accès à plusieurs comptes de gestionnaire. Cet élément est requis pour la plupart des opérations de service et, à titre de bonne pratique, vous devez toujours le définir. Pour plus d’informations, consultez Obtenir votre compte et ID de client.	chaîne
DeveloperToken	Jeton de développeur utilisé pour accéder à l’API Bing Ads. Pour plus d’informations, consultez Obtenir un jeton de développeur.	chaîne
Mot de passe	Cet élément est réservé à un usage interne et sera supprimé d’une version ultérieure de l’API. Vous devez utiliser l’élément AuthenticationToken pour définir les informations d’identification de l’utilisateur.	chaîne
UserName	Cet élément est réservé à un usage interne et sera supprimé d’une version ultérieure de l’API. Vous devez utiliser l’élément AuthenticationToken pour définir les informations d’identification de l’utilisateur.	chaîne

Éléments Response

Response Body, éléments

Élément	Description	Type de données
PartialErrors	Tableau BatchError qui contient des détails pour tous les éléments de requête qui n’ont pas réussi. La liste des erreurs ne correspond pas directement à la liste des éléments de la demande. La liste peut être vide s’il n’y a pas d’erreur, ou peut inclure un ou plusieurs objets d’erreur correspondant à chaque élément de liste ayant échoué dans la demande.	Tableau BatchError
TextAssetSuggestions	Valeur de chaîne suggérée à utiliser pour la ressource de texte.	Tableau TextAssetSuggestions

Éléments d’en-tête de réponse

Élément	Description	Type de données
TrackingId	Identificateur de l’entrée de journal qui contient les détails de l’appel d’API.	chaîne

Requête JSON

Ce modèle a été généré par un outil pour afficher le corps et les éléments d’en-tête de la requête JSON. Pour connaître les types pris en charge que vous pouvez utiliser avec cette opération de service, consultez la référence Éléments du corps de la demande ci-dessus.

{
  "FinalUrls": [
    "ValueHere"
  ]
}

JSON de réponse

Ce modèle a été généré par un outil pour afficher le corps et les éléments d’en-tête de la réponse JSON.

{
  "TextAssetSuggestions": [
    {
      "FinalUrl": "ValueHere",
      "TextAssets": [
        "ValueHere"
      ]
    }
  ],
  "PartialErrors": [
    {
      "Code": IntValueHere,
      "Details": "ValueHere",
      "ErrorCode": "ValueHere",
      "Index": IntValueHere,
      "Message": "ValueHere"
    }
  ]
}

Syntaxe du code

Pour appeler l’API REST via des kits SDK, vous devez mettre à niveau le KIT de développement logiciel (SDK) vers une certaine version et configurer les paramètres système. L’exemple de syntaxe peut être utilisé avec les Kits de développement logiciel (SDK) Bing Ads. Pour plus d’exemples, consultez Exemples de code de l’API Bing Ads .

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)

Partager via

Opération de service GetTextAssetSuggestionsByFinalUrls - Ad Insight

Éléments de demande

Éléments du corps de la requête

Éléments d’en-tête de requête

Éléments Response

Response Body, éléments

Éléments d’en-tête de réponse

Requête SOAP

Soap de réponse

Syntaxe du code

Configuration requise

URL de la demande

Éléments de demande

Éléments du corps de la requête

Éléments d’en-tête de requête

Éléments Response

Response Body, éléments

Éléments d’en-tête de réponse

Requête JSON

JSON de réponse

Syntaxe du code

Commentaires

Ressources supplémentaires