Documentation

get

Returns the parameters of audience targets.

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": { 
    "SelectionCriteria
[no-highlight[

Criteria for selecting audience targets.

Required

Yes

]no-highlight]
": { /* AudienceTargetSelectionCriteria */ "Ids
[no-highlight[

Selects audience targets with the specified IDs. From 1 to 10,000 items in the array.

Required

At least one of the parameters Ids, AdGroupIds, CampaignIds, RetargetingListIds, InterestIds (all may be present)

]no-highlight]
": [(long), ... ], "AdGroupIds
[no-highlight[

Selects audience targets in the specified ad groups. From 1 to 1000 items in the array.

Required

At least one of the parameters Ids, AdGroupIds, CampaignIds, RetargetingListIds, InterestIds (all may be present)

]no-highlight]
": [(long), ... ], "CampaignIds
[no-highlight[

Selects audience targets in the specified campaigns. From 1 to 100 items in the array.

Required

At least one of the parameters Ids, AdGroupIds, CampaignIds, RetargetingListIds, InterestIds (all may be present)

]no-highlight]
": [(long), ... ], "RetargetingListIds
[no-highlight[

Selects audience targets with the specified retargeting lists. From 1 to 1000 items in the array.

Required

At least one of the parameters Ids, AdGroupIds, CampaignIds, RetargetingListIds, InterestIds (all may be present)

]no-highlight]
": [(long), ... ], "InterestIds
[no-highlight[

Selects audience targets with the specified interests. From 1 to 1000 items in the array.

Required

At least one of the parameters Ids, AdGroupIds, CampaignIds, RetargetingListIds, InterestIds (all may be present)

]no-highlight]
": [(long), ... ], "States
[no-highlight[

Selects audience targets with the specified states. See State of an audience target.

Required

No

]no-highlight]
": [( "ON" | "SUSPENDED" ), ... ] }, /* required */ "FieldNames
[no-highlight[

The names of parameters to get.

Required

Yes

]no-highlight]
": [( "Id" | "AdGroupId" | "CampaignId" | "RetargetingListId" | "InterestId" | "ContextBid" | "StrategyPriority" | "State" )], /* required */ "Page
[no-highlight[

Structure that defines the page for paginated selection of data.

Required

No

]no-highlight]
": { /* LimitOffset */ "Limit": (long), "Offset": (long) } } }
Parameter Type Description Required
params structure (for JSON) / GetRequest (for SOAP)
SelectionCriteria AudienceTargetSelectionCriteria

Criteria for selecting audience targets.

Yes
FieldNames array of AudienceTargetFieldEnum

The names of parameters to get.

Yes
Page LimitOffset

Structure that defines the page for paginated selection of data.

No
AudienceTargetSelectionCriteria structure
Ids array 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)
AdGroupIds array of longSelects audience targets in the specified ad groups. From 1 to 1000 items in the array.
CampaignIds array of longSelects audience targets in the specified campaigns. From 1 to 100 items in the array.
RetargetingListIds array of longSelects audience targets with the specified retargeting lists. From 1 to 1000 items in the array.
InterestIds array of longSelects audience targets with the specified interests. From 1 to 1000 items in the array.
States array of AudienceTargetStateEnumSelects audience targets with the specified states. See State of an audience target.No

Response

Response structure in JSON format:

{
  "result": { 
    "AudienceTargets
[no-highlight[

Audience targets.

]no-highlight]
": [{ /* AudienceTargetGetItem */ "Id
[no-highlight[

ID of the audience target.

]no-highlight]
": (long), "AdGroupId
[no-highlight[

ID of the ad group that the audience target belongs to.

]no-highlight]
": (long), "CampaignId
[no-highlight[

ID of the campaign that the audience target belongs to.

]no-highlight]
": (long), "RetargetingListId
[no-highlight[

ID of the retargeting list.

]no-highlight]
": (long), /* nillable */ "InterestId
[no-highlight[

ID of an app category interest.

]no-highlight]
": (long), /* nillable */ "State
[no-highlight[

State of an audience target. See State of an audience target.

]no-highlight]
": ( "ON" | "SUSPENDED" | "UNKNOWN" ), "ContextBid
[no-highlight[

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

]no-highlight]
": (long), "StrategyPriority
[no-highlight[

Priority: LOW, NORMAL or HIGH.

]no-highlight]
": ( "LOW" | "NORMAL" | "HIGH" ) }, ... ], "LimitedBy
[no-highlight[

Sequential 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 selection.

]no-highlight]
": (long) } }
Parameter Type Description
result structure (for JSON) / GetResponse (for SOAP)
AudienceTargets array of AudienceTargetGetItemAudience targets.
LimitedBy longSequential 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 selection.
AudienceTargetGetItem structure
Id longID of the audience target.
AdGroupId longID of the ad group that the audience target belongs to.
CampaignId longID of the campaign that the audience target belongs to.
RetargetingListId long, nillableID of the retargeting list.
InterestId long, nillableID of an app category interest.
ContextBid long

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

StrategyPriority PriorityEnumPriority: LOW, NORMAL or HIGH.
State StateEnumState of an audience target. See State of an audience target.