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

GetAdExtensionsByIds Service Operation

Gets the specified ad extensions from the account’s ad extension library.

Request | Response

Error Codes

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

GetAdExtensionsByIdsRequest Message

Request Body

The GetAdExtensionsByIdsRequest 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 owns the ad extensions.

long

AdExtensionIds

A list of ad extension identifiers. You can specify a maximum of 100 identifiers.

long array

AdExtensionType

The types of ad extensions that the list of identifiers contains.

AdExtensionsTypeFilter

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">GetAdExtensionsByIds</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>
    <GetAdExtensionsByIdsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v9">
      <AccountId></AccountId>
      <AdExtensionIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <a1:long></a1:long>
      </AdExtensionIds>
      <AdExtensionType></AdExtensionType>
    </GetAdExtensionsByIdsRequest>
  </s:Body>
</s:Envelope>

GetAdExtensionsByIdsResponse Message

Response Body

Element

Description

Data Type

AdExtensions

A list of AdExtension objects. The list corresponds directly to the list of identifiers in the request. If an ad extension ID in the request is not valid or the extension is not of the type specified, the corresponding item in this list is null.

AdExtension 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>
    <GetAdExtensionsByIdsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v9">
      <AdExtensions p4:nil="false" xmlns:p4="http://www.w3.org/2001/XMLSchema-instance">
        <AdExtension p4:type="-- specify derived type here with the appropriate prefix --">
          <ForwardCompatibilityMap xmlns:e8="http://schemas.datacontract.org/2004/07/System.Collections.Generic" p4:nil="false">
            <e8:KeyValuePairOfstringstring>
              <e8:key p4:nil="false"></e8:key>
              <e8:value p4:nil="false"></e8:value>
            </e8:KeyValuePairOfstringstring>
          </ForwardCompatibilityMap>
          <Id p4:nil="false"></Id>
          <Status p4:nil="false"></Status>
          <Type p4:nil="false"></Type>
          <Version p4:nil="false"></Version>
          <!--Keep these fields if you set the i:type attribute to LocationAdExtension-->
          <Address p4:nil="false">
            <CityName p4:nil="false"></CityName>
            <CountryCode p4:nil="false"></CountryCode>
            <PostalCode p4:nil="false"></PostalCode>
            <ProvinceCode p4:nil="false"></ProvinceCode>
            <ProvinceName p4:nil="false"></ProvinceName>
            <StreetAddress p4:nil="false"></StreetAddress>
            <StreetAddress2 p4:nil="false"></StreetAddress2>
          </Address>
          <CompanyName p4:nil="false"></CompanyName>
          <GeoCodeStatus p4:nil="false"></GeoCodeStatus>
          <GeoPoint p4:nil="false">
            <LatitudeInMicroDegrees></LatitudeInMicroDegrees>
            <LongitudeInMicroDegrees></LongitudeInMicroDegrees>
          </GeoPoint>
          <IconMediaId p4:nil="false"></IconMediaId>
          <ImageMediaId p4:nil="false"></ImageMediaId>
          <PhoneNumber p4:nil="false"></PhoneNumber>
          <!--Keep these fields if you set the i:type attribute to CallAdExtension-->
          <CountryCode p4:nil="false"></CountryCode>
          <DevicePreference p4:nil="false"></DevicePreference>
          <IsCallOnly p4:nil="false"></IsCallOnly>
          <IsCallTrackingEnabled p4:nil="false"></IsCallTrackingEnabled>
          <PhoneNumber p4:nil="false"></PhoneNumber>
          <RequireTollFreeTrackingNumber p4:nil="false"></RequireTollFreeTrackingNumber>
          <!--Keep these fields if you set the i:type attribute to SiteLinksAdExtension-->
          <SiteLinks p4:nil="false">
            <SiteLink>
              <DestinationUrl p4:nil="false"></DestinationUrl>
              <DevicePreference p4:nil="false"></DevicePreference>
              <DisplayText p4:nil="false"></DisplayText>
            </SiteLink>
          </SiteLinks>
          <!--Keep these fields if you set the i:type attribute to ProductAdExtension-->
          <Name p4:nil="false"></Name>
          <ProductSelection p4:nil="false">
            <ProductConditionCollection>
              <Conditions p4:nil="false">
                <ProductCondition>
                  <Attribute p4:nil="false"></Attribute>
                  <Operand p4:nil="false"></Operand>
                </ProductCondition>
              </Conditions>
            </ProductConditionCollection>
          </ProductSelection>
          <StoreId></StoreId>
          <StoreName p4:nil="false"></StoreName>
        </AdExtension>
      </AdExtensions>
    </GetAdExtensionsByIdsResponse>
  </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

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.