Partager via

Opération du service RefineResponsiveSearchAdRecommendation - Gestion des campagnes

Affinez une recommandation publicitaire de recherche réactive.

Éléments de demande

L’objet RefineResponsiveSearchAdRecommendationRequest 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
ResponsiveSearchAd Réservé. ResponsiveSearchAd
TextRefineOperations Réservé. Tableau AdRecommendationTextRefineOperation

É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 RefineResponsiveSearchAdRecommendationResponse 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
TextRefineResults Liste des résultats d’affinement du texte. Tableau AdRecommendationTextRefineResult

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

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/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">
      <TextRefineResults d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <AdRecommendationTextRefineResult>
          <Errors d4p1:nil="false">
            <OperationError>
              <Code>ValueHere</Code>
              <Details d4p1:nil="false">ValueHere</Details>
              <ErrorCode d4p1:nil="false">ValueHere</ErrorCode>
              <Message d4p1:nil="false">ValueHere</Message>
            </OperationError>
          </Errors>
          <TextAssetLinks d4p1:nil="false">
            <AssetLink>
              <Asset d4p1:nil="false" d4p1:type="-- derived type specified here with the appropriate prefix --">
                <Id d4p1:nil="false">ValueHere</Id>
                <Name d4p1:nil="false">ValueHere</Name>
                <Type d4p1:nil="false">ValueHere</Type>
                <!--This field is applicable if the derived type attribute is set to TextAsset-->
                <Text d4p1:nil="false">ValueHere</Text>
                <!--These fields are applicable if the derived type attribute is set to ImageAsset-->
                <CropHeight d4p1:nil="false">ValueHere</CropHeight>
                <CropWidth d4p1:nil="false">ValueHere</CropWidth>
                <CropX d4p1:nil="false">ValueHere</CropX>
                <CropY d4p1:nil="false">ValueHere</CropY>
                <SubType d4p1:nil="false">ValueHere</SubType>
                <TargetHeight d4p1:nil="false">ValueHere</TargetHeight>
                <TargetWidth d4p1:nil="false">ValueHere</TargetWidth>
                <!--These fields are applicable if the derived type attribute is set to VideoAsset-->
                <SubType d4p1:nil="false">ValueHere</SubType>
                <ThumbnailImage d4p1:nil="false">
                  <CropHeight d4p1:nil="false">ValueHere</CropHeight>
                  <CropWidth d4p1:nil="false">ValueHere</CropWidth>
                  <CropX d4p1:nil="false">ValueHere</CropX>
                  <CropY d4p1:nil="false">ValueHere</CropY>
                  <SubType d4p1:nil="false">ValueHere</SubType>
                  <TargetHeight d4p1:nil="false">ValueHere</TargetHeight>
                  <TargetWidth d4p1:nil="false">ValueHere</TargetWidth>
                </ThumbnailImage>
              </Asset>
              <AssetPerformanceLabel d4p1:nil="false">ValueHere</AssetPerformanceLabel>
              <EditorialStatus d4p1:nil="false">ValueHere</EditorialStatus>
              <PinnedField d4p1:nil="false">ValueHere</PinnedField>
            </AssetLink>
          </TextAssetLinks>
        </AdRecommendationTextRefineResult>
      </TextRefineResults>
    </RefineResponsiveSearchAdRecommendationResponse>
  </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<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)

Configuration requise

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

URL de la demande

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

Éléments de demande

L’objet RefineResponsiveSearchAdRecommendationRequest 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
ResponsiveSearchAd Réservé. ResponsiveSearchAd
TextRefineOperations Réservé. Tableau AdRecommendationTextRefineOperation

É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

L’objet RefineResponsiveSearchAdRecommendationResponse 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 le json de réponse.

Response Body, éléments

Élément Description Type de données
TextRefineResults Liste des résultats d’affinement du texte. Tableau AdRecommendationTextRefineResult

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

Voici un exemple qui s’applique si le type de ressource est 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"
    }
  ]
}

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.

Voici un exemple qui s’applique si le type de ressource est ImageAsset.

{
  "TextRefineResults": [
    {
      "Errors": [
        {
          "Code": IntValueHere,
          "Details": "ValueHere",
          "ErrorCode": "ValueHere",
          "Message": "ValueHere"
        }
      ],
      "TextAssetLinks": [
        {
          "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"
        }
      ]
    }
  ]
}

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<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)
  • Last updated on