Show / Hide Table of Contents

Class UserListServiceClientImpl

UserListService client wrapper implementation, for convenient use.

Inheritance
object
UserListServiceClient
UserListServiceClientImpl
Inherited Members
UserListServiceClient.DefaultEndpoint
UserListServiceClient.DefaultScopes
UserListServiceClient.ServiceMetadata
UserListServiceClient.CreateAsync(CancellationToken)
UserListServiceClient.Create()
UserListServiceClient.ShutdownDefaultChannelsAsync()
UserListServiceClient.GetUserListAsync(GetUserListRequest, CancellationToken)
UserListServiceClient.GetUserList(string, CallSettings)
UserListServiceClient.GetUserListAsync(string, CallSettings)
UserListServiceClient.GetUserListAsync(string, CancellationToken)
UserListServiceClient.GetUserList(UserListName, CallSettings)
UserListServiceClient.GetUserListAsync(UserListName, CallSettings)
UserListServiceClient.GetUserListAsync(UserListName, CancellationToken)
UserListServiceClient.ListUserLists(string, string, int?, CallSettings)
UserListServiceClient.ListUserListsAsync(string, string, int?, CallSettings)
UserListServiceClient.ListUserLists(AccountName, string, int?, CallSettings)
UserListServiceClient.ListUserListsAsync(AccountName, string, int?, CallSettings)
UserListServiceClient.CreateUserListAsync(CreateUserListRequest, CancellationToken)
UserListServiceClient.CreateUserList(string, UserList, CallSettings)
UserListServiceClient.CreateUserListAsync(string, UserList, CallSettings)
UserListServiceClient.CreateUserListAsync(string, UserList, CancellationToken)
UserListServiceClient.CreateUserList(AccountName, UserList, CallSettings)
UserListServiceClient.CreateUserListAsync(AccountName, UserList, CallSettings)
UserListServiceClient.CreateUserListAsync(AccountName, UserList, CancellationToken)
UserListServiceClient.UpdateUserListAsync(UpdateUserListRequest, CancellationToken)
UserListServiceClient.UpdateUserList(UserList, FieldMask, CallSettings)
UserListServiceClient.UpdateUserListAsync(UserList, FieldMask, CallSettings)
UserListServiceClient.UpdateUserListAsync(UserList, FieldMask, CancellationToken)
UserListServiceClient.DeleteUserListAsync(DeleteUserListRequest, CancellationToken)
UserListServiceClient.DeleteUserList(string, CallSettings)
UserListServiceClient.DeleteUserListAsync(string, CallSettings)
UserListServiceClient.DeleteUserListAsync(string, CancellationToken)
UserListServiceClient.DeleteUserList(UserListName, CallSettings)
UserListServiceClient.DeleteUserListAsync(UserListName, CallSettings)
UserListServiceClient.DeleteUserListAsync(UserListName, CancellationToken)
object.GetHashCode()
object.GetType()
object.ToString()
Namespace: Google.Ads.DataManager.V1
Assembly: Google.Ads.DataManager.V1.dll
Syntax
public sealed class UserListServiceClientImpl : UserListServiceClient
Remarks

Service for managing UserList resources.

Constructors

UserListServiceClientImpl(UserListServiceClient, UserListServiceSettings, ILogger)

Constructs a client wrapper for the UserListService service, with the specified gRPC client and settings.

Declaration
public UserListServiceClientImpl(UserListService.UserListServiceClient grpcClient, UserListServiceSettings settings, ILogger logger)
Parameters
Type Name Description
UserListService.UserListServiceClient grpcClient

The underlying gRPC client.

UserListServiceSettings settings

The base UserListServiceSettings used within this client.

ILogger logger

Optional ILogger to use within this client.

Properties

GrpcClient

The underlying gRPC UserListService client

Declaration
public override UserListService.UserListServiceClient GrpcClient { get; }
Property Value
Type Description
UserListService.UserListServiceClient
Overrides
UserListServiceClient.GrpcClient

Methods

CreateUserList(CreateUserListRequest, CallSettings)

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 override UserList CreateUserList(CreateUserListRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
CreateUserListRequest 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
UserList

The RPC response.

Overrides
UserListServiceClient.CreateUserList(CreateUserListRequest, CallSettings)

CreateUserListAsync(CreateUserListRequest, CallSettings)

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 override Task<UserList> CreateUserListAsync(CreateUserListRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
CreateUserListRequest 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<UserList>

A Task containing the RPC response.

Overrides
UserListServiceClient.CreateUserListAsync(CreateUserListRequest, CallSettings)

DeleteUserList(DeleteUserListRequest, CallSettings)

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 override void DeleteUserList(DeleteUserListRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
DeleteUserListRequest request

The request object containing all of the parameters for the API call.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Overrides
UserListServiceClient.DeleteUserList(DeleteUserListRequest, CallSettings)

DeleteUserListAsync(DeleteUserListRequest, CallSettings)

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 override Task DeleteUserListAsync(DeleteUserListRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
DeleteUserListRequest 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

A Task containing the RPC response.

Overrides
UserListServiceClient.DeleteUserListAsync(DeleteUserListRequest, CallSettings)

GetUserList(GetUserListRequest, CallSettings)

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 override UserList GetUserList(GetUserListRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
GetUserListRequest 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
UserList

The RPC response.

Overrides
UserListServiceClient.GetUserList(GetUserListRequest, CallSettings)

GetUserListAsync(GetUserListRequest, CallSettings)

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 override Task<UserList> GetUserListAsync(GetUserListRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
GetUserListRequest 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<UserList>

A Task containing the RPC response.

Overrides
UserListServiceClient.GetUserListAsync(GetUserListRequest, CallSettings)

ListUserLists(ListUserListsRequest, CallSettings)

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 override PagedEnumerable<ListUserListsResponse, UserList> ListUserLists(ListUserListsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ListUserListsRequest 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<ListUserListsResponse, UserList>

A pageable sequence of UserList resources.

Overrides
UserListServiceClient.ListUserLists(ListUserListsRequest, CallSettings)

ListUserListsAsync(ListUserListsRequest, CallSettings)

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 override PagedAsyncEnumerable<ListUserListsResponse, UserList> ListUserListsAsync(ListUserListsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ListUserListsRequest 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<ListUserListsResponse, UserList>

A pageable asynchronous sequence of UserList resources.

Overrides
UserListServiceClient.ListUserListsAsync(ListUserListsRequest, CallSettings)

UpdateUserList(UpdateUserListRequest, CallSettings)

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 override UserList UpdateUserList(UpdateUserListRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
UpdateUserListRequest 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
UserList

The RPC response.

Overrides
UserListServiceClient.UpdateUserList(UpdateUserListRequest, CallSettings)

UpdateUserListAsync(UpdateUserListRequest, CallSettings)

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 override Task<UserList> UpdateUserListAsync(UpdateUserListRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
UpdateUserListRequest 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<UserList>

A Task containing the RPC response.

Overrides
UserListServiceClient.UpdateUserListAsync(UpdateUserListRequest, CallSettings)
In this article
Back to top Generated by DocFX