Documentation

get

Returns parameters of dynamic text ad 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 dynamic text ad targets.

Required

Yes

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

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

Required

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

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

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

Required

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

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

Selects dynamic text ad targets in the specified campaigns. From 1 to 2 items in the array.

Required

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

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

Selects dynamic text ad targets with the specified states. For a description of the states, see the section State of a dynamic ad target.

Note. The get method returns a dynamic text ad target in the DELETED state only if the States parameter is set to DELETED or the ID of this condition is specified in the Ids parameter. If both the Ids and States parameters are omitted, the method doesn‘t return dynamic text ad targets in the DELETED state.

Required

No

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

The names of parameters to get.

Required

Yes

]no-highlight]
": [( "AdGroupId" | "Bid" | "CampaignId" | "Conditions" | "ConditionType" | "ContextBid" | "Id" | "Name" | "State" | "StatusClarification" | "StrategyPriority" )], /* 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 WebpagesSelectionCriteria

Criteria for selecting dynamic text ad targets.

Yes
FieldNames array of WebpageFieldEnum

The names of parameters to get.

Yes
Page LimitOffset

Structure that defines the page for paginated selection of data.

No
WebpagesSelectionCriteria structure
Ids array of longSelects dynamic text ad targets with the specified IDs. From 1 to 10,000 items in the array.At least one of the parameters Ids, AdGroupIds, or CampaignIds (or all may be present)
AdGroupIds array of longSelects dynamic text ad targets in the specified groups. From 1 to 1000 items in the array.
CampaignIds array of longSelects dynamic text ad targets in the specified campaigns. From 1 to 2 items in the array.
States array of WebpageStateSelectionEnum

Selects dynamic text ad targets with the specified states. For a description of the states, see the section State of a dynamic ad target.

Note. The get method returns a dynamic text ad target in the DELETED state only if the States parameter is set to DELETED or the ID of this condition is specified in the Ids parameter. If both the Ids and States parameters are omitted, the method doesn't return dynamic text ad targets in the DELETED state.
No

Response

Response structure in JSON format:

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

Dynamic text ad targets.

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

ID of the dynamic text ad target.

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

ID of the ad group that the dynamic text ad target belongs to.

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

ID of the campaign that the dynamic text ad target belongs to.

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

Name of the dynamic text ad target.

]no-highlight]
": (string), "Bid
[no-highlight[

Bid in search results.

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

This parameter is reserved for future use.

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

The priority of the dynamic text ad target: LOW, NORMAL or HIGH.

]no-highlight]
": ( "LOW" | "NORMAL" | "HIGH" ), /* nillable */ "State
[no-highlight[

State of a dynamic text ad target. For a description of the states, see the section State of a dynamic ad target.

]no-highlight]
": ( "ON" | "OFF" | "SUSPENDED" | "DELETED" | "UNKNOWN" ), "StatusClarification
[no-highlight[

Text explanation of the state.

]no-highlight]
": (string), "Conditions
[no-highlight[

Rules for page filtering. A dynamic ad is generated if the page meets all the selection criteria simultaneously.

]no-highlight]
": [{ /* WebpageCondition */ "Operand
[no-highlight[

The operand is a property of a site page to compare with the argument. For a description of the operands, see the section Selection rule.

]no-highlight]
": ( "DOMAIN" | "OFFERS_LIST_URL" | "PAGE_CONTENT" | "PAGE_TITLE" | "URL" ), /* required */ "Operator
[no-highlight[

How the operand and argument are compared. For a description of the operators, see the section Selection rule.

]no-highlight]
": ( "EQUALS_ANY" | "NOT_EQUALS_ALL" | "CONTAINS_ANY" | "NOT_CONTAINS_ALL" ), /* required */ "Arguments
[no-highlight[

An array of strings to compare the operand to. Maximum of 10 strings in the array.

If the operand is OFFERS_LIST_URL, the length of each string must be less than 1024 characters. In all other cases, each string can have a maximum of 100 characters.

]no-highlight]
": [(string), ... ] /* required */ }, ... ], "ConditionType
[no-highlight[

Type of dynamic text ad target. For a description of the types, see the section Type of dynamic ad target.

]no-highlight]
": ( "PAGES_ALL" | "PAGES_SUBSET" ) }, ... ], "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)
Webpages array of WebpageGetItemDynamic text ad 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.
WebpageGetItem structure
Id longID of the dynamic text ad target.
AdGroupId longID of the ad group that the dynamic text ad target belongs to.
CampaignId longID of the campaign that the dynamic text ad target belongs to.
Name stringName of the dynamic text ad target.
Bid longBid in search results.
ContextBid longThis parameter is reserved for future use.
StrategyPriority PriorityEnum, nillableThe priority of the dynamic text ad target: LOW, NORMAL or HIGH.
State StateEnumState of a dynamic text ad target. For a description of the states, see the section State of a dynamic ad target.
StatusClarification stringText explanation of the state.
Conditions array of WebpageConditionRules for page filtering. A dynamic ad is generated if the page meets all the selection criteria simultaneously.
ConditionType WebpageTypeEnum

Type of dynamic text ad target. For a description of the types, see the section Type of dynamic ad target.

WebpageCondition structure
Operand WebpageCondition OperandEnum

The operand is a property of a site page to compare with the argument. For a description of the operands, see the section Selection rule.

Operator StringCondition OperatorEnum

How the operand and argument are compared. For a description of the operators, see the section Selection rule.

Arguments string

An array of strings to compare the operand to. Maximum of 10 strings in the array.

If the operand is OFFERS_LIST_URL, the length of each string must be less than 1024 characters. In all other cases, each string can have a maximum of 100 characters.