GetAdsByAdGroupId
TOC
Collapse the table of content
Expand the table of content

GetAdsByAdGroupId Service Operation

Retrieves the ads that are associated with an ad group.

Request | Response

Error Codes

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

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 example.

Element

Description

Data Type

AdGroupId

The identifier of the ad group to retrieve the ads from.

long

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.

Element

Description

Data Type

AuthenticationToken

The OAuth access token used to manage Bing Ads accounts linked to a Microsoft Account.

string

CustomerAccountId

The 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 service operations related to ad extensions. As a best practice you should always specify this element for operations limited in scope to a single account per service call.

string

CustomerId

The identifier of the customer that owns the account.

Note: Required for service operations related to targeting and editorial. As a best practice you should always specify this element.

string

DeveloperToken

The client application's developer access token.

string

Password Authentication

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

Element

Description

Data Type

CustomerAccountId

The 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 service operations related to ad extensions. As a best practice you should always specify this element for operations limited in scope to a single account per service call.

string

CustomerId

The identifier of the customer that owns the account.

Note: Required for service operations related to targeting and editorial. As a best practice you should always specify this element.

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 or email address.

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/v10">
    <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/v10">
      <AdGroupId></AdGroupId>
    </GetAdsByAdGroupIdRequest>
  </s:Body>
</s:Envelope>

Response Body

Element

Description

Data Type

Ads

An array of Ad objects that represents the ads that have been retrieved. If the ad group doesn't contain ads, this array is empty.

Ad 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/v10">
    <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/v10">
      <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:e65="http://schemas.datacontract.org/2004/07/Microsoft.AdCenter.Advertiser.CampaignManagement.Api.DataContracts.V10" p4:nil="false">
            <e65:AppUrl>
              <e65:OsType p4:nil="false"></e65:OsType>
              <e65:Url p4:nil="false"></e65:Url>
            </e65: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:e66="http://schemas.datacontract.org/2004/07/System.Collections.Generic" p4:nil="false">
            <e66:KeyValuePairOfstringstring>
              <e66:key p4:nil="false"></e66:key>
              <e66:value p4:nil="false"></e66:value>
            </e66:KeyValuePairOfstringstring>
          </ForwardCompatibilityMap>
          <Id p4:nil="false"></Id>
          <Status p4:nil="false"></Status>
          <TrackingUrlTemplate p4:nil="false"></TrackingUrlTemplate>
          <Type p4:nil="false"></Type>
          <UrlCustomParameters xmlns:e67="http://schemas.datacontract.org/2004/07/Microsoft.AdCenter.Advertiser.CampaignManagement.Api.DataContracts.V10" p4:nil="false">
            <e67:Parameters p4:nil="false">
              <e67:CustomParameter>
                <e67:Key p4:nil="false"></e67:Key>
                <e67:Value p4:nil="false"></e67:Value>
              </e67:CustomParameter>
            </e67: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>
        </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

Community Additions

ADD
Show:
© 2016 Microsoft