Class UserService.UserServiceClient

Client for UserService

Inheritance

object

ClientBase

ClientBase<UserService.UserServiceClient>

UserService.UserServiceClient

Inherited Members

ClientBase<UserService.UserServiceClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace: Google.Ads.AdManager.V1

Assembly: Google.Ads.AdManager.V1.dll

Syntax

public class UserService.UserServiceClient : ClientBase<UserService.UserServiceClient>

Constructors

UserServiceClient()

Protected parameterless constructor to allow creation of test doubles.

Declaration

protected UserServiceClient()

UserServiceClient(CallInvoker)

Creates a new client for UserService that uses a custom CallInvoker.

Declaration

public UserServiceClient(CallInvoker callInvoker)

Parameters

Type	Name	Description
CallInvoker	callInvoker	The callInvoker to use to make remote calls.

UserServiceClient(ChannelBase)

Creates a new client for UserService

Declaration

public UserServiceClient(ChannelBase channel)

Parameters

Type	Name	Description
ChannelBase	channel	The channel to use to make remote calls.

UserServiceClient(ClientBaseConfiguration)

Protected constructor to allow creation of configured clients.

Declaration

protected UserServiceClient(ClientBase.ClientBaseConfiguration configuration)

Parameters

Type	Name	Description
ClientBase.ClientBaseConfiguration	configuration	The client configuration.

Methods

BatchActivateUsers(BatchActivateUsersRequest, CallOptions)

Activates a list of User objects.

Declaration

public virtual BatchActivateUsersResponse BatchActivateUsers(BatchActivateUsersRequest request, CallOptions options)

Parameters

Type	Name	Description
BatchActivateUsersRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
BatchActivateUsersResponse	The response received from the server.

BatchActivateUsers(BatchActivateUsersRequest, Metadata, DateTime?, CancellationToken)

Activates a list of User objects.

Declaration

public virtual BatchActivateUsersResponse BatchActivateUsers(BatchActivateUsersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
BatchActivateUsersRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
BatchActivateUsersResponse	The response received from the server.

BatchActivateUsersAsync(BatchActivateUsersRequest, CallOptions)

Activates a list of User objects.

Declaration

public virtual AsyncUnaryCall<BatchActivateUsersResponse> BatchActivateUsersAsync(BatchActivateUsersRequest request, CallOptions options)

Parameters

Type	Name	Description
BatchActivateUsersRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
AsyncUnaryCall<BatchActivateUsersResponse>	The call object.

BatchActivateUsersAsync(BatchActivateUsersRequest, Metadata, DateTime?, CancellationToken)

Activates a list of User objects.

Declaration

public virtual AsyncUnaryCall<BatchActivateUsersResponse> BatchActivateUsersAsync(BatchActivateUsersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
BatchActivateUsersRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
AsyncUnaryCall<BatchActivateUsersResponse>	The call object.

BatchCreateUsers(BatchCreateUsersRequest, CallOptions)

Creates User objects.

Declaration

public virtual BatchCreateUsersResponse BatchCreateUsers(BatchCreateUsersRequest request, CallOptions options)

Parameters

Type	Name	Description
BatchCreateUsersRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
BatchCreateUsersResponse	The response received from the server.

BatchCreateUsers(BatchCreateUsersRequest, Metadata, DateTime?, CancellationToken)

Creates User objects.

Declaration

public virtual BatchCreateUsersResponse BatchCreateUsers(BatchCreateUsersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
BatchCreateUsersRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
BatchCreateUsersResponse	The response received from the server.

BatchCreateUsersAsync(BatchCreateUsersRequest, CallOptions)

Creates User objects.

Declaration

public virtual AsyncUnaryCall<BatchCreateUsersResponse> BatchCreateUsersAsync(BatchCreateUsersRequest request, CallOptions options)

Parameters

Type	Name	Description
BatchCreateUsersRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
AsyncUnaryCall<BatchCreateUsersResponse>	The call object.

BatchCreateUsersAsync(BatchCreateUsersRequest, Metadata, DateTime?, CancellationToken)

Creates User objects.

Declaration

public virtual AsyncUnaryCall<BatchCreateUsersResponse> BatchCreateUsersAsync(BatchCreateUsersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
BatchCreateUsersRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
AsyncUnaryCall<BatchCreateUsersResponse>	The call object.

BatchDeactivateUsers(BatchDeactivateUsersRequest, CallOptions)

Deactivates a list of User objects.

Declaration

public virtual BatchDeactivateUsersResponse BatchDeactivateUsers(BatchDeactivateUsersRequest request, CallOptions options)

Parameters

Type	Name	Description
BatchDeactivateUsersRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
BatchDeactivateUsersResponse	The response received from the server.

BatchDeactivateUsers(BatchDeactivateUsersRequest, Metadata, DateTime?, CancellationToken)

Deactivates a list of User objects.

Declaration

public virtual BatchDeactivateUsersResponse BatchDeactivateUsers(BatchDeactivateUsersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
BatchDeactivateUsersRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
BatchDeactivateUsersResponse	The response received from the server.

BatchDeactivateUsersAsync(BatchDeactivateUsersRequest, CallOptions)

Deactivates a list of User objects.

Declaration

public virtual AsyncUnaryCall<BatchDeactivateUsersResponse> BatchDeactivateUsersAsync(BatchDeactivateUsersRequest request, CallOptions options)

Parameters

Type	Name	Description
BatchDeactivateUsersRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
AsyncUnaryCall<BatchDeactivateUsersResponse>	The call object.

BatchDeactivateUsersAsync(BatchDeactivateUsersRequest, Metadata, DateTime?, CancellationToken)

Deactivates a list of User objects.

Declaration

public virtual AsyncUnaryCall<BatchDeactivateUsersResponse> BatchDeactivateUsersAsync(BatchDeactivateUsersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
BatchDeactivateUsersRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
AsyncUnaryCall<BatchDeactivateUsersResponse>	The call object.

BatchUpdateUsers(BatchUpdateUsersRequest, CallOptions)

Batch updates User objects.

Declaration

public virtual BatchUpdateUsersResponse BatchUpdateUsers(BatchUpdateUsersRequest request, CallOptions options)

Parameters

Type	Name	Description
BatchUpdateUsersRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
BatchUpdateUsersResponse	The response received from the server.

BatchUpdateUsers(BatchUpdateUsersRequest, Metadata, DateTime?, CancellationToken)

Batch updates User objects.

Declaration

public virtual BatchUpdateUsersResponse BatchUpdateUsers(BatchUpdateUsersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
BatchUpdateUsersRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
BatchUpdateUsersResponse	The response received from the server.

BatchUpdateUsersAsync(BatchUpdateUsersRequest, CallOptions)

Batch updates User objects.

Declaration

public virtual AsyncUnaryCall<BatchUpdateUsersResponse> BatchUpdateUsersAsync(BatchUpdateUsersRequest request, CallOptions options)

Parameters

Type	Name	Description
BatchUpdateUsersRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
AsyncUnaryCall<BatchUpdateUsersResponse>	The call object.

BatchUpdateUsersAsync(BatchUpdateUsersRequest, Metadata, DateTime?, CancellationToken)

Batch updates User objects.

Declaration

public virtual AsyncUnaryCall<BatchUpdateUsersResponse> BatchUpdateUsersAsync(BatchUpdateUsersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
BatchUpdateUsersRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
AsyncUnaryCall<BatchUpdateUsersResponse>	The call object.

CreateUser(CreateUserRequest, CallOptions)

Creates a User object.

Declaration

public virtual User CreateUser(CreateUserRequest request, CallOptions options)

Parameters

Type	Name	Description
CreateUserRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
User	The response received from the server.

CreateUser(CreateUserRequest, Metadata, DateTime?, CancellationToken)

Creates a User object.

Declaration

public virtual User CreateUser(CreateUserRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CreateUserRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
User	The response received from the server.

CreateUserAsync(CreateUserRequest, CallOptions)

Creates a User object.

Declaration

public virtual AsyncUnaryCall<User> CreateUserAsync(CreateUserRequest request, CallOptions options)

Parameters

Type	Name	Description
CreateUserRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
AsyncUnaryCall<User>	The call object.

CreateUserAsync(CreateUserRequest, Metadata, DateTime?, CancellationToken)

Creates a User object.

Declaration

public virtual AsyncUnaryCall<User> CreateUserAsync(CreateUserRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CreateUserRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
AsyncUnaryCall<User>	The call object.

GetUser(GetUserRequest, CallOptions)

Retrieves a User object.

To get the current user, the resource name networks/{networkCode}/users/me can be used.

Declaration

public virtual User GetUser(GetUserRequest request, CallOptions options)

Parameters

Type	Name	Description
GetUserRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
User	The response received from the server.

GetUser(GetUserRequest, Metadata, DateTime?, CancellationToken)

Retrieves a User object.

To get the current user, the resource name networks/{networkCode}/users/me can be used.

Declaration

public virtual User GetUser(GetUserRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
GetUserRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
User	The response received from the server.

GetUserAsync(GetUserRequest, CallOptions)

Retrieves a User object.

To get the current user, the resource name networks/{networkCode}/users/me can be used.

Declaration

public virtual AsyncUnaryCall<User> GetUserAsync(GetUserRequest request, CallOptions options)

Parameters

Type	Name	Description
GetUserRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
AsyncUnaryCall<User>	The call object.

GetUserAsync(GetUserRequest, Metadata, DateTime?, CancellationToken)

Retrieves a User object.

To get the current user, the resource name networks/{networkCode}/users/me can be used.

Declaration

public virtual AsyncUnaryCall<User> GetUserAsync(GetUserRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
GetUserRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
AsyncUnaryCall<User>	The call object.

ListUsers(ListUsersRequest, CallOptions)

Lists User objects.

Declaration

public virtual ListUsersResponse ListUsers(ListUsersRequest request, CallOptions options)

Parameters

Type	Name	Description
ListUsersRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
ListUsersResponse	The response received from the server.

ListUsers(ListUsersRequest, Metadata, DateTime?, CancellationToken)

Lists User objects.

Declaration

public virtual ListUsersResponse ListUsers(ListUsersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListUsersRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
ListUsersResponse	The response received from the server.

ListUsersAsync(ListUsersRequest, CallOptions)

Lists User objects.

Declaration

public virtual AsyncUnaryCall<ListUsersResponse> ListUsersAsync(ListUsersRequest request, CallOptions options)

Parameters

Type	Name	Description
ListUsersRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
AsyncUnaryCall<ListUsersResponse>	The call object.

ListUsersAsync(ListUsersRequest, Metadata, DateTime?, CancellationToken)

Lists User objects.

Declaration

public virtual AsyncUnaryCall<ListUsersResponse> ListUsersAsync(ListUsersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListUsersRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
AsyncUnaryCall<ListUsersResponse>	The call object.

NewInstance(ClientBaseConfiguration)

Creates a new instance of client from given ClientBaseConfiguration.

Declaration

protected override UserService.UserServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Parameters

Type	Name	Description
ClientBase.ClientBaseConfiguration	configuration

Returns

Type	Description
UserService.UserServiceClient

Overrides

Grpc.Core.ClientBase<Google.Ads.AdManager.V1.UserService.UserServiceClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

UpdateUser(UpdateUserRequest, CallOptions)

Updates a User object.

Declaration

public virtual User UpdateUser(UpdateUserRequest request, CallOptions options)

Parameters

Type	Name	Description
UpdateUserRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
User	The response received from the server.

UpdateUser(UpdateUserRequest, Metadata, DateTime?, CancellationToken)

Updates a User object.

Declaration

public virtual User UpdateUser(UpdateUserRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
UpdateUserRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
User	The response received from the server.

UpdateUserAsync(UpdateUserRequest, CallOptions)

Updates a User object.

Declaration

public virtual AsyncUnaryCall<User> UpdateUserAsync(UpdateUserRequest request, CallOptions options)

Parameters

Type	Name	Description
UpdateUserRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
AsyncUnaryCall<User>	The call object.

UpdateUserAsync(UpdateUserRequest, Metadata, DateTime?, CancellationToken)

Updates a User object.

Declaration

public virtual AsyncUnaryCall<User> UpdateUserAsync(UpdateUserRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
UpdateUserRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
AsyncUnaryCall<User>	The call object.