event

Edit banner events.

Request format

https://adfox.yandex.com/api/v1
  ? object=banner
  & action=modify
  & actionObject=event
  & objectID=<integer>
  & [event*Name=<string>]
  & [event*HitURL=<string>]
  & [events*Limit=<integer>]
  & [events*LimitToday=<integer>]
  & [events*LimitHour=<integer>]
  & [actionObjectID=<integer>]

objectID*

ID объекта, над которым производится действие.

event*Name

Event name, where * in the parameter name is the event number from 1 to 30.

An entry can contain Russian and Latin letters, numbers, and any special characters.

event*HitURL

Specify the click URL for calling events, where * in the parameter name is the event number from 1 to 30.

events*Limit

The maximum number of event calls after which banner impressions are limited, where * in the parameter name is the event number from 1 to 30.

Acceptable values: Integer values from 1 to 2,147,483,647.

events*LimitToday

The maximum number of event calls per day after which banner impressions are limited, where * in the parameter name is the event number from 1 to 30.

Acceptable values: Integer values from 1 to 2,147,483,647.

events*LimitHour

The maximum number of event calls per hour, after which banner impressions are limited, where * in the parameter name is the event number from 1 to 30.

Acceptable values: Integer values from 1 to 2,147,483,647.

actionObjectID

Event number from 1 to 30.

Specify if you need to edit just one event.

* Required

Response format

<response>
<status>
  <code>{integer}</code>
</status>
</response>

Response parameters

code

Request processing status. For the key, see Error handling.

Sample request and response

Request:

https://adfox.yandex.com/api/v1?object=banner&action=modify&actionObject=event&objectID=234532&event2Name=userAction

Response:

<response>
<status>
  <code>0</code>
</status>
</response>

Other actions with the object

See more actions with the banner object:

Event number from 1 to 30.

Specify if you need to edit just one event.

Required

ID of the object that the action is performed on.

Event name, where * in the parameter name is the event number from 1 to 30.

An entry can contain Russian and Latin letters, numbers, and any special characters.

Specify the click URL for calling events, where * in the parameter name is the event number from 1 to 30.

The maximum number of event calls after which banner impressions are limited, where * in the parameter name is the event number from 1 to 30.

Acceptable values: Integer values from 1 to 2,147,483,647.

The maximum number of event calls per day after which banner impressions are limited, where * in the parameter name is the event number from 1 to 30.

Acceptable values: Integer values from 1 to 2,147,483,647.

The maximum number of event calls per hour, after which banner impressions are limited, where * in the parameter name is the event number from 1 to 30.

Acceptable values: Integer values from 1 to 2,147,483,647.

Previous
banner
Next
placement