GetCampaignsByIds Service Operation - Campaign Management
Gets the specified campaigns within an account.
Request Elements
The GetCampaignsByIdsRequest 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 |
|---|---|---|
| AccountId | The identifier of the account that contains the campaigns to get. | long |
| CampaignIds | A maximum of 100 identifiers of the campaigns to get from the specified account. The identifiers must correspond to campaigns of the specified CampaignType or types, and otherwise the service will return error code EntityIdFilterMismatch (Code 516). |
long array |
| CampaignType | The type of campaigns to get, for example Search, Shopping, or DynamicSearchAds. This request element is optional. If you do not set any campaign type, the default value is Search i.e., only Search campaigns will be returned. You may include multiple values as flags. How you specify multiple flags depends on the programming language that you use. For example, C# treats these values as flag values and Java treats them as an array of strings. The SOAP should include a string that contains a space-delimited list of values for example, <CampaignType>Search Shopping</CampaignType>. |
CampaignType |
| ReturnAdditionalFields | The list of additional properties that you want included within each returned campaign. The additional field values enable you to get the latest features using the current version of Campaign Management API, and in the next version the corresponding elements will be included by default. This request element is optional. |
CampaignAdditionalField |
Request Header Elements
| Element | Description | Data Type |
|---|---|---|
| AuthenticationToken | The OAuth access token that represents the credentials of a user who has permissions to Microsoft Advertising accounts. For more information see Authentication with OAuth. |
string |
| CustomerAccountId | The identifier of the ad account that owns or is associated with the entities in the request. This header element must have the same value as the AccountId body element when both are required. This element is required for most service operations, and as a best practice you should always set it. For more information see Get Your Account and Customer IDs. |
string |
| CustomerId | The identifier of the manager account (customer) the user is accessing or operating from. A user can have access to multiple manager accounts. This element is required for most service operations, and as a best practice you should always set it. For more information see Get Your Account and Customer IDs. |
string |
| DeveloperToken | The developer token used to access the Bing Ads API. For more information see Get a Developer Token. |
string |
| Password | This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials. | string |
| UserName | This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials. | string |
Response Elements
The GetCampaignsByIdsResponse 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 |
|---|---|---|
| Campaigns | An array of Campaign objects that corresponds directly to the campaign identifiers that you specified in the request. Items of the list may be returned as null. For each list index where a campaign was not retrieved, the corresponding element will be null. | Campaign array |
| PartialErrors | An array of BatchError objects that contain details for any campaigns that were not successfully retrieved. The list of errors corresponds directly to the list of campaigns in the request. Items of the list may be returned as null. For each list index where a campaign was successfully retrieved, the corresponding error element will be null. Ideally all campaigns are retrieved successfully and all elements in this list are null. |
BatchError array |
Response Header Elements
| Element | Description | Data Type |
|---|---|---|
| TrackingId | The identifier of the log entry that contains the details of the API call. | string |
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">GetCampaignsByIds</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>
<GetCampaignsByIdsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<AccountId>ValueHere</AccountId>
<CampaignIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:long>ValueHere</a1:long>
</CampaignIds>
<CampaignType>ValueHere</CampaignType>
<ReturnAdditionalFields i:nil="false">ValueHere</ReturnAdditionalFields>
</GetCampaignsByIdsRequest>
</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>
<GetCampaignsByIdsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<Campaigns d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<Campaign>
<AudienceAdsBidAdjustment d4p1:nil="false">ValueHere</AudienceAdsBidAdjustment>
<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>
<BudgetType d4p1:nil="false">ValueHere</BudgetType>
<DailyBudget d4p1:nil="false">ValueHere</DailyBudget>
<DealIds d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:long>ValueHere</a1:long>
</DealIds>
<ExperimentId d4p1:nil="false">ValueHere</ExperimentId>
<FinalUrlSuffix d4p1:nil="false">ValueHere</FinalUrlSuffix>
<ForwardCompatibilityMap xmlns:e285="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
<e285:KeyValuePairOfstringstring>
<e285:key d4p1:nil="false">ValueHere</e285:key>
<e285:value d4p1:nil="false">ValueHere</e285:value>
</e285:KeyValuePairOfstringstring>
</ForwardCompatibilityMap>
<GoalIds d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:long>ValueHere</a1:long>
</GoalIds>
<Id d4p1:nil="false">ValueHere</Id>
<IsDealCampaign d4p1:nil="false">ValueHere</IsDealCampaign>
<MultimediaAdsBidAdjustment d4p1:nil="false">ValueHere</MultimediaAdsBidAdjustment>
<Name d4p1:nil="false">ValueHere</Name>
<Status d4p1:nil="false">ValueHere</Status>
<SubType d4p1:nil="false">ValueHere</SubType>
<TimeZone d4p1:nil="false">ValueHere</TimeZone>
<TrackingUrlTemplate d4p1:nil="false">ValueHere</TrackingUrlTemplate>
<UrlCustomParameters d4p1:nil="false">
<Parameters d4p1:nil="false">
<CustomParameter>
<Key d4p1:nil="false">ValueHere</Key>
<Value d4p1:nil="false">ValueHere</Value>
</CustomParameter>
</Parameters>
</UrlCustomParameters>
<CampaignType d4p1:nil="false">ValueHere</CampaignType>
<Settings d4p1:nil="false">
<Setting 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 VerifiedTrackingSetting-->
<Details xmlns:e286="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
<e286:ArrayOfKeyValuePairOfstringstring>
<e286:KeyValuePairOfstringstring>
<e286:key d4p1:nil="false">ValueHere</e286:key>
<e286:value d4p1:nil="false">ValueHere</e286:value>
</e286:KeyValuePairOfstringstring>
</e286:ArrayOfKeyValuePairOfstringstring>
</Details>
<!--These fields are applicable if the derived type attribute is set to ShoppingSetting-->
<FeedLabel d4p1:nil="false">ValueHere</FeedLabel>
<LocalInventoryAdsEnabled d4p1:nil="false">ValueHere</LocalInventoryAdsEnabled>
<Priority d4p1:nil="false">ValueHere</Priority>
<SalesCountryCode d4p1:nil="false">ValueHere</SalesCountryCode>
<ShoppableAdsEnabled d4p1:nil="false">ValueHere</ShoppableAdsEnabled>
<StoreId d4p1:nil="false">ValueHere</StoreId>
<!--This field is applicable if the derived type attribute is set to DynamicFeedSetting-->
<FeedId d4p1:nil="false">ValueHere</FeedId>
<!--These fields are applicable if the derived type attribute is set to DynamicSearchAdsSetting-->
<DomainName d4p1:nil="false">ValueHere</DomainName>
<DynamicDescriptionEnabled d4p1:nil="false">ValueHere</DynamicDescriptionEnabled>
<Language d4p1:nil="false">ValueHere</Language>
<PageFeedIds d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:long>ValueHere</a1:long>
</PageFeedIds>
<Source d4p1:nil="false">ValueHere</Source>
<!--This field is applicable if the derived type attribute is set to TargetSetting-->
<Details d4p1:nil="false">
<TargetSettingDetail>
<CriterionTypeGroup>ValueHere</CriterionTypeGroup>
<TargetAndBid>ValueHere</TargetAndBid>
</TargetSettingDetail>
</Details>
<!--These fields are applicable if the derived type attribute is set to CoOpSetting-->
<BidBoostValue d4p1:nil="false">ValueHere</BidBoostValue>
<BidMaxValue d4p1:nil="false">ValueHere</BidMaxValue>
<BidOption d4p1:nil="false">ValueHere</BidOption>
<!--This field is applicable if the derived type attribute is set to DisclaimerSetting-->
<DisclaimerAdsEnabled>ValueHere</DisclaimerAdsEnabled>
<!--This field is applicable if the derived type attribute is set to HotelSetting-->
<HotelAdGroupType>ValueHere</HotelAdGroupType>
<!--This field is applicable if the derived type attribute is set to ResponsiveSearchAdsSetting-->
<AutoGeneratedAssetsEnabled d4p1:nil="false">ValueHere</AutoGeneratedAssetsEnabled>
<!--These fields are applicable if the derived type attribute is set to PerformanceMaxSetting-->
<AutoGeneratedImageOptOut d4p1:nil="false">ValueHere</AutoGeneratedImageOptOut>
<AutoGeneratedTextOptOut d4p1:nil="false">ValueHere</AutoGeneratedTextOptOut>
<CostPerSaleOptOut d4p1:nil="false">ValueHere</CostPerSaleOptOut>
<FinalUrlExpansionOptOut>ValueHere</FinalUrlExpansionOptOut>
<PageFeedIds d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:long>ValueHere</a1:long>
</PageFeedIds>
<!--These fields are applicable if the derived type attribute is set to CallToActionSetting-->
<AutomatedCallToActionOptOut d4p1:nil="false">ValueHere</AutomatedCallToActionOptOut>
<CallToActionOptOut d4p1:nil="false">ValueHere</CallToActionOptOut>
<!--These fields are applicable if the derived type attribute is set to VanityPharmaSetting-->
<DisplayUrlMode d4p1:nil="false">ValueHere</DisplayUrlMode>
<WebsiteDescription d4p1:nil="false">ValueHere</WebsiteDescription>
<!--These fields are applicable if the derived type attribute is set to AppSetting-->
<AppId d4p1:nil="false">ValueHere</AppId>
<AppStore>ValueHere</AppStore>
<!--This field is applicable if the derived type attribute is set to ThirdPartyMeasurementSetting-->
<Details xmlns:e287="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
<e287:ArrayOfKeyValuePairOfstringstring>
<e287:KeyValuePairOfstringstring>
<e287:key d4p1:nil="false">ValueHere</e287:key>
<e287:value d4p1:nil="false">ValueHere</e287:value>
</e287:KeyValuePairOfstringstring>
</e287:ArrayOfKeyValuePairOfstringstring>
</Details>
</Setting>
</Settings>
<BudgetId d4p1:nil="false">ValueHere</BudgetId>
<Languages d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:string>ValueHere</a1:string>
</Languages>
<AdScheduleUseSearcherTimeZone d4p1:nil="false">ValueHere</AdScheduleUseSearcherTimeZone>
<BidStrategyId d4p1:nil="false">ValueHere</BidStrategyId>
</Campaign>
</Campaigns>
<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:e288="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
<e288:KeyValuePairOfstringstring>
<e288:key d4p1:nil="false">ValueHere</e288:key>
<e288:value d4p1:nil="false">ValueHere</e288:value>
</e288: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>
</GetCampaignsByIdsResponse>
</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<GetCampaignsByIdsResponse> GetCampaignsByIdsAsync(
long accountId,
IList<long> campaignIds,
CampaignType campaignType,
CampaignAdditionalField? returnAdditionalFields)
{
var request = new GetCampaignsByIdsRequest
{
AccountId = accountId,
CampaignIds = campaignIds,
CampaignType = campaignType,
ReturnAdditionalFields = returnAdditionalFields
};
return (await CampaignManagementService.CallAsync((s, r) => s.GetCampaignsByIdsAsync(r), request));
}
static GetCampaignsByIdsResponse getCampaignsByIds(
java.lang.Long accountId,
ArrayOflong campaignIds,
ArrayList<CampaignType> campaignType,
ArrayList<CampaignAdditionalField> returnAdditionalFields) throws RemoteException, Exception
{
GetCampaignsByIdsRequest request = new GetCampaignsByIdsRequest();
request.setAccountId(accountId);
request.setCampaignIds(campaignIds);
request.setCampaignType(campaignType);
request.setReturnAdditionalFields(returnAdditionalFields);
return CampaignManagementService.getService().getCampaignsByIds(request);
}
static function GetCampaignsByIds(
$accountId,
$campaignIds,
$campaignType,
$returnAdditionalFields)
{
$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];
$request = new GetCampaignsByIdsRequest();
$request->AccountId = $accountId;
$request->CampaignIds = $campaignIds;
$request->CampaignType = $campaignType;
$request->ReturnAdditionalFields = $returnAdditionalFields;
return $GLOBALS['CampaignManagementProxy']->GetService()->GetCampaignsByIds($request);
}
response=campaignmanagement_service.GetCampaignsByIds(
AccountId=AccountId,
CampaignIds=CampaignIds,
CampaignType=CampaignType,
ReturnAdditionalFields=ReturnAdditionalFields)
Requirements
Service: CampaignManagementService.svc v13
Namespace: https://bingads.microsoft.com/CampaignManagement/v13
Request Url
https://campaign.api.bingads.microsoft.com/CampaignManagement/v13/Campaigns/QueryByIds
Request Elements
The GetCampaignsByIdsRequest object defines the body and header elements of the service operation request.
Note
Unless otherwise noted below, all request elements are required.
Request Body Elements
| Element | Description | Data Type |
|---|---|---|
| AccountId | The identifier of the account that contains the campaigns to get. | long |
| CampaignIds | A maximum of 100 identifiers of the campaigns to get from the specified account. The identifiers must correspond to campaigns of the specified CampaignType or types, and otherwise the service will return error code EntityIdFilterMismatch (Code 516). |
long array |
| CampaignType | The type of campaigns to get, for example Search, Shopping, or DynamicSearchAds. This request element is optional. If you do not set any campaign type, the default value is Search i.e., only Search campaigns will be returned. You may include multiple values as flags. How you specify multiple flags depends on the programming language that you use. For example, C# treats these values as flag values and Java treats them as an array of strings. The SOAP should include a string that contains a space-delimited list of values for example, <CampaignType>Search Shopping</CampaignType>. |
CampaignType |
| ReturnAdditionalFields | The list of additional properties that you want included within each returned campaign. The additional field values enable you to get the latest features using the current version of Campaign Management API, and in the next version the corresponding elements will be included by default. This request element is optional. |
CampaignAdditionalField |
Request Header Elements
| Element | Description | Data Type |
|---|---|---|
| Authorization | The OAuth access token that represents the credentials of a user who has permissions to Microsoft Advertising accounts. Please ensure that the token is prefixed with "Bearer ", this is necessary for proper authentication. For more information see Authentication with OAuth. |
string |
| CustomerAccountId | The identifier of the ad account that owns or is associated with the entities in the request. This header element must have the same value as the AccountId body element when both are required. This element is required for most service operations, and as a best practice you should always set it. For more information see Get Your Account and Customer IDs. |
string |
| CustomerId | The identifier of the manager account (customer) the user is accessing or operating from. A user can have access to multiple manager accounts. This element is required for most service operations, and as a best practice you should always set it. For more information see Get Your Account and Customer IDs. |
string |
| DeveloperToken | The developer token used to access the Bing Ads API. For more information see Get a Developer Token. |
string |
| Password | This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials. | string |
| UserName | This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials. | string |
Response Elements
The GetCampaignsByIdsResponse 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 JSON.
Response Body Elements
| Element | Description | Data Type |
|---|---|---|
| Campaigns | An array of Campaign objects that corresponds directly to the campaign identifiers that you specified in the request. Items of the list may be returned as null. For each list index where a campaign was not retrieved, the corresponding element will be null. | Campaign array |
| PartialErrors | An array of BatchError objects that contain details for any campaigns that were not successfully retrieved. The list of errors corresponds directly to the list of campaigns in the request. Items of the list may be returned as null. For each list index where a campaign was successfully retrieved, the corresponding error element will be null. Ideally all campaigns are retrieved successfully and all elements in this list are null. |
BatchError array |
Response Header Elements
| Element | Description | Data Type |
|---|---|---|
| TrackingId | The identifier of the log entry that contains the details of the API call. | string |
Request JSON
This template was generated by a tool to show the body and header elements for the JSON request. For supported types that you can use with this service operation, see the Request Body Elements reference above.
{
"AccountId": "LongValueHere",
"CampaignIds": [
"LongValueHere"
],
"CampaignType": "ValueHere",
"ReturnAdditionalFields": "ValueHere"
}
Response JSON
This template was generated by a tool to show the body and header elements for the JSON response.
Below is an example that is applicable if the type of BiddingScheme is CommissionBiddingScheme, Setting is AppSetting, BatchError is EditorialError.
{
"Campaigns": [
{
"AdScheduleUseSearcherTimeZone": "ValueHere",
"AudienceAdsBidAdjustment": IntValueHere,
"BiddingScheme": {
"Type": "CommissionBiddingScheme",
"CommissionRate": DoubleValueHere
},
"BidStrategyId": "LongValueHere",
"BudgetId": "LongValueHere",
"BudgetType": "ValueHere",
"CampaignType": "ValueHere",
"DailyBudget": DoubleValueHere,
"DealIds": [
"LongValueHere"
],
"ExperimentId": "LongValueHere",
"FinalUrlSuffix": "ValueHere",
"ForwardCompatibilityMap": [
{
"key": "ValueHere",
"value": "ValueHere"
}
],
"GoalIds": [
"LongValueHere"
],
"Id": "LongValueHere",
"IsDealCampaign": "ValueHere",
"Languages": [
"ValueHere"
],
"MultimediaAdsBidAdjustment": IntValueHere,
"Name": "ValueHere",
"Settings": [
{
"Type": "AppSetting",
"AppId": "ValueHere",
"AppStore": "ValueHere"
}
],
"Status": "ValueHere",
"SubType": "ValueHere",
"TimeZone": "ValueHere",
"TrackingUrlTemplate": "ValueHere",
"UrlCustomParameters": {
"Parameters": [
{
"Key": "ValueHere",
"Value": "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
}
]
}
Code Syntax
To call REST API through SDKs, you need to upgrade SDK to a certain version and configure the system parameters.The example syntax can be used with Bing Ads SDKs. See Bing Ads API Code Examples for more examples.
public async Task<GetCampaignsByIdsResponse> GetCampaignsByIdsAsync(
long accountId,
IList<long> campaignIds,
CampaignType campaignType,
CampaignAdditionalField? returnAdditionalFields)
{
var request = new GetCampaignsByIdsRequest
{
AccountId = accountId,
CampaignIds = campaignIds,
CampaignType = campaignType,
ReturnAdditionalFields = returnAdditionalFields
};
return (await CampaignManagementService.CallAsync((s, r) => s.GetCampaignsByIdsAsync(r), request));
}
static GetCampaignsByIdsResponse getCampaignsByIds(
java.lang.Long accountId,
ArrayOflong campaignIds,
ArrayList<CampaignType> campaignType,
ArrayList<CampaignAdditionalField> returnAdditionalFields) throws RemoteException, Exception
{
GetCampaignsByIdsRequest request = new GetCampaignsByIdsRequest();
request.setAccountId(accountId);
request.setCampaignIds(campaignIds);
request.setCampaignType(campaignType);
request.setReturnAdditionalFields(returnAdditionalFields);
return CampaignManagementService.getService().getCampaignsByIds(request);
}
static function GetCampaignsByIds(
$accountId,
$campaignIds,
$campaignType,
$returnAdditionalFields)
{
$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];
$request = new GetCampaignsByIdsRequest();
$request->AccountId = $accountId;
$request->CampaignIds = $campaignIds;
$request->CampaignType = $campaignType;
$request->ReturnAdditionalFields = $returnAdditionalFields;
return $GLOBALS['CampaignManagementProxy']->GetService()->GetCampaignsByIds($request);
}
response=campaignmanagement_service.GetCampaignsByIds(
AccountId=AccountId,
CampaignIds=CampaignIds,
CampaignType=CampaignType,
ReturnAdditionalFields=ReturnAdditionalFields)