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.

Alert

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

Learn more

How the "get" method works

Restrictions

The method returns a maximum of page-size 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)
    }
  }
}

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 long	Selects dynamic text ad targets with the specified IDs. From 1 to `ids-select` items in the array.	At least one of the parameters: `Ids`, `AdGroupIds`, or `CampaignIds` (or all may be present)
`AdGroupIds`	array of long	Selects dynamic text ad targets in the specified groups. From 1 to `adgroup-ids-select` items in the array.
`CampaignIds`	array of long	Selects 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 text ad target.	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)
  }
}

Parameter	Type	Description
result structure (for JSON) / GetResponse (for SOAP)
`Webpages`	array of WebpageGetItem	Dynamic text ad targets
`LimitedBy`	long	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 data selection.
WebpageGetItem structure
`Id`	long	ID of a dynamic text ad target.
`AdGroupId`	long	ID of the ad group that the dynamic text ad target belongs to.
`CampaignId`	long	ID of the campaign that the dynamic text ad target belongs to.
`Name`	string	Name of the dynamic text ad target.
`Bid`	long	Bid in search results.
`ContextBid`	long	This parameter is reserved for future use.
`StrategyPriority`	PriorityEnum, nillable	The priority of the dynamic text ad target: LOW, NORMAL or HIGH.
`State`	StateEnum	State of the dynamic text ad target. For a description of the states, see the section State of a dynamic text ad target.
`StatusClarification`	string	Text explanation of the state.
`Conditions`	array of WebpageCondition	Rules for page filtering. A dynamic ad is generated if the page meets all the selection rules at the same time.
`ConditionType`	WebpageTypeEnum	Type of dynamic text ad target. For a description of the types, see the section Type of dynamic text 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 Selection rule.
`Operator`	StringCondition OperatorEnum	How the operand and argument are compared. For a description of the operators, see 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.

Was the article helpful?

delete

resume