Class BuyersResource.UserListsResource

The "userLists" collection of methods.

Inheritance

object

BuyersResource.UserListsResource

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.RealTimeBidding.v1

Assembly: Google.Apis.RealTimeBidding.v1.dll

Syntax

public class BuyersResource.UserListsResource

Constructors

UserListsResource(IClientService)

Constructs a new resource.

Declaration

public UserListsResource(IClientService service)

Parameters

Type	Name	Description
IClientService	service

Methods

Close(CloseUserListRequest, string)

Changes the status of a user list to CLOSED. This prevents new users from being added to the user list.

Declaration

public virtual BuyersResource.UserListsResource.CloseRequest Close(CloseUserListRequest body, string name)

Parameters

Type	Name	Description
CloseUserListRequest	body	The body of the request.
string	name	Required. The name of the user list to close. See UserList.name

Returns

Type	Description
BuyersResource.UserListsResource.CloseRequest

Create(UserList, string)

Creates a new user list.

Declaration

public virtual BuyersResource.UserListsResource.CreateRequest Create(UserList body, string parent)

Parameters

Type	Name	Description
UserList	body	The body of the request.
string	parent	Required. The name of the parent buyer of the user list to be retrieved, which must follow the pattern buyers/{buyerAccountId}, where {buyerAccountId} represents the account ID of the buyer who owns the user list. For a bidder accessing user lists on behalf of a child seat buyer, {buyerAccountId} should represent the account ID of the child seat buyer.

Returns

Type	Description
BuyersResource.UserListsResource.CreateRequest

Get(string)

Gets a user list by its name.

Declaration

public virtual BuyersResource.UserListsResource.GetRequest Get(string name)

Parameters

Type	Name	Description
string	name	Required. The name of the user list to be retrieved. See UserList.name.

Returns

Type	Description
BuyersResource.UserListsResource.GetRequest

GetRemarketingTag(string)

This has been sunset as of October 2023, and will return an error response if called. For more information, see the release notes: https://developers.google.com/authorized-buyers/apis/relnotes#real-time-bidding-api Gets remarketing tag for a buyer. A remarketing tag is a piece of JavaScript code that can be placed on a web page. When a user visits a page containing a remarketing tag, Google adds the user to a user list.

Declaration

public virtual BuyersResource.UserListsResource.GetRemarketingTagRequest GetRemarketingTag(string name)

Parameters

Type	Name	Description
string	name	Required. To fetch the remarketing tag for an account, the name must follow the pattern buyers/{accountId}, where {accountId} represents the ID of the buyer that owns the remarketing tag. For a bidder accessing the remarketing tag on behalf of a child seat buyer, {accountId} should represent the ID of the child seat buyer. To fetch the remarketing tag for a specific user list, the name must follow the pattern buyers/{accountId}/userLists/{userListId}. See UserList.name.

Returns

Type	Description
BuyersResource.UserListsResource.GetRemarketingTagRequest

List(string)

Lists the user lists visible to the current user.

Declaration

public virtual BuyersResource.UserListsResource.ListRequest List(string parent)

Parameters

Type	Name	Description
string	parent	Required. The name of the parent buyer for the user lists to be returned that must follow the pattern buyers/{buyerAccountId}, where {buyerAccountId} represents the account ID of the buyer who owns user lists. For a bidder accessing user lists on behalf of a child seat buyer , {buyerAccountId} should represent the account ID of the child seat buyer.

Returns

Type	Description
BuyersResource.UserListsResource.ListRequest

Open(OpenUserListRequest, string)

Changes the status of a user list to OPEN. This allows new users to be added to the user list.

Declaration

public virtual BuyersResource.UserListsResource.OpenRequest Open(OpenUserListRequest body, string name)

Parameters

Type	Name	Description
OpenUserListRequest	body	The body of the request.
string	name	Required. The name of the user list to open. See UserList.name

Returns

Type	Description
BuyersResource.UserListsResource.OpenRequest

Update(UserList, string)

Updates the given user list. Only user lists with URLRestrictions can be updated.

Declaration

public virtual BuyersResource.UserListsResource.UpdateRequest Update(UserList body, string name)

Parameters

Type	Name	Description
UserList	body	The body of the request.
string	name	Output only. Name of the user list that must follow the pattern buyers/{buyer}/userLists/{user_list}, where {buyer} represents the account ID of the buyer who owns the user list. For a bidder accessing user lists on behalf of a child seat buyer, {buyer} represents the account ID of the child seat buyer. {user_list} is an int64 identifier assigned by Google to uniquely identify a user list.

Returns

Type	Description
BuyersResource.UserListsResource.UpdateRequest