Export (0) Print
Expand All
Expand Minimize
This topic has not yet been rated - Rate this topic

GetCampaignsByIds Service Operation

Retrieves the specified campaigns from the specified account.

Request | Response

Error Codes

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

GetCampaignsByIdsRequest Message

Request Body

The GetCampaignsByIdsRequest object defines the elements of the request’s body. The elements must be in the same order as shown in the SOAP example.

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.

long array

Request Header

For information about the values you set the DeveloperToken, Password, and UserName elements to, see Getting Started With the Bing Ads API.

Element

Description

Data Type

ApplicationToken

The application-access token. This header element is not used and should be null.

string

AuthenticationToken

The OAuth access token used to manage Bing Ads accounts linked to a Microsoft Account. For more information, see Managing User Authentication with OAuth.

string

CustomerAccountId

The identifier of the account that owns the entities in the request.

string

CustomerId

The identifier of the customer that owns the account.

string

DeveloperToken

The client application's developer access token.

string

Password

The Bing Ads user's sign-in password.

string

UserName

The Bing Ads user's sign-in user name. You may not set this element to a Microsoft account.

string

Request SOAP

The following example shows the complete request envelope.

<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/v9">
    <Action mustUnderstand="1">GetCampaignsByIds</Action>
    <ApplicationToken i:nil="false"></ApplicationToken>
    <AuthenticationToken i:nil="false"></AuthenticationToken>
    <CustomerAccountId i:nil="false"></CustomerAccountId>
    <CustomerId i:nil="false"></CustomerId>
    <DeveloperToken i:nil="false"></DeveloperToken>
    <Password i:nil="false"></Password>
    <UserName i:nil="false"></UserName>
  </s:Header>
  <s:Body>
    <GetCampaignsByIdsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v9">
      <AccountId></AccountId>
      <CampaignIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <a1:long></a1:long>
      </CampaignIds>
    </GetCampaignsByIdsRequest>
  </s:Body>
</s:Envelope>

GetCampaignsByIdsResponse Message

Response Body

Element

Description

Data Type

Campaigns

An array of Campaign objects that corresponds directly to the campaign identifiers that you specified in the request. If a campaign does not exist, the corresponding element of the array is set to NULL.

Campaign array

Response Header

Element

Description

Data Type

TrackingId

The identifier of the log entry that contains details about the API call.

string

Response SOAP

The following example shows the complete response envelope.

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header xmlns="https://bingads.microsoft.com/CampaignManagement/v9">
    <TrackingId p4:nil="false" xmlns:p4="http://www.w3.org/2001/XMLSchema-instance"></TrackingId>
  </s:Header>
  <s:Body>
    <GetCampaignsByIdsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v9">
      <Campaigns p4:nil="false" xmlns:p4="http://www.w3.org/2001/XMLSchema-instance">
        <Campaign>
          <BudgetType p4:nil="false"></BudgetType>
          <ConversionTrackingEnabled p4:nil="false"></ConversionTrackingEnabled>
          <DailyBudget p4:nil="false"></DailyBudget>
          <DaylightSaving p4:nil="false"></DaylightSaving>
          <Description p4:nil="false"></Description>
          <ForwardCompatibilityMap xmlns:e15="http://schemas.datacontract.org/2004/07/System.Collections.Generic" p4:nil="false">
            <e15:KeyValuePairOfstringstring>
              <e15:key p4:nil="false"></e15:key>
              <e15:value p4:nil="false"></e15:value>
            </e15:KeyValuePairOfstringstring>
          </ForwardCompatibilityMap>
          <Id p4:nil="false"></Id>
          <MonthlyBudget p4:nil="false"></MonthlyBudget>
          <Name p4:nil="false"></Name>
          <Status p4:nil="false"></Status>
          <TimeZone p4:nil="false"></TimeZone>
        </Campaign>
      </Campaigns>
    </GetCampaignsByIdsResponse>
  </s:Body>
</s:Envelope>

Error Codes

If the service operation fails, it throws a FaultException exception, which contains one or more of the Bing Ads API error data objects. For information about the fault detail objects, see Campaign Management Error Data Objects and Handling Service Errors and Exceptions.

The following are example error codes that the error objects can include when using this service operation. For all documented error codes, please see Bing Ads Operation Error Codes.

Error Code

InvalidCredentials

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.