Show / Hide Table of Contents

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.Shopping.Merchant.Accounts.V1
Assembly: Google.Shopping.Merchant.Accounts.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

CreateUser(CreateUserRequest, CallOptions)

Creates a Merchant Center account user. Executing this method requires admin access.

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 Merchant Center account user. Executing this method requires admin access.

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 Merchant Center account user. Executing this method requires admin access.

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 Merchant Center account user. Executing this method requires admin access.

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.

DeleteUser(DeleteUserRequest, CallOptions)

Deletes a Merchant Center account user. Executing this method requires admin access. The user to be deleted can't be the last admin user of that account. Also a user is protected from deletion if it is managed by Business Manager"

Declaration
public virtual Empty DeleteUser(DeleteUserRequest request, CallOptions options)
Parameters
Type Name Description
DeleteUserRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
Empty

The response received from the server.

DeleteUser(DeleteUserRequest, Metadata, DateTime?, CancellationToken)

Deletes a Merchant Center account user. Executing this method requires admin access. The user to be deleted can't be the last admin user of that account. Also a user is protected from deletion if it is managed by Business Manager"

Declaration
public virtual Empty DeleteUser(DeleteUserRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
DeleteUserRequest 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
Empty

The response received from the server.

DeleteUserAsync(DeleteUserRequest, CallOptions)

Deletes a Merchant Center account user. Executing this method requires admin access. The user to be deleted can't be the last admin user of that account. Also a user is protected from deletion if it is managed by Business Manager"

Declaration
public virtual AsyncUnaryCall<Empty> DeleteUserAsync(DeleteUserRequest request, CallOptions options)
Parameters
Type Name Description
DeleteUserRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
AsyncUnaryCall<Empty>

The call object.

DeleteUserAsync(DeleteUserRequest, Metadata, DateTime?, CancellationToken)

Deletes a Merchant Center account user. Executing this method requires admin access. The user to be deleted can't be the last admin user of that account. Also a user is protected from deletion if it is managed by Business Manager"

Declaration
public virtual AsyncUnaryCall<Empty> DeleteUserAsync(DeleteUserRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
DeleteUserRequest 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<Empty>

The call object.

GetUser(GetUserRequest, CallOptions)

Retrieves a Merchant Center account user.

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 Merchant Center account user.

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 Merchant Center account user.

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 Merchant Center account user.

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 all users of a Merchant Center account.

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 all users of a Merchant Center account.

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 all users of a Merchant Center account.

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 all users of a Merchant Center account.

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.Shopping.Merchant.Accounts.V1.UserService.UserServiceClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

UpdateUser(UpdateUserRequest, CallOptions)

Updates a Merchant Center account user. Executing this method requires admin access.

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 Merchant Center account user. Executing this method requires admin access.

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 Merchant Center account user. Executing this method requires admin access.

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 Merchant Center account user. Executing this method requires admin access.

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.

In this article
Back to top Generated by DocFX