GetAdExtensionsAssociations Service Operation - Campaign Management

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

Request Elements

The GetAdExtensionsAssociationsRequest object defines the body and header elements of the service operation request. The elements must be in the same order as shown in the Request SOAP.

Request Body Elements

Element Description Data Type
AccountId The identifier of the account that owns the extensions. long
AdExtensionType Filters the returned associations by ad extension type. AdExtensionsTypeFilter
AssociationType Filters the returned associations by entity type. AssociationType
EntityIds The list of entity identifiers by which you may request the respective ad extension associations. long array

Request Header Elements

Element Description Data Type
AuthenticationToken The OAuth access token that represents a Microsoft Account user who has permissions to Bing Ads accounts. 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. string
CustomerId The 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. string
DeveloperToken The developer token used to access the Bing Ads API. string
Password This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials. string
UserName This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials. string

Note

The CustomerAccountId and CustomerId are required for most service operations, and as a best practice you should always specify them in the request.

Response Elements

The GetAdExtensionsAssociationsResponse object defines the body and header elements of the service operation response. The elements are returned in the same order as shown in the Response SOAP.

Response Body Elements

Element Description Data Type
AdExtensionAssociationCollection An array of ad extension association collections.

For each entity identifier specified in the request, an AdExtensionAssociationCollection is returned.
AdExtensionAssociationCollection array
PartialErrors An 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 Elements

Element Description Data Type
TrackingId The identifier of the log entry that contains the details of the API call. string

Request SOAP

The following template shows the order of the body and header elements for the SOAP request.

<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/v12">
    <Action mustUnderstand="1">GetAdExtensionsAssociations</Action>
    <ApplicationToken i:nil="false">ValueHere</ApplicationToken>
    <AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
    <CustomerAccountId i:nil="false">ValueHere</CustomerAccountId>
    <CustomerId i:nil="false">ValueHere</CustomerId>
    <DeveloperToken i:nil="false">ValueHere</DeveloperToken>
    <Password i:nil="false">ValueHere</Password>
    <UserName i:nil="false">ValueHere</UserName>
  </s:Header>
  <s:Body>
    <GetAdExtensionsAssociationsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v12">
      <AccountId>ValueHere</AccountId>
      <AdExtensionType>ValueHere</AdExtensionType>
      <AssociationType>ValueHere</AssociationType>
      <EntityIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <a1:long>ValueHere</a1:long>
      </EntityIds>
    </GetAdExtensionsAssociationsRequest>
  </s:Body>
</s:Envelope>

Response SOAP

The following template shows the order of the body and header elements for the SOAP response.

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header xmlns="https://bingads.microsoft.com/CampaignManagement/v12">
    <TrackingId d3p1:nil="false" xmlns:d3p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</TrackingId>
  </s:Header>
  <s:Body>
    <GetAdExtensionsAssociationsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v12">
      <AdExtensionAssociationCollection d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <AdExtensionAssociationCollection>
          <AdExtensionAssociations d4p1:nil="false">
            <AdExtensionAssociation>
              <AdExtension d4p1:nil="false" d4p1:type="-- derived type specified here with the appropriate prefix --">
                <DevicePreference d4p1:nil="false">ValueHere</DevicePreference>
                <ForwardCompatibilityMap xmlns:e1029="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
                  <e1029:KeyValuePairOfstringstring>
                    <e1029:key d4p1:nil="false">ValueHere</e1029:key>
                    <e1029:value d4p1:nil="false">ValueHere</e1029:value>
                  </e1029:KeyValuePairOfstringstring>
                </ForwardCompatibilityMap>
                <Id d4p1:nil="false">ValueHere</Id>
                <Scheduling d4p1:nil="false">
                  <DayTimeRanges d4p1:nil="false">
                    <DayTime>
                      <Day>ValueHere</Day>
                      <EndHour>ValueHere</EndHour>
                      <EndMinute>ValueHere</EndMinute>
                      <StartHour>ValueHere</StartHour>
                      <StartMinute>ValueHere</StartMinute>
                    </DayTime>
                  </DayTimeRanges>
                  <EndDate d4p1:nil="false">
                    <Day>ValueHere</Day>
                    <Month>ValueHere</Month>
                    <Year>ValueHere</Year>
                  </EndDate>
                  <StartDate d4p1:nil="false">
                    <Day>ValueHere</Day>
                    <Month>ValueHere</Month>
                    <Year>ValueHere</Year>
                  </StartDate>
                  <UseSearcherTimeZone d4p1:nil="false">ValueHere</UseSearcherTimeZone>
                </Scheduling>
                <Status d4p1:nil="false">ValueHere</Status>
                <Type d4p1:nil="false">ValueHere</Type>
                <Version d4p1:nil="false">ValueHere</Version>
                <!--These fields are applicable if the derived type attribute is set to LocationAdExtension-->
                <Address d4p1:nil="false">
                  <CityName d4p1:nil="false">ValueHere</CityName>
                  <CountryCode d4p1:nil="false">ValueHere</CountryCode>
                  <PostalCode d4p1:nil="false">ValueHere</PostalCode>
                  <ProvinceCode d4p1:nil="false">ValueHere</ProvinceCode>
                  <ProvinceName d4p1:nil="false">ValueHere</ProvinceName>
                  <StreetAddress d4p1:nil="false">ValueHere</StreetAddress>
                  <StreetAddress2 d4p1:nil="false">ValueHere</StreetAddress2>
                </Address>
                <CompanyName d4p1:nil="false">ValueHere</CompanyName>
                <GeoCodeStatus d4p1:nil="false">ValueHere</GeoCodeStatus>
                <GeoPoint d4p1:nil="false">
                  <LatitudeInMicroDegrees>ValueHere</LatitudeInMicroDegrees>
                  <LongitudeInMicroDegrees>ValueHere</LongitudeInMicroDegrees>
                </GeoPoint>
                <PhoneNumber d4p1:nil="false">ValueHere</PhoneNumber>
                <!--These fields are applicable if the derived type attribute is set to CallAdExtension-->
                <CountryCode d4p1:nil="false">ValueHere</CountryCode>
                <IsCallOnly d4p1:nil="false">ValueHere</IsCallOnly>
                <IsCallTrackingEnabled d4p1:nil="false">ValueHere</IsCallTrackingEnabled>
                <PhoneNumber d4p1:nil="false">ValueHere</PhoneNumber>
                <RequireTollFreeTrackingNumber d4p1:nil="false">ValueHere</RequireTollFreeTrackingNumber>
                <!--These fields are applicable if the derived type attribute is set to ImageAdExtension-->
                <AlternativeText d4p1:nil="false">ValueHere</AlternativeText>
                <Description d4p1:nil="false">ValueHere</Description>
                <DestinationUrl d4p1:nil="false">ValueHere</DestinationUrl>
                <FinalAppUrls d4p1:nil="false">
                  <AppUrl>
                    <OsType d4p1:nil="false">ValueHere</OsType>
                    <Url d4p1:nil="false">ValueHere</Url>
                  </AppUrl>
                </FinalAppUrls>
                <FinalMobileUrls d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                  <a1:string>ValueHere</a1:string>
                </FinalMobileUrls>
                <FinalUrls d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                  <a1:string>ValueHere</a1:string>
                </FinalUrls>
                <ImageMediaIds d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                  <a1:long>ValueHere</a1:long>
                </ImageMediaIds>
                <TrackingUrlTemplate d4p1:nil="false">ValueHere</TrackingUrlTemplate>
                <UrlCustomParameters d4p1:nil="false">
                  <Parameters d4p1:nil="false">
                    <CustomParameter>
                      <Key d4p1:nil="false">ValueHere</Key>
                      <Value d4p1:nil="false">ValueHere</Value>
                    </CustomParameter>
                  </Parameters>
                </UrlCustomParameters>
                <!--These fields are applicable if the derived type attribute is set to AppAdExtension-->
                <AppPlatform d4p1:nil="false">ValueHere</AppPlatform>
                <AppStoreId d4p1:nil="false">ValueHere</AppStoreId>
                <DestinationUrl d4p1:nil="false">ValueHere</DestinationUrl>
                <DisplayText d4p1:nil="false">ValueHere</DisplayText>
                <FinalAppUrls d4p1:nil="false">
                  <AppUrl>
                    <OsType d4p1:nil="false">ValueHere</OsType>
                    <Url d4p1:nil="false">ValueHere</Url>
                  </AppUrl>
                </FinalAppUrls>
                <FinalMobileUrls d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                  <a1:string>ValueHere</a1:string>
                </FinalMobileUrls>
                <FinalUrls d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                  <a1:string>ValueHere</a1:string>
                </FinalUrls>
                <TrackingUrlTemplate d4p1:nil="false">ValueHere</TrackingUrlTemplate>
                <UrlCustomParameters d4p1:nil="false">
                  <Parameters d4p1:nil="false">
                    <CustomParameter>
                      <Key d4p1:nil="false">ValueHere</Key>
                      <Value d4p1:nil="false">ValueHere</Value>
                    </CustomParameter>
                  </Parameters>
                </UrlCustomParameters>
                <!--These fields are applicable if the derived type attribute is set to ReviewAdExtension-->
                <IsExact>ValueHere</IsExact>
                <Source d4p1:nil="false">ValueHere</Source>
                <Text d4p1:nil="false">ValueHere</Text>
                <Url d4p1:nil="false">ValueHere</Url>
                <!--This field is applicable if the derived type attribute is set to CalloutAdExtension-->
                <Text d4p1:nil="false">ValueHere</Text>
                <!--These fields are applicable if the derived type attribute is set to SitelinkAdExtension-->
                <Description1 d4p1:nil="false">ValueHere</Description1>
                <Description2 d4p1:nil="false">ValueHere</Description2>
                <DestinationUrl d4p1:nil="false">ValueHere</DestinationUrl>
                <DisplayText d4p1:nil="false">ValueHere</DisplayText>
                <FinalAppUrls d4p1:nil="false">
                  <AppUrl>
                    <OsType d4p1:nil="false">ValueHere</OsType>
                    <Url d4p1:nil="false">ValueHere</Url>
                  </AppUrl>
                </FinalAppUrls>
                <FinalMobileUrls d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                  <a1:string>ValueHere</a1:string>
                </FinalMobileUrls>
                <FinalUrls d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                  <a1:string>ValueHere</a1:string>
                </FinalUrls>
                <TrackingUrlTemplate d4p1:nil="false">ValueHere</TrackingUrlTemplate>
                <UrlCustomParameters d4p1:nil="false">
                  <Parameters d4p1:nil="false">
                    <CustomParameter>
                      <Key d4p1:nil="false">ValueHere</Key>
                      <Value d4p1:nil="false">ValueHere</Value>
                    </CustomParameter>
                  </Parameters>
                </UrlCustomParameters>
                <!--These fields are applicable if the derived type attribute is set to StructuredSnippetAdExtension-->
                <Header d4p1:nil="false">ValueHere</Header>
                <Values d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                  <a1:string>ValueHere</a1:string>
                </Values>
                <!--These fields are applicable if the derived type attribute is set to PriceAdExtension-->
                <Language d4p1:nil="false">ValueHere</Language>
                <PriceExtensionType>ValueHere</PriceExtensionType>
                <TableRows d4p1:nil="false">
                  <PriceTableRow>
                    <CurrencyCode d4p1:nil="false">ValueHere</CurrencyCode>
                    <Description d4p1:nil="false">ValueHere</Description>
                    <FinalMobileUrls d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                      <a1:string>ValueHere</a1:string>
                    </FinalMobileUrls>
                    <FinalUrls d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                      <a1:string>ValueHere</a1:string>
                    </FinalUrls>
                    <Header d4p1:nil="false">ValueHere</Header>
                    <Price>ValueHere</Price>
                    <PriceQualifier>ValueHere</PriceQualifier>
                    <PriceUnit>ValueHere</PriceUnit>
                    <TermsAndConditions d4p1:nil="false">ValueHere</TermsAndConditions>
                    <TermsAndConditionsUrl d4p1:nil="false">ValueHere</TermsAndConditionsUrl>
                  </PriceTableRow>
                </TableRows>
                <TrackingUrlTemplate d4p1:nil="false">ValueHere</TrackingUrlTemplate>
                <UrlCustomParameters d4p1:nil="false">
                  <Parameters d4p1:nil="false">
                    <CustomParameter>
                      <Key d4p1:nil="false">ValueHere</Key>
                      <Value d4p1:nil="false">ValueHere</Value>
                    </CustomParameter>
                  </Parameters>
                </UrlCustomParameters>
              </AdExtension>
              <AssociationType>ValueHere</AssociationType>
              <EditorialStatus d4p1:nil="false">ValueHere</EditorialStatus>
              <EntityId>ValueHere</EntityId>
            </AdExtensionAssociation>
          </AdExtensionAssociations>
        </AdExtensionAssociationCollection>
      </AdExtensionAssociationCollection>
      <PartialErrors d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <BatchError d4p1:type="-- derived type specified here with the appropriate prefix --">
          <Code>ValueHere</Code>
          <Details d4p1:nil="false">ValueHere</Details>
          <ErrorCode d4p1:nil="false">ValueHere</ErrorCode>
          <FieldPath d4p1:nil="false">ValueHere</FieldPath>
          <ForwardCompatibilityMap xmlns:e1030="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
            <e1030:KeyValuePairOfstringstring>
              <e1030:key d4p1:nil="false">ValueHere</e1030:key>
              <e1030:value d4p1:nil="false">ValueHere</e1030:value>
            </e1030:KeyValuePairOfstringstring>
          </ForwardCompatibilityMap>
          <Index>ValueHere</Index>
          <Message d4p1:nil="false">ValueHere</Message>
          <Type d4p1:nil="false">ValueHere</Type>
          <!--These fields are applicable if the derived type attribute is set to EditorialError-->
          <Appealable d4p1:nil="false">ValueHere</Appealable>
          <DisapprovedText d4p1:nil="false">ValueHere</DisapprovedText>
          <Location d4p1:nil="false">ValueHere</Location>
          <PublisherCountry d4p1:nil="false">ValueHere</PublisherCountry>
          <ReasonCode>ValueHere</ReasonCode>
        </BatchError>
      </PartialErrors>
    </GetAdExtensionsAssociationsResponse>
  </s:Body>
</s:Envelope>

Code Syntax

The example syntax can be used with Bing Ads SDKs. See Bing Ads Code Examples for more examples.

public async Task<GetAdExtensionsAssociationsResponse> GetAdExtensionsAssociationsAsync(
    long accountId,
    AdExtensionsTypeFilter adExtensionType,
    AssociationType associationType,
    IList<long> entityIds)
{
    var request = new GetAdExtensionsAssociationsRequest
    {
        AccountId = accountId,
        AdExtensionType = adExtensionType,
        AssociationType = associationType,
        EntityIds = entityIds
    };

    return (await CampaignManagementService.CallAsync((s, r) => s.GetAdExtensionsAssociationsAsync(r), request));
}
static GetAdExtensionsAssociationsResponse getAdExtensionsAssociations(
    java.lang.Long accountId,
    ArrayList<AdExtensionsTypeFilter> adExtensionType,
    AssociationType associationType,
    ArrayOflong entityIds) throws RemoteException, Exception
{
    GetAdExtensionsAssociationsRequest request = new GetAdExtensionsAssociationsRequest();

    request.setAccountId(accountId);
    request.setAdExtensionType(adExtensionType);
    request.setAssociationType(associationType);
    request.setEntityIds(entityIds);

    return CampaignManagementService.getService().getAdExtensionsAssociations(request);
}
static function GetAdExtensionsAssociations(
    $accountId,
    $adExtensionType,
    $associationType,
    $entityIds)
{

    $GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];

    $request = new GetAdExtensionsAssociationsRequest();

    $request->AccountId = $accountId;
    $request->AdExtensionType = $adExtensionType;
    $request->AssociationType = $associationType;
    $request->EntityIds = $entityIds;

    return $GLOBALS['CampaignManagementProxy']->GetService()->GetAdExtensionsAssociations($request);
}
response=campaignmanagement_service.GetAdExtensionsAssociations(
    AccountId=AccountId,
    AdExtensionType=AdExtensionType,
    AssociationType=AssociationType,
    EntityIds=EntityIds)

Requirements

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