Export (0) Print
Expand All

GetAdGroupsByIds REST Template

Gets one or more ad groups from the specified campaign.

/customer/account/campaign/{CampaignId}/adGroup?$field=ids

Variables

CampaignId

The identifier of the campaign that contains the ad groups to retrieve.

Query Parameters

field

The ids value is a constant string that indicates that the POST method is getting ad groups. The body of the request includes the list of ad group identifiers of the ad groups that you want to retrieve.

Request Components

The following specifies the HTTP method, supported content types, and base URI to use in your request.

  • HTTP method: POST

  • Supported content types: XML and JSON

    To use JSON, the following apply:

    • Your request URL must include the “format=json” query string.

    • For enumeration types, the value in the response is set to a numeric value instead of to the value name defined in the value set. For example, if the bidding model of an ad group is Keyword, the BiddingModel value is set to 0 (zero) instead of to Keyword.

    • All enumerations are zero-based, and increment by 1, except for the AdDistribution value set, which is one-based.

    • The key names that you use for the JSON members are the same as the elements of the XML objects shown in the examples below.

  • Production base URI: https://adcenterapi.microsoft.com/Api/Advertiser/v8/CampaignManagement/CampaignManagementServiceREST.svc

  • Sandbox base URI: Not available.

Request Headers

The following are the headers to include in your request.

Header

Description

ApplicationToken

The application access token. This header is not used.

CustomerAccountId

The account identifier. For more information, see Account and Customer Identifiers.

CustomerId

The customer identifier. For more information, see Account and Customer Identifiers.

DeveloperToken

The developer access token.

Password

The user’s logon password.

UserName

The user’s logon user name.

Request Body

The following XML fragment shows the elements to use to get ad groups from a campaign. For a description of each element and the header elements that your request must include, see GetAdGroupsByIdsRequest Message Object.

<GetAdGroupsByIdsRequest xmlns="http://schemas.datacontract.org/2004/07/HostedService.CampaignManagementService.Rest" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <AdGroupIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d4p1:long></d4p1:long>
  </AdGroupIds>
</GetAdGroupsByIdsRequest>

Response Body

The following XML fragment shows the elements that are included in the response. For a description of each element and the TrackingId header element that the response includes, see GetAdGroupsByIdsResponse Message Object.

<GetAdGroupsByIdsResponse xmlns="http://schemas.datacontract.org/2004/07/Microsoft.AdCenter.Advertiser.CampaignManagement.Api.DataContracts" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <AdGroups xmlns:d2p1="https://adcenter.microsoft.com/v8">
    <d2p1:AdGroup>
      <d2p1:AdDistribution></d2p1:AdDistribution>
      <d2p1:BiddingModel></d2p1:BiddingModel>
      <d2p1:BroadMatchBid>
        <d2p1:Amount></d2p1:Amount>
      </d2p1:BroadMatchBid>
      <d2p1:ContentMatchBid>
        <d2p1:Amount></d2p1:Amount>
      </d2p1:ContentMatchBid>
      <d2p1:EndDate>
        <d2p1:Day></d2p1:Day>
        < d2p1:Month></d2p1:Month>
        <d2p1:Year></d2p1:Year>
      </d2p1:EndDate>
      <d2p1:ExactMatchBid>
        <d2p1:Amount></d2p1:Amount>
      </d2p1:ExactMatchBid>
      <d2p1:Id></d2p1:Id>
      <d2p1:Language></d2p1:Language>
      <d2p1:Name></d2p1:Name>
      <d2p1:Network></d2p1:Network>
      <d2p1:PhraseMatchBid>
        <d2p1:Amount></d2p1:Amount>
      </d2p1:PhraseMatchBid>
      <d2p1:PricingModel></d2p1:PricingModel>
      <d2p1:PublisherCountries>
        <d2p1:PublisherCountry>
          <d2p1:Country></d2p1:Country>
          <d2p1:IsOptedIn></d2p1:IsOptedIn>
        </d2p1:PublisherCountry>
      <d2p1:PublisherCountries>
      <d2p1:StartDate>
        <d2p1:Day></d2p1:Day>
        <d2p1:Month></d2p1:Month>
        <d2p1:Year></d2p1:Year>
      </d2p1:StartDate>
      <d2p1:Status><d2p1:Status>
    </d2p1:AdGroup>
  </AdGroups>
</GetAdGroupsByIdsResponse>

Faults

If an error occurs, the service returns one of the following HTTP error codes.

Code

Description

400

Bad request, which indicates that the request data contains an error. The response will contain either an ApiFaultDetail or AdApiFaultDetail object that identifies the error. For a list of possible error codes, see Campaign Management Error Codes and Common Error Codes.

401

Not authorized.

404

Not found.

405

Method not allowed, which indicates that the URI template is not correct.

500

Server error.

Community Additions

Show:
© 2014 Microsoft