Show / Hide Table of Contents

Class UserListGlobalLicenseServiceClient

UserListGlobalLicenseService client wrapper, for convenient use.

Inheritance
object
UserListGlobalLicenseServiceClient
UserListGlobalLicenseServiceClientImpl
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 UserListGlobalLicenseServiceClient
Remarks

Service for managing user list global licenses. Delete is not a supported operation for UserListGlobalLicenses. 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 UserListGlobalLicenseService 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 UserListGlobalLicenseService scopes.

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

The default UserListGlobalLicenseService scopes are:

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

GrpcClient

The underlying gRPC UserListGlobalLicenseService client

Declaration
public virtual UserListGlobalLicenseService.UserListGlobalLicenseServiceClient GrpcClient { get; }
Property Value
Type Description
UserListGlobalLicenseService.UserListGlobalLicenseServiceClient

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 UserListGlobalLicenseServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use UserListGlobalLicenseServiceClientBuilder.

Declaration
public static UserListGlobalLicenseServiceClient Create()
Returns
Type Description
UserListGlobalLicenseServiceClient

The created UserListGlobalLicenseServiceClient.

CreateAsync(CancellationToken)

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

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

The CancellationToken to use while creating the client.

Returns
Type Description
Task<UserListGlobalLicenseServiceClient>

The task representing the created UserListGlobalLicenseServiceClient.

CreateUserListGlobalLicense(AccountName, UserListGlobalLicense, CallSettings)

Creates a user list global license.

This feature is only available to data partners.

Declaration
public virtual UserListGlobalLicense CreateUserListGlobalLicense(AccountName parent, UserListGlobalLicense userListGlobalLicense, 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}

UserListGlobalLicense userListGlobalLicense

Required. The user list global license to create.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
UserListGlobalLicense

The RPC response.

Sample code
// Create client
UserListGlobalLicenseServiceClient userListGlobalLicenseServiceClient = UserListGlobalLicenseServiceClient.Create();
// Initialize request argument(s)
AccountName parent = AccountName.FromAccountTypeAccount("[ACCOUNT_TYPE]", "[ACCOUNT]");
UserListGlobalLicense userListGlobalLicense = new UserListGlobalLicense();
// Make the request
UserListGlobalLicense response = userListGlobalLicenseServiceClient.CreateUserListGlobalLicense(parent, userListGlobalLicense);

CreateUserListGlobalLicense(CreateUserListGlobalLicenseRequest, CallSettings)

Creates a user list global license.

This feature is only available to data partners.

Declaration
public virtual UserListGlobalLicense CreateUserListGlobalLicense(CreateUserListGlobalLicenseRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
CreateUserListGlobalLicenseRequest 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
UserListGlobalLicense

The RPC response.

Sample code
// Create client
UserListGlobalLicenseServiceClient userListGlobalLicenseServiceClient = UserListGlobalLicenseServiceClient.Create();
// Initialize request argument(s)
CreateUserListGlobalLicenseRequest request = new CreateUserListGlobalLicenseRequest
{
    ParentAsAccountName = AccountName.FromAccountTypeAccount("[ACCOUNT_TYPE]", "[ACCOUNT]"),
    UserListGlobalLicense = new UserListGlobalLicense(),
};
// Make the request
UserListGlobalLicense response = userListGlobalLicenseServiceClient.CreateUserListGlobalLicense(request);

CreateUserListGlobalLicense(string, UserListGlobalLicense, CallSettings)

Creates a user list global license.

This feature is only available to data partners.

Declaration
public virtual UserListGlobalLicense CreateUserListGlobalLicense(string parent, UserListGlobalLicense userListGlobalLicense, 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}

UserListGlobalLicense userListGlobalLicense

Required. The user list global license to create.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
UserListGlobalLicense

The RPC response.

Sample code
// Create client
UserListGlobalLicenseServiceClient userListGlobalLicenseServiceClient = UserListGlobalLicenseServiceClient.Create();
// Initialize request argument(s)
string parent = "accountTypes/[ACCOUNT_TYPE]/accounts/[ACCOUNT]";
UserListGlobalLicense userListGlobalLicense = new UserListGlobalLicense();
// Make the request
UserListGlobalLicense response = userListGlobalLicenseServiceClient.CreateUserListGlobalLicense(parent, userListGlobalLicense);

CreateUserListGlobalLicenseAsync(AccountName, UserListGlobalLicense, CallSettings)

Creates a user list global license.

This feature is only available to data partners.

Declaration
public virtual Task<UserListGlobalLicense> CreateUserListGlobalLicenseAsync(AccountName parent, UserListGlobalLicense userListGlobalLicense, 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}

UserListGlobalLicense userListGlobalLicense

Required. The user list global license to create.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task<UserListGlobalLicense>

A Task containing the RPC response.

Sample code
// Create client
UserListGlobalLicenseServiceClient userListGlobalLicenseServiceClient = await UserListGlobalLicenseServiceClient.CreateAsync();
// Initialize request argument(s)
AccountName parent = AccountName.FromAccountTypeAccount("[ACCOUNT_TYPE]", "[ACCOUNT]");
UserListGlobalLicense userListGlobalLicense = new UserListGlobalLicense();
// Make the request
UserListGlobalLicense response = await userListGlobalLicenseServiceClient.CreateUserListGlobalLicenseAsync(parent, userListGlobalLicense);

CreateUserListGlobalLicenseAsync(AccountName, UserListGlobalLicense, CancellationToken)

Creates a user list global license.

This feature is only available to data partners.

Declaration
public virtual Task<UserListGlobalLicense> CreateUserListGlobalLicenseAsync(AccountName parent, UserListGlobalLicense userListGlobalLicense, 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}

UserListGlobalLicense userListGlobalLicense

Required. The user list global license to create.

CancellationToken cancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task<UserListGlobalLicense>

A Task containing the RPC response.

Sample code
// Create client
UserListGlobalLicenseServiceClient userListGlobalLicenseServiceClient = await UserListGlobalLicenseServiceClient.CreateAsync();
// Initialize request argument(s)
AccountName parent = AccountName.FromAccountTypeAccount("[ACCOUNT_TYPE]", "[ACCOUNT]");
UserListGlobalLicense userListGlobalLicense = new UserListGlobalLicense();
// Make the request
UserListGlobalLicense response = await userListGlobalLicenseServiceClient.CreateUserListGlobalLicenseAsync(parent, userListGlobalLicense);

CreateUserListGlobalLicenseAsync(CreateUserListGlobalLicenseRequest, CallSettings)

Creates a user list global license.

This feature is only available to data partners.

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

A Task containing the RPC response.

Sample code
// Create client
UserListGlobalLicenseServiceClient userListGlobalLicenseServiceClient = await UserListGlobalLicenseServiceClient.CreateAsync();
// Initialize request argument(s)
CreateUserListGlobalLicenseRequest request = new CreateUserListGlobalLicenseRequest
{
    ParentAsAccountName = AccountName.FromAccountTypeAccount("[ACCOUNT_TYPE]", "[ACCOUNT]"),
    UserListGlobalLicense = new UserListGlobalLicense(),
};
// Make the request
UserListGlobalLicense response = await userListGlobalLicenseServiceClient.CreateUserListGlobalLicenseAsync(request);

CreateUserListGlobalLicenseAsync(CreateUserListGlobalLicenseRequest, CancellationToken)

Creates a user list global license.

This feature is only available to data partners.

Declaration
public virtual Task<UserListGlobalLicense> CreateUserListGlobalLicenseAsync(CreateUserListGlobalLicenseRequest request, CancellationToken cancellationToken)
Parameters
Type Name Description
CreateUserListGlobalLicenseRequest 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<UserListGlobalLicense>

A Task containing the RPC response.

Sample code
// Create client
UserListGlobalLicenseServiceClient userListGlobalLicenseServiceClient = await UserListGlobalLicenseServiceClient.CreateAsync();
// Initialize request argument(s)
CreateUserListGlobalLicenseRequest request = new CreateUserListGlobalLicenseRequest
{
    ParentAsAccountName = AccountName.FromAccountTypeAccount("[ACCOUNT_TYPE]", "[ACCOUNT]"),
    UserListGlobalLicense = new UserListGlobalLicense(),
};
// Make the request
UserListGlobalLicense response = await userListGlobalLicenseServiceClient.CreateUserListGlobalLicenseAsync(request);

CreateUserListGlobalLicenseAsync(string, UserListGlobalLicense, CallSettings)

Creates a user list global license.

This feature is only available to data partners.

Declaration
public virtual Task<UserListGlobalLicense> CreateUserListGlobalLicenseAsync(string parent, UserListGlobalLicense userListGlobalLicense, 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}

UserListGlobalLicense userListGlobalLicense

Required. The user list global license to create.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task<UserListGlobalLicense>

A Task containing the RPC response.

Sample code
// Create client
UserListGlobalLicenseServiceClient userListGlobalLicenseServiceClient = await UserListGlobalLicenseServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "accountTypes/[ACCOUNT_TYPE]/accounts/[ACCOUNT]";
UserListGlobalLicense userListGlobalLicense = new UserListGlobalLicense();
// Make the request
UserListGlobalLicense response = await userListGlobalLicenseServiceClient.CreateUserListGlobalLicenseAsync(parent, userListGlobalLicense);

CreateUserListGlobalLicenseAsync(string, UserListGlobalLicense, CancellationToken)

Creates a user list global license.

This feature is only available to data partners.

Declaration
public virtual Task<UserListGlobalLicense> CreateUserListGlobalLicenseAsync(string parent, UserListGlobalLicense userListGlobalLicense, 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}

UserListGlobalLicense userListGlobalLicense

Required. The user list global license to create.

CancellationToken cancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task<UserListGlobalLicense>

A Task containing the RPC response.

Sample code
// Create client
UserListGlobalLicenseServiceClient userListGlobalLicenseServiceClient = await UserListGlobalLicenseServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "accountTypes/[ACCOUNT_TYPE]/accounts/[ACCOUNT]";
UserListGlobalLicense userListGlobalLicense = new UserListGlobalLicense();
// Make the request
UserListGlobalLicense response = await userListGlobalLicenseServiceClient.CreateUserListGlobalLicenseAsync(parent, userListGlobalLicense);

GetUserListGlobalLicense(GetUserListGlobalLicenseRequest, CallSettings)

Retrieves a user list global license.

This feature is only available to data partners.

Declaration
public virtual UserListGlobalLicense GetUserListGlobalLicense(GetUserListGlobalLicenseRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
GetUserListGlobalLicenseRequest 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
UserListGlobalLicense

The RPC response.

Sample code
// Create client
UserListGlobalLicenseServiceClient userListGlobalLicenseServiceClient = UserListGlobalLicenseServiceClient.Create();
// Initialize request argument(s)
GetUserListGlobalLicenseRequest request = new GetUserListGlobalLicenseRequest
{
    UserListGlobalLicenseName = UserListGlobalLicenseName.FromAccountTypeAccountUserListGlobalLicense("[ACCOUNT_TYPE]", "[ACCOUNT]", "[USER_LIST_GLOBAL_LICENSE]"),
};
// Make the request
UserListGlobalLicense response = userListGlobalLicenseServiceClient.GetUserListGlobalLicense(request);

GetUserListGlobalLicense(UserListGlobalLicenseName, CallSettings)

Retrieves a user list global license.

This feature is only available to data partners.

Declaration
public virtual UserListGlobalLicense GetUserListGlobalLicense(UserListGlobalLicenseName name, CallSettings callSettings = null)
Parameters
Type Name Description
UserListGlobalLicenseName name

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

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
UserListGlobalLicense

The RPC response.

Sample code
// Create client
UserListGlobalLicenseServiceClient userListGlobalLicenseServiceClient = UserListGlobalLicenseServiceClient.Create();
// Initialize request argument(s)
UserListGlobalLicenseName name = UserListGlobalLicenseName.FromAccountTypeAccountUserListGlobalLicense("[ACCOUNT_TYPE]", "[ACCOUNT]", "[USER_LIST_GLOBAL_LICENSE]");
// Make the request
UserListGlobalLicense response = userListGlobalLicenseServiceClient.GetUserListGlobalLicense(name);

GetUserListGlobalLicense(string, CallSettings)

Retrieves a user list global license.

This feature is only available to data partners.

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

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

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
UserListGlobalLicense

The RPC response.

Sample code
// Create client
UserListGlobalLicenseServiceClient userListGlobalLicenseServiceClient = UserListGlobalLicenseServiceClient.Create();
// Initialize request argument(s)
string name = "accountTypes/[ACCOUNT_TYPE]/accounts/[ACCOUNT]/userListGlobalLicenses/[USER_LIST_GLOBAL_LICENSE]";
// Make the request
UserListGlobalLicense response = userListGlobalLicenseServiceClient.GetUserListGlobalLicense(name);

GetUserListGlobalLicenseAsync(GetUserListGlobalLicenseRequest, CallSettings)

Retrieves a user list global license.

This feature is only available to data partners.

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

A Task containing the RPC response.

Sample code
// Create client
UserListGlobalLicenseServiceClient userListGlobalLicenseServiceClient = await UserListGlobalLicenseServiceClient.CreateAsync();
// Initialize request argument(s)
GetUserListGlobalLicenseRequest request = new GetUserListGlobalLicenseRequest
{
    UserListGlobalLicenseName = UserListGlobalLicenseName.FromAccountTypeAccountUserListGlobalLicense("[ACCOUNT_TYPE]", "[ACCOUNT]", "[USER_LIST_GLOBAL_LICENSE]"),
};
// Make the request
UserListGlobalLicense response = await userListGlobalLicenseServiceClient.GetUserListGlobalLicenseAsync(request);

GetUserListGlobalLicenseAsync(GetUserListGlobalLicenseRequest, CancellationToken)

Retrieves a user list global license.

This feature is only available to data partners.

Declaration
public virtual Task<UserListGlobalLicense> GetUserListGlobalLicenseAsync(GetUserListGlobalLicenseRequest request, CancellationToken cancellationToken)
Parameters
Type Name Description
GetUserListGlobalLicenseRequest 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<UserListGlobalLicense>

A Task containing the RPC response.

Sample code
// Create client
UserListGlobalLicenseServiceClient userListGlobalLicenseServiceClient = await UserListGlobalLicenseServiceClient.CreateAsync();
// Initialize request argument(s)
GetUserListGlobalLicenseRequest request = new GetUserListGlobalLicenseRequest
{
    UserListGlobalLicenseName = UserListGlobalLicenseName.FromAccountTypeAccountUserListGlobalLicense("[ACCOUNT_TYPE]", "[ACCOUNT]", "[USER_LIST_GLOBAL_LICENSE]"),
};
// Make the request
UserListGlobalLicense response = await userListGlobalLicenseServiceClient.GetUserListGlobalLicenseAsync(request);

GetUserListGlobalLicenseAsync(UserListGlobalLicenseName, CallSettings)

Retrieves a user list global license.

This feature is only available to data partners.

Declaration
public virtual Task<UserListGlobalLicense> GetUserListGlobalLicenseAsync(UserListGlobalLicenseName name, CallSettings callSettings = null)
Parameters
Type Name Description
UserListGlobalLicenseName name

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

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task<UserListGlobalLicense>

A Task containing the RPC response.

Sample code
// Create client
UserListGlobalLicenseServiceClient userListGlobalLicenseServiceClient = await UserListGlobalLicenseServiceClient.CreateAsync();
// Initialize request argument(s)
UserListGlobalLicenseName name = UserListGlobalLicenseName.FromAccountTypeAccountUserListGlobalLicense("[ACCOUNT_TYPE]", "[ACCOUNT]", "[USER_LIST_GLOBAL_LICENSE]");
// Make the request
UserListGlobalLicense response = await userListGlobalLicenseServiceClient.GetUserListGlobalLicenseAsync(name);

GetUserListGlobalLicenseAsync(UserListGlobalLicenseName, CancellationToken)

Retrieves a user list global license.

This feature is only available to data partners.

Declaration
public virtual Task<UserListGlobalLicense> GetUserListGlobalLicenseAsync(UserListGlobalLicenseName name, CancellationToken cancellationToken)
Parameters
Type Name Description
UserListGlobalLicenseName name

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

CancellationToken cancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task<UserListGlobalLicense>

A Task containing the RPC response.

Sample code
// Create client
UserListGlobalLicenseServiceClient userListGlobalLicenseServiceClient = await UserListGlobalLicenseServiceClient.CreateAsync();
// Initialize request argument(s)
UserListGlobalLicenseName name = UserListGlobalLicenseName.FromAccountTypeAccountUserListGlobalLicense("[ACCOUNT_TYPE]", "[ACCOUNT]", "[USER_LIST_GLOBAL_LICENSE]");
// Make the request
UserListGlobalLicense response = await userListGlobalLicenseServiceClient.GetUserListGlobalLicenseAsync(name);

GetUserListGlobalLicenseAsync(string, CallSettings)

Retrieves a user list global license.

This feature is only available to data partners.

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

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

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task<UserListGlobalLicense>

A Task containing the RPC response.

Sample code
// Create client
UserListGlobalLicenseServiceClient userListGlobalLicenseServiceClient = await UserListGlobalLicenseServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "accountTypes/[ACCOUNT_TYPE]/accounts/[ACCOUNT]/userListGlobalLicenses/[USER_LIST_GLOBAL_LICENSE]";
// Make the request
UserListGlobalLicense response = await userListGlobalLicenseServiceClient.GetUserListGlobalLicenseAsync(name);

GetUserListGlobalLicenseAsync(string, CancellationToken)

Retrieves a user list global license.

This feature is only available to data partners.

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

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

CancellationToken cancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task<UserListGlobalLicense>

A Task containing the RPC response.

Sample code
// Create client
UserListGlobalLicenseServiceClient userListGlobalLicenseServiceClient = await UserListGlobalLicenseServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "accountTypes/[ACCOUNT_TYPE]/accounts/[ACCOUNT]/userListGlobalLicenses/[USER_LIST_GLOBAL_LICENSE]";
// Make the request
UserListGlobalLicense response = await userListGlobalLicenseServiceClient.GetUserListGlobalLicenseAsync(name);

ListUserListGlobalLicenseCustomerInfos(ListUserListGlobalLicenseCustomerInfosRequest, CallSettings)

Lists all customer info for a user list global license.

This feature is only available to data partners.

Declaration
public virtual PagedEnumerable<ListUserListGlobalLicenseCustomerInfosResponse, UserListGlobalLicenseCustomerInfo> ListUserListGlobalLicenseCustomerInfos(ListUserListGlobalLicenseCustomerInfosRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ListUserListGlobalLicenseCustomerInfosRequest 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<ListUserListGlobalLicenseCustomerInfosResponse, UserListGlobalLicenseCustomerInfo>

A pageable sequence of UserListGlobalLicenseCustomerInfo resources.

Sample code
// Create client
UserListGlobalLicenseServiceClient userListGlobalLicenseServiceClient = UserListGlobalLicenseServiceClient.Create();
// Initialize request argument(s)
ListUserListGlobalLicenseCustomerInfosRequest request = new ListUserListGlobalLicenseCustomerInfosRequest
{
    ParentAsUserListGlobalLicenseName = UserListGlobalLicenseName.FromAccountTypeAccountUserListGlobalLicense("[ACCOUNT_TYPE]", "[ACCOUNT]", "[USER_LIST_GLOBAL_LICENSE]"),
    Filter = "",
};
// Make the request
PagedEnumerable<ListUserListGlobalLicenseCustomerInfosResponse, UserListGlobalLicenseCustomerInfo> response = userListGlobalLicenseServiceClient.ListUserListGlobalLicenseCustomerInfos(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (UserListGlobalLicenseCustomerInfo 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 (ListUserListGlobalLicenseCustomerInfosResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (UserListGlobalLicenseCustomerInfo 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<UserListGlobalLicenseCustomerInfo> 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 (UserListGlobalLicenseCustomerInfo 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;

ListUserListGlobalLicenseCustomerInfos(UserListGlobalLicenseName, string, int?, CallSettings)

Lists all customer info for a user list global license.

This feature is only available to data partners.

Declaration
public virtual PagedEnumerable<ListUserListGlobalLicenseCustomerInfosResponse, UserListGlobalLicenseCustomerInfo> ListUserListGlobalLicenseCustomerInfos(UserListGlobalLicenseName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Parameters
Type Name Description
UserListGlobalLicenseName parent

Required. The global license whose customer info are being queried. Should be in the format accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}/userListGlobalLicenses/{USER_LIST_GLOBAL_LICENSE_ID}. To list all global license customer info under an account, replace the user list global license id with a '-' (for example, accountTypes/DATA_PARTNER/accounts/123/userListGlobalLicenses/-)

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<ListUserListGlobalLicenseCustomerInfosResponse, UserListGlobalLicenseCustomerInfo>

A pageable sequence of UserListGlobalLicenseCustomerInfo resources.

Sample code
// Create client
UserListGlobalLicenseServiceClient userListGlobalLicenseServiceClient = UserListGlobalLicenseServiceClient.Create();
// Initialize request argument(s)
UserListGlobalLicenseName parent = UserListGlobalLicenseName.FromAccountTypeAccountUserListGlobalLicense("[ACCOUNT_TYPE]", "[ACCOUNT]", "[USER_LIST_GLOBAL_LICENSE]");
// Make the request
PagedEnumerable<ListUserListGlobalLicenseCustomerInfosResponse, UserListGlobalLicenseCustomerInfo> response = userListGlobalLicenseServiceClient.ListUserListGlobalLicenseCustomerInfos(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (UserListGlobalLicenseCustomerInfo 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 (ListUserListGlobalLicenseCustomerInfosResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (UserListGlobalLicenseCustomerInfo 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<UserListGlobalLicenseCustomerInfo> 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 (UserListGlobalLicenseCustomerInfo 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;

ListUserListGlobalLicenseCustomerInfos(string, string, int?, CallSettings)

Lists all customer info for a user list global license.

This feature is only available to data partners.

Declaration
public virtual PagedEnumerable<ListUserListGlobalLicenseCustomerInfosResponse, UserListGlobalLicenseCustomerInfo> ListUserListGlobalLicenseCustomerInfos(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Parameters
Type Name Description
string parent

Required. The global license whose customer info are being queried. Should be in the format accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}/userListGlobalLicenses/{USER_LIST_GLOBAL_LICENSE_ID}. To list all global license customer info under an account, replace the user list global license id with a '-' (for example, accountTypes/DATA_PARTNER/accounts/123/userListGlobalLicenses/-)

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<ListUserListGlobalLicenseCustomerInfosResponse, UserListGlobalLicenseCustomerInfo>

A pageable sequence of UserListGlobalLicenseCustomerInfo resources.

Sample code
// Create client
UserListGlobalLicenseServiceClient userListGlobalLicenseServiceClient = UserListGlobalLicenseServiceClient.Create();
// Initialize request argument(s)
string parent = "accountTypes/[ACCOUNT_TYPE]/accounts/[ACCOUNT]/userListGlobalLicenses/[USER_LIST_GLOBAL_LICENSE]";
// Make the request
PagedEnumerable<ListUserListGlobalLicenseCustomerInfosResponse, UserListGlobalLicenseCustomerInfo> response = userListGlobalLicenseServiceClient.ListUserListGlobalLicenseCustomerInfos(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (UserListGlobalLicenseCustomerInfo 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 (ListUserListGlobalLicenseCustomerInfosResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (UserListGlobalLicenseCustomerInfo 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<UserListGlobalLicenseCustomerInfo> 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 (UserListGlobalLicenseCustomerInfo 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;

ListUserListGlobalLicenseCustomerInfosAsync(ListUserListGlobalLicenseCustomerInfosRequest, CallSettings)

Lists all customer info for a user list global license.

This feature is only available to data partners.

Declaration
public virtual PagedAsyncEnumerable<ListUserListGlobalLicenseCustomerInfosResponse, UserListGlobalLicenseCustomerInfo> ListUserListGlobalLicenseCustomerInfosAsync(ListUserListGlobalLicenseCustomerInfosRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ListUserListGlobalLicenseCustomerInfosRequest 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<ListUserListGlobalLicenseCustomerInfosResponse, UserListGlobalLicenseCustomerInfo>

A pageable asynchronous sequence of UserListGlobalLicenseCustomerInfo resources.

Sample code
// Create client
UserListGlobalLicenseServiceClient userListGlobalLicenseServiceClient = await UserListGlobalLicenseServiceClient.CreateAsync();
// Initialize request argument(s)
ListUserListGlobalLicenseCustomerInfosRequest request = new ListUserListGlobalLicenseCustomerInfosRequest
{
    ParentAsUserListGlobalLicenseName = UserListGlobalLicenseName.FromAccountTypeAccountUserListGlobalLicense("[ACCOUNT_TYPE]", "[ACCOUNT]", "[USER_LIST_GLOBAL_LICENSE]"),
    Filter = "",
};
// Make the request
PagedAsyncEnumerable<ListUserListGlobalLicenseCustomerInfosResponse, UserListGlobalLicenseCustomerInfo> response = userListGlobalLicenseServiceClient.ListUserListGlobalLicenseCustomerInfosAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await foreach (UserListGlobalLicenseCustomerInfo 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 (ListUserListGlobalLicenseCustomerInfosResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (UserListGlobalLicenseCustomerInfo 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<UserListGlobalLicenseCustomerInfo> 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 (UserListGlobalLicenseCustomerInfo 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;

ListUserListGlobalLicenseCustomerInfosAsync(UserListGlobalLicenseName, string, int?, CallSettings)

Lists all customer info for a user list global license.

This feature is only available to data partners.

Declaration
public virtual PagedAsyncEnumerable<ListUserListGlobalLicenseCustomerInfosResponse, UserListGlobalLicenseCustomerInfo> ListUserListGlobalLicenseCustomerInfosAsync(UserListGlobalLicenseName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Parameters
Type Name Description
UserListGlobalLicenseName parent

Required. The global license whose customer info are being queried. Should be in the format accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}/userListGlobalLicenses/{USER_LIST_GLOBAL_LICENSE_ID}. To list all global license customer info under an account, replace the user list global license id with a '-' (for example, accountTypes/DATA_PARTNER/accounts/123/userListGlobalLicenses/-)

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<ListUserListGlobalLicenseCustomerInfosResponse, UserListGlobalLicenseCustomerInfo>

A pageable asynchronous sequence of UserListGlobalLicenseCustomerInfo resources.

Sample code
// Create client
UserListGlobalLicenseServiceClient userListGlobalLicenseServiceClient = await UserListGlobalLicenseServiceClient.CreateAsync();
// Initialize request argument(s)
UserListGlobalLicenseName parent = UserListGlobalLicenseName.FromAccountTypeAccountUserListGlobalLicense("[ACCOUNT_TYPE]", "[ACCOUNT]", "[USER_LIST_GLOBAL_LICENSE]");
// Make the request
PagedAsyncEnumerable<ListUserListGlobalLicenseCustomerInfosResponse, UserListGlobalLicenseCustomerInfo> response = userListGlobalLicenseServiceClient.ListUserListGlobalLicenseCustomerInfosAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await foreach (UserListGlobalLicenseCustomerInfo 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 (ListUserListGlobalLicenseCustomerInfosResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (UserListGlobalLicenseCustomerInfo 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<UserListGlobalLicenseCustomerInfo> 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 (UserListGlobalLicenseCustomerInfo 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;

ListUserListGlobalLicenseCustomerInfosAsync(string, string, int?, CallSettings)

Lists all customer info for a user list global license.

This feature is only available to data partners.

Declaration
public virtual PagedAsyncEnumerable<ListUserListGlobalLicenseCustomerInfosResponse, UserListGlobalLicenseCustomerInfo> ListUserListGlobalLicenseCustomerInfosAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Parameters
Type Name Description
string parent

Required. The global license whose customer info are being queried. Should be in the format accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}/userListGlobalLicenses/{USER_LIST_GLOBAL_LICENSE_ID}. To list all global license customer info under an account, replace the user list global license id with a '-' (for example, accountTypes/DATA_PARTNER/accounts/123/userListGlobalLicenses/-)

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<ListUserListGlobalLicenseCustomerInfosResponse, UserListGlobalLicenseCustomerInfo>

A pageable asynchronous sequence of UserListGlobalLicenseCustomerInfo resources.

Sample code
// Create client
UserListGlobalLicenseServiceClient userListGlobalLicenseServiceClient = await UserListGlobalLicenseServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "accountTypes/[ACCOUNT_TYPE]/accounts/[ACCOUNT]/userListGlobalLicenses/[USER_LIST_GLOBAL_LICENSE]";
// Make the request
PagedAsyncEnumerable<ListUserListGlobalLicenseCustomerInfosResponse, UserListGlobalLicenseCustomerInfo> response = userListGlobalLicenseServiceClient.ListUserListGlobalLicenseCustomerInfosAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await foreach (UserListGlobalLicenseCustomerInfo 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 (ListUserListGlobalLicenseCustomerInfosResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (UserListGlobalLicenseCustomerInfo 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<UserListGlobalLicenseCustomerInfo> 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 (UserListGlobalLicenseCustomerInfo 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;

ListUserListGlobalLicenses(AccountName, string, int?, CallSettings)

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

This feature is only available to data partners.

Declaration
public virtual PagedEnumerable<ListUserListGlobalLicensesResponse, UserListGlobalLicense> ListUserListGlobalLicenses(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<ListUserListGlobalLicensesResponse, UserListGlobalLicense>

A pageable sequence of UserListGlobalLicense resources.

Sample code
// Create client
UserListGlobalLicenseServiceClient userListGlobalLicenseServiceClient = UserListGlobalLicenseServiceClient.Create();
// Initialize request argument(s)
AccountName parent = AccountName.FromAccountTypeAccount("[ACCOUNT_TYPE]", "[ACCOUNT]");
// Make the request
PagedEnumerable<ListUserListGlobalLicensesResponse, UserListGlobalLicense> response = userListGlobalLicenseServiceClient.ListUserListGlobalLicenses(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (UserListGlobalLicense 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 (ListUserListGlobalLicensesResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (UserListGlobalLicense 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<UserListGlobalLicense> 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 (UserListGlobalLicense 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;

ListUserListGlobalLicenses(ListUserListGlobalLicensesRequest, CallSettings)

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

This feature is only available to data partners.

Declaration
public virtual PagedEnumerable<ListUserListGlobalLicensesResponse, UserListGlobalLicense> ListUserListGlobalLicenses(ListUserListGlobalLicensesRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ListUserListGlobalLicensesRequest 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<ListUserListGlobalLicensesResponse, UserListGlobalLicense>

A pageable sequence of UserListGlobalLicense resources.

Sample code
// Create client
UserListGlobalLicenseServiceClient userListGlobalLicenseServiceClient = UserListGlobalLicenseServiceClient.Create();
// Initialize request argument(s)
ListUserListGlobalLicensesRequest request = new ListUserListGlobalLicensesRequest
{
    ParentAsAccountName = AccountName.FromAccountTypeAccount("[ACCOUNT_TYPE]", "[ACCOUNT]"),
    Filter = "",
};
// Make the request
PagedEnumerable<ListUserListGlobalLicensesResponse, UserListGlobalLicense> response = userListGlobalLicenseServiceClient.ListUserListGlobalLicenses(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (UserListGlobalLicense 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 (ListUserListGlobalLicensesResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (UserListGlobalLicense 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<UserListGlobalLicense> 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 (UserListGlobalLicense 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;

ListUserListGlobalLicenses(string, string, int?, CallSettings)

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

This feature is only available to data partners.

Declaration
public virtual PagedEnumerable<ListUserListGlobalLicensesResponse, UserListGlobalLicense> ListUserListGlobalLicenses(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<ListUserListGlobalLicensesResponse, UserListGlobalLicense>

A pageable sequence of UserListGlobalLicense resources.

Sample code
// Create client
UserListGlobalLicenseServiceClient userListGlobalLicenseServiceClient = UserListGlobalLicenseServiceClient.Create();
// Initialize request argument(s)
string parent = "accountTypes/[ACCOUNT_TYPE]/accounts/[ACCOUNT]";
// Make the request
PagedEnumerable<ListUserListGlobalLicensesResponse, UserListGlobalLicense> response = userListGlobalLicenseServiceClient.ListUserListGlobalLicenses(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (UserListGlobalLicense 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 (ListUserListGlobalLicensesResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (UserListGlobalLicense 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<UserListGlobalLicense> 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 (UserListGlobalLicense 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;

ListUserListGlobalLicensesAsync(AccountName, string, int?, CallSettings)

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

This feature is only available to data partners.

Declaration
public virtual PagedAsyncEnumerable<ListUserListGlobalLicensesResponse, UserListGlobalLicense> ListUserListGlobalLicensesAsync(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<ListUserListGlobalLicensesResponse, UserListGlobalLicense>

A pageable asynchronous sequence of UserListGlobalLicense resources.

Sample code
// Create client
UserListGlobalLicenseServiceClient userListGlobalLicenseServiceClient = await UserListGlobalLicenseServiceClient.CreateAsync();
// Initialize request argument(s)
AccountName parent = AccountName.FromAccountTypeAccount("[ACCOUNT_TYPE]", "[ACCOUNT]");
// Make the request
PagedAsyncEnumerable<ListUserListGlobalLicensesResponse, UserListGlobalLicense> response = userListGlobalLicenseServiceClient.ListUserListGlobalLicensesAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await foreach (UserListGlobalLicense 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 (ListUserListGlobalLicensesResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (UserListGlobalLicense 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<UserListGlobalLicense> 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 (UserListGlobalLicense 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;

ListUserListGlobalLicensesAsync(ListUserListGlobalLicensesRequest, CallSettings)

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

This feature is only available to data partners.

Declaration
public virtual PagedAsyncEnumerable<ListUserListGlobalLicensesResponse, UserListGlobalLicense> ListUserListGlobalLicensesAsync(ListUserListGlobalLicensesRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ListUserListGlobalLicensesRequest 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<ListUserListGlobalLicensesResponse, UserListGlobalLicense>

A pageable asynchronous sequence of UserListGlobalLicense resources.

Sample code
// Create client
UserListGlobalLicenseServiceClient userListGlobalLicenseServiceClient = await UserListGlobalLicenseServiceClient.CreateAsync();
// Initialize request argument(s)
ListUserListGlobalLicensesRequest request = new ListUserListGlobalLicensesRequest
{
    ParentAsAccountName = AccountName.FromAccountTypeAccount("[ACCOUNT_TYPE]", "[ACCOUNT]"),
    Filter = "",
};
// Make the request
PagedAsyncEnumerable<ListUserListGlobalLicensesResponse, UserListGlobalLicense> response = userListGlobalLicenseServiceClient.ListUserListGlobalLicensesAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await foreach (UserListGlobalLicense 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 (ListUserListGlobalLicensesResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (UserListGlobalLicense 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<UserListGlobalLicense> 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 (UserListGlobalLicense 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;

ListUserListGlobalLicensesAsync(string, string, int?, CallSettings)

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

This feature is only available to data partners.

Declaration
public virtual PagedAsyncEnumerable<ListUserListGlobalLicensesResponse, UserListGlobalLicense> ListUserListGlobalLicensesAsync(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<ListUserListGlobalLicensesResponse, UserListGlobalLicense>

A pageable asynchronous sequence of UserListGlobalLicense resources.

Sample code
// Create client
UserListGlobalLicenseServiceClient userListGlobalLicenseServiceClient = await UserListGlobalLicenseServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "accountTypes/[ACCOUNT_TYPE]/accounts/[ACCOUNT]";
// Make the request
PagedAsyncEnumerable<ListUserListGlobalLicensesResponse, UserListGlobalLicense> response = userListGlobalLicenseServiceClient.ListUserListGlobalLicensesAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await foreach (UserListGlobalLicense 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 (ListUserListGlobalLicensesResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (UserListGlobalLicense 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<UserListGlobalLicense> 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 (UserListGlobalLicense 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.

UpdateUserListGlobalLicense(UpdateUserListGlobalLicenseRequest, CallSettings)

Updates a user list global license.

This feature is only available to data partners.

Declaration
public virtual UserListGlobalLicense UpdateUserListGlobalLicense(UpdateUserListGlobalLicenseRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
UpdateUserListGlobalLicenseRequest 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
UserListGlobalLicense

The RPC response.

Sample code
// Create client
UserListGlobalLicenseServiceClient userListGlobalLicenseServiceClient = UserListGlobalLicenseServiceClient.Create();
// Initialize request argument(s)
UpdateUserListGlobalLicenseRequest request = new UpdateUserListGlobalLicenseRequest
{
    UserListGlobalLicense = new UserListGlobalLicense(),
    UpdateMask = new FieldMask(),
};
// Make the request
UserListGlobalLicense response = userListGlobalLicenseServiceClient.UpdateUserListGlobalLicense(request);

UpdateUserListGlobalLicense(UserListGlobalLicense, FieldMask, CallSettings)

Updates a user list global license.

This feature is only available to data partners.

Declaration
public virtual UserListGlobalLicense UpdateUserListGlobalLicense(UserListGlobalLicense userListGlobalLicense, FieldMask updateMask, CallSettings callSettings = null)
Parameters
Type Name Description
UserListGlobalLicense userListGlobalLicense

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
UserListGlobalLicense

The RPC response.

Sample code
// Create client
UserListGlobalLicenseServiceClient userListGlobalLicenseServiceClient = UserListGlobalLicenseServiceClient.Create();
// Initialize request argument(s)
UserListGlobalLicense userListGlobalLicense = new UserListGlobalLicense();
FieldMask updateMask = new FieldMask();
// Make the request
UserListGlobalLicense response = userListGlobalLicenseServiceClient.UpdateUserListGlobalLicense(userListGlobalLicense, updateMask);

UpdateUserListGlobalLicenseAsync(UpdateUserListGlobalLicenseRequest, CallSettings)

Updates a user list global license.

This feature is only available to data partners.

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

A Task containing the RPC response.

Sample code
// Create client
UserListGlobalLicenseServiceClient userListGlobalLicenseServiceClient = await UserListGlobalLicenseServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateUserListGlobalLicenseRequest request = new UpdateUserListGlobalLicenseRequest
{
    UserListGlobalLicense = new UserListGlobalLicense(),
    UpdateMask = new FieldMask(),
};
// Make the request
UserListGlobalLicense response = await userListGlobalLicenseServiceClient.UpdateUserListGlobalLicenseAsync(request);

UpdateUserListGlobalLicenseAsync(UpdateUserListGlobalLicenseRequest, CancellationToken)

Updates a user list global license.

This feature is only available to data partners.

Declaration
public virtual Task<UserListGlobalLicense> UpdateUserListGlobalLicenseAsync(UpdateUserListGlobalLicenseRequest request, CancellationToken cancellationToken)
Parameters
Type Name Description
UpdateUserListGlobalLicenseRequest 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<UserListGlobalLicense>

A Task containing the RPC response.

Sample code
// Create client
UserListGlobalLicenseServiceClient userListGlobalLicenseServiceClient = await UserListGlobalLicenseServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateUserListGlobalLicenseRequest request = new UpdateUserListGlobalLicenseRequest
{
    UserListGlobalLicense = new UserListGlobalLicense(),
    UpdateMask = new FieldMask(),
};
// Make the request
UserListGlobalLicense response = await userListGlobalLicenseServiceClient.UpdateUserListGlobalLicenseAsync(request);

UpdateUserListGlobalLicenseAsync(UserListGlobalLicense, FieldMask, CallSettings)

Updates a user list global license.

This feature is only available to data partners.

Declaration
public virtual Task<UserListGlobalLicense> UpdateUserListGlobalLicenseAsync(UserListGlobalLicense userListGlobalLicense, FieldMask updateMask, CallSettings callSettings = null)
Parameters
Type Name Description
UserListGlobalLicense userListGlobalLicense

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<UserListGlobalLicense>

A Task containing the RPC response.

Sample code
// Create client
UserListGlobalLicenseServiceClient userListGlobalLicenseServiceClient = await UserListGlobalLicenseServiceClient.CreateAsync();
// Initialize request argument(s)
UserListGlobalLicense userListGlobalLicense = new UserListGlobalLicense();
FieldMask updateMask = new FieldMask();
// Make the request
UserListGlobalLicense response = await userListGlobalLicenseServiceClient.UpdateUserListGlobalLicenseAsync(userListGlobalLicense, updateMask);

UpdateUserListGlobalLicenseAsync(UserListGlobalLicense, FieldMask, CancellationToken)

Updates a user list global license.

This feature is only available to data partners.

Declaration
public virtual Task<UserListGlobalLicense> UpdateUserListGlobalLicenseAsync(UserListGlobalLicense userListGlobalLicense, FieldMask updateMask, CancellationToken cancellationToken)
Parameters
Type Name Description
UserListGlobalLicense userListGlobalLicense

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<UserListGlobalLicense>

A Task containing the RPC response.

Sample code
// Create client
UserListGlobalLicenseServiceClient userListGlobalLicenseServiceClient = await UserListGlobalLicenseServiceClient.CreateAsync();
// Initialize request argument(s)
UserListGlobalLicense userListGlobalLicense = new UserListGlobalLicense();
FieldMask updateMask = new FieldMask();
// Make the request
UserListGlobalLicense response = await userListGlobalLicenseServiceClient.UpdateUserListGlobalLicenseAsync(userListGlobalLicense, updateMask);
In this article
Back to top Generated by DocFX