GetCampaignsByAccountId Service Operation

 

Retrieves all the campaigns that exist within a specified account.

Request | Response

Error Codes

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

Request Body

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

ElementDescriptionData TypeRequired
AccountIdThe identifier of the account that contains the campaigns to get.longRequired
CampaignTypeThe type of campaign to get, for example SearchAndContent, Shopping, or DynamicSearchAds. You can specify one or more types.CampaignTypeRequired
ReturnAdditionalFieldsThe list of additional elements that you want included within each returned Campaign object. This set of flags enables you to get the latest features using the current version of Bing Ads Campaign Management API, and in the next version the corresponding elements will be included by default.CampaignAdditionalFieldOptional

Request Headers

Set the required header elements for each service request. New customers are required to sign up for Bing Ads with a Microsoft Account, and to manage those accounts you must use OAuth. Existing users with legacy Bing Ads credentials may continue to specify the UserName and Password header elements. In future versions of the API, Bing Ads will transition exclusively to Microsoft Account authentication. For more information, see Getting Started With the Bing Ads API.

OAuth Authentication

These request headers are required for Managing User Authentication with OAuth.

ElementDescriptionData Type
AuthenticationTokenThe OAuth access token that represents a Microsoft Account user who has permissions to Bing Ads accounts.string
CustomerAccountIdThe identifier of the account that owns the entities in the request. This header element must have the same value as the AccountId body element when both are required.

Note: Required for most service operations, and as a best practice you should always specify this element.
string
CustomerIdThe identifier of the customer that contains and owns the account. If you manage an account of another customer, you should use that customer ID instead of your own customer ID.

Note: Required for most service operations, and as a best practice you should always specify this element.
string
DeveloperTokenThe developer token used to access the Bing Ads API.string

Password Authentication

These request headers are required for legacy username and password authentication.

ElementDescriptionData Type
CustomerAccountIdThe identifier of the account that owns the entities in the request. This header element must have the same value as the AccountId body element when both are required.

Note: Required for most service operations, and as a best practice you should always specify this element.
string
CustomerIdThe identifier of the customer that contains and owns the account. If you manage an account of another customer, you should use that customer ID instead of your own customer ID.

Note: Required for most service operations, and as a best practice you should always specify this element.
string
DeveloperTokenThe developer token used to access the Bing Ads API.string
PasswordThe Bing Ads user's sign-in password.string
UserNameThe Bing Ads user's sign-in user name. You must not set this element to a Microsoft account or email address. To authenticate a Microsoft account, use the AuthenticationToken header instead of UserName and Password.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/v10">
    <Action mustUnderstand="1">GetCampaignsByAccountId</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>
    <GetCampaignsByAccountIdRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v10">
      <AccountId></AccountId>
      <CampaignType></CampaignType>
      <ReturnAdditionalFields i:nil="false"></ReturnAdditionalFields>
    </GetCampaignsByAccountIdRequest>
  </s:Body>
</s:Envelope>

Response Body

ElementDescriptionData Type
CampaignsAn array of Campaign objects that represents the campaigns that were retrieved. If no campaigns exist, an empty array is returned.Campaign array

Response Header

ElementDescriptionData Type
TrackingIdThe 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/v10">
    <TrackingId p4:nil="false" xmlns:p4="http://www.w3.org/2001/XMLSchema-instance"></TrackingId>
  </s:Header>
  <s:Body>
    <GetCampaignsByAccountIdResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v10">
      <Campaigns p4:nil="false" xmlns:p4="http://www.w3.org/2001/XMLSchema-instance">
        <Campaign>
          <BiddingScheme xmlns:e114="http://schemas.datacontract.org/2004/07/Microsoft.AdCenter.Advertiser.CampaignManagement.Api.DataContracts.V10" p4:nil="false" p4:type="-- specify derived type here with the appropriate prefix --">
            <e114:Type p4:nil="false"></e114:Type>
            <!--These fields will be set if the i:type attribute is MaxClicksBiddingScheme-->
            <MaxCpc p4:nil="false">
              <Amount p4:nil="false"></Amount>
            </MaxCpc>
            <!--These fields will be set if the i:type attribute is MaxConversionsBiddingScheme-->
            <MaxCpc p4:nil="false">
              <Amount p4:nil="false"></Amount>
            </MaxCpc>
            <StartingBid p4:nil="false">
              <Amount p4:nil="false"></Amount>
            </StartingBid>
            <!--These fields will be set if the i:type attribute is TargetCpaBiddingScheme-->
            <MaxCpc p4:nil="false">
              <Amount p4:nil="false"></Amount>
            </MaxCpc>
            <StartingBid p4:nil="false">
              <Amount p4:nil="false"></Amount>
            </StartingBid>
            <e114:TargetCpa p4:nil="false"></e114:TargetCpa>
            <!--These fields will be set if the i:type attribute is ManualCpcBiddingScheme-->
            <!--These fields will be set if the i:type attribute is EnhancedCpcBiddingScheme-->
            <!--These fields will be set if the i:type attribute is InheritFromParentBiddingScheme-->
          </BiddingScheme>
          <BudgetType p4:nil="false"></BudgetType>
          <DailyBudget p4:nil="false"></DailyBudget>
          <DaylightSaving p4:nil="false"></DaylightSaving>
          <Description p4:nil="false"></Description>
          <ForwardCompatibilityMap xmlns:e115="http://schemas.datacontract.org/2004/07/System.Collections.Generic" p4:nil="false">
            <e115:KeyValuePairOfstringstring>
              <e115:key p4:nil="false"></e115:key>
              <e115:value p4:nil="false"></e115:value>
            </e115:KeyValuePairOfstringstring>
          </ForwardCompatibilityMap>
          <Id p4:nil="false"></Id>
          <MonthlyBudget p4:nil="false"></MonthlyBudget>
          <Name p4:nil="false"></Name>
          <NativeBidAdjustment p4:nil="false"></NativeBidAdjustment>
          <Status p4:nil="false"></Status>
          <TimeZone p4:nil="false"></TimeZone>
          <TrackingUrlTemplate p4:nil="false"></TrackingUrlTemplate>
          <UrlCustomParameters xmlns:e116="http://schemas.datacontract.org/2004/07/Microsoft.AdCenter.Advertiser.CampaignManagement.Api.DataContracts.V10" p4:nil="false">
            <e116:Parameters p4:nil="false">
              <e116:CustomParameter>
                <e116:Key p4:nil="false"></e116:Key>
                <e116:Value p4:nil="false"></e116:Value>
              </e116:CustomParameter>
            </e116:Parameters>
          </UrlCustomParameters>
          <CampaignType p4:nil="false"></CampaignType>
          <Settings p4:nil="false">
            <Setting p4:type="-- specify derived type here with the appropriate prefix --">
              <Type p4:nil="false"></Type>
              <!--These fields will be set if the i:type attribute is ShoppingSetting-->
              <Priority p4:nil="false"></Priority>
              <SalesCountryCode p4:nil="false"></SalesCountryCode>
              <StoreId p4:nil="false"></StoreId>
              <!--These fields will be set if the i:type attribute is DynamicSearchAdsSetting-->
              <DomainName p4:nil="false"></DomainName>
              <Language p4:nil="false"></Language>
            </Setting>
          </Settings>
          <BudgetId p4:nil="false"></BudgetId>
        </Campaign>
      </Campaigns>
    </GetCampaignsByAccountIdResponse>
  </s:Body>
</s:Envelope>

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

AddCampaignsDeleteCampaignsGetCampaignsByIdsUpdateCampaigns

Community Additions

ADD
Show: