1. class
  2. Google
  3. \
  4. Service
  5. \
  6. Dfareporting
  7. \
  8. Resource
  9. \
  10. UserRoles

UserRoles

class UserRoles extends Resource (View source)

The "userRoles" collection of methods.

Typical usage is:

 $dfareportingService = new Google\Service\Dfareporting(...);
 $userRoles = $dfareportingService->userRoles;

Methods

delete(string $profileId, string $id, array $optParams = [])

Deletes an existing user role. (userRoles.delete)

UserRole
get(string $profileId, string $id, array $optParams = [])

Gets one user role by ID. (userRoles.get)

UserRole
insert(string $profileId, UserRole $postBody, array $optParams = [])

Inserts a new user role. (userRoles.insert)

UserRolesListResponse
listUserRoles(string $profileId, array $optParams = [])

Retrieves a list of user roles, possibly filtered. This method supports paging. (userRoles.listUserRoles)

UserRole
patch(string $profileId, string $id, UserRole $postBody, array $optParams = [])

Updates an existing user role. This method supports patch semantics.

UserRole
update(string $profileId, UserRole $postBody, array $optParams = [])

Updates an existing user role. (userRoles.update)

Details

at line 41
delete(string $profileId, string $id, array $optParams = [])

Deletes an existing user role. (userRoles.delete)

Parameters

string $profileId

User profile ID associated with this request.
string $id

User role ID.
array $optParams

Optional parameters.

Exceptions

Exception

at line 56
UserRole get(string $profileId, string $id, array $optParams = [])

Gets one user role by ID. (userRoles.get)

Parameters

string $profileId

User profile ID associated with this request.
string $id

User role ID.
array $optParams

Optional parameters.

Return Value

UserRole

Exceptions

Exception

at line 71
UserRole insert(string $profileId, UserRole $postBody, array $optParams = [])

Inserts a new user role. (userRoles.insert)

Parameters

string $profileId

User profile ID associated with this request.
UserRole $postBody
array $optParams

Optional parameters.

Return Value

UserRole

Exceptions

Exception

at line 104
UserRolesListResponse listUserRoles(string $profileId, array $optParams = [])

Retrieves a list of user roles, possibly filtered. This method supports paging. (userRoles.listUserRoles)

Parameters

string $profileId

User profile ID associated with this request.
array $optParams

Optional parameters.

Return Value

UserRolesListResponse

Exceptions

Exception

at line 121
UserRole patch(string $profileId, string $id, UserRole $postBody, array $optParams = [])

Updates an existing user role. This method supports patch semantics.

(userRoles.patch)

Parameters

string $profileId

User profile ID associated with this request.
string $id

Required. UserRole ID.
UserRole $postBody
array $optParams

Optional parameters.

Return Value

UserRole

Exceptions

Exception

at line 136
UserRole update(string $profileId, UserRole $postBody, array $optParams = [])

Updates an existing user role. (userRoles.update)

Parameters

string $profileId

User profile ID associated with this request.
UserRole $postBody
array $optParams

Optional parameters.

Return Value

UserRole

Exceptions

Exception