Skip to content

Latest commit

 

History

History
189 lines (165 loc) · 8.67 KB

getexperimentsbyids.md

File metadata and controls

189 lines (165 loc) · 8.67 KB
Raw
title ms.service ms.subservice ms.topic author ms.author description dev_langs
GetExperimentsByIds Service Operation - Campaign Management
bing-ads
campaign-management-api
article
jonmeyers
jonmeyers
Gets experiments by experiment identifiers.
csharp
java
php
python

GetExperimentsByIds Service Operation - Campaign Management

Gets experiments by experiment identifiers.

Note

Experiments are only available for Search campaigns. If the campaign uses a shared budget, then you cannot use it as the base campaign for an experiment.

Request Elements

The GetExperimentsByIdsRequest 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
ExperimentIds The identifiers of the experiments to get.

The maximum size of the list is 5,000 items per service request. If this element is not specified, the operation will return all active experiments in the ad account. An ad account can contain at most 5,000 experiments.		 long array
PageInfo Reserved for future use. Paging

Request Header Elements

[!INCLUDErequest-header]

Response Elements

The GetExperimentsByIdsResponse 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
Experiments An array of Experiment objects that corresponds directly to the experiment identifiers that you specified in the request. Items of the list may be returned as null. For each list index where an experiment was not retrieved, the corresponding element will be null. Experiment array
PartialErrors An array of BatchError objects 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

Response Header Elements

[!INCLUDEresponse-header]

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

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

Code Syntax

The example syntax can be used with Bing Ads SDKs. See Bing Ads API Code Examples for more examples.

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)

Requirements

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