GetAdExtensionsAssociations Service Operation

 

Gets the respective ad extension associations by the specified campaign and ad group identifiers.

Request | Response

Error Codes

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

Request Body

The GetAdExtensionsAssociationsRequest 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 extensions.longRequired
AdExtensionTypeFilters the returned associations by ad extension type.AdExtensionsTypeFilterRequired
AssociationTypeFilters the returned associations by entity type.AssociationTypeRequired
EntityIdsThe list of entity identifiers by which you may request the respective ad extension associations.long arrayRequired
ReturnAdditionalFieldsThe list of additional elements that you want included within each returned AdExtension object. This set of flags enables you to get the latest features using the current version of Bing Ads Campaign Management API, and in the next version the corresponding elements will be included by default.AdExtensionAdditionalFieldOptional

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.

ElementDescriptionData Type
AuthenticationTokenThe OAuth access token used to manage Bing Ads accounts linked to a Microsoft Account.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 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
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 service operations related to targeting and editorial. As a best practice you should always specify this element.
string
DeveloperTokenThe client application's developer access token.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 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
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 service operations related to targeting and editorial. As a best practice you should always specify this element.
string
DeveloperTokenThe client application's developer access token.string
PasswordThe Bing Ads user's sign-in password.string
UserNameThe 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 response does not contain additional body elements.

<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">GetAdExtensionsAssociations</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>
    <GetAdExtensionsAssociationsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v10">
      <AccountId></AccountId>
      <AdExtensionType></AdExtensionType>
      <AssociationType></AssociationType>
      <EntityIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <a1:long></a1:long>
      </EntityIds>
    </GetAdExtensionsAssociationsRequest>
  </s:Body>
</s:Envelope>

Response Body

ElementDescriptionData Type
AdExtensionAssociationCollectionAn array of ad extension association collections.

For each entity identifier specified in the request, an AdExtensionAssociationCollection is returned.
AdExtensionAssociationCollection array
PartialErrorsAn array of BatchError objects that contain details for any associations that were not successfully retrieved.

The list of errors corresponds directly to the list of associations in the request. Items of the list may be returned as null. For each list index where an association was successfully retrieved, the corresponding error element will be null. Ideally all associations are retrieved successfully and all elements in this list are null.
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/v10">
    <TrackingId p4:nil="false" xmlns:p4="http://www.w3.org/2001/XMLSchema-instance"></TrackingId>
  </s:Header>
  <s:Body>
    <GetAdExtensionsAssociationsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v10">
      <AdExtensionAssociationCollection p4:nil="false" xmlns:p4="http://www.w3.org/2001/XMLSchema-instance">
        <AdExtensionAssociationCollection>
          <AdExtensionAssociations p4:nil="false">
            <AdExtensionAssociation>
              <AdExtension p4:nil="false" p4:type="-- specify derived type here with the appropriate prefix --">
                <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>
                <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:e67="http://schemas.datacontract.org/2004/07/Microsoft.AdCenter.Advertiser.CampaignManagement.Api.DataContracts.V10" p4:nil="false">
                      <e67:AppUrl>
                        <e67:OsType p4:nil="false"></e67:OsType>
                        <e67:Url p4:nil="false"></e67:Url>
                      </e67: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:e68="http://schemas.datacontract.org/2004/07/Microsoft.AdCenter.Advertiser.CampaignManagement.Api.DataContracts.V10" p4:nil="false">
                      <e68:Parameters p4:nil="false">
                        <e68:CustomParameter>
                          <e68:Key p4:nil="false"></e68:Key>
                          <e68:Value p4:nil="false"></e68:Value>
                        </e68:CustomParameter>
                      </e68: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>
                <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 ImageAdExtension-->
                <AlternativeText p4:nil="false"></AlternativeText>
                <Description p4:nil="false"></Description>
                <DestinationUrl p4:nil="false"></DestinationUrl>
                <FinalAppUrls xmlns:e69="http://schemas.datacontract.org/2004/07/Microsoft.AdCenter.Advertiser.CampaignManagement.Api.DataContracts.V10" p4:nil="false">
                  <e69:AppUrl>
                    <e69:OsType p4:nil="false"></e69:OsType>
                    <e69:Url p4:nil="false"></e69:Url>
                  </e69: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:e70="http://schemas.datacontract.org/2004/07/Microsoft.AdCenter.Advertiser.CampaignManagement.Api.DataContracts.V10" p4:nil="false">
                  <e70:Parameters p4:nil="false">
                    <e70:CustomParameter>
                      <e70:Key p4:nil="false"></e70:Key>
                      <e70:Value p4:nil="false"></e70:Value>
                    </e70:CustomParameter>
                  </e70: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>
                <DevicePreference p4:nil="false"></DevicePreference>
                <DisplayText p4:nil="false"></DisplayText>
                <FinalAppUrls xmlns:e71="http://schemas.datacontract.org/2004/07/Microsoft.AdCenter.Advertiser.CampaignManagement.Api.DataContracts.V10" p4:nil="false">
                  <e71:AppUrl>
                    <e71:OsType p4:nil="false"></e71:OsType>
                    <e71:Url p4:nil="false"></e71:Url>
                  </e71: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:e72="http://schemas.datacontract.org/2004/07/Microsoft.AdCenter.Advertiser.CampaignManagement.Api.DataContracts.V10" p4:nil="false">
                  <e72:Parameters p4:nil="false">
                    <e72:CustomParameter>
                      <e72:Key p4:nil="false"></e72:Key>
                      <e72:Value p4:nil="false"></e72:Value>
                    </e72:CustomParameter>
                  </e72: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>
                <DevicePreference p4:nil="false"></DevicePreference>
                <DisplayText p4:nil="false"></DisplayText>
                <FinalAppUrls xmlns:e73="http://schemas.datacontract.org/2004/07/Microsoft.AdCenter.Advertiser.CampaignManagement.Api.DataContracts.V10" p4:nil="false">
                  <e73:AppUrl>
                    <e73:OsType p4:nil="false"></e73:OsType>
                    <e73:Url p4:nil="false"></e73:Url>
                  </e73: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:e74="http://schemas.datacontract.org/2004/07/Microsoft.AdCenter.Advertiser.CampaignManagement.Api.DataContracts.V10" p4:nil="false">
                  <e74:Parameters p4:nil="false">
                    <e74:CustomParameter>
                      <e74:Key p4:nil="false"></e74:Key>
                      <e74:Value p4:nil="false"></e74:Value>
                    </e74:CustomParameter>
                  </e74: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>
              </AdExtension>
              <AssociationType></AssociationType>
              <EditorialStatus p4:nil="false"></EditorialStatus>
              <EntityId></EntityId>
            </AdExtensionAssociation>
          </AdExtensionAssociations>
        </AdExtensionAssociationCollection>
      </AdExtensionAssociationCollection>
      <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:e75="http://schemas.datacontract.org/2004/07/System.Collections.Generic" p4:nil="false">
            <e75:KeyValuePairOfstringstring>
              <e75:key p4:nil="false"></e75:key>
              <e75:value p4:nil="false"></e75:value>
            </e75: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>
    </GetAdExtensionsAssociationsResponse>
  </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

AddAdExtensionsDeleteAdExtensionsDeleteAdExtensionsAssociationsGetAdExtensionIdsByAccountIdGetAdExtensionsByIdsGetAdExtensionsEditorialReasonsSetAdExtensionsAssociationsUpdateAdExtensions

Community Additions

ADD
Show: