Class UserListService.UserListServiceClient

Client for UserListService

Inheritance

object

ClientBase

ClientBase<UserListService.UserListServiceClient>

UserListService.UserListServiceClient

Inherited Members

ClientBase<UserListService.UserListServiceClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace: Google.Ads.DataManager.V1

Assembly: Google.Ads.DataManager.V1.dll

Syntax

public class UserListService.UserListServiceClient : ClientBase<UserListService.UserListServiceClient>

Constructors

UserListServiceClient()

Protected parameterless constructor to allow creation of test doubles.

Declaration

protected UserListServiceClient()

UserListServiceClient(CallInvoker)

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

Declaration

public UserListServiceClient(CallInvoker callInvoker)

Parameters

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

UserListServiceClient(ChannelBase)

Creates a new client for UserListService

Declaration

public UserListServiceClient(ChannelBase channel)

Parameters

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

UserListServiceClient(ClientBaseConfiguration)

Protected constructor to allow creation of configured clients.

Declaration

protected UserListServiceClient(ClientBase.ClientBaseConfiguration configuration)

Parameters

Type	Name	Description
ClientBase.ClientBaseConfiguration	configuration	The client configuration.

Methods

CreateUserList(CreateUserListRequest, CallOptions)

Creates a UserList.

Authorization Headers:

This method supports the following optional headers to define how the API authorizes access for the request:

• login-account: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format: accountTypes/{loginAccountType}/accounts/{loginAccountId}
• linked-account: (Optional) The resource name of the account with an established product link to the login-account. Format: accountTypes/{linkedAccountType}/accounts/{linkedAccountId}

Declaration

public virtual UserList CreateUserList(CreateUserListRequest request, CallOptions options)

Parameters

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

Returns

Type	Description
UserList	The response received from the server.

CreateUserList(CreateUserListRequest, Metadata, DateTime?, CancellationToken)

Creates a UserList.

Authorization Headers:

This method supports the following optional headers to define how the API authorizes access for the request:

• login-account: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format: accountTypes/{loginAccountType}/accounts/{loginAccountId}
• linked-account: (Optional) The resource name of the account with an established product link to the login-account. Format: accountTypes/{linkedAccountType}/accounts/{linkedAccountId}

Declaration

public virtual UserList CreateUserList(CreateUserListRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CreateUserListRequest	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
UserList	The response received from the server.

CreateUserListAsync(CreateUserListRequest, CallOptions)

Creates a UserList.

Authorization Headers:

This method supports the following optional headers to define how the API authorizes access for the request:

• login-account: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format: accountTypes/{loginAccountType}/accounts/{loginAccountId}
• linked-account: (Optional) The resource name of the account with an established product link to the login-account. Format: accountTypes/{linkedAccountType}/accounts/{linkedAccountId}

Declaration

public virtual AsyncUnaryCall<UserList> CreateUserListAsync(CreateUserListRequest request, CallOptions options)

Parameters

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

Returns

Type	Description
AsyncUnaryCall<UserList>	The call object.

CreateUserListAsync(CreateUserListRequest, Metadata, DateTime?, CancellationToken)

Creates a UserList.

Authorization Headers:

This method supports the following optional headers to define how the API authorizes access for the request:

• login-account: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format: accountTypes/{loginAccountType}/accounts/{loginAccountId}
• linked-account: (Optional) The resource name of the account with an established product link to the login-account. Format: accountTypes/{linkedAccountType}/accounts/{linkedAccountId}

Declaration

public virtual AsyncUnaryCall<UserList> CreateUserListAsync(CreateUserListRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CreateUserListRequest	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<UserList>	The call object.

DeleteUserList(DeleteUserListRequest, CallOptions)

Deletes a UserList.

Authorization Headers:

This method supports the following optional headers to define how the API authorizes access for the request:

• login-account: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format: accountTypes/{loginAccountType}/accounts/{loginAccountId}
• linked-account: (Optional) The resource name of the account with an established product link to the login-account. Format: accountTypes/{linkedAccountType}/accounts/{linkedAccountId}

Declaration

public virtual Empty DeleteUserList(DeleteUserListRequest request, CallOptions options)

Parameters

Type	Name	Description
DeleteUserListRequest	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.

DeleteUserList(DeleteUserListRequest, Metadata, DateTime?, CancellationToken)

Deletes a UserList.

Authorization Headers:

This method supports the following optional headers to define how the API authorizes access for the request:

• login-account: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format: accountTypes/{loginAccountType}/accounts/{loginAccountId}
• linked-account: (Optional) The resource name of the account with an established product link to the login-account. Format: accountTypes/{linkedAccountType}/accounts/{linkedAccountId}

Declaration

public virtual Empty DeleteUserList(DeleteUserListRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
DeleteUserListRequest	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.

DeleteUserListAsync(DeleteUserListRequest, CallOptions)

Deletes a UserList.

Authorization Headers:

This method supports the following optional headers to define how the API authorizes access for the request:

• login-account: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format: accountTypes/{loginAccountType}/accounts/{loginAccountId}
• linked-account: (Optional) The resource name of the account with an established product link to the login-account. Format: accountTypes/{linkedAccountType}/accounts/{linkedAccountId}

Declaration

public virtual AsyncUnaryCall<Empty> DeleteUserListAsync(DeleteUserListRequest request, CallOptions options)

Parameters

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

Returns

Type	Description
AsyncUnaryCall<Empty>	The call object.

DeleteUserListAsync(DeleteUserListRequest, Metadata, DateTime?, CancellationToken)

Deletes a UserList.

Authorization Headers:

This method supports the following optional headers to define how the API authorizes access for the request:

• login-account: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format: accountTypes/{loginAccountType}/accounts/{loginAccountId}
• linked-account: (Optional) The resource name of the account with an established product link to the login-account. Format: accountTypes/{linkedAccountType}/accounts/{linkedAccountId}

Declaration

public virtual AsyncUnaryCall<Empty> DeleteUserListAsync(DeleteUserListRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
DeleteUserListRequest	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.

GetUserList(GetUserListRequest, CallOptions)

Gets a UserList.

Authorization Headers:

This method supports the following optional headers to define how the API authorizes access for the request:

• login-account: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format: accountTypes/{loginAccountType}/accounts/{loginAccountId}
• linked-account: (Optional) The resource name of the account with an established product link to the login-account. Format: accountTypes/{linkedAccountType}/accounts/{linkedAccountId}

Declaration

public virtual UserList GetUserList(GetUserListRequest request, CallOptions options)

Parameters

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

Returns

Type	Description
UserList	The response received from the server.

GetUserList(GetUserListRequest, Metadata, DateTime?, CancellationToken)

Gets a UserList.

Authorization Headers:

This method supports the following optional headers to define how the API authorizes access for the request:

• login-account: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format: accountTypes/{loginAccountType}/accounts/{loginAccountId}
• linked-account: (Optional) The resource name of the account with an established product link to the login-account. Format: accountTypes/{linkedAccountType}/accounts/{linkedAccountId}

Declaration

public virtual UserList GetUserList(GetUserListRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
GetUserListRequest	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
UserList	The response received from the server.

GetUserListAsync(GetUserListRequest, CallOptions)

Gets a UserList.

Authorization Headers:

This method supports the following optional headers to define how the API authorizes access for the request:

• login-account: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format: accountTypes/{loginAccountType}/accounts/{loginAccountId}
• linked-account: (Optional) The resource name of the account with an established product link to the login-account. Format: accountTypes/{linkedAccountType}/accounts/{linkedAccountId}

Declaration

public virtual AsyncUnaryCall<UserList> GetUserListAsync(GetUserListRequest request, CallOptions options)

Parameters

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

Returns

Type	Description
AsyncUnaryCall<UserList>	The call object.

GetUserListAsync(GetUserListRequest, Metadata, DateTime?, CancellationToken)

Gets a UserList.

Authorization Headers:

This method supports the following optional headers to define how the API authorizes access for the request:

• login-account: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format: accountTypes/{loginAccountType}/accounts/{loginAccountId}
• linked-account: (Optional) The resource name of the account with an established product link to the login-account. Format: accountTypes/{linkedAccountType}/accounts/{linkedAccountId}

Declaration

public virtual AsyncUnaryCall<UserList> GetUserListAsync(GetUserListRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
GetUserListRequest	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<UserList>	The call object.

ListUserLists(ListUserListsRequest, CallOptions)

Lists UserLists.

Authorization Headers:

This method supports the following optional headers to define how the API authorizes access for the request:

• login-account: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format: accountTypes/{loginAccountType}/accounts/{loginAccountId}
• linked-account: (Optional) The resource name of the account with an established product link to the login-account. Format: accountTypes/{linkedAccountType}/accounts/{linkedAccountId}

Declaration

public virtual ListUserListsResponse ListUserLists(ListUserListsRequest request, CallOptions options)

Parameters

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

Returns

Type	Description
ListUserListsResponse	The response received from the server.

ListUserLists(ListUserListsRequest, Metadata, DateTime?, CancellationToken)

Lists UserLists.

Authorization Headers:

This method supports the following optional headers to define how the API authorizes access for the request:

• login-account: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format: accountTypes/{loginAccountType}/accounts/{loginAccountId}
• linked-account: (Optional) The resource name of the account with an established product link to the login-account. Format: accountTypes/{linkedAccountType}/accounts/{linkedAccountId}

Declaration

public virtual ListUserListsResponse ListUserLists(ListUserListsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListUserListsRequest	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
ListUserListsResponse	The response received from the server.

ListUserListsAsync(ListUserListsRequest, CallOptions)

Lists UserLists.

Authorization Headers:

This method supports the following optional headers to define how the API authorizes access for the request:

• login-account: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format: accountTypes/{loginAccountType}/accounts/{loginAccountId}
• linked-account: (Optional) The resource name of the account with an established product link to the login-account. Format: accountTypes/{linkedAccountType}/accounts/{linkedAccountId}

Declaration

public virtual AsyncUnaryCall<ListUserListsResponse> ListUserListsAsync(ListUserListsRequest request, CallOptions options)

Parameters

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

Returns

Type	Description
AsyncUnaryCall<ListUserListsResponse>	The call object.

ListUserListsAsync(ListUserListsRequest, Metadata, DateTime?, CancellationToken)

Lists UserLists.

Authorization Headers:

This method supports the following optional headers to define how the API authorizes access for the request:

• login-account: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format: accountTypes/{loginAccountType}/accounts/{loginAccountId}
• linked-account: (Optional) The resource name of the account with an established product link to the login-account. Format: accountTypes/{linkedAccountType}/accounts/{linkedAccountId}

Declaration

public virtual AsyncUnaryCall<ListUserListsResponse> ListUserListsAsync(ListUserListsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListUserListsRequest	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<ListUserListsResponse>	The call object.

NewInstance(ClientBaseConfiguration)

Creates a new instance of client from given ClientBaseConfiguration.

Declaration

protected override UserListService.UserListServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Parameters

Type	Name	Description
ClientBase.ClientBaseConfiguration	configuration

Returns

Type	Description
UserListService.UserListServiceClient

Overrides

Grpc.Core.ClientBase<Google.Ads.DataManager.V1.UserListService.UserListServiceClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

UpdateUserList(UpdateUserListRequest, CallOptions)

Updates a UserList.

Authorization Headers:

This method supports the following optional headers to define how the API authorizes access for the request:

• login-account: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format: accountTypes/{loginAccountType}/accounts/{loginAccountId}
• linked-account: (Optional) The resource name of the account with an established product link to the login-account. Format: accountTypes/{linkedAccountType}/accounts/{linkedAccountId}

Declaration

public virtual UserList UpdateUserList(UpdateUserListRequest request, CallOptions options)

Parameters

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

Returns

Type	Description
UserList	The response received from the server.

UpdateUserList(UpdateUserListRequest, Metadata, DateTime?, CancellationToken)

Updates a UserList.

Authorization Headers:

This method supports the following optional headers to define how the API authorizes access for the request:

• login-account: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format: accountTypes/{loginAccountType}/accounts/{loginAccountId}
• linked-account: (Optional) The resource name of the account with an established product link to the login-account. Format: accountTypes/{linkedAccountType}/accounts/{linkedAccountId}

Declaration

public virtual UserList UpdateUserList(UpdateUserListRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
UpdateUserListRequest	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
UserList	The response received from the server.

UpdateUserListAsync(UpdateUserListRequest, CallOptions)

Updates a UserList.

Authorization Headers:

This method supports the following optional headers to define how the API authorizes access for the request:

• login-account: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format: accountTypes/{loginAccountType}/accounts/{loginAccountId}
• linked-account: (Optional) The resource name of the account with an established product link to the login-account. Format: accountTypes/{linkedAccountType}/accounts/{linkedAccountId}

Declaration

public virtual AsyncUnaryCall<UserList> UpdateUserListAsync(UpdateUserListRequest request, CallOptions options)

Parameters

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

Returns

Type	Description
AsyncUnaryCall<UserList>	The call object.

UpdateUserListAsync(UpdateUserListRequest, Metadata, DateTime?, CancellationToken)

Updates a UserList.

Authorization Headers:

This method supports the following optional headers to define how the API authorizes access for the request:

• login-account: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format: accountTypes/{loginAccountType}/accounts/{loginAccountId}
• linked-account: (Optional) The resource name of the account with an established product link to the login-account. Format: accountTypes/{linkedAccountType}/accounts/{linkedAccountId}

Declaration

public virtual AsyncUnaryCall<UserList> UpdateUserListAsync(UpdateUserListRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
UpdateUserListRequest	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<UserList>	The call object.