Show / Hide Table of Contents

Class UserListDirectLicenseServiceClient

UserListDirectLicenseService client wrapper, for convenient use.

Inheritance
object
UserListDirectLicenseServiceClient
UserListDirectLicenseServiceClientImpl
Inherited Members
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ToString()
Namespace: Google.Ads.DataManager.V1
Assembly: Google.Ads.DataManager.V1.dll
Syntax
public abstract class UserListDirectLicenseServiceClient
Remarks

Service for managing user list direct licenses. Delete is not a supported operation for UserListDirectLicenses. Callers should update the license status to DISABLED to instead to deactivate a license.

This feature is only available to data partners.

Properties

DefaultEndpoint

The default endpoint for the UserListDirectLicenseService service, which is a host of "datamanager.googleapis.com" and a port of 443.

Declaration
public static string DefaultEndpoint { get; }
Property Value
Type Description
string

DefaultScopes

The default UserListDirectLicenseService scopes.

Declaration
public static IReadOnlyList<string> DefaultScopes { get; }
Property Value
Type Description
IReadOnlyList<string>
Remarks

The default UserListDirectLicenseService scopes are:

  • https://www.googleapis.com/auth/datamanager

GrpcClient

The underlying gRPC UserListDirectLicenseService client

Declaration
public virtual UserListDirectLicenseService.UserListDirectLicenseServiceClient GrpcClient { get; }
Property Value
Type Description
UserListDirectLicenseService.UserListDirectLicenseServiceClient

ServiceMetadata

The service metadata associated with this client type.

Declaration
public static ServiceMetadata ServiceMetadata { get; }
Property Value
Type Description
ServiceMetadata

Methods

Create()

Synchronously creates a UserListDirectLicenseServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use UserListDirectLicenseServiceClientBuilder.

Declaration
public static UserListDirectLicenseServiceClient Create()
Returns
Type Description
UserListDirectLicenseServiceClient

The created UserListDirectLicenseServiceClient.

CreateAsync(CancellationToken)

Asynchronously creates a UserListDirectLicenseServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use UserListDirectLicenseServiceClientBuilder.

Declaration
public static Task<UserListDirectLicenseServiceClient> CreateAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken

The CancellationToken to use while creating the client.

Returns
Type Description
Task<UserListDirectLicenseServiceClient>

The task representing the created UserListDirectLicenseServiceClient.

CreateUserListDirectLicense(AccountName, UserListDirectLicense, CallSettings)

Creates a user list direct license.

This feature is only available to data partners.

Declaration
public virtual UserListDirectLicense CreateUserListDirectLicense(AccountName parent, UserListDirectLicense userListDirectLicense, CallSettings callSettings = null)
Parameters
Type Name Description
AccountName parent

Required. The account that owns the user list being licensed. Should be in the format accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}

UserListDirectLicense userListDirectLicense

Required. The user list direct license to create.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
UserListDirectLicense

The RPC response.

Sample code
// Create client
UserListDirectLicenseServiceClient userListDirectLicenseServiceClient = UserListDirectLicenseServiceClient.Create();
// Initialize request argument(s)
AccountName parent = AccountName.FromAccountTypeAccount("[ACCOUNT_TYPE]", "[ACCOUNT]");
UserListDirectLicense userListDirectLicense = new UserListDirectLicense();
// Make the request
UserListDirectLicense response = userListDirectLicenseServiceClient.CreateUserListDirectLicense(parent, userListDirectLicense);

CreateUserListDirectLicense(CreateUserListDirectLicenseRequest, CallSettings)

Creates a user list direct license.

This feature is only available to data partners.

Declaration
public virtual UserListDirectLicense CreateUserListDirectLicense(CreateUserListDirectLicenseRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
CreateUserListDirectLicenseRequest 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
UserListDirectLicense

The RPC response.

Sample code
// Create client
UserListDirectLicenseServiceClient userListDirectLicenseServiceClient = UserListDirectLicenseServiceClient.Create();
// Initialize request argument(s)
CreateUserListDirectLicenseRequest request = new CreateUserListDirectLicenseRequest
{
    ParentAsAccountName = AccountName.FromAccountTypeAccount("[ACCOUNT_TYPE]", "[ACCOUNT]"),
    UserListDirectLicense = new UserListDirectLicense(),
};
// Make the request
UserListDirectLicense response = userListDirectLicenseServiceClient.CreateUserListDirectLicense(request);

CreateUserListDirectLicense(string, UserListDirectLicense, CallSettings)

Creates a user list direct license.

This feature is only available to data partners.

Declaration
public virtual UserListDirectLicense CreateUserListDirectLicense(string parent, UserListDirectLicense userListDirectLicense, CallSettings callSettings = null)
Parameters
Type Name Description
string parent

Required. The account that owns the user list being licensed. Should be in the format accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}

UserListDirectLicense userListDirectLicense

Required. The user list direct license to create.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
UserListDirectLicense

The RPC response.

Sample code
// Create client
UserListDirectLicenseServiceClient userListDirectLicenseServiceClient = UserListDirectLicenseServiceClient.Create();
// Initialize request argument(s)
string parent = "accountTypes/[ACCOUNT_TYPE]/accounts/[ACCOUNT]";
UserListDirectLicense userListDirectLicense = new UserListDirectLicense();
// Make the request
UserListDirectLicense response = userListDirectLicenseServiceClient.CreateUserListDirectLicense(parent, userListDirectLicense);

CreateUserListDirectLicenseAsync(AccountName, UserListDirectLicense, CallSettings)

Creates a user list direct license.

This feature is only available to data partners.

Declaration
public virtual Task<UserListDirectLicense> CreateUserListDirectLicenseAsync(AccountName parent, UserListDirectLicense userListDirectLicense, CallSettings callSettings = null)
Parameters
Type Name Description
AccountName parent

Required. The account that owns the user list being licensed. Should be in the format accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}

UserListDirectLicense userListDirectLicense

Required. The user list direct license to create.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task<UserListDirectLicense>

A Task containing the RPC response.

Sample code
// Create client
UserListDirectLicenseServiceClient userListDirectLicenseServiceClient = await UserListDirectLicenseServiceClient.CreateAsync();
// Initialize request argument(s)
AccountName parent = AccountName.FromAccountTypeAccount("[ACCOUNT_TYPE]", "[ACCOUNT]");
UserListDirectLicense userListDirectLicense = new UserListDirectLicense();
// Make the request
UserListDirectLicense response = await userListDirectLicenseServiceClient.CreateUserListDirectLicenseAsync(parent, userListDirectLicense);

CreateUserListDirectLicenseAsync(AccountName, UserListDirectLicense, CancellationToken)

Creates a user list direct license.

This feature is only available to data partners.

Declaration
public virtual Task<UserListDirectLicense> CreateUserListDirectLicenseAsync(AccountName parent, UserListDirectLicense userListDirectLicense, CancellationToken cancellationToken)
Parameters
Type Name Description
AccountName parent

Required. The account that owns the user list being licensed. Should be in the format accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}

UserListDirectLicense userListDirectLicense

Required. The user list direct license to create.

CancellationToken cancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task<UserListDirectLicense>

A Task containing the RPC response.

Sample code
// Create client
UserListDirectLicenseServiceClient userListDirectLicenseServiceClient = await UserListDirectLicenseServiceClient.CreateAsync();
// Initialize request argument(s)
AccountName parent = AccountName.FromAccountTypeAccount("[ACCOUNT_TYPE]", "[ACCOUNT]");
UserListDirectLicense userListDirectLicense = new UserListDirectLicense();
// Make the request
UserListDirectLicense response = await userListDirectLicenseServiceClient.CreateUserListDirectLicenseAsync(parent, userListDirectLicense);

CreateUserListDirectLicenseAsync(CreateUserListDirectLicenseRequest, CallSettings)

Creates a user list direct license.

This feature is only available to data partners.

Declaration
public virtual Task<UserListDirectLicense> CreateUserListDirectLicenseAsync(CreateUserListDirectLicenseRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
CreateUserListDirectLicenseRequest 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<UserListDirectLicense>

A Task containing the RPC response.

Sample code
// Create client
UserListDirectLicenseServiceClient userListDirectLicenseServiceClient = await UserListDirectLicenseServiceClient.CreateAsync();
// Initialize request argument(s)
CreateUserListDirectLicenseRequest request = new CreateUserListDirectLicenseRequest
{
    ParentAsAccountName = AccountName.FromAccountTypeAccount("[ACCOUNT_TYPE]", "[ACCOUNT]"),
    UserListDirectLicense = new UserListDirectLicense(),
};
// Make the request
UserListDirectLicense response = await userListDirectLicenseServiceClient.CreateUserListDirectLicenseAsync(request);

CreateUserListDirectLicenseAsync(CreateUserListDirectLicenseRequest, CancellationToken)

Creates a user list direct license.

This feature is only available to data partners.

Declaration
public virtual Task<UserListDirectLicense> CreateUserListDirectLicenseAsync(CreateUserListDirectLicenseRequest request, CancellationToken cancellationToken)
Parameters
Type Name Description
CreateUserListDirectLicenseRequest request

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

CancellationToken cancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task<UserListDirectLicense>

A Task containing the RPC response.

Sample code
// Create client
UserListDirectLicenseServiceClient userListDirectLicenseServiceClient = await UserListDirectLicenseServiceClient.CreateAsync();
// Initialize request argument(s)
CreateUserListDirectLicenseRequest request = new CreateUserListDirectLicenseRequest
{
    ParentAsAccountName = AccountName.FromAccountTypeAccount("[ACCOUNT_TYPE]", "[ACCOUNT]"),
    UserListDirectLicense = new UserListDirectLicense(),
};
// Make the request
UserListDirectLicense response = await userListDirectLicenseServiceClient.CreateUserListDirectLicenseAsync(request);

CreateUserListDirectLicenseAsync(string, UserListDirectLicense, CallSettings)

Creates a user list direct license.

This feature is only available to data partners.

Declaration
public virtual Task<UserListDirectLicense> CreateUserListDirectLicenseAsync(string parent, UserListDirectLicense userListDirectLicense, CallSettings callSettings = null)
Parameters
Type Name Description
string parent

Required. The account that owns the user list being licensed. Should be in the format accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}

UserListDirectLicense userListDirectLicense

Required. The user list direct license to create.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task<UserListDirectLicense>

A Task containing the RPC response.

Sample code
// Create client
UserListDirectLicenseServiceClient userListDirectLicenseServiceClient = await UserListDirectLicenseServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "accountTypes/[ACCOUNT_TYPE]/accounts/[ACCOUNT]";
UserListDirectLicense userListDirectLicense = new UserListDirectLicense();
// Make the request
UserListDirectLicense response = await userListDirectLicenseServiceClient.CreateUserListDirectLicenseAsync(parent, userListDirectLicense);

CreateUserListDirectLicenseAsync(string, UserListDirectLicense, CancellationToken)

Creates a user list direct license.

This feature is only available to data partners.

Declaration
public virtual Task<UserListDirectLicense> CreateUserListDirectLicenseAsync(string parent, UserListDirectLicense userListDirectLicense, CancellationToken cancellationToken)
Parameters
Type Name Description
string parent

Required. The account that owns the user list being licensed. Should be in the format accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}

UserListDirectLicense userListDirectLicense

Required. The user list direct license to create.

CancellationToken cancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task<UserListDirectLicense>

A Task containing the RPC response.

Sample code
// Create client
UserListDirectLicenseServiceClient userListDirectLicenseServiceClient = await UserListDirectLicenseServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "accountTypes/[ACCOUNT_TYPE]/accounts/[ACCOUNT]";
UserListDirectLicense userListDirectLicense = new UserListDirectLicense();
// Make the request
UserListDirectLicense response = await userListDirectLicenseServiceClient.CreateUserListDirectLicenseAsync(parent, userListDirectLicense);

GetUserListDirectLicense(GetUserListDirectLicenseRequest, CallSettings)

Retrieves a user list direct license.

This feature is only available to data partners.

Declaration
public virtual UserListDirectLicense GetUserListDirectLicense(GetUserListDirectLicenseRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
GetUserListDirectLicenseRequest 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
UserListDirectLicense

The RPC response.

Sample code
// Create client
UserListDirectLicenseServiceClient userListDirectLicenseServiceClient = UserListDirectLicenseServiceClient.Create();
// Initialize request argument(s)
GetUserListDirectLicenseRequest request = new GetUserListDirectLicenseRequest
{
    UserListDirectLicenseName = UserListDirectLicenseName.FromAccountTypeAccountUserListDirectLicense("[ACCOUNT_TYPE]", "[ACCOUNT]", "[USER_LIST_DIRECT_LICENSE]"),
};
// Make the request
UserListDirectLicense response = userListDirectLicenseServiceClient.GetUserListDirectLicense(request);

GetUserListDirectLicense(UserListDirectLicenseName, CallSettings)

Retrieves a user list direct license.

This feature is only available to data partners.

Declaration
public virtual UserListDirectLicense GetUserListDirectLicense(UserListDirectLicenseName name, CallSettings callSettings = null)
Parameters
Type Name Description
UserListDirectLicenseName name

Required. The resource name of the user list direct license.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
UserListDirectLicense

The RPC response.

Sample code
// Create client
UserListDirectLicenseServiceClient userListDirectLicenseServiceClient = UserListDirectLicenseServiceClient.Create();
// Initialize request argument(s)
UserListDirectLicenseName name = UserListDirectLicenseName.FromAccountTypeAccountUserListDirectLicense("[ACCOUNT_TYPE]", "[ACCOUNT]", "[USER_LIST_DIRECT_LICENSE]");
// Make the request
UserListDirectLicense response = userListDirectLicenseServiceClient.GetUserListDirectLicense(name);

GetUserListDirectLicense(string, CallSettings)

Retrieves a user list direct license.

This feature is only available to data partners.

Declaration
public virtual UserListDirectLicense GetUserListDirectLicense(string name, CallSettings callSettings = null)
Parameters
Type Name Description
string name

Required. The resource name of the user list direct license.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
UserListDirectLicense

The RPC response.

Sample code
// Create client
UserListDirectLicenseServiceClient userListDirectLicenseServiceClient = UserListDirectLicenseServiceClient.Create();
// Initialize request argument(s)
string name = "accountTypes/[ACCOUNT_TYPE]/accounts/[ACCOUNT]/userListDirectLicenses/[USER_LIST_DIRECT_LICENSE]";
// Make the request
UserListDirectLicense response = userListDirectLicenseServiceClient.GetUserListDirectLicense(name);

GetUserListDirectLicenseAsync(GetUserListDirectLicenseRequest, CallSettings)

Retrieves a user list direct license.

This feature is only available to data partners.

Declaration
public virtual Task<UserListDirectLicense> GetUserListDirectLicenseAsync(GetUserListDirectLicenseRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
GetUserListDirectLicenseRequest 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<UserListDirectLicense>

A Task containing the RPC response.

Sample code
// Create client
UserListDirectLicenseServiceClient userListDirectLicenseServiceClient = await UserListDirectLicenseServiceClient.CreateAsync();
// Initialize request argument(s)
GetUserListDirectLicenseRequest request = new GetUserListDirectLicenseRequest
{
    UserListDirectLicenseName = UserListDirectLicenseName.FromAccountTypeAccountUserListDirectLicense("[ACCOUNT_TYPE]", "[ACCOUNT]", "[USER_LIST_DIRECT_LICENSE]"),
};
// Make the request
UserListDirectLicense response = await userListDirectLicenseServiceClient.GetUserListDirectLicenseAsync(request);

GetUserListDirectLicenseAsync(GetUserListDirectLicenseRequest, CancellationToken)

Retrieves a user list direct license.

This feature is only available to data partners.

Declaration
public virtual Task<UserListDirectLicense> GetUserListDirectLicenseAsync(GetUserListDirectLicenseRequest request, CancellationToken cancellationToken)
Parameters
Type Name Description
GetUserListDirectLicenseRequest request

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

CancellationToken cancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task<UserListDirectLicense>

A Task containing the RPC response.

Sample code
// Create client
UserListDirectLicenseServiceClient userListDirectLicenseServiceClient = await UserListDirectLicenseServiceClient.CreateAsync();
// Initialize request argument(s)
GetUserListDirectLicenseRequest request = new GetUserListDirectLicenseRequest
{
    UserListDirectLicenseName = UserListDirectLicenseName.FromAccountTypeAccountUserListDirectLicense("[ACCOUNT_TYPE]", "[ACCOUNT]", "[USER_LIST_DIRECT_LICENSE]"),
};
// Make the request
UserListDirectLicense response = await userListDirectLicenseServiceClient.GetUserListDirectLicenseAsync(request);

GetUserListDirectLicenseAsync(UserListDirectLicenseName, CallSettings)

Retrieves a user list direct license.

This feature is only available to data partners.

Declaration
public virtual Task<UserListDirectLicense> GetUserListDirectLicenseAsync(UserListDirectLicenseName name, CallSettings callSettings = null)
Parameters
Type Name Description
UserListDirectLicenseName name

Required. The resource name of the user list direct license.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task<UserListDirectLicense>

A Task containing the RPC response.

Sample code
// Create client
UserListDirectLicenseServiceClient userListDirectLicenseServiceClient = await UserListDirectLicenseServiceClient.CreateAsync();
// Initialize request argument(s)
UserListDirectLicenseName name = UserListDirectLicenseName.FromAccountTypeAccountUserListDirectLicense("[ACCOUNT_TYPE]", "[ACCOUNT]", "[USER_LIST_DIRECT_LICENSE]");
// Make the request
UserListDirectLicense response = await userListDirectLicenseServiceClient.GetUserListDirectLicenseAsync(name);

GetUserListDirectLicenseAsync(UserListDirectLicenseName, CancellationToken)

Retrieves a user list direct license.

This feature is only available to data partners.

Declaration
public virtual Task<UserListDirectLicense> GetUserListDirectLicenseAsync(UserListDirectLicenseName name, CancellationToken cancellationToken)
Parameters
Type Name Description
UserListDirectLicenseName name

Required. The resource name of the user list direct license.

CancellationToken cancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task<UserListDirectLicense>

A Task containing the RPC response.

Sample code
// Create client
UserListDirectLicenseServiceClient userListDirectLicenseServiceClient = await UserListDirectLicenseServiceClient.CreateAsync();
// Initialize request argument(s)
UserListDirectLicenseName name = UserListDirectLicenseName.FromAccountTypeAccountUserListDirectLicense("[ACCOUNT_TYPE]", "[ACCOUNT]", "[USER_LIST_DIRECT_LICENSE]");
// Make the request
UserListDirectLicense response = await userListDirectLicenseServiceClient.GetUserListDirectLicenseAsync(name);

GetUserListDirectLicenseAsync(string, CallSettings)

Retrieves a user list direct license.

This feature is only available to data partners.

Declaration
public virtual Task<UserListDirectLicense> GetUserListDirectLicenseAsync(string name, CallSettings callSettings = null)
Parameters
Type Name Description
string name

Required. The resource name of the user list direct license.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task<UserListDirectLicense>

A Task containing the RPC response.

Sample code
// Create client
UserListDirectLicenseServiceClient userListDirectLicenseServiceClient = await UserListDirectLicenseServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "accountTypes/[ACCOUNT_TYPE]/accounts/[ACCOUNT]/userListDirectLicenses/[USER_LIST_DIRECT_LICENSE]";
// Make the request
UserListDirectLicense response = await userListDirectLicenseServiceClient.GetUserListDirectLicenseAsync(name);

GetUserListDirectLicenseAsync(string, CancellationToken)

Retrieves a user list direct license.

This feature is only available to data partners.

Declaration
public virtual Task<UserListDirectLicense> GetUserListDirectLicenseAsync(string name, CancellationToken cancellationToken)
Parameters
Type Name Description
string name

Required. The resource name of the user list direct license.

CancellationToken cancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task<UserListDirectLicense>

A Task containing the RPC response.

Sample code
// Create client
UserListDirectLicenseServiceClient userListDirectLicenseServiceClient = await UserListDirectLicenseServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "accountTypes/[ACCOUNT_TYPE]/accounts/[ACCOUNT]/userListDirectLicenses/[USER_LIST_DIRECT_LICENSE]";
// Make the request
UserListDirectLicense response = await userListDirectLicenseServiceClient.GetUserListDirectLicenseAsync(name);

ListUserListDirectLicenses(AccountName, string, int?, CallSettings)

Lists all user list direct licenses owned by the parent account.

This feature is only available to data partners.

Declaration
public virtual PagedEnumerable<ListUserListDirectLicensesResponse, UserListDirectLicense> ListUserListDirectLicenses(AccountName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Parameters
Type Name Description
AccountName parent

Required. The account whose licenses are being queried. Should be in the format accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}

string pageToken

The token returned from the previous request. A value of null or an empty string retrieves the first page.

int? pageSize

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerable<ListUserListDirectLicensesResponse, UserListDirectLicense>

A pageable sequence of UserListDirectLicense resources.

Sample code
// Create client
UserListDirectLicenseServiceClient userListDirectLicenseServiceClient = UserListDirectLicenseServiceClient.Create();
// Initialize request argument(s)
AccountName parent = AccountName.FromAccountTypeAccount("[ACCOUNT_TYPE]", "[ACCOUNT]");
// Make the request
PagedEnumerable<ListUserListDirectLicensesResponse, UserListDirectLicense> response = userListDirectLicenseServiceClient.ListUserListDirectLicenses(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (UserListDirectLicense item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListUserListDirectLicensesResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (UserListDirectLicense item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<UserListDirectLicense> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (UserListDirectLicense item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListUserListDirectLicenses(ListUserListDirectLicensesRequest, CallSettings)

Lists all user list direct licenses owned by the parent account.

This feature is only available to data partners.

Declaration
public virtual PagedEnumerable<ListUserListDirectLicensesResponse, UserListDirectLicense> ListUserListDirectLicenses(ListUserListDirectLicensesRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ListUserListDirectLicensesRequest 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<ListUserListDirectLicensesResponse, UserListDirectLicense>

A pageable sequence of UserListDirectLicense resources.

Sample code
// Create client
UserListDirectLicenseServiceClient userListDirectLicenseServiceClient = UserListDirectLicenseServiceClient.Create();
// Initialize request argument(s)
ListUserListDirectLicensesRequest request = new ListUserListDirectLicensesRequest
{
    ParentAsAccountName = AccountName.FromAccountTypeAccount("[ACCOUNT_TYPE]", "[ACCOUNT]"),
    Filter = "",
};
// Make the request
PagedEnumerable<ListUserListDirectLicensesResponse, UserListDirectLicense> response = userListDirectLicenseServiceClient.ListUserListDirectLicenses(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (UserListDirectLicense item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListUserListDirectLicensesResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (UserListDirectLicense item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<UserListDirectLicense> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (UserListDirectLicense item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListUserListDirectLicenses(string, string, int?, CallSettings)

Lists all user list direct licenses owned by the parent account.

This feature is only available to data partners.

Declaration
public virtual PagedEnumerable<ListUserListDirectLicensesResponse, UserListDirectLicense> ListUserListDirectLicenses(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Parameters
Type Name Description
string parent

Required. The account whose licenses are being queried. Should be in the format accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}

string pageToken

The token returned from the previous request. A value of null or an empty string retrieves the first page.

int? pageSize

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerable<ListUserListDirectLicensesResponse, UserListDirectLicense>

A pageable sequence of UserListDirectLicense resources.

Sample code
// Create client
UserListDirectLicenseServiceClient userListDirectLicenseServiceClient = UserListDirectLicenseServiceClient.Create();
// Initialize request argument(s)
string parent = "accountTypes/[ACCOUNT_TYPE]/accounts/[ACCOUNT]";
// Make the request
PagedEnumerable<ListUserListDirectLicensesResponse, UserListDirectLicense> response = userListDirectLicenseServiceClient.ListUserListDirectLicenses(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (UserListDirectLicense item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListUserListDirectLicensesResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (UserListDirectLicense item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<UserListDirectLicense> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (UserListDirectLicense item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListUserListDirectLicensesAsync(AccountName, string, int?, CallSettings)

Lists all user list direct licenses owned by the parent account.

This feature is only available to data partners.

Declaration
public virtual PagedAsyncEnumerable<ListUserListDirectLicensesResponse, UserListDirectLicense> ListUserListDirectLicensesAsync(AccountName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Parameters
Type Name Description
AccountName parent

Required. The account whose licenses are being queried. Should be in the format accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}

string pageToken

The token returned from the previous request. A value of null or an empty string retrieves the first page.

int? pageSize

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerable<ListUserListDirectLicensesResponse, UserListDirectLicense>

A pageable asynchronous sequence of UserListDirectLicense resources.

Sample code
// Create client
UserListDirectLicenseServiceClient userListDirectLicenseServiceClient = await UserListDirectLicenseServiceClient.CreateAsync();
// Initialize request argument(s)
AccountName parent = AccountName.FromAccountTypeAccount("[ACCOUNT_TYPE]", "[ACCOUNT]");
// Make the request
PagedAsyncEnumerable<ListUserListDirectLicensesResponse, UserListDirectLicense> response = userListDirectLicenseServiceClient.ListUserListDirectLicensesAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await foreach (UserListDirectLicense item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
await foreach (ListUserListDirectLicensesResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (UserListDirectLicense item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<UserListDirectLicense> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (UserListDirectLicense item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListUserListDirectLicensesAsync(ListUserListDirectLicensesRequest, CallSettings)

Lists all user list direct licenses owned by the parent account.

This feature is only available to data partners.

Declaration
public virtual PagedAsyncEnumerable<ListUserListDirectLicensesResponse, UserListDirectLicense> ListUserListDirectLicensesAsync(ListUserListDirectLicensesRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ListUserListDirectLicensesRequest 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<ListUserListDirectLicensesResponse, UserListDirectLicense>

A pageable asynchronous sequence of UserListDirectLicense resources.

Sample code
// Create client
UserListDirectLicenseServiceClient userListDirectLicenseServiceClient = await UserListDirectLicenseServiceClient.CreateAsync();
// Initialize request argument(s)
ListUserListDirectLicensesRequest request = new ListUserListDirectLicensesRequest
{
    ParentAsAccountName = AccountName.FromAccountTypeAccount("[ACCOUNT_TYPE]", "[ACCOUNT]"),
    Filter = "",
};
// Make the request
PagedAsyncEnumerable<ListUserListDirectLicensesResponse, UserListDirectLicense> response = userListDirectLicenseServiceClient.ListUserListDirectLicensesAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await foreach (UserListDirectLicense item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
await foreach (ListUserListDirectLicensesResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (UserListDirectLicense item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<UserListDirectLicense> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (UserListDirectLicense item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListUserListDirectLicensesAsync(string, string, int?, CallSettings)

Lists all user list direct licenses owned by the parent account.

This feature is only available to data partners.

Declaration
public virtual PagedAsyncEnumerable<ListUserListDirectLicensesResponse, UserListDirectLicense> ListUserListDirectLicensesAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Parameters
Type Name Description
string parent

Required. The account whose licenses are being queried. Should be in the format accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}

string pageToken

The token returned from the previous request. A value of null or an empty string retrieves the first page.

int? pageSize

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerable<ListUserListDirectLicensesResponse, UserListDirectLicense>

A pageable asynchronous sequence of UserListDirectLicense resources.

Sample code
// Create client
UserListDirectLicenseServiceClient userListDirectLicenseServiceClient = await UserListDirectLicenseServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "accountTypes/[ACCOUNT_TYPE]/accounts/[ACCOUNT]";
// Make the request
PagedAsyncEnumerable<ListUserListDirectLicensesResponse, UserListDirectLicense> response = userListDirectLicenseServiceClient.ListUserListDirectLicensesAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await foreach (UserListDirectLicense item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
await foreach (ListUserListDirectLicensesResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (UserListDirectLicense item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<UserListDirectLicense> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (UserListDirectLicense item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ShutdownDefaultChannelsAsync()

Shuts down any channels automatically created by Create() and CreateAsync(CancellationToken). Channels which weren't automatically created are not affected.

Declaration
public static Task ShutdownDefaultChannelsAsync()
Returns
Type Description
Task

A task representing the asynchronous shutdown operation.

Remarks

After calling this method, further calls to Create() and CreateAsync(CancellationToken) will create new channels, which could in turn be shut down by another call to this method.

UpdateUserListDirectLicense(UpdateUserListDirectLicenseRequest, CallSettings)

Updates a user list direct license.

This feature is only available to data partners.

Declaration
public virtual UserListDirectLicense UpdateUserListDirectLicense(UpdateUserListDirectLicenseRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
UpdateUserListDirectLicenseRequest 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
UserListDirectLicense

The RPC response.

Sample code
// Create client
UserListDirectLicenseServiceClient userListDirectLicenseServiceClient = UserListDirectLicenseServiceClient.Create();
// Initialize request argument(s)
UpdateUserListDirectLicenseRequest request = new UpdateUserListDirectLicenseRequest
{
    UserListDirectLicense = new UserListDirectLicense(),
    UpdateMask = new FieldMask(),
};
// Make the request
UserListDirectLicense response = userListDirectLicenseServiceClient.UpdateUserListDirectLicense(request);

UpdateUserListDirectLicense(UserListDirectLicense, FieldMask, CallSettings)

Updates a user list direct license.

This feature is only available to data partners.

Declaration
public virtual UserListDirectLicense UpdateUserListDirectLicense(UserListDirectLicense userListDirectLicense, FieldMask updateMask, CallSettings callSettings = null)
Parameters
Type Name Description
UserListDirectLicense userListDirectLicense

Required. The licenses' name field is used to identify the license to update.

FieldMask updateMask

Optional. The list of fields to update. The special character * is not supported and an INVALID_UPDATE_MASK error will be thrown if used.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
UserListDirectLicense

The RPC response.

Sample code
// Create client
UserListDirectLicenseServiceClient userListDirectLicenseServiceClient = UserListDirectLicenseServiceClient.Create();
// Initialize request argument(s)
UserListDirectLicense userListDirectLicense = new UserListDirectLicense();
FieldMask updateMask = new FieldMask();
// Make the request
UserListDirectLicense response = userListDirectLicenseServiceClient.UpdateUserListDirectLicense(userListDirectLicense, updateMask);

UpdateUserListDirectLicenseAsync(UpdateUserListDirectLicenseRequest, CallSettings)

Updates a user list direct license.

This feature is only available to data partners.

Declaration
public virtual Task<UserListDirectLicense> UpdateUserListDirectLicenseAsync(UpdateUserListDirectLicenseRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
UpdateUserListDirectLicenseRequest 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<UserListDirectLicense>

A Task containing the RPC response.

Sample code
// Create client
UserListDirectLicenseServiceClient userListDirectLicenseServiceClient = await UserListDirectLicenseServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateUserListDirectLicenseRequest request = new UpdateUserListDirectLicenseRequest
{
    UserListDirectLicense = new UserListDirectLicense(),
    UpdateMask = new FieldMask(),
};
// Make the request
UserListDirectLicense response = await userListDirectLicenseServiceClient.UpdateUserListDirectLicenseAsync(request);

UpdateUserListDirectLicenseAsync(UpdateUserListDirectLicenseRequest, CancellationToken)

Updates a user list direct license.

This feature is only available to data partners.

Declaration
public virtual Task<UserListDirectLicense> UpdateUserListDirectLicenseAsync(UpdateUserListDirectLicenseRequest request, CancellationToken cancellationToken)
Parameters
Type Name Description
UpdateUserListDirectLicenseRequest request

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

CancellationToken cancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task<UserListDirectLicense>

A Task containing the RPC response.

Sample code
// Create client
UserListDirectLicenseServiceClient userListDirectLicenseServiceClient = await UserListDirectLicenseServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateUserListDirectLicenseRequest request = new UpdateUserListDirectLicenseRequest
{
    UserListDirectLicense = new UserListDirectLicense(),
    UpdateMask = new FieldMask(),
};
// Make the request
UserListDirectLicense response = await userListDirectLicenseServiceClient.UpdateUserListDirectLicenseAsync(request);

UpdateUserListDirectLicenseAsync(UserListDirectLicense, FieldMask, CallSettings)

Updates a user list direct license.

This feature is only available to data partners.

Declaration
public virtual Task<UserListDirectLicense> UpdateUserListDirectLicenseAsync(UserListDirectLicense userListDirectLicense, FieldMask updateMask, CallSettings callSettings = null)
Parameters
Type Name Description
UserListDirectLicense userListDirectLicense

Required. The licenses' name field is used to identify the license to update.

FieldMask updateMask

Optional. The list of fields to update. The special character * is not supported and an INVALID_UPDATE_MASK error will be thrown if used.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task<UserListDirectLicense>

A Task containing the RPC response.

Sample code
// Create client
UserListDirectLicenseServiceClient userListDirectLicenseServiceClient = await UserListDirectLicenseServiceClient.CreateAsync();
// Initialize request argument(s)
UserListDirectLicense userListDirectLicense = new UserListDirectLicense();
FieldMask updateMask = new FieldMask();
// Make the request
UserListDirectLicense response = await userListDirectLicenseServiceClient.UpdateUserListDirectLicenseAsync(userListDirectLicense, updateMask);

UpdateUserListDirectLicenseAsync(UserListDirectLicense, FieldMask, CancellationToken)

Updates a user list direct license.

This feature is only available to data partners.

Declaration
public virtual Task<UserListDirectLicense> UpdateUserListDirectLicenseAsync(UserListDirectLicense userListDirectLicense, FieldMask updateMask, CancellationToken cancellationToken)
Parameters
Type Name Description
UserListDirectLicense userListDirectLicense

Required. The licenses' name field is used to identify the license to update.

FieldMask updateMask

Optional. The list of fields to update. The special character * is not supported and an INVALID_UPDATE_MASK error will be thrown if used.

CancellationToken cancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task<UserListDirectLicense>

A Task containing the RPC response.

Sample code
// Create client
UserListDirectLicenseServiceClient userListDirectLicenseServiceClient = await UserListDirectLicenseServiceClient.CreateAsync();
// Initialize request argument(s)
UserListDirectLicense userListDirectLicense = new UserListDirectLicense();
FieldMask updateMask = new FieldMask();
// Make the request
UserListDirectLicense response = await userListDirectLicenseServiceClient.UpdateUserListDirectLicenseAsync(userListDirectLicense, updateMask);
In this article
Back to top Generated by DocFX