GetCampaignsByIds REST Template
Gets one or more campaigns from the specified account.
The identifier of the account that contains the campaigns to retrieve.
The ids value is a constant string that indicates that the POST method is getting campaigns. The body of the request includes the list of campaign identifiers of the campaigns that you want to retrieve.
The following specifies the HTTP method, supported content types, and base URI to use in your request.
HTTP method: POST
Supported content types: XML and JSON
To use JSON, the following apply:
Your request URL must include the “format=json” query string.
For enumeration types, the value in the response is set to a numeric value instead of to the value name defined in the value set. For example, if the status of the campaign is Active, the Status value is set to 0 (zero) instead of to Active.
All enumerations are zero-based, and increment by 1.
The key names that you use for the JSON members are the same as the elements of the XML objects shown in the examples below.
Production base URI: https://adcenterapi.microsoft.com/Api/Advertiser/v8/CampaignManagement/CampaignManagementServiceREST.svc
Sandbox base URI: Not available.
The following are the headers to include in your request.
The application access token. This header is not used.
The account identifier. For more information, see Account and Customer Identifiers.
The customer identifier. For more information, see Account and Customer Identifiers.
The developer access token.
The user’s logon password.
The user’s logon user name.
The following XML fragment shows the elements to use to get campaigns from an account. For a description of each element and the header elements that your request must include, see GetCampaignsByIdsRequest Message Object.
<GetCampaignsByIdsRequest xmlns="http://schemas.datacontract.org/2004/07/HostedService.CampaignManagementService.Rest" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <CampaignIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:long></d4p1:long> </CampaignIds> </GetCampaignsByIdsRequest>
The following XML fragment shows the elements that are included in the response. For a description of each element and the TrackingId header element that the response includes, see GetCampaignsByIdsResponse Message Object.
<GetCampaignsByCampaignIdResponse xmlns="http://schemas.datacontract.org/2004/07/Microsoft.AdCenter.Advertiser.CampaignManagement.Api.DataContracts" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <Campaigns xmlns:c="https://adcenter.microsoft.com/v8"> <c:Campaign> <c:BudgetType></c:BudgetType> <c:ConversionTrackingEnabled></c:ConversionTrackingEnabled> <c:DailyBudget></c:DailyBudget> <c:DaylightSaving></c:DaylightSaving> <c:Description></c:Description> <c:Id></c:Id> <c:MonthlyBudget></c:MonthlyBudget> <c:Name></c:Name> <c:Status></c:Status> <c:TimeZone></c:TimeZone> </c:Campaign> </Campaigns> </GetCampaignsByCampaignIdResponse>
If an error occurs, the service returns one of the following HTTP error codes.
Bad request, which indicates that the request data contains an error. The response will contain either an ApiFaultDetail or AdApiFaultDetail object that identifies the error. For a list of possible error codes, see Campaign Management Error Codes and Common Error Codes.
Method not allowed, which indicates that the URI template is not correct.