get

Returns the parameters of audience targets.

  1. Restrictions
  2. Request
  3. Response

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 integers — the result of multiplying the bid 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": {  /* AudienceTargetSelectionCriteria */
      "Ids": [(long), ... ],
      "AdGroupIds": [(long), ... ],
      "CampaignIds": [(long), ... ],
      "RetargetingListIds": [(long), ... ],
      "InterestIds": [(long), ... ],
      "States": [( "ON" | "SUSPENDED" ), ... ]
    }, /* required */
    "FieldNames": [( "Id" | "AdGroupId" | "CampaignId" | "RetargetingListId" | "InterestId" | "ContextBid" | "StrategyPriority" | "State" )], /* required */
    "Page": {  /* LimitOffset */
      "Limit": (long),
      "Offset": (long)
    }
  }
}
ParameterTypeDescriptionRequired
Params structure (for JSON) / GetRequest (for SOAP)
SelectionCriteriaAudienceTargetSelectionCriteria

Criteria for selecting audience targets.

Yes
FieldNamesarray of AudienceTargetFieldEnum

The names of parameters to get.

Yes
PageLimitOffset

Structure that defines the page for paginated selection of data.

No
AudienceTargetSelectionCriteria structure
Idsarray of longSelects audience targets with the specified IDs. From 1 to 10,000 items in the array.At least one of the parameters Ids, AdGroupIds, CampaignIds, RetargetingListIds, InterestIds (all may be present)
AdGroupIdsarray of longSelects audience targets in the specified ad groups. From 1 to 1000 items in the array.
CampaignIdsarray of longSelects audience targets in the specified campaigns. From 1 to 100 items in the array.
RetargetingListIdsarray of longSelects audience targets with the specified retargeting lists. From 1 to 1000 items in the array.
InterestIdsarray of longSelects audience targets with the specified interests. From 1 to 1000 items in the array.
Statesarray of AudienceTargetStateEnumSelects audience targets with the specified states. See State of an audience target.No

Response

Response structure in JSON format:

{
  "result": { /* result */
    "AudienceTargets": [{  /* AudienceTargetGetItem */
      "Id": (long),
      "AdGroupId": (long),
      "CampaignId": (long),
      "RetargetingListId": (long),  /* nillable */
      "InterestId": (long),  /* nillable */
      "State": ( "ON" | "SUSPENDED" | "UNKNOWN" ),
      "ContextBid": (long),
      "StrategyPriority": ( "LOW" | "NORMAL" | "HIGH" )
   }, ... ],
   "LimitedBy": (long)
  }
}
ParameterTypeDescription
Result structure (for JSON) / GetResponse (for SOAP)
AudienceTargetsarray of AudienceTargetGetItemAudience targets.
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.
AudienceTargetGetItem structure
IdlongID of the audience target.
AdGroupIdlongID of the ad group that the audience target belongs to.
CampaignIdlongID of the campaign that the audience target belongs to.
RetargetingListIdlong, nillableID of the retargeting list.
InterestIdlong, nillableID of an app category interest.
ContextBidlong

The bid in ad networks, multiplied by 1,000,000.

StrategyPriorityPriorityEnumPriority: LOW, NORMAL or HIGH.
StateStateEnumState of an audience target. See State of an audience target.