Opération de service GetExperimentsByIds - Gestion des campagnes
Obtient des expériences par identificateurs d’expérience.
Remarque
Les expériences sont uniquement disponibles pour les campagnes de recherche. Si la campagne utilise un budget partagé, vous ne pouvez pas l’utiliser comme campagne de base pour une expérience.
Éléments de demande
L’objet GetExperimentsByIdsRequest 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 |
---|---|---|
ExperimentIds | Identificateurs des expériences à obtenir. La taille maximale de la liste est de 5 000 éléments par demande de service. Si cet élément n’est pas spécifié, l’opération retourne toutes les expériences actives dans le compte publicitaire. Un compte publicitaire peut contenir au maximum 5 000 expériences. |
tableau long |
PageInfo | Réservé à une utilisation future. | Pagination |
É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 |
Password | 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 GetExperimentsByIdsResponse 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 |
---|---|---|
Expériences | Tableau d’objets Experiment qui correspond directement aux identificateurs d’expérience 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 expérience n’a pas été récupérée, l’élément correspondant est null. | Tableau d’expériences |
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">GetExperimentsByIds</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>
<GetExperimentsByIdsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<ExperimentIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:long>ValueHere</a1:long>
</ExperimentIds>
<PageInfo i:nil="false">
<Index>ValueHere</Index>
<Size>ValueHere</Size>
</PageInfo>
</GetExperimentsByIdsRequest>
</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>
<GetExperimentsByIdsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<Experiments d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<Experiment>
<BaseCampaignId d4p1:nil="false">ValueHere</BaseCampaignId>
<EndDate d4p1:nil="false">
<Day>ValueHere</Day>
<Month>ValueHere</Month>
<Year>ValueHere</Year>
</EndDate>
<ExperimentCampaignId d4p1:nil="false">ValueHere</ExperimentCampaignId>
<ExperimentStatus d4p1:nil="false">ValueHere</ExperimentStatus>
<ExperimentType d4p1:nil="false">ValueHere</ExperimentType>
<Id d4p1:nil="false">ValueHere</Id>
<Name d4p1:nil="false">ValueHere</Name>
<StartDate d4p1:nil="false">
<Day>ValueHere</Day>
<Month>ValueHere</Month>
<Year>ValueHere</Year>
</StartDate>
<TrafficSplitPercent d4p1:nil="false">ValueHere</TrafficSplitPercent>
</Experiment>
</Experiments>
<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:e144="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
<e144:KeyValuePairOfstringstring>
<e144:key d4p1:nil="false">ValueHere</e144:key>
<e144:value d4p1:nil="false">ValueHere</e144:value>
</e144: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>
</GetExperimentsByIdsResponse>
</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<GetExperimentsByIdsResponse> GetExperimentsByIdsAsync(
IList<long> experimentIds,
Paging pageInfo)
{
var request = new GetExperimentsByIdsRequest
{
ExperimentIds = experimentIds,
PageInfo = pageInfo
};
return (await CampaignManagementService.CallAsync((s, r) => s.GetExperimentsByIdsAsync(r), request));
}
static GetExperimentsByIdsResponse getExperimentsByIds(
ArrayOflong experimentIds,
Paging pageInfo) throws RemoteException, Exception
{
GetExperimentsByIdsRequest request = new GetExperimentsByIdsRequest();
request.setExperimentIds(experimentIds);
request.setPageInfo(pageInfo);
return CampaignManagementService.getService().getExperimentsByIds(request);
}
static function GetExperimentsByIds(
$experimentIds,
$pageInfo)
{
$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];
$request = new GetExperimentsByIdsRequest();
$request->ExperimentIds = $experimentIds;
$request->PageInfo = $pageInfo;
return $GLOBALS['CampaignManagementProxy']->GetService()->GetExperimentsByIds($request);
}
response=campaignmanagement_service.GetExperimentsByIds(
ExperimentIds=ExperimentIds,
PageInfo=PageInfo)
Configuration requise
Service : CampaignManagementService.svc v13
Noms: https://bingads.microsoft.com/CampaignManagement/v13