add

Creates audience targets and sets bids and priorities for the created targets.

  1. How bids and priorities are applied
  2. Restrictions
  3. Request
  4. Response
Attention.
  • Bids and prices are passed via the Yandex.Direct API as integer numbers. The value that is passed represents the bid or price multiplied by 1,000,000.

  • All bids and prices are shown in the advertiser's currency.

Restrictions

Audience targets with a retargeting list are allowed only for the TEXT_AD_GROUP or MOBILE_APP_AD_GROUP types of ad groups.

Audience targets with mobile app categories are allowed only for the MOBILE_APP_AD_GROUP type of ad group.

Maximum of 50 audience targets per ad group.

Maximum of 1000 audience targets per method call.

Request

Request structure in JSON format:

{
  "method": "add",
  "params": { /* params */
    "AudienceTargets": [{  /* AudienceTargetAddItem */
      "AdGroupId": (long), /* required */
      "RetargetingListId": (long),
      "InterestId": (long),
      "ContextBid": (long),
      "StrategyPriority": ( "LOW" | "NORMAL" | "HIGH" )
    }, ... ] /* required */
  }
}
Parameter Type Description Required
Params structure (for JSON) / AddRequest structure (for SOAP)
AudienceTargets array of AudienceTargetAddItem Audience targets to add. Yes
AudienceTargetAddItem structure
AdGroupId long ID of the group to add the audience target to. Yes
RetargetingListId long

ID of the retargeting list. Retargeting lists must have the scope FOR_TARGETS_AND_ADJUSTMENTS.

The ID must be unique within the ad group (you can't have two audience targets with identical retargeting list IDs).

Either RetargetingListId or InterestId
InterestId long

ID of an app category interest.

To get the list of app categories, use the Dictionaries.get method and specify the dictionary name Interests in the request. You can only use interests that have the IsTargetable parameter set to YES in the reference list.

This parameter can only be used with the MOBILE_APP_AD_GROUP type of ad group. The ID must be unique within the ad group (you can't have two audience targets with identical interest IDs).

ContextBid long

The bid in ad networks, multiplied by 1,000,000. Integer. Only used for a manual strategy.

Specified in the advertiser's currency. For restrictions, see the page Minimum and maximum CPC.

The default value is the minimum bid.

Attention. An image ad can be displayed only if the bid is at least as high as the minimum bid for an ad with an image.
No
StrategyPriority PriorityEnum

The priority of the audience target: LOW, NORMAL or HIGH. Only used for an automatic strategy.

The default value is NORMAL.

No

Response

Response structure in JSON format:

{
  "result": { /* result */
    "AddResults": [{  /* ActionResult */
      "Id": (long),
      "Warnings": [{  /* ExceptionNotification */
        "Code": (int), /* required */
        "Message": (string), /* required */
        "Details": (string)
      }, ... ],
      "Errors": [{  /* ExceptionNotification */
        "Code": (int), /* required */
        "Message": (string), /* required */
        "Details": (string)
      }, ... ] 
    }, ... ]
  }
}
Parameter Type Description
Result structure (for JSON) / AddResponse structure (for SOAP)
AddResults array of ActionResult Results of adding audience targets.
ActionResult structure
Id long

The ID of a created audience target. Returned if there aren't any errors. See the section Operations on object arrays.

Warnings array of ExceptionNotification

Warnings that occurred during the operation.

Errors array of ExceptionNotification

Errors that occurred during the operation.