get

Returns parameters of dynamic text ad 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": {  /* WebpagesSelectionCriteria */
      "Ids": [(long), ... ],
      "AdGroupIds": [(long), ... ],
      "CampaignIds": [(long), ... ],
      "States": [( "ON" | "OFF" | "SUSPENDED" | "DELETED" ), ... ]
    }, /* required */
    "FieldNames": [( "AdGroupId" | "Bid" | "CampaignId" | "Conditions" | "ConditionType" | "ContextBid" | "Id" | "Name" | "State" | "StatusClarification" | "StrategyPriority" )], /* required */
    "Page": {  /* LimitOffset */
      "Limit": (long),
      "Offset": (long)
    }
  }
}
ParameterTypeDescriptionRequired
Params structure (for JSON) / GetRequest (for SOAP)
SelectionCriteriaWebpagesSelectionCriteria

Criteria for selecting dynamic text ad targets.

Yes
FieldNamesarray of WebpageFieldEnum

The names of parameters to get.

Yes
PageLimitOffset

Structure that defines the page for paginated selection of data.

No
WebpagesSelectionCriteria structure
Idsarray 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)
AdGroupIdsarray of longSelects dynamic text ad targets in the specified groups. From 1 to 1000 items in the array.
CampaignIdsarray of longSelects dynamic text ad targets in the specified campaigns. From 1 to 2 items in the array.
Statesarray of WebpageStateSelectionEnum

Selects dynamic text ad targets with the specified states. For a description of the states, see the section State of a dynamic text 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 target 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": {  /* result */
    "Webpages": [{  /* WebpageGetItem */
      "Id": (long),
      "AdGroupId": (long),
      "CampaignId": (long),
      "Name": (string),
      "Bid": (long),
      "ContextBid": (long),
      "StrategyPriority": ( "LOW" | "NORMAL" | "HIGH" ), /* nillable */
      "State": ( "ON" | "OFF" | "SUSPENDED" | "DELETED" | "UNKNOWN" ),
      "StatusClarification": (string),
      "Conditions": [{  /* WebpageCondition */
        "Operand": ( "DOMAIN" | "OFFERS_LIST_URL" | "PAGE_CONTENT" | "PAGE_TITLE" | "URL" ), /* required */
        "Operator": ( "EQUALS_ANY" | "NOT_EQUALS_ALL" | "CONTAINS_ANY" | "NOT_CONTAINS_ALL" ), /* required */
        "Arguments": [(string), ... ] /* required */
      }, ... ],
      "ConditionType": ( "PAGES_ALL" | "PAGES_SUBSET" )
    }, ... ],
    "LimitedBy": (long)
  }
}
ParameterTypeDescription
Result structure (for JSON) / GetResponse (for SOAP)
Webpagesarray of WebpageGetItemDynamic text ad 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.
WebpageGetItem structure
IdlongID of a dynamic text ad target.
AdGroupIdlongID of the ad group that the dynamic text ad target belongs to.
CampaignIdlongID of the campaign that the dynamic text ad target belongs to.
NamestringName of the dynamic text ad target.
BidlongBid in search results.
ContextBidlongThis parameter is reserved for future use.
StrategyPriorityPriorityEnum, nillableThe priority of the dynamic text ad target: LOW, NORMAL or HIGH.
StateStateEnumState of the dynamic text ad target. For a description of the states, see the section State of a dynamic text ad target.
StatusClarificationstringText explanation of the state.
Conditionsarray of WebpageConditionRules for page filtering. A dynamic ad is generated if the page meets all the selection criteria simultaneously.
ConditionTypeWebpageTypeEnum

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

WebpageCondition structure
OperandWebpageCondition OperandEnum

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

OperatorStringCondition OperatorEnum

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

Argumentsstring

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.