Partager via

Opération de service GetBidStrategiesByIds - Gestion des campagnes

  • Article

Obtient les stratégies d’enchère dans la bibliothèque de stratégies d’enchères de portefeuille d’un compte.

Une stratégie d’enchère de portefeuille est une fonctionnalité d’appel d’offres automatisée qui gère les enchères sur plusieurs campagnes qui travaillent toutes vers le même objectif. Pour inclure une campagne dans la stratégie d’enchère de portefeuille, définissez bidstrategyId de la campagne sur l’ID de stratégie d’enchère.

Remarque

Tout le monde n’a pas encore cette fonctionnalité. Si ce n’est pas le cas, ne vous inquiétez pas, il sera bientôt disponible !

Éléments de demande

L’objet GetBidStrategiesByIdsRequest 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
BidStrategyIds Liste d’identificateurs de stratégie d’enchère uniques qui identifient les stratégies d’enchères à obtenir.

Vous pouvez inclure un maximum de 100 ID dans un seul appel.

Les ID de stratégie d’enchère doivent se trouver dans le même compte que celui que vous avez spécifié dans l’élément d’en-tête CustomerAccountId requis.

Si vous laissez cet élément à zéro ou vide, l’opération renverra toutes les stratégies d’offre de portefeuille dans le compte.		 tableau long

É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 GetBidStrategiesByIdsResponse 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
BidStrategies Tableau d’objets BidStrategy qui correspond directement aux identificateurs de stratégie d’enchère que vous avez spécifiés dans la requête. Les éléments de la liste peuvent être retournés comme null. Pour chaque index de liste où une stratégie d’enchère n’a pas été récupérée, l’élément correspondant est null. Tableau BidStrategy
PartialErrors Tableau d’objets BatchError qui contiennent des détails pour tous les éléments de demande 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

É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">GetBidStrategiesByIds</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>
    <GetBidStrategiesByIdsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <BidStrategyIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <a1:long>ValueHere</a1:long>
      </BidStrategyIds>
    </GetBidStrategiesByIdsRequest>
  </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>
    <GetBidStrategiesByIdsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <BidStrategies d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <BidStrategy>
          <AssociatedCampaignType d4p1:nil="false">ValueHere</AssociatedCampaignType>
          <AssociationCount d4p1:nil="false">ValueHere</AssociationCount>
          <BiddingScheme d4p1:nil="false" d4p1:type="-- derived type specified here with the appropriate prefix --">
            <Type d4p1:nil="false">ValueHere</Type>
            <!--This field is applicable if the derived type attribute is set to MaxClicksBiddingScheme-->
            <MaxCpc d4p1:nil="false">
              <Amount d4p1:nil="false">ValueHere</Amount>
            </MaxCpc>
            <!--These fields are applicable if the derived type attribute is set to MaxConversionsBiddingScheme-->
            <MaxCpc d4p1:nil="false">
              <Amount d4p1:nil="false">ValueHere</Amount>
            </MaxCpc>
            <TargetCpa d4p1:nil="false">ValueHere</TargetCpa>
            <!--These fields are applicable if the derived type attribute is set to TargetCpaBiddingScheme-->
            <MaxCpc d4p1:nil="false">
              <Amount d4p1:nil="false">ValueHere</Amount>
            </MaxCpc>
            <TargetCpa d4p1:nil="false">ValueHere</TargetCpa>
            <!--No additional fields are applicable if the derived type attribute is set to ManualCpcBiddingScheme-->
            <!--No additional fields are applicable if the derived type attribute is set to EnhancedCpcBiddingScheme-->
            <!--No additional fields are applicable if the derived type attribute is set to ManualCpvBiddingScheme-->
            <!--No additional fields are applicable if the derived type attribute is set to ManualCpmBiddingScheme-->
            <!--This field is applicable if the derived type attribute is set to InheritFromParentBiddingScheme-->
            <InheritedBidStrategyType d4p1:nil="false">ValueHere</InheritedBidStrategyType>
            <!--These fields are applicable if the derived type attribute is set to TargetRoasBiddingScheme-->
            <MaxCpc d4p1:nil="false">
              <Amount d4p1:nil="false">ValueHere</Amount>
            </MaxCpc>
            <TargetRoas d4p1:nil="false">ValueHere</TargetRoas>
            <!--This field is applicable if the derived type attribute is set to MaxRoasBiddingScheme-->
            <MaxCpc d4p1:nil="false">
              <Amount d4p1:nil="false">ValueHere</Amount>
            </MaxCpc>
            <!--This field is applicable if the derived type attribute is set to MaxConversionValueBiddingScheme-->
            <TargetRoas d4p1:nil="false">ValueHere</TargetRoas>
            <!--These fields are applicable if the derived type attribute is set to TargetImpressionShareBiddingScheme-->
            <MaxCpc d4p1:nil="false">
              <Amount d4p1:nil="false">ValueHere</Amount>
            </MaxCpc>
            <TargetAdPosition d4p1:nil="false">ValueHere</TargetAdPosition>
            <TargetImpressionShare d4p1:nil="false">ValueHere</TargetImpressionShare>
            <!--This field is applicable if the derived type attribute is set to PercentCpcBiddingScheme-->
            <MaxPercentCpc d4p1:nil="false">ValueHere</MaxPercentCpc>
            <!--This field is applicable if the derived type attribute is set to CommissionBiddingScheme-->
            <CommissionRate d4p1:nil="false">ValueHere</CommissionRate>
            <!--This field is applicable if the derived type attribute is set to ManualCpaBiddingScheme-->
            <ManualCpi d4p1:nil="false">ValueHere</ManualCpi>
            <!--This field is applicable if the derived type attribute is set to CostPerSaleBiddingScheme-->
            <TargetCostPerSale d4p1:nil="false">ValueHere</TargetCostPerSale>
          </BiddingScheme>
          <Id d4p1:nil="false">ValueHere</Id>
          <Name d4p1:nil="false">ValueHere</Name>
        </BidStrategy>
      </BidStrategies>
      <PartialErrors d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <BatchError d4p1:type="-- derived type specified here with the appropriate prefix --">
          <Code>ValueHere</Code>
          <Details d4p1:nil="false">ValueHere</Details>
          <ErrorCode d4p1:nil="false">ValueHere</ErrorCode>
          <FieldPath d4p1:nil="false">ValueHere</FieldPath>
          <ForwardCompatibilityMap xmlns:e269="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
            <e269:KeyValuePairOfstringstring>
              <e269:key d4p1:nil="false">ValueHere</e269:key>
              <e269:value d4p1:nil="false">ValueHere</e269:value>
            </e269:KeyValuePairOfstringstring>
          </ForwardCompatibilityMap>
          <Index>ValueHere</Index>
          <Message d4p1:nil="false">ValueHere</Message>
          <Type d4p1:nil="false">ValueHere</Type>
          <!--These fields are applicable if the derived type attribute is set to EditorialError-->
          <Appealable d4p1:nil="false">ValueHere</Appealable>
          <DisapprovedText d4p1:nil="false">ValueHere</DisapprovedText>
          <Location d4p1:nil="false">ValueHere</Location>
          <PublisherCountry d4p1:nil="false">ValueHere</PublisherCountry>
          <ReasonCode>ValueHere</ReasonCode>
        </BatchError>
      </PartialErrors>
    </GetBidStrategiesByIdsResponse>
  </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<GetBidStrategiesByIdsResponse> GetBidStrategiesByIdsAsync(
	IList<long> bidStrategyIds)
{
	var request = new GetBidStrategiesByIdsRequest
	{
		BidStrategyIds = bidStrategyIds
	};

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

static GetBidStrategiesByIdsResponse getBidStrategiesByIds(
	ArrayOflong bidStrategyIds) throws RemoteException, Exception
{
	GetBidStrategiesByIdsRequest request = new GetBidStrategiesByIdsRequest();

	request.setBidStrategyIds(bidStrategyIds);

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

static function GetBidStrategiesByIds(
	$bidStrategyIds)
{

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

	$request = new GetBidStrategiesByIdsRequest();

	$request->BidStrategyIds = $bidStrategyIds;

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

response=campaignmanagement_service.GetBidStrategiesByIds(
	BidStrategyIds=BidStrategyIds)

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/BidStrategies/QueryByIds

Éléments de demande

L’objet GetBidStrategiesByIdsRequest 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
BidStrategyIds Liste d’identificateurs de stratégie d’enchère uniques qui identifient les stratégies d’enchères à obtenir.

Vous pouvez inclure un maximum de 100 ID dans un seul appel.

Les ID de stratégie d’enchère doivent se trouver dans le même compte que celui que vous avez spécifié dans l’élément d’en-tête CustomerAccountId requis.

Si vous laissez cet élément à zéro ou vide, l’opération renverra toutes les stratégies d’offre de portefeuille dans le compte.		 tableau long

É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 GetBidStrategiesByIdsResponse 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
BidStrategies Tableau d’objets BidStrategy qui correspond directement aux identificateurs de stratégie d’enchère que vous avez spécifiés dans la requête. Les éléments de la liste peuvent être retournés comme null. Pour chaque index de liste où une stratégie d’enchère n’a pas été récupérée, l’élément correspondant est null. Tableau BidStrategy
PartialErrors Tableau d’objets BatchError qui contiennent des détails pour tous les éléments de demande 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

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

{
  "BidStrategyIds": [
    "LongValueHere"
  ]
}

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 BiddingScheme est CommissionBiddingScheme, BatchError est EditorialError.

{
  "BidStrategies": [
    {
      "AssociatedCampaignType": "ValueHere",
      "AssociationCount": IntValueHere,
      "BiddingScheme": {
        "Type": "CommissionBiddingScheme",
        "CommissionRate": DoubleValueHere
      },
      "Id": "LongValueHere",
      "Name": "ValueHere"
    }
  ],
  "PartialErrors": [
    {
      "Code": IntValueHere,
      "Details": "ValueHere",
      "ErrorCode": "ValueHere",
      "FieldPath": "ValueHere",
      "ForwardCompatibilityMap": [
        {
          "key": "ValueHere",
          "value": "ValueHere"
        }
      ],
      "Index": IntValueHere,
      "Message": "ValueHere",
      "Type": "EditorialError",
      "Appealable": "ValueHere",
      "DisapprovedText": "ValueHere",
      "Location": "ValueHere",
      "PublisherCountry": "ValueHere",
      "ReasonCode": IntValueHere
    }
  ]
}

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<GetBidStrategiesByIdsResponse> GetBidStrategiesByIdsAsync(
	IList<long> bidStrategyIds)
{
	var request = new GetBidStrategiesByIdsRequest
	{
		BidStrategyIds = bidStrategyIds
	};

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

static GetBidStrategiesByIdsResponse getBidStrategiesByIds(
	ArrayOflong bidStrategyIds) throws RemoteException, Exception
{
	GetBidStrategiesByIdsRequest request = new GetBidStrategiesByIdsRequest();

	request.setBidStrategyIds(bidStrategyIds);

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

static function GetBidStrategiesByIds(
	$bidStrategyIds)
{

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

	$request = new GetBidStrategiesByIdsRequest();

	$request->BidStrategyIds = $bidStrategyIds;

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

response=campaignmanagement_service.GetBidStrategiesByIds(
	BidStrategyIds=BidStrategyIds)