Users
- AddUser
- UpdateUser
- DeleteUser
- GetUsersList
- GetUserInfo
- SearchUser
- GetOwnerSettings
- GetUserRolesList
- GetUserRoleTypesList
AddUser [finished]
Overlays:
Activation:
AddUser.php ? sessionID = ... & login = ...
[ & name = ... ]
[ & email = ... ]
& roleID = ...
[ & roleTypeID = ... ]
[ & aliasedUserID = ... ]
[ & parentID = ... ]
[ & emailAlerts = ... ]
[ & alertEmailAddress = ... ]
[ & isBlocked = ... ]
[ & expireTS = ... ]
[ & comments = ... ]
Description:
Adds a user.
Parameters:
- sessionID: string(16)
- login: string(255) - Login must be at least 3 characters long and unique.
- name: string(255) - Parameter is mandatory for user role Client, Publisher and Custom.
- email: string(255)
- roleID: uint - User role id.
- roleTypeID: nullable uint - User role type id, mandatory for user role Publisher and Client.
- aliasedUserID: uint - Is mandatory for user role Alias-Owner.
- parentID: uint
- emailAlerts: enum('Y','N') - default 'N'
- alertEmailAddress: string(100) - E-mail, where alert informations will be sent
- isBlocked: enum('Y','N') - default 'N'
- expireTS: nullable uint - Auto expire of account after specific time (provided in UNIX timestamps format).
- comments: string(255)
Results:
<AddUser>
<status>OK</status>
<userID>1234</userID> : uint
</AddUser>
Throw Errors:
UpdateUser [finished]
Overlays:
Activation:
UpdateUser.php
Description:
Changes existing user.
Note that this function requires using HTTP POST method and passing parameters in POST request body.
Parameters:
- userID: uint - user id
- login: string(255) - Login must be at least 3 characters long and unique.
- passwd: string(255) - User password must be set to 6 or more characters. Passwd and md5passwd parameters can't be used together.
- oldpasswd: string(100) - Old password string in plain text format.
- name: string(255)
- email: string(255)
- roleTypeID: nullable uint
- emailAlerts: enum('Y','N') - default 'N'
- alertEmailAddress: string(100) - E-mail, where alert informations will be sent
- isBlocked: enum('Y', 'N')
- expireTS: nullable uint - Auto expire of account after specific time (provided in UNIX timestamps format).
- comments: string(255)
- userRoleID: uint
Results:
<UpdateUser>
<status>OK</status>
</UpdateUser>
Throw Errors:
DeleteUser [finished]
Overlays:
Activation:
DeleteUser.php ? userID = ...
Description:
Removes existing user.
Parameters:
- userID: uint
Results:
<DeleteUser>
<status>OK</status>
</DeleteUser>
Throw Errors:
GetUsersList [finished]
Overlays:
Activation:
GetUsersList.php ? sessionID = ...
[ & userID = ... ]
[ & userIDs = ... ]
[ & parentID = ... ]
[ & roleIDs = ... ]
[ & roleTypeID = ... ]
[ & isBlocked = ... ]
[ & campaignsNumber = ... ]
[ & namePattern = ... ]
[ & commentsPattern = ... ]
[ & loginPattern = ... ]
[ & sortField = ... ]
[ & sortOrder = ... ]
[ & limit = ... ]
[ & offset = ... ]
Description:
Returns a list of users matching specified criteria.
Parameters:
- sessionID: string(16)
- userID: uint - only users visible for passed user will be returned
- userIDs: uint - only users with ids passed will be returned
- parentID: uint - filters parent in users hierarchy
- roleIDs: uint list
- roleTypeID: uint
- isBlocked: enum('Y','N')
- campaignsNumber: enum('Y','N')
- namePattern: string(100)
- commentsPattern: string(255)
- loginPattern: string(255)
- sortField: enum('name', 'login', 'parentLogin', 'creatorLogin', 'email', 'roleID', 'creationTS', 'modificationTS', 'lastLoginTS', 'isBlocked', 'isGdePlus', 'childrensCount', 'comments', 'campaignsWaiting', 'campaignsFinished', 'campaignsCurrent')
- sortOrder: enum('asc','desc')
- limit: uint - limits result to given number of records
- offset: uint - skips given number of records
Results:
<GetUsersList>
<status>OK</status>
<usersNumber>1</usersNumber> : uint - all records number (if there were no limit and offset)
<users>
<user>
<userID>123</userID> : uint
<login>admin</login> : string(255)
<name>jacek</name> : string(255)
<email>gde@gemius.pl</email> : string(255)
<ownerID>123</ownerID> : uint
<parentID>123</parentID> : nullable uint - parent in users hierarchy
<parentLogin>login</parentLogin> : string(255)
<aliasedUserID></aliasedUserID> : nullable uint - for alias-owner and alias-owner-ro
<creatorID>12</creatorID> : nullable uint
<creatorLogin>admin_pl</creatorLogin> : string(255)
<roleID>6</roleID> : uint
<roleName>Client</roleName> : string(30)
<roleType>Agency</roleType> : string(30)
<comments>lala</comments> : string(255)
<isBlocked>N</isBlocked> : enum('Y', 'N')
<isGdePlus>Y</isGdePlus> : enum('Y', 'N')
<creationTS>1242123024</creationTS> : uint
<lastLoginTS>1242123024</lastLoginTS> : nullable uint
<childrensCount>12</childrensCount> : uint
<campaignsNumber>
<waiting>1</waiting>
<finished>4</finished>
<current>2</current>
</campaignsNumber>
<campaignsNumber>
<waiting>1</waiting>
<finished>4</finished>
<current>2</current>
</campaignsNumber>
</user>
</users>
</GetUsersList>
Throw Errors:
GetUserInfo [finished]
Overlays:
Activation:
GetUserInfo.php ? sessionID = ...
[ & userID = ... ]
Description:
Returns information about a given user.
Parameters:
- sessionID: string(16)
- userID: uint - user, whom info will be returned
Results:
<GetUserInfo>
<status>OK</status>
<users>
<user>
<userID>123</userID> : uint
<login>admin</login> : string(255)
<name>jacek</name> : string(255)
<email>gde@gemius.pl</email> : string(255)
<parentID>123</parentID> : nullable uint - parent in users hierarchy
<parentLogin>3</parentLogin> : string(255)
<parentName></parentName> : string(255)
<aliasedUserID></aliasedUserID> : nullable uint - for alias-owner and alias-owner-ro
<ownerID/> : nullable uint
<ownerLogin/> : string(255)
<roleID>6</roleID> : uint
<roleName>Client</roleName> : string(30)
<roleTypeID>1</roleTypeID> : uint
<roleTypeName>Broker</roleTypeName> : string(30)
<childrensCount>12</childrensCount> : uint
<countryIDs>42</countryIDs> : uint list
<comments>lala</comments> : string(255)
<isBlocked>N</isBlocked> : enum('Y', 'N')
<creationTS>1242123024</creationTS> : uint
<lastLoginTS>1242123024</lastLoginTS> : nullable uint
<timeZoneID>283</timeZoneID> : uint
<timeZoneName>Warsaw</timeZoneName> : string(255)
<emailAlerts>Y</emailAlerts> : enum('Y', 'N')
<alertEmailAddress>abc@abc.com</alertEmailAddress> : string(100)
<expireTS>1262123024</expireTS> : nullable uint - account expiration date
</user>
</users>
</GetUserInfo>
Throw Errors:
SearchUser [finished]
Overlays:
Activation:
SearchUser.php ? sessionID = ...
[ & userIDs = ... ]
[ & roleID = ... ]
[ & parentID = ... ]
[ & isBlocked = ... ]
& matchingField = ...
[ & pattern = ... ]
[ & sortField = ... ]
[ & sortOrder = ... ]
[ & limit = ... ]
[ & offset = ... ]
Description:
Returns a list of users matching specified criteria. Faster than GetUsersList.
Parameters:
- sessionID: string(16)
- userIDs: uint list - only users with ids passed will be returned
- roleID: uint
- parentID: uint
- isBlocked: enum('Y','N')
- matchingField: enum('login','name')
- pattern: string(100)
- sortField: enum('login','name','roleID','comments','isBlocked','interfaceBlocked','creationTS','lastLoginTS')
- sortOrder: enum('asc','desc')
- limit: uint - limits result to given number of records
- offset: uint - skips given number of records
Results:
<SearchUser>
<status>OK</status>
<usersNumber>1</usersNumber> : uint - all records number (if there were no limit and offset)
<users>
<user>
<userID>123</userID> : uint
<matchingField>admin</matchingField> : string(255)
</user>
</users>
</SearchUser>
Throw Errors:
GetOwnerSettings [finished]
Overlays:
Activation:
GetOwnerSettings.php ? sessionID = ...
Description:
Returns account settings such as category names.
Parameters:
- sessionID: string(16)
Results:
<GetOwnerSettings>
<owners>
<owner>
<ownerID>1</ownerID> : uint
<isGdePlus>Y</isGdePlus> : enum('Y', 'N')
<rootPlacementID>123</rootPlacementID> : uint
<rootGtScriptID>12</rootGtScriptID> : uint
<emiterIDs>1,2,3,4</emiterIDs> : uint list
<emiterNames>first,second,third,fourth</emiterNames> : string list
<hitCollectorIDs>1,2,3,4</hitCollectorIDs> : uint list
<hitCollectorNames>first,second,third,fourth</hitCollectorNames> : string list
<defaultEmiterID>3</defaultEmiterID> : nullable uint - Default delivery server id for new campaigns.
<defaultHitCollectorID>2</defaultHitCollectorID> : nullable uint - Default Hit Collector id for new placements.
<campaignTag1Name>a</campaignTag1Name> : nullable string(255) - Name of the campaign primary category
<campaignTag2Name>b</campaignTag2Name> : nullable string(255) - Name of the campaign secondary category
<campaignLabel1Name>c</campaignLabel1Name> : nullable string(255) - Name of the first campaign external id
<campaignLabel2Name>d</campaignLabel2Name> : nullable string(255) - Name of the second campaign external id
<creativeTag1Name>e</creativeTag1Name> : nullable string(255) - Name of the creative primary category
<creativeTag2Name>f</creativeTag2Name> : nullable string(255) - Name of the creative secondary category
<creativeLabel1Name>g</creativeLabel1Name> : nullable string(255) - Name of the first creative external id
<creativeLabel2Name>h</creativeLabel2Name> : nullable string(255) - Name of the second creative external id
<placementTag1Name>i</placementTag1Name> : nullable string(255) - Name of the placement primary category
<placementTag2Name>j</placementTag2Name> : nullable string(255) - Name of the placement secondary category
<placementLabel1Name>k</placementLabel1Name> : nullable string(255) - Name of the first placement external id
<placementLabel2Name>l</placementLabel2Name> : nullable string(255) - Name of the second placement external id
</owner>
</owners>
</GetOwnerSettings>
Throw Errors:
GetUserRolesList [finished]
Overlays:
Activation:
GetUserRolesList.php ? sessionID = ...
Description:
1. Admin
2. Owner
3. Traffic
4. Mediaplanner
5. Client
6. Publisher
7. Custom
8. Alias-Owner
9. analyst
10. Alias-Owner-RO
Parameters:
- sessionID: string(16)
Results:
<GetUserRolesList>
<status>OK</status>
<roles>
<role>
<roleID>123</roleID> : uint
<roleName>admin</roleName> : string
</role>
</roles>
</GetUserRolesList>
Throw Errors:
GetUserRoleTypesList [finished]
Overlays:
Activation:
GetUserRoleTypesList.php ? sessionID = ... & roleID = ...
Description:
Returns constant role types for given role.
for role 'Client':
1. Advertiser
2. Agency
3. Brand
4. Media House
for role 'Publisher':
20. Publisher
21. Broker
22. AdNetwork
Parameters:
- sessionID: string(16)
- roleID: uint
Results:
<GetUserRoleTypesList>
<status>OK</status>
<roleTypes>
<roleType>
<roleTypeID>123</roleTypeID> : uint
<roleTypeName>Marka</roleTypeName> : string(30)
</roleType>
</roleTypes>
</GetUserRoleTypesList>