GetAdExtensionIdsByAccountId Service Operation - Campaign Management

Gets the ad extensions from the account's ad extension library.

Request Elements

The GetAdExtensionIdsByAccountIdRequest 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 contains the ad extensions to get. long
AdExtensionType The types of ad extensions to get from the account. You can specify one or more types. For possible values, see AdExtensionsTypeFilter. AdExtensionsTypeFilter
AssociationType A value that filters the extensions based on whether they?re associated with a specific entity type. For possible values, see AssociationType.

To get all extensions including those not associated with any entity, set this element to NULL.
AssociationType

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 GetAdExtensionIdsByAccountIdResponse 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
AdExtensionIds A list of ad extension IDs. To get the extension, call the GetAdExtensionsByIds operation. long 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">GetAdExtensionIdsByAccountId</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>
    <GetAdExtensionIdsByAccountIdRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v12">
      <AccountId>ValueHere</AccountId>
      <AdExtensionType>ValueHere</AdExtensionType>
      <AssociationType i:nil="false">ValueHere</AssociationType>
    </GetAdExtensionIdsByAccountIdRequest>
  </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>
    <GetAdExtensionIdsByAccountIdResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v12">
      <AdExtensionIds d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <a1:long>ValueHere</a1:long>
      </AdExtensionIds>
    </GetAdExtensionIdsByAccountIdResponse>
  </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<GetAdExtensionIdsByAccountIdResponse> GetAdExtensionIdsByAccountIdAsync(
    long accountId,
    AdExtensionsTypeFilter adExtensionType,
    AssociationType? associationType)
{
    var request = new GetAdExtensionIdsByAccountIdRequest
    {
        AccountId = accountId,
        AdExtensionType = adExtensionType,
        AssociationType = associationType
    };

    return (await CampaignManagementService.CallAsync((s, r) => s.GetAdExtensionIdsByAccountIdAsync(r), request));
}
static GetAdExtensionIdsByAccountIdResponse getAdExtensionIdsByAccountId(
    java.lang.Long accountId,
    ArrayList<AdExtensionsTypeFilter> adExtensionType,
    AssociationType associationType) throws RemoteException, Exception
{
    GetAdExtensionIdsByAccountIdRequest request = new GetAdExtensionIdsByAccountIdRequest();

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

    return CampaignManagementService.getService().getAdExtensionIdsByAccountId(request);
}
static function GetAdExtensionIdsByAccountId(
    $accountId,
    $adExtensionType,
    $associationType)
{

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

    $request = new GetAdExtensionIdsByAccountIdRequest();

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

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

Requirements

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