assistant
Add a user with the “assistant” type. Assistants are users who help the administrator in their work. Assistants can view campaign reports and manage their campaigns.
Request format
https://adfox.yandex.com/api/v1
? object=account
& action=add
& actionObject=assistant
& account=<string>
& eMail=<string>
& [company=<string>]
& [firstName=<string>]
& [lastName=<string>]
& [isCreateOwnCampaigns=<integer>]
& [isAdvertisers=<integer>]
& [isModifyAllCampaigns=<integer>]
& [isModifyOwnCampaigns=<integer>]
& [isViewAllCampaigns=<integer>]
& [isViewOwnCampaigns=<integer>]
& [isWebsite=<integer>]
& [isCommonReports=<integer>]
|
|
Account for a new user. The account name must be unique within the system. An entry can contain Russian and Latin letters, numbers, and any special characters. |
|
|
Email address that the user's access is registered to. |
|
|
Company name. |
|
|
User's first name. |
|
|
User's last name. |
|
|
Access rights setup. Create own campaigns. Acceptable values:
Default value: |
|
|
Access rights setup. Create own advertisers. Acceptable values:
Default value: |
|
|
Access rights setup. Manage all campaigns:
Default value: |
|
|
Access rights setup. Manage campaigns assigned to the assistant. Acceptable values:
Enabled automatically if the following applies:
Default value: |
|
|
Access rights setup. View all campaigns. Acceptable values:
Enabled automatically if the following applies:
Default value: |
|
|
Access rights setup. View campaigns assigned to the assistant. Acceptable values:
Enabled automatically if the following applies:
Default value: |
|
|
Access rights setup. Manage all sites. Acceptable values:
Default value: |
|
|
Access rights setup. Access general reports. Acceptable values:
Default value: |
* Required
Response format
<response>
<status>
<code>{integer}</code>
<ID>{integer}</ID>
</status>
</response>
Response parameters
|
|
Request processing status. If the value is |
|
|
Object ID. |
Sample request and response
Request:
https://adfox.yandex.com/api/v1?object=account&action=add&actionObject=assistantResponse:
<response> <status> <code>0</code> <ID>393747</ID> </status> </response>
Other actions with the object
See more actions with the assistant object:
Access rights setup. Access general reports.
Acceptable values:
-
1: Enable. -
0: Disable.
Default value: 0
Required
Account for a new user. The account name must be unique within the system.
An entry can contain Russian and Latin letters, numbers, and any special characters.
Email address that the user's access is registered to.
Company name.
User's first name.
User's last name.
Access rights setup. Create own campaigns.
Acceptable values:
-
1: Enable. -
0: Disable.
Default value: 0
Access rights setup. Create own advertisers.
Acceptable values:
-
1: Enable. -
0: Disable.
Default value: 0
Access rights setup. Manage all campaigns:
-
1: Enable. -
0: Disable.
Default value: 0
Access rights setup. Manage campaigns assigned to the assistant.
Acceptable values:
-
1: Enable. -
0: Disable.
Enabled automatically if the following applies:
-
isCreateOwnCampaigns=1: Allowed to create own campaigns. -
isModifyAllCampaigns=1: Allowed to manage all campaigns.
Default value: 0
Access rights setup. View all campaigns.
Acceptable values:
-
1: Enable. -
0: Disable.
Enabled automatically if the following applies:
isModifyAllCampaigns=1: Allowed to manage all campaigns.
Default value: 0
Access rights setup. View campaigns assigned to the assistant.
Acceptable values:
-
1: Enable. -
0: Disable.
Enabled automatically if the following applies:
-
isModifyAllCampaigns=1: Allowed to manage all campaigns. -
isCreateOwnCampaigns=1: Allowed to create own campaigns. -
isModifyOwnCampaigns=1: Allowed to manage campaigns assigned to the assistant.
Default value: 0
Access rights setup. Manage all sites.
Acceptable values:
-
1: Enable. -
0: Disable.
Default value: 0