Show / Hide Table of Contents

Class UserListService.UserListServiceBase

Base class for server-side implementations of UserListService

Inheritance
object
UserListService.UserListServiceBase
Inherited Members
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ToString()
Namespace: Google.Ads.DataManager.V1
Assembly: Google.Ads.DataManager.V1.dll
Syntax
[BindServiceMethod(typeof(UserListService), "BindService")]
public abstract class UserListService.UserListServiceBase

Methods

CreateUserList(CreateUserListRequest, ServerCallContext)

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 Task<UserList> CreateUserList(CreateUserListRequest request, ServerCallContext context)
Parameters
Type Name Description
CreateUserListRequest request

The request received from the client.

ServerCallContext context

The context of the server-side call handler being invoked.

Returns
Type Description
Task<UserList>

The response to send back to the client (wrapped by a task).

DeleteUserList(DeleteUserListRequest, ServerCallContext)

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 Task<Empty> DeleteUserList(DeleteUserListRequest request, ServerCallContext context)
Parameters
Type Name Description
DeleteUserListRequest request

The request received from the client.

ServerCallContext context

The context of the server-side call handler being invoked.

Returns
Type Description
Task<Empty>

The response to send back to the client (wrapped by a task).

GetUserList(GetUserListRequest, ServerCallContext)

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 Task<UserList> GetUserList(GetUserListRequest request, ServerCallContext context)
Parameters
Type Name Description
GetUserListRequest request

The request received from the client.

ServerCallContext context

The context of the server-side call handler being invoked.

Returns
Type Description
Task<UserList>

The response to send back to the client (wrapped by a task).

ListUserLists(ListUserListsRequest, ServerCallContext)

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 Task<ListUserListsResponse> ListUserLists(ListUserListsRequest request, ServerCallContext context)
Parameters
Type Name Description
ListUserListsRequest request

The request received from the client.

ServerCallContext context

The context of the server-side call handler being invoked.

Returns
Type Description
Task<ListUserListsResponse>

The response to send back to the client (wrapped by a task).

UpdateUserList(UpdateUserListRequest, ServerCallContext)

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 Task<UserList> UpdateUserList(UpdateUserListRequest request, ServerCallContext context)
Parameters
Type Name Description
UpdateUserListRequest request

The request received from the client.

ServerCallContext context

The context of the server-side call handler being invoked.

Returns
Type Description
Task<UserList>

The response to send back to the client (wrapped by a task).

In this article
Back to top Generated by DocFX