GetAdExtensionsByIds Service Operation

 

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

Request | Response

Error Codes

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

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 Request SOAP.

ElementDescriptionData TypeRequired
AccountIdThe identifier of the account that owns the ad extensions.longRequired
AdExtensionIdsA list of ad extension identifiers. You can specify a maximum of 100 identifiers.long arrayRequired
AdExtensionTypeThe types of ad extensions that the list of identifiers contains.AdExtensionsTypeFilterRequired

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 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/v11">
    <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/v11">
      <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>

Response Body

ElementDescriptionData Type
AdExtensionsA 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
PartialErrorsAn array of BatchError objects that contain details for any request items that were not successful.

The list of errors do not correspond directly to the list of items in the request. The list can be empty if there were no errors, or can include one or more error objects corresponding to each unsuccessful list item in the request.
BatchError 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>
    <GetAdExtensionsByIdsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v11">
      <AdExtensions p4:nil="false" xmlns:p4="http://www.w3.org/2001/XMLSchema-instance">
        <AdExtension p4:type="-- specify derived type here with the appropriate prefix --">
          <DevicePreference p4:nil="false"></DevicePreference>
          <ForwardCompatibilityMap xmlns:e83="http://schemas.datacontract.org/2004/07/System.Collections.Generic" p4:nil="false">
            <e83:KeyValuePairOfstringstring>
              <e83:key p4:nil="false"></e83:key>
              <e83:value p4:nil="false"></e83:value>
            </e83:KeyValuePairOfstringstring>
          </ForwardCompatibilityMap>
          <Id p4:nil="false"></Id>
          <Scheduling p4:nil="false">
            <DayTimeRanges p4:nil="false">
              <DayTime>
                <Day></Day>
                <EndHour></EndHour>
                <EndMinute></EndMinute>
                <StartHour></StartHour>
                <StartMinute></StartMinute>
              </DayTime>
            </DayTimeRanges>
            <EndDate p4:nil="false">
              <Day></Day>
              <Month></Month>
              <Year></Year>
            </EndDate>
            <StartDate p4:nil="false">
              <Day></Day>
              <Month></Month>
              <Year></Year>
            </StartDate>
            <UseSearcherTimeZone p4:nil="false"></UseSearcherTimeZone>
          </Scheduling>
          <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 SiteLinksAdExtension-->
          <SiteLinks p4:nil="false">
            <SiteLink>
              <Description1 p4:nil="false"></Description1>
              <Description2 p4:nil="false"></Description2>
              <DestinationUrl p4:nil="false"></DestinationUrl>
              <DevicePreference p4:nil="false"></DevicePreference>
              <DisplayText p4:nil="false"></DisplayText>
              <FinalAppUrls xmlns:e84="http://schemas.datacontract.org/2004/07/Microsoft.AdCenter.Advertiser.CampaignManagement.Api.DataContracts.V11" p4:nil="false">
                <e84:AppUrl>
                  <e84:OsType p4:nil="false"></e84:OsType>
                  <e84:Url p4:nil="false"></e84:Url>
                </e84: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>
              <Scheduling p4:nil="false">
                <DayTimeRanges p4:nil="false">
                  <DayTime>
                    <Day></Day>
                    <EndHour></EndHour>
                    <EndMinute></EndMinute>
                    <StartHour></StartHour>
                    <StartMinute></StartMinute>
                  </DayTime>
                </DayTimeRanges>
                <EndDate p4:nil="false">
                  <Day></Day>
                  <Month></Month>
                  <Year></Year>
                </EndDate>
                <StartDate p4:nil="false">
                  <Day></Day>
                  <Month></Month>
                  <Year></Year>
                </StartDate>
                <UseSearcherTimeZone p4:nil="false"></UseSearcherTimeZone>
              </Scheduling>
              <TrackingUrlTemplate p4:nil="false"></TrackingUrlTemplate>
              <UrlCustomParameters xmlns:e85="http://schemas.datacontract.org/2004/07/Microsoft.AdCenter.Advertiser.CampaignManagement.Api.DataContracts.V11" p4:nil="false">
                <e85:Parameters p4:nil="false">
                  <e85:CustomParameter>
                    <e85:Key p4:nil="false"></e85:Key>
                    <e85:Value p4:nil="false"></e85:Value>
                  </e85:CustomParameter>
                </e85:Parameters>
              </UrlCustomParameters>
            </SiteLink>
          </SiteLinks>
          <!--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>
          <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 ImageAdExtension-->
          <AlternativeText p4:nil="false"></AlternativeText>
          <Description p4:nil="false"></Description>
          <DestinationUrl p4:nil="false"></DestinationUrl>
          <FinalAppUrls xmlns:e86="http://schemas.datacontract.org/2004/07/Microsoft.AdCenter.Advertiser.CampaignManagement.Api.DataContracts.V11" p4:nil="false">
            <e86:AppUrl>
              <e86:OsType p4:nil="false"></e86:OsType>
              <e86:Url p4:nil="false"></e86:Url>
            </e86: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>
          <ImageMediaIds p4:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <a1:long></a1:long>
          </ImageMediaIds>
          <TrackingUrlTemplate p4:nil="false"></TrackingUrlTemplate>
          <UrlCustomParameters xmlns:e87="http://schemas.datacontract.org/2004/07/Microsoft.AdCenter.Advertiser.CampaignManagement.Api.DataContracts.V11" p4:nil="false">
            <e87:Parameters p4:nil="false">
              <e87:CustomParameter>
                <e87:Key p4:nil="false"></e87:Key>
                <e87:Value p4:nil="false"></e87:Value>
              </e87:CustomParameter>
            </e87:Parameters>
          </UrlCustomParameters>
          <!--Keep these fields if you set the i:type attribute to AppAdExtension-->
          <AppPlatform p4:nil="false"></AppPlatform>
          <AppStoreId p4:nil="false"></AppStoreId>
          <DestinationUrl p4:nil="false"></DestinationUrl>
          <DisplayText p4:nil="false"></DisplayText>
          <FinalAppUrls xmlns:e88="http://schemas.datacontract.org/2004/07/Microsoft.AdCenter.Advertiser.CampaignManagement.Api.DataContracts.V11" p4:nil="false">
            <e88:AppUrl>
              <e88:OsType p4:nil="false"></e88:OsType>
              <e88:Url p4:nil="false"></e88:Url>
            </e88: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>
          <TrackingUrlTemplate p4:nil="false"></TrackingUrlTemplate>
          <UrlCustomParameters xmlns:e89="http://schemas.datacontract.org/2004/07/Microsoft.AdCenter.Advertiser.CampaignManagement.Api.DataContracts.V11" p4:nil="false">
            <e89:Parameters p4:nil="false">
              <e89:CustomParameter>
                <e89:Key p4:nil="false"></e89:Key>
                <e89:Value p4:nil="false"></e89:Value>
              </e89:CustomParameter>
            </e89:Parameters>
          </UrlCustomParameters>
          <!--Keep these fields if you set the i:type attribute to ReviewAdExtension-->
          <IsExact></IsExact>
          <Source p4:nil="false"></Source>
          <Text p4:nil="false"></Text>
          <Url p4:nil="false"></Url>
          <!--Keep these fields if you set the i:type attribute to CalloutAdExtension-->
          <Text p4:nil="false"></Text>
          <!--Keep these fields if you set the i:type attribute to Sitelink2AdExtension-->
          <Description1 p4:nil="false"></Description1>
          <Description2 p4:nil="false"></Description2>
          <DestinationUrl p4:nil="false"></DestinationUrl>
          <DisplayText p4:nil="false"></DisplayText>
          <FinalAppUrls xmlns:e90="http://schemas.datacontract.org/2004/07/Microsoft.AdCenter.Advertiser.CampaignManagement.Api.DataContracts.V11" p4:nil="false">
            <e90:AppUrl>
              <e90:OsType p4:nil="false"></e90:OsType>
              <e90:Url p4:nil="false"></e90:Url>
            </e90: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>
          <TrackingUrlTemplate p4:nil="false"></TrackingUrlTemplate>
          <UrlCustomParameters xmlns:e91="http://schemas.datacontract.org/2004/07/Microsoft.AdCenter.Advertiser.CampaignManagement.Api.DataContracts.V11" p4:nil="false">
            <e91:Parameters p4:nil="false">
              <e91:CustomParameter>
                <e91:Key p4:nil="false"></e91:Key>
                <e91:Value p4:nil="false"></e91:Value>
              </e91:CustomParameter>
            </e91:Parameters>
          </UrlCustomParameters>
          <!--Keep these fields if you set the i:type attribute to StructuredSnippetAdExtension-->
          <Header p4:nil="false"></Header>
          <Values p4:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <a1:string></a1:string>
          </Values>
          <!--Keep these fields if you set the i:type attribute to PriceAdExtension-->
          <Language p4:nil="false"></Language>
          <PriceExtensionType></PriceExtensionType>
          <TableRows p4:nil="false">
            <PriceTableRow>
              <CurrencyCode p4:nil="false"></CurrencyCode>
              <Description p4:nil="false"></Description>
              <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>
              <Header p4:nil="false"></Header>
              <Price></Price>
              <PriceQualifier></PriceQualifier>
              <PriceUnit></PriceUnit>
              <TermsAndConditions p4:nil="false"></TermsAndConditions>
              <TermsAndConditionsUrl p4:nil="false"></TermsAndConditionsUrl>
            </PriceTableRow>
          </TableRows>
          <TrackingUrlTemplate p4:nil="false"></TrackingUrlTemplate>
          <UrlCustomParameters xmlns:e92="http://schemas.datacontract.org/2004/07/Microsoft.AdCenter.Advertiser.CampaignManagement.Api.DataContracts.V11" p4:nil="false">
            <e92:Parameters p4:nil="false">
              <e92:CustomParameter>
                <e92:Key p4:nil="false"></e92:Key>
                <e92:Value p4:nil="false"></e92:Value>
              </e92:CustomParameter>
            </e92:Parameters>
          </UrlCustomParameters>
        </AdExtension>
      </AdExtensions>
      <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>
          <FieldPath p4:nil="false"></FieldPath>
          <ForwardCompatibilityMap xmlns:e93="http://schemas.datacontract.org/2004/07/System.Collections.Generic" p4:nil="false">
            <e93:KeyValuePairOfstringstring>
              <e93:key p4:nil="false"></e93:key>
              <e93:value p4:nil="false"></e93:value>
            </e93:KeyValuePairOfstringstring>
          </ForwardCompatibilityMap>
          <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>
    </GetAdExtensionsByIdsResponse>
  </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

AddAdExtensions
DeleteAdExtensions
DeleteAdExtensionsAssociations
GetAdExtensionIdsByAccountId
GetAdExtensionsAssociations
GetAdExtensionsEditorialReasons
SetAdExtensionsAssociations
UpdateAdExtensions

Show: