Export (0) Print
Expand All
Expand Minimize

GetAdsByIds Service Operation

Retrieves the specified ads from the specified ad group.

Request | Response

Error Codes

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

GetAdsByIdsRequest Message

Request Body

The GetAdsByIdsRequest 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

AdGroupId

The identifier of the ad group that contains the ads to get.

long

AdIds

A maximum of 20 identifiers of the ads to get.

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">GetAdsByIds</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>
    <GetAdsByIdsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v9">
      <AdGroupId></AdGroupId>
      <AdIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <a1:long></a1:long>
      </AdIds>
    </GetAdsByIdsRequest>
  </s:Body>
</s:Envelope>

GetAdsByIdsResponse Message

Response Body

Element

Description

Data Type

Ads

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

Ad array

PartialErrors

An array of BatchError objects that contain details for any ads that were not successfully retrieved.

BatchError 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>
    <GetAdsByIdsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v9">
      <Ads p4:nil="false" xmlns:p4="http://www.w3.org/2001/XMLSchema-instance">
        <Ad p4:type="-- specify derived type here with the appropriate prefix --">
          <DevicePreference p4:nil="false"></DevicePreference>
          <EditorialStatus p4:nil="false"></EditorialStatus>
          <ForwardCompatibilityMap xmlns:e13="http://schemas.datacontract.org/2004/07/System.Collections.Generic" p4:nil="false">
            <e13:KeyValuePairOfstringstring>
              <e13:key p4:nil="false"></e13:key>
              <e13:value p4:nil="false"></e13:value>
            </e13:KeyValuePairOfstringstring>
          </ForwardCompatibilityMap>
          <Id p4:nil="false"></Id>
          <Status p4:nil="false"></Status>
          <Type p4:nil="false"></Type>
          <!--Keep these fields if you set the i:type attribute to MobileAd-->
          <BusinessName p4:nil="false"></BusinessName>
          <DestinationUrl p4:nil="false"></DestinationUrl>
          <DisplayUrl p4:nil="false"></DisplayUrl>
          <PhoneNumber p4:nil="false"></PhoneNumber>
          <Text p4:nil="false"></Text>
          <Title p4:nil="false"></Title>
          <!--Keep these fields if you set the i:type attribute to TextAd-->
          <DestinationUrl p4:nil="false"></DestinationUrl>
          <DisplayUrl p4:nil="false"></DisplayUrl>
          <Text p4:nil="false"></Text>
          <Title p4:nil="false"></Title>
          <!--Keep these fields if you set the i:type attribute to ProductAd-->
          <PromotionalText p4:nil="false"></PromotionalText>
        </Ad>
      </Ads>
      <PartialErrors p4:nil="false" xmlns:p4="http://www.w3.org/2001/XMLSchema-instance">
        <BatchError p4:type="-- specify derived type here with the appropriate prefix --">
          <Code></Code>
          <Details p4:nil="false"></Details>
          <ErrorCode p4:nil="false"></ErrorCode>
          <Index></Index>
          <Message p4:nil="false"></Message>
          <Type p4:nil="false"></Type>
          <!--Keep these fields if you set the i:type attribute to EditorialError-->
          <Appealable p4:nil="false"></Appealable>
          <DisapprovedText p4:nil="false"></DisapprovedText>
          <Location p4:nil="false"></Location>
          <PublisherCountry p4:nil="false"></PublisherCountry>
          <ReasonCode></ReasonCode>
        </BatchError>
      </PartialErrors>
    </GetAdsByIdsResponse>
  </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