GetAdsByAdGroupId Service Operation

 

Retrieves the ads within an ad group.

Request | Response

Error Codes

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

Request Body

The GetAdsByAdGroupIdRequest 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
AdGroupIdThe identifier of the ad group to retrieve the ads from.longYes
AdTypesOne or more ad types to retrieve.AdType arrayYes

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 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 response 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/v11">
    <Action mustUnderstand="1">GetAdsByAdGroupId</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>
    <GetAdsByAdGroupIdRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v11">
      <AdGroupId></AdGroupId>
      <AdTypes i:nil="false">
        <AdType></AdType>
      </AdTypes>
    </GetAdsByAdGroupIdRequest>
  </s:Body>
</s:Envelope>

Response Body

ElementDescriptionData Type
AdsThe list of ads that have been retrieved. If the ad group doesn't contain ads, this array is empty.Ad 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/v11">
    <TrackingId p4:nil="false" xmlns:p4="http://www.w3.org/2001/XMLSchema-instance"></TrackingId>
  </s:Header>
  <s:Body>
    <GetAdsByAdGroupIdResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v11">
      <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>
          <FinalAppUrls xmlns:e95="http://schemas.datacontract.org/2004/07/Microsoft.AdCenter.Advertiser.CampaignManagement.Api.DataContracts.V11" p4:nil="false">
            <e95:AppUrl>
              <e95:OsType p4:nil="false"></e95:OsType>
              <e95:Url p4:nil="false"></e95:Url>
            </e95:AppUrl>
          </FinalAppUrls>
          <FinalMobileUrls p4:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <a1:string></a1:string>
          </FinalMobileUrls>
          <FinalUrls p4:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <a1:string></a1:string>
          </FinalUrls>
          <ForwardCompatibilityMap xmlns:e96="http://schemas.datacontract.org/2004/07/System.Collections.Generic" p4:nil="false">
            <e96:KeyValuePairOfstringstring>
              <e96:key p4:nil="false"></e96:key>
              <e96:value p4:nil="false"></e96:value>
            </e96:KeyValuePairOfstringstring>
          </ForwardCompatibilityMap>
          <Id p4:nil="false"></Id>
          <Status p4:nil="false"></Status>
          <TrackingUrlTemplate p4:nil="false"></TrackingUrlTemplate>
          <Type p4:nil="false"></Type>
          <UrlCustomParameters xmlns:e97="http://schemas.datacontract.org/2004/07/Microsoft.AdCenter.Advertiser.CampaignManagement.Api.DataContracts.V11" p4:nil="false">
            <e97:Parameters p4:nil="false">
              <e97:CustomParameter>
                <e97:Key p4:nil="false"></e97:Key>
                <e97:Value p4:nil="false"></e97:Value>
              </e97:CustomParameter>
            </e97:Parameters>
          </UrlCustomParameters>
          <!--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>
          <!--Keep these fields if you set the i:type attribute to AppInstallAd-->
          <AppPlatform p4:nil="false"></AppPlatform>
          <AppStoreId p4:nil="false"></AppStoreId>
          <Text p4:nil="false"></Text>
          <Title p4:nil="false"></Title>
          <!--Keep these fields if you set the i:type attribute to ExpandedTextAd-->
          <DisplayUrl p4:nil="false"></DisplayUrl>
          <Path1 p4:nil="false"></Path1>
          <Path2 p4:nil="false"></Path2>
          <Text p4:nil="false"></Text>
          <TitlePart1 p4:nil="false"></TitlePart1>
          <TitlePart2 p4:nil="false"></TitlePart2>
          <!--Keep these fields if you set the i:type attribute to DynamicSearchAd-->
          <Path1 p4:nil="false"></Path1>
          <Path2 p4:nil="false"></Path2>
          <Text p4:nil="false"></Text>
        </Ad>
      </Ads>
    </GetAdsByAdGroupIdResponse>
  </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

AddAds
DeleteAds
GetAdsByEditorialStatus
GetAdsByIds
UpdateAds

Show: