get

Returns bids and priorities for keywords and autotargetings that match the specified criteria, along with data that is useful for bid selection: auction data on the search display positions and bids for various percents of audience coverage in ad networks.

  1. Restrictions
  2. Request
  3. Response
  4. Examples

You can get bids and priorities regardless of whether a manual or automatic strategy is selected in the campaign.

Attention. All returned monetary values are whole integers — the result of multiplying the bid or price by 1,000,000.

Restrictions

The method returns a maximum of 10,000 objects.

Request

Request structure in JSON format:

{
  "method": "get",
  "params": { /* params */
    "SelectionCriteria": {  /* BidsSelectionCriteria */
      "KeywordIds": [(long), ... ], 
      "AdGroupIds": [(long), ... ],
      "CampaignIds": [(long), ... ],
      "ServingStatuses": [( "ELIGIBLE" | "RARELY_SERVED" ), ... ]
    }, /* required */
    "FieldNames": [( "KeywordId" | ... | "AuctionBids" ), ... ], /* required */
    "Page": {  /* LimitOffset */
      "Limit": (long),
      "Offset": (long)
    }
  } 
}
ParameterTypeDescriptionRequired
Params structure (for JSON) / GetRequest (for SOAP)
SelectionCriteriaBidsSelectionCriteriaCriteria for selecting keywords and autotargetings.Yes
FieldNamesarray of BidFieldEnum

Names of top-level parameters to get.

Don't request the parameters CompetitorsBids, SearchPrices, MinSearchPrice, CurrentSearchPrice, and AuctionBids if the campaign has displays on search disabled (the SERVING_OFF strategy for search results).

Don't request the ContextCoverage parameter if the campaign has displays in ad networks disabled (the SERVING_OFF strategy in ad networks).

Yes
PageLimitOffset

Structure that defines the page for paginated selection of data.

No
BidsSelectionCriteria structure
KeywordIdsarray of longGet bids or priorities for the specified keywords and autotargetings. Maximum of 10,000 items in the array.One of the parameters KeywordIds, AdGroupIds, or CampaignIds (or all may be present)
AdGroupIdsarray of longGet bids or priorities for keywords and autotargetings in the specified ad groups. From 1 to 1000 items in the array.
CampaignIdsarray of longGet bids or priorities for keywords and autotargetings in the specified campaigns. From 1 to 10 items in the array.
ServingStatusesarray of ServingStatusEnumGet bids or priorities for keywords and autotargetings with the specified ad group serving statuses. For a description of the statuses, see the section Serving status for the ad group.No

Response

Response structure in JSON format:

{
  "result": { /* result */
    "Bids": [{  /* BidGetItem */
      "CampaignId": (long),
      "AdGroupId": (long),
      "KeywordId": (long),
      "ServingStatus": ( "ELIGIBLE" | "RARELY_SERVED" ),
      "Bid": (long),
      "ContextBid": (long),
      "StrategyPriority": ( "LOW" | "NORMAL" | "HIGH" ), /* nillable */
      "CompetitorsBids": [(long), ... ], 
      "SearchPrices": [{  /* SearchPrices */
        "Position": ( "PREMIUMFIRST" | "PREMIUMBLOCK" | "FOOTERFIRST" | "FOOTERBLOCK" ),
        "Price": (long)
      }, ... ], 
      "ContextCoverage": {  /* ContextCoverage */
        "Items": [{  /* ContextCoverageItem */
          "Probability": (decimal), /* required */
          "Price": (long) /* required */
        }, ... ]
      }, /* nillable */
      "MinSearchPrice": (long), /* nillable */
      "CurrentSearchPrice": (long), /* nillable */       
      "AuctionBids": [{  /* AuctionBidItem */ 
        "Position": (string),
        "Bid": (long),
        "Price": (long)
      }, ... ]
    }, ... ],
    "LimitedBy": (long)
  }
}
ParameterTypeDescription
Result structure (for JSON) / GetResponse (for SOAP)
Bidsarray of BidGetItemBids and/or priorities.
LimitedBylongSequential number of the last object returned. It is included if there was a limit on the number of objects in the response. See the section Paginated data selection.
BidGetItem structure
CampaignIdlongID of the campaign that the keyword or autotargeting is associated with.
AdGroupIdlongID of the ad group that the keyword or autotargeting is associated with.
KeywordIdlongID of the keyword or autotargeting.
ServingStatusServingStatusEnumServing status for the ad group. For a description of the statuses, see the section Serving status for the ad group.
BidlongBid in search results.
ContextBidlong

Bid in ad networks.

For autotargeting, this parameter isn't returned.

StrategyPriorityPriorityEnum, nillablePriority of the keyword or autotargeting: LOW, NORMAL or HIGH.
CompetitorsBidsarray of long

Array of minimum bids for this keyword for all positions in Premium Placement and Guaranteed Placement.

If the ad group has very few displays (the ServingStatus parameter has the value RARELY_SERVED), the parameter isn't returned.

For autotargeting, this parameter isn't returned.

SearchPricesarray of SearchPrices

Minimum bids for this keyword for display positions in the search.

If the ad group has very few displays (the ServingStatus parameter has the value RARELY_SERVED), the parameter isn't returned.

For autotargeting, this parameter isn't returned.

ContextCoverageContextCoverage, nillable

Bids for this keyword that allow you to get various percentages of audience coverage in ad networks (forecast). Use as a guide when selecting bids.

If the ad group has very few displays (the ServingStatus parameter has the value RARELY_SERVED), it returns null (nil).

If the campaign uses the SERVING_OFF or NETWORK_DEFAULT strategy in ad networks, it returns null (nil).

For autotargeting, it returns null (nil).

MinSearchPricelong, nillable

The minimum bid set for the advertiser that allows displays in search results.

If the ad group has very few displays (the ServingStatus parameter has the value RARELY_SERVED), it returns null (nil).

For autotargeting, it returns null (nil).

CurrentSearchPricelong, nillable

Current CPC in search results. This price may be deducted for click-throughs on the search results page (for a query that exactly matches the keyword). For more information, see How is cost per click calculated? in the Help for Yandex.Direct.

If the ad group has very few displays (the ServingStatus parameter has the value RARELY_SERVED), it returns null (nil).

For autotargeting, it returns null (nil).

AuctionBidsarray of AuctionBidItem

Auction results for the keyword.

If the group only has image ads, this parameter is not returned.

If the ad group has very few displays (the ServingStatus parameter has the value RARELY_SERVED), the parameter isn't returned.

For autotargeting, this parameter isn't returned.

SearchPrices structure
PositionPositionEnumDisplay position in search results:
  • FOOTERBLOCK — Minimum bid for the 4th position in Guaranteed (for getting into Guaranteed Placement).
  • FOOTERFIRST — Minimum bid for the 1st position in Guaranteed.
  • PREMIUMBLOCK — Minimum bid for the 4th position in Premium Placement (for getting into Premium Placement).
  • PREMIUMFIRST — Minimum bid for the 1st position in Premium Placement.
Pricelong

Minimum bid for the specified position.

ContextCoverage structure
Itemsarray of ContextCoverageItemBids for this keyword that allow you to get various percentages of audience coverage in ad networks (forecast). Use as a guide when selecting bids.
ContextCoverageItem structure
ProbabilitydecimalThe frequency of impressions (the audience coverage) in ad networks. Indicated as a percentage from 0 to 100.
PricelongBid in ad networks that the specified frequency is forecast for.
AuctionBidItem structure
PositionstringDisplay position: Pmn, where
  • m is the block number (1 is Premium Placement, 2 is Guaranteed Placement).
  • n is the position number within the block.

For example, P12 is the 2nd position in Premium Placement, and P21 is the 1st position in Guaranteed Placement.

BidlongMinimum bid for the specified position.
PricelongActual CPC for the specified position.

Examples

Request example
{
  "method" : "get",
  "params" : {
    "SelectionCriteria" : {
      "KeywordIds" : [
        151289987,
        151289988,
        414808783,
        414808784,
        414808785,
        414811825,
        414811826,
        414811827,
        1574449505
      ]
    },
    "FieldNames" : [
      "KeywordId",
      "Bid",
      "ContextBid"
    ]
  }
}
Response example
{
  "result" : {
    "Bids" : [
      {
        "KeywordId" : 414808783,
        "Bid" : 10000,
        "ContextBid" : 0
      },
      {
        "Bid" : 10000,
        "KeywordId" : 414808784,
        "ContextBid" : 0
      },
      {
        "Bid" : 10000,
        "KeywordId" : 414808785,
        "ContextBid" : 0
      },
      {
        "Bid" : 10000,
        "KeywordId" : 1574449505,
        "ContextBid" : 0
      }
    ]
  }
}