Class UserServiceClientImpl
UserService client wrapper implementation, for convenient use.
Inherited Members
Namespace: Google.Ads.AdManager.V1
Assembly: Google.Ads.AdManager.V1.dll
Syntax
public sealed class UserServiceClientImpl : UserServiceClient
Remarks
Provides methods for handling User objects.
Constructors
UserServiceClientImpl(UserServiceClient, UserServiceSettings, ILogger)
Constructs a client wrapper for the UserService service, with the specified gRPC client and settings.
Declaration
public UserServiceClientImpl(UserService.UserServiceClient grpcClient, UserServiceSettings settings, ILogger logger)
Parameters
| Type | Name | Description |
|---|---|---|
| UserService.UserServiceClient | grpcClient | The underlying gRPC client. |
| UserServiceSettings | settings | The base UserServiceSettings used within this client. |
| ILogger | logger | Optional ILogger to use within this client. |
Properties
GrpcClient
The underlying gRPC UserService client
Declaration
public override UserService.UserServiceClient GrpcClient { get; }
Property Value
| Type | Description |
|---|---|
| UserService.UserServiceClient |
Overrides
Methods
BatchActivateUsers(BatchActivateUsersRequest, CallSettings)
Activates a list of User objects.
Declaration
public override BatchActivateUsersResponse BatchActivateUsers(BatchActivateUsersRequest request, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| BatchActivateUsersRequest | request | The request object containing all of the parameters for the API call. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| BatchActivateUsersResponse | The RPC response. |
Overrides
BatchActivateUsersAsync(BatchActivateUsersRequest, CallSettings)
Activates a list of User objects.
Declaration
public override Task<BatchActivateUsersResponse> BatchActivateUsersAsync(BatchActivateUsersRequest request, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| BatchActivateUsersRequest | request | The request object containing all of the parameters for the API call. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| Task<BatchActivateUsersResponse> | A Task containing the RPC response. |
Overrides
BatchCreateUsers(BatchCreateUsersRequest, CallSettings)
Creates User objects.
Declaration
public override BatchCreateUsersResponse BatchCreateUsers(BatchCreateUsersRequest request, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| BatchCreateUsersRequest | request | The request object containing all of the parameters for the API call. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| BatchCreateUsersResponse | The RPC response. |
Overrides
BatchCreateUsersAsync(BatchCreateUsersRequest, CallSettings)
Creates User objects.
Declaration
public override Task<BatchCreateUsersResponse> BatchCreateUsersAsync(BatchCreateUsersRequest request, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| BatchCreateUsersRequest | request | The request object containing all of the parameters for the API call. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| Task<BatchCreateUsersResponse> | A Task containing the RPC response. |
Overrides
BatchDeactivateUsers(BatchDeactivateUsersRequest, CallSettings)
Deactivates a list of User objects.
Declaration
public override BatchDeactivateUsersResponse BatchDeactivateUsers(BatchDeactivateUsersRequest request, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| BatchDeactivateUsersRequest | request | The request object containing all of the parameters for the API call. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| BatchDeactivateUsersResponse | The RPC response. |
Overrides
BatchDeactivateUsersAsync(BatchDeactivateUsersRequest, CallSettings)
Deactivates a list of User objects.
Declaration
public override Task<BatchDeactivateUsersResponse> BatchDeactivateUsersAsync(BatchDeactivateUsersRequest request, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| BatchDeactivateUsersRequest | request | The request object containing all of the parameters for the API call. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| Task<BatchDeactivateUsersResponse> | A Task containing the RPC response. |
Overrides
BatchUpdateUsers(BatchUpdateUsersRequest, CallSettings)
Batch updates User objects.
Declaration
public override BatchUpdateUsersResponse BatchUpdateUsers(BatchUpdateUsersRequest request, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| BatchUpdateUsersRequest | request | The request object containing all of the parameters for the API call. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| BatchUpdateUsersResponse | The RPC response. |
Overrides
BatchUpdateUsersAsync(BatchUpdateUsersRequest, CallSettings)
Batch updates User objects.
Declaration
public override Task<BatchUpdateUsersResponse> BatchUpdateUsersAsync(BatchUpdateUsersRequest request, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| BatchUpdateUsersRequest | request | The request object containing all of the parameters for the API call. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| Task<BatchUpdateUsersResponse> | A Task containing the RPC response. |
Overrides
CreateUser(CreateUserRequest, CallSettings)
Creates a User object.
Declaration
public override User CreateUser(CreateUserRequest request, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| CreateUserRequest | request | The request object containing all of the parameters for the API call. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| User | The RPC response. |
Overrides
CreateUserAsync(CreateUserRequest, CallSettings)
Creates a User object.
Declaration
public override Task<User> CreateUserAsync(CreateUserRequest request, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| CreateUserRequest | request | The request object containing all of the parameters for the API call. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| Task<User> | A Task containing the RPC response. |
Overrides
GetUser(GetUserRequest, CallSettings)
Retrieves a User object.
To get the current user, the resource name
networks/{networkCode}/users/me can be used.
Declaration
public override User GetUser(GetUserRequest request, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| GetUserRequest | request | The request object containing all of the parameters for the API call. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| User | The RPC response. |
Overrides
GetUserAsync(GetUserRequest, CallSettings)
Retrieves a User object.
To get the current user, the resource name
networks/{networkCode}/users/me can be used.
Declaration
public override Task<User> GetUserAsync(GetUserRequest request, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| GetUserRequest | request | The request object containing all of the parameters for the API call. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| Task<User> | A Task containing the RPC response. |
Overrides
ListUsers(ListUsersRequest, CallSettings)
Lists User objects.
Declaration
public override PagedEnumerable<ListUsersResponse, User> ListUsers(ListUsersRequest request, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| ListUsersRequest | request | The request object containing all of the parameters for the API call. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| PagedEnumerable<ListUsersResponse, User> | A pageable sequence of User resources. |
Overrides
ListUsersAsync(ListUsersRequest, CallSettings)
Lists User objects.
Declaration
public override PagedAsyncEnumerable<ListUsersResponse, User> ListUsersAsync(ListUsersRequest request, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| ListUsersRequest | request | The request object containing all of the parameters for the API call. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| PagedAsyncEnumerable<ListUsersResponse, User> | A pageable asynchronous sequence of User resources. |
Overrides
UpdateUser(UpdateUserRequest, CallSettings)
Updates a User object.
Declaration
public override User UpdateUser(UpdateUserRequest request, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| UpdateUserRequest | request | The request object containing all of the parameters for the API call. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| User | The RPC response. |
Overrides
UpdateUserAsync(UpdateUserRequest, CallSettings)
Updates a User object.
Declaration
public override Task<User> UpdateUserAsync(UpdateUserRequest request, CallSettings callSettings = null)
Parameters
| Type | Name | Description |
|---|---|---|
| UpdateUserRequest | request | The request object containing all of the parameters for the API call. |
| CallSettings | callSettings | If not null, applies overrides to this RPC call. |
Returns
| Type | Description |
|---|---|
| Task<User> | A Task containing the RPC response. |