Class PrivateAuctionServiceClient

PrivateAuctionService client wrapper, for convenient use.

Inheritance

object

PrivateAuctionServiceClient

PrivateAuctionServiceClientImpl

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace: Google.Ads.AdManager.V1

Assembly: Google.Ads.AdManager.V1.dll

Syntax

public abstract class PrivateAuctionServiceClient

Remarks

Provides methods for handling PrivateAuction objects.

Properties

DefaultEndpoint

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

Declaration

public static string DefaultEndpoint { get; }

Property Value

Type	Description
string

DefaultScopes

The default PrivateAuctionService scopes.

Declaration

public static IReadOnlyList<string> DefaultScopes { get; }

Property Value

Type	Description
IReadOnlyList<string>

Remarks

The default PrivateAuctionService scopes are:

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

GrpcClient

The underlying gRPC PrivateAuctionService client

Declaration

public virtual PrivateAuctionService.PrivateAuctionServiceClient GrpcClient { get; }

Property Value

Type	Description
PrivateAuctionService.PrivateAuctionServiceClient

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

Declaration

public static PrivateAuctionServiceClient Create()

Returns

Type	Description
PrivateAuctionServiceClient	The created PrivateAuctionServiceClient.

CreateAsync(CancellationToken)

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

Declaration

public static Task<PrivateAuctionServiceClient> CreateAsync(CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	The CancellationToken to use while creating the client.

Returns

Type	Description
Task<PrivateAuctionServiceClient>	The task representing the created PrivateAuctionServiceClient.

CreatePrivateAuction(CreatePrivateAuctionRequest, CallSettings)

API to create a PrivateAuction object.

Declaration

public virtual PrivateAuction CreatePrivateAuction(CreatePrivateAuctionRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
CreatePrivateAuctionRequest	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
PrivateAuction	The RPC response.

Sample code

// Create client
PrivateAuctionServiceClient privateAuctionServiceClient = PrivateAuctionServiceClient.Create();
// Initialize request argument(s)
CreatePrivateAuctionRequest request = new CreatePrivateAuctionRequest
{
    ParentAsNetworkName = NetworkName.FromNetworkCode("[NETWORK_CODE]"),
    PrivateAuction = new PrivateAuction(),
};
// Make the request
PrivateAuction response = privateAuctionServiceClient.CreatePrivateAuction(request);

CreatePrivateAuction(NetworkName, PrivateAuction, CallSettings)

API to create a PrivateAuction object.

Declaration

public virtual PrivateAuction CreatePrivateAuction(NetworkName parent, PrivateAuction privateAuction, CallSettings callSettings = null)

Parameters

Type	Name	Description
NetworkName	parent	Required. The parent resource where this PrivateAuction will be created. Format: networks/{network_code}
PrivateAuction	privateAuction	Required. The PrivateAuction to create.
CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

Type	Description
PrivateAuction	The RPC response.

Sample code

// Create client
PrivateAuctionServiceClient privateAuctionServiceClient = PrivateAuctionServiceClient.Create();
// Initialize request argument(s)
NetworkName parent = NetworkName.FromNetworkCode("[NETWORK_CODE]");
PrivateAuction privateAuction = new PrivateAuction();
// Make the request
PrivateAuction response = privateAuctionServiceClient.CreatePrivateAuction(parent, privateAuction);

CreatePrivateAuction(string, PrivateAuction, CallSettings)

API to create a PrivateAuction object.

Declaration

public virtual PrivateAuction CreatePrivateAuction(string parent, PrivateAuction privateAuction, CallSettings callSettings = null)

Parameters

Type	Name	Description
string	parent	Required. The parent resource where this PrivateAuction will be created. Format: networks/{network_code}
PrivateAuction	privateAuction	Required. The PrivateAuction to create.
CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

Type	Description
PrivateAuction	The RPC response.

Sample code

// Create client
PrivateAuctionServiceClient privateAuctionServiceClient = PrivateAuctionServiceClient.Create();
// Initialize request argument(s)
string parent = "networks/[NETWORK_CODE]";
PrivateAuction privateAuction = new PrivateAuction();
// Make the request
PrivateAuction response = privateAuctionServiceClient.CreatePrivateAuction(parent, privateAuction);

CreatePrivateAuctionAsync(CreatePrivateAuctionRequest, CallSettings)

API to create a PrivateAuction object.

Declaration

public virtual Task<PrivateAuction> CreatePrivateAuctionAsync(CreatePrivateAuctionRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
CreatePrivateAuctionRequest	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<PrivateAuction>	A Task containing the RPC response.

Sample code

// Create client
PrivateAuctionServiceClient privateAuctionServiceClient = await PrivateAuctionServiceClient.CreateAsync();
// Initialize request argument(s)
CreatePrivateAuctionRequest request = new CreatePrivateAuctionRequest
{
    ParentAsNetworkName = NetworkName.FromNetworkCode("[NETWORK_CODE]"),
    PrivateAuction = new PrivateAuction(),
};
// Make the request
PrivateAuction response = await privateAuctionServiceClient.CreatePrivateAuctionAsync(request);

CreatePrivateAuctionAsync(CreatePrivateAuctionRequest, CancellationToken)

API to create a PrivateAuction object.

Declaration

public virtual Task<PrivateAuction> CreatePrivateAuctionAsync(CreatePrivateAuctionRequest request, CancellationToken cancellationToken)

Parameters

Type	Name	Description
CreatePrivateAuctionRequest	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<PrivateAuction>	A Task containing the RPC response.

Sample code

// Create client
PrivateAuctionServiceClient privateAuctionServiceClient = await PrivateAuctionServiceClient.CreateAsync();
// Initialize request argument(s)
CreatePrivateAuctionRequest request = new CreatePrivateAuctionRequest
{
    ParentAsNetworkName = NetworkName.FromNetworkCode("[NETWORK_CODE]"),
    PrivateAuction = new PrivateAuction(),
};
// Make the request
PrivateAuction response = await privateAuctionServiceClient.CreatePrivateAuctionAsync(request);

CreatePrivateAuctionAsync(NetworkName, PrivateAuction, CallSettings)

API to create a PrivateAuction object.

Declaration

public virtual Task<PrivateAuction> CreatePrivateAuctionAsync(NetworkName parent, PrivateAuction privateAuction, CallSettings callSettings = null)

Parameters

Type	Name	Description
NetworkName	parent	Required. The parent resource where this PrivateAuction will be created. Format: networks/{network_code}
PrivateAuction	privateAuction	Required. The PrivateAuction to create.
CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

Type	Description
Task<PrivateAuction>	A Task containing the RPC response.

Sample code

// Create client
PrivateAuctionServiceClient privateAuctionServiceClient = await PrivateAuctionServiceClient.CreateAsync();
// Initialize request argument(s)
NetworkName parent = NetworkName.FromNetworkCode("[NETWORK_CODE]");
PrivateAuction privateAuction = new PrivateAuction();
// Make the request
PrivateAuction response = await privateAuctionServiceClient.CreatePrivateAuctionAsync(parent, privateAuction);

CreatePrivateAuctionAsync(NetworkName, PrivateAuction, CancellationToken)

API to create a PrivateAuction object.

Declaration

public virtual Task<PrivateAuction> CreatePrivateAuctionAsync(NetworkName parent, PrivateAuction privateAuction, CancellationToken cancellationToken)

Parameters

Type	Name	Description
NetworkName	parent	Required. The parent resource where this PrivateAuction will be created. Format: networks/{network_code}
PrivateAuction	privateAuction	Required. The PrivateAuction to create.
CancellationToken	cancellationToken	A CancellationToken to use for this RPC.

Returns

Type	Description
Task<PrivateAuction>	A Task containing the RPC response.

Sample code

// Create client
PrivateAuctionServiceClient privateAuctionServiceClient = await PrivateAuctionServiceClient.CreateAsync();
// Initialize request argument(s)
NetworkName parent = NetworkName.FromNetworkCode("[NETWORK_CODE]");
PrivateAuction privateAuction = new PrivateAuction();
// Make the request
PrivateAuction response = await privateAuctionServiceClient.CreatePrivateAuctionAsync(parent, privateAuction);

CreatePrivateAuctionAsync(string, PrivateAuction, CallSettings)

API to create a PrivateAuction object.

Declaration

public virtual Task<PrivateAuction> CreatePrivateAuctionAsync(string parent, PrivateAuction privateAuction, CallSettings callSettings = null)

Parameters

Type	Name	Description
string	parent	Required. The parent resource where this PrivateAuction will be created. Format: networks/{network_code}
PrivateAuction	privateAuction	Required. The PrivateAuction to create.
CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

Type	Description
Task<PrivateAuction>	A Task containing the RPC response.

Sample code

// Create client
PrivateAuctionServiceClient privateAuctionServiceClient = await PrivateAuctionServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "networks/[NETWORK_CODE]";
PrivateAuction privateAuction = new PrivateAuction();
// Make the request
PrivateAuction response = await privateAuctionServiceClient.CreatePrivateAuctionAsync(parent, privateAuction);

CreatePrivateAuctionAsync(string, PrivateAuction, CancellationToken)

API to create a PrivateAuction object.

Declaration

public virtual Task<PrivateAuction> CreatePrivateAuctionAsync(string parent, PrivateAuction privateAuction, CancellationToken cancellationToken)

Parameters

Type	Name	Description
string	parent	Required. The parent resource where this PrivateAuction will be created. Format: networks/{network_code}
PrivateAuction	privateAuction	Required. The PrivateAuction to create.
CancellationToken	cancellationToken	A CancellationToken to use for this RPC.

Returns

Type	Description
Task<PrivateAuction>	A Task containing the RPC response.

Sample code

// Create client
PrivateAuctionServiceClient privateAuctionServiceClient = await PrivateAuctionServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "networks/[NETWORK_CODE]";
PrivateAuction privateAuction = new PrivateAuction();
// Make the request
PrivateAuction response = await privateAuctionServiceClient.CreatePrivateAuctionAsync(parent, privateAuction);

GetPrivateAuction(GetPrivateAuctionRequest, CallSettings)

API to retrieve a PrivateAuction object.

Declaration

public virtual PrivateAuction GetPrivateAuction(GetPrivateAuctionRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
GetPrivateAuctionRequest	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
PrivateAuction	The RPC response.

Sample code

// Create client
PrivateAuctionServiceClient privateAuctionServiceClient = PrivateAuctionServiceClient.Create();
// Initialize request argument(s)
GetPrivateAuctionRequest request = new GetPrivateAuctionRequest
{
    PrivateAuctionName = PrivateAuctionName.FromNetworkCodePrivateAuction("[NETWORK_CODE]", "[PRIVATE_AUCTION]"),
};
// Make the request
PrivateAuction response = privateAuctionServiceClient.GetPrivateAuction(request);

GetPrivateAuction(PrivateAuctionName, CallSettings)

API to retrieve a PrivateAuction object.

Declaration

public virtual PrivateAuction GetPrivateAuction(PrivateAuctionName name, CallSettings callSettings = null)

Parameters

Type	Name	Description
PrivateAuctionName	name	Required. The resource name of the PrivateAuction. Format: networks/{network_code}/privateAuctions/{private_auction_id}
CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

Type	Description
PrivateAuction	The RPC response.

Sample code

// Create client
PrivateAuctionServiceClient privateAuctionServiceClient = PrivateAuctionServiceClient.Create();
// Initialize request argument(s)
PrivateAuctionName name = PrivateAuctionName.FromNetworkCodePrivateAuction("[NETWORK_CODE]", "[PRIVATE_AUCTION]");
// Make the request
PrivateAuction response = privateAuctionServiceClient.GetPrivateAuction(name);

GetPrivateAuction(string, CallSettings)

API to retrieve a PrivateAuction object.

Declaration

public virtual PrivateAuction GetPrivateAuction(string name, CallSettings callSettings = null)

Parameters

Type	Name	Description
string	name	Required. The resource name of the PrivateAuction. Format: networks/{network_code}/privateAuctions/{private_auction_id}
CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

Type	Description
PrivateAuction	The RPC response.

Sample code

// Create client
PrivateAuctionServiceClient privateAuctionServiceClient = PrivateAuctionServiceClient.Create();
// Initialize request argument(s)
string name = "networks/[NETWORK_CODE]/privateAuctions/[PRIVATE_AUCTION]";
// Make the request
PrivateAuction response = privateAuctionServiceClient.GetPrivateAuction(name);

GetPrivateAuctionAsync(GetPrivateAuctionRequest, CallSettings)

API to retrieve a PrivateAuction object.

Declaration

public virtual Task<PrivateAuction> GetPrivateAuctionAsync(GetPrivateAuctionRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
GetPrivateAuctionRequest	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<PrivateAuction>	A Task containing the RPC response.

Sample code

// Create client
PrivateAuctionServiceClient privateAuctionServiceClient = await PrivateAuctionServiceClient.CreateAsync();
// Initialize request argument(s)
GetPrivateAuctionRequest request = new GetPrivateAuctionRequest
{
    PrivateAuctionName = PrivateAuctionName.FromNetworkCodePrivateAuction("[NETWORK_CODE]", "[PRIVATE_AUCTION]"),
};
// Make the request
PrivateAuction response = await privateAuctionServiceClient.GetPrivateAuctionAsync(request);

GetPrivateAuctionAsync(GetPrivateAuctionRequest, CancellationToken)

API to retrieve a PrivateAuction object.

Declaration

public virtual Task<PrivateAuction> GetPrivateAuctionAsync(GetPrivateAuctionRequest request, CancellationToken cancellationToken)

Parameters

Type	Name	Description
GetPrivateAuctionRequest	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<PrivateAuction>	A Task containing the RPC response.

Sample code

// Create client
PrivateAuctionServiceClient privateAuctionServiceClient = await PrivateAuctionServiceClient.CreateAsync();
// Initialize request argument(s)
GetPrivateAuctionRequest request = new GetPrivateAuctionRequest
{
    PrivateAuctionName = PrivateAuctionName.FromNetworkCodePrivateAuction("[NETWORK_CODE]", "[PRIVATE_AUCTION]"),
};
// Make the request
PrivateAuction response = await privateAuctionServiceClient.GetPrivateAuctionAsync(request);

GetPrivateAuctionAsync(PrivateAuctionName, CallSettings)

API to retrieve a PrivateAuction object.

Declaration

public virtual Task<PrivateAuction> GetPrivateAuctionAsync(PrivateAuctionName name, CallSettings callSettings = null)

Parameters

Type	Name	Description
PrivateAuctionName	name	Required. The resource name of the PrivateAuction. Format: networks/{network_code}/privateAuctions/{private_auction_id}
CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

Type	Description
Task<PrivateAuction>	A Task containing the RPC response.

Sample code

// Create client
PrivateAuctionServiceClient privateAuctionServiceClient = await PrivateAuctionServiceClient.CreateAsync();
// Initialize request argument(s)
PrivateAuctionName name = PrivateAuctionName.FromNetworkCodePrivateAuction("[NETWORK_CODE]", "[PRIVATE_AUCTION]");
// Make the request
PrivateAuction response = await privateAuctionServiceClient.GetPrivateAuctionAsync(name);

GetPrivateAuctionAsync(PrivateAuctionName, CancellationToken)

API to retrieve a PrivateAuction object.

Declaration

public virtual Task<PrivateAuction> GetPrivateAuctionAsync(PrivateAuctionName name, CancellationToken cancellationToken)

Parameters

Type	Name	Description
PrivateAuctionName	name	Required. The resource name of the PrivateAuction. Format: networks/{network_code}/privateAuctions/{private_auction_id}
CancellationToken	cancellationToken	A CancellationToken to use for this RPC.

Returns

Type	Description
Task<PrivateAuction>	A Task containing the RPC response.

Sample code

// Create client
PrivateAuctionServiceClient privateAuctionServiceClient = await PrivateAuctionServiceClient.CreateAsync();
// Initialize request argument(s)
PrivateAuctionName name = PrivateAuctionName.FromNetworkCodePrivateAuction("[NETWORK_CODE]", "[PRIVATE_AUCTION]");
// Make the request
PrivateAuction response = await privateAuctionServiceClient.GetPrivateAuctionAsync(name);

GetPrivateAuctionAsync(string, CallSettings)

API to retrieve a PrivateAuction object.

Declaration

public virtual Task<PrivateAuction> GetPrivateAuctionAsync(string name, CallSettings callSettings = null)

Parameters

Type	Name	Description
string	name	Required. The resource name of the PrivateAuction. Format: networks/{network_code}/privateAuctions/{private_auction_id}
CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

Type	Description
Task<PrivateAuction>	A Task containing the RPC response.

Sample code

// Create client
PrivateAuctionServiceClient privateAuctionServiceClient = await PrivateAuctionServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "networks/[NETWORK_CODE]/privateAuctions/[PRIVATE_AUCTION]";
// Make the request
PrivateAuction response = await privateAuctionServiceClient.GetPrivateAuctionAsync(name);

GetPrivateAuctionAsync(string, CancellationToken)

API to retrieve a PrivateAuction object.

Declaration

public virtual Task<PrivateAuction> GetPrivateAuctionAsync(string name, CancellationToken cancellationToken)

Parameters

Type	Name	Description
string	name	Required. The resource name of the PrivateAuction. Format: networks/{network_code}/privateAuctions/{private_auction_id}
CancellationToken	cancellationToken	A CancellationToken to use for this RPC.

Returns

Type	Description
Task<PrivateAuction>	A Task containing the RPC response.

Sample code

// Create client
PrivateAuctionServiceClient privateAuctionServiceClient = await PrivateAuctionServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "networks/[NETWORK_CODE]/privateAuctions/[PRIVATE_AUCTION]";
// Make the request
PrivateAuction response = await privateAuctionServiceClient.GetPrivateAuctionAsync(name);

ListPrivateAuctions(ListPrivateAuctionsRequest, CallSettings)

API to retrieve a list of PrivateAuction objects.

Declaration

public virtual PagedEnumerable<ListPrivateAuctionsResponse, PrivateAuction> ListPrivateAuctions(ListPrivateAuctionsRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
ListPrivateAuctionsRequest	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<ListPrivateAuctionsResponse, PrivateAuction>	A pageable sequence of PrivateAuction resources.

Sample code

// Create client
PrivateAuctionServiceClient privateAuctionServiceClient = PrivateAuctionServiceClient.Create();
// Initialize request argument(s)
ListPrivateAuctionsRequest request = new ListPrivateAuctionsRequest
{
    ParentAsNetworkName = NetworkName.FromNetworkCode("[NETWORK_CODE]"),
    Filter = "",
    OrderBy = "",
    Skip = 0,
};
// Make the request
PagedEnumerable<ListPrivateAuctionsResponse, PrivateAuction> response = privateAuctionServiceClient.ListPrivateAuctions(request);

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

ListPrivateAuctions(NetworkName, string, int?, CallSettings)

API to retrieve a list of PrivateAuction objects.

Declaration

public virtual PagedEnumerable<ListPrivateAuctionsResponse, PrivateAuction> ListPrivateAuctions(NetworkName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Parameters

Type	Name	Description
NetworkName	parent	Required. The parent, which owns this collection of PrivateAuctions. Format: networks/{network_code}
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<ListPrivateAuctionsResponse, PrivateAuction>	A pageable sequence of PrivateAuction resources.

Sample code

// Create client
PrivateAuctionServiceClient privateAuctionServiceClient = PrivateAuctionServiceClient.Create();
// Initialize request argument(s)
NetworkName parent = NetworkName.FromNetworkCode("[NETWORK_CODE]");
// Make the request
PagedEnumerable<ListPrivateAuctionsResponse, PrivateAuction> response = privateAuctionServiceClient.ListPrivateAuctions(parent);

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

ListPrivateAuctions(string, string, int?, CallSettings)

API to retrieve a list of PrivateAuction objects.

Declaration

public virtual PagedEnumerable<ListPrivateAuctionsResponse, PrivateAuction> ListPrivateAuctions(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Parameters

Type	Name	Description
string	parent	Required. The parent, which owns this collection of PrivateAuctions. Format: networks/{network_code}
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<ListPrivateAuctionsResponse, PrivateAuction>	A pageable sequence of PrivateAuction resources.

Sample code

// Create client
PrivateAuctionServiceClient privateAuctionServiceClient = PrivateAuctionServiceClient.Create();
// Initialize request argument(s)
string parent = "networks/[NETWORK_CODE]";
// Make the request
PagedEnumerable<ListPrivateAuctionsResponse, PrivateAuction> response = privateAuctionServiceClient.ListPrivateAuctions(parent);

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

ListPrivateAuctionsAsync(ListPrivateAuctionsRequest, CallSettings)

API to retrieve a list of PrivateAuction objects.

Declaration

public virtual PagedAsyncEnumerable<ListPrivateAuctionsResponse, PrivateAuction> ListPrivateAuctionsAsync(ListPrivateAuctionsRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
ListPrivateAuctionsRequest	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<ListPrivateAuctionsResponse, PrivateAuction>	A pageable asynchronous sequence of PrivateAuction resources.

Sample code

// Create client
PrivateAuctionServiceClient privateAuctionServiceClient = await PrivateAuctionServiceClient.CreateAsync();
// Initialize request argument(s)
ListPrivateAuctionsRequest request = new ListPrivateAuctionsRequest
{
    ParentAsNetworkName = NetworkName.FromNetworkCode("[NETWORK_CODE]"),
    Filter = "",
    OrderBy = "",
    Skip = 0,
};
// Make the request
PagedAsyncEnumerable<ListPrivateAuctionsResponse, PrivateAuction> response = privateAuctionServiceClient.ListPrivateAuctionsAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((PrivateAuction item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListPrivateAuctionsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (PrivateAuction 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<PrivateAuction> 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 (PrivateAuction 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;

ListPrivateAuctionsAsync(NetworkName, string, int?, CallSettings)

API to retrieve a list of PrivateAuction objects.

Declaration

public virtual PagedAsyncEnumerable<ListPrivateAuctionsResponse, PrivateAuction> ListPrivateAuctionsAsync(NetworkName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Parameters

Type	Name	Description
NetworkName	parent	Required. The parent, which owns this collection of PrivateAuctions. Format: networks/{network_code}
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<ListPrivateAuctionsResponse, PrivateAuction>	A pageable asynchronous sequence of PrivateAuction resources.

Sample code

// Create client
PrivateAuctionServiceClient privateAuctionServiceClient = await PrivateAuctionServiceClient.CreateAsync();
// Initialize request argument(s)
NetworkName parent = NetworkName.FromNetworkCode("[NETWORK_CODE]");
// Make the request
PagedAsyncEnumerable<ListPrivateAuctionsResponse, PrivateAuction> response = privateAuctionServiceClient.ListPrivateAuctionsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((PrivateAuction item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListPrivateAuctionsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (PrivateAuction 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<PrivateAuction> 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 (PrivateAuction 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;

ListPrivateAuctionsAsync(string, string, int?, CallSettings)

API to retrieve a list of PrivateAuction objects.

Declaration

public virtual PagedAsyncEnumerable<ListPrivateAuctionsResponse, PrivateAuction> ListPrivateAuctionsAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Parameters

Type	Name	Description
string	parent	Required. The parent, which owns this collection of PrivateAuctions. Format: networks/{network_code}
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<ListPrivateAuctionsResponse, PrivateAuction>	A pageable asynchronous sequence of PrivateAuction resources.

Sample code

// Create client
PrivateAuctionServiceClient privateAuctionServiceClient = await PrivateAuctionServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "networks/[NETWORK_CODE]";
// Make the request
PagedAsyncEnumerable<ListPrivateAuctionsResponse, PrivateAuction> response = privateAuctionServiceClient.ListPrivateAuctionsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((PrivateAuction item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListPrivateAuctionsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (PrivateAuction 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<PrivateAuction> 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 (PrivateAuction 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.

UpdatePrivateAuction(PrivateAuction, FieldMask, CallSettings)

API to update a PrivateAuction object.

Declaration

public virtual PrivateAuction UpdatePrivateAuction(PrivateAuction privateAuction, FieldMask updateMask, CallSettings callSettings = null)

Parameters

Type	Name	Description
PrivateAuction	privateAuction	Required. The PrivateAuction to update. The PrivateAuction's name is used to identify the PrivateAuction to update.
FieldMask	updateMask	Required. The list of fields to update.
CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

Type	Description
PrivateAuction	The RPC response.

Sample code

// Create client
PrivateAuctionServiceClient privateAuctionServiceClient = PrivateAuctionServiceClient.Create();
// Initialize request argument(s)
PrivateAuction privateAuction = new PrivateAuction();
FieldMask updateMask = new FieldMask();
// Make the request
PrivateAuction response = privateAuctionServiceClient.UpdatePrivateAuction(privateAuction, updateMask);

UpdatePrivateAuction(UpdatePrivateAuctionRequest, CallSettings)

API to update a PrivateAuction object.

Declaration

public virtual PrivateAuction UpdatePrivateAuction(UpdatePrivateAuctionRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
UpdatePrivateAuctionRequest	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
PrivateAuction	The RPC response.

Sample code

// Create client
PrivateAuctionServiceClient privateAuctionServiceClient = PrivateAuctionServiceClient.Create();
// Initialize request argument(s)
UpdatePrivateAuctionRequest request = new UpdatePrivateAuctionRequest
{
    PrivateAuction = new PrivateAuction(),
    UpdateMask = new FieldMask(),
};
// Make the request
PrivateAuction response = privateAuctionServiceClient.UpdatePrivateAuction(request);

UpdatePrivateAuctionAsync(PrivateAuction, FieldMask, CallSettings)

API to update a PrivateAuction object.

Declaration

public virtual Task<PrivateAuction> UpdatePrivateAuctionAsync(PrivateAuction privateAuction, FieldMask updateMask, CallSettings callSettings = null)

Parameters

Type	Name	Description
PrivateAuction	privateAuction	Required. The PrivateAuction to update. The PrivateAuction's name is used to identify the PrivateAuction to update.
FieldMask	updateMask	Required. The list of fields to update.
CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

Type	Description
Task<PrivateAuction>	A Task containing the RPC response.

Sample code

// Create client
PrivateAuctionServiceClient privateAuctionServiceClient = await PrivateAuctionServiceClient.CreateAsync();
// Initialize request argument(s)
PrivateAuction privateAuction = new PrivateAuction();
FieldMask updateMask = new FieldMask();
// Make the request
PrivateAuction response = await privateAuctionServiceClient.UpdatePrivateAuctionAsync(privateAuction, updateMask);

UpdatePrivateAuctionAsync(PrivateAuction, FieldMask, CancellationToken)

API to update a PrivateAuction object.

Declaration

public virtual Task<PrivateAuction> UpdatePrivateAuctionAsync(PrivateAuction privateAuction, FieldMask updateMask, CancellationToken cancellationToken)

Parameters

Type	Name	Description
PrivateAuction	privateAuction	Required. The PrivateAuction to update. The PrivateAuction's name is used to identify the PrivateAuction to update.
FieldMask	updateMask	Required. The list of fields to update.
CancellationToken	cancellationToken	A CancellationToken to use for this RPC.

Returns

Type	Description
Task<PrivateAuction>	A Task containing the RPC response.

Sample code

// Create client
PrivateAuctionServiceClient privateAuctionServiceClient = await PrivateAuctionServiceClient.CreateAsync();
// Initialize request argument(s)
PrivateAuction privateAuction = new PrivateAuction();
FieldMask updateMask = new FieldMask();
// Make the request
PrivateAuction response = await privateAuctionServiceClient.UpdatePrivateAuctionAsync(privateAuction, updateMask);

UpdatePrivateAuctionAsync(UpdatePrivateAuctionRequest, CallSettings)

API to update a PrivateAuction object.

Declaration

public virtual Task<PrivateAuction> UpdatePrivateAuctionAsync(UpdatePrivateAuctionRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
UpdatePrivateAuctionRequest	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<PrivateAuction>	A Task containing the RPC response.

Sample code

// Create client
PrivateAuctionServiceClient privateAuctionServiceClient = await PrivateAuctionServiceClient.CreateAsync();
// Initialize request argument(s)
UpdatePrivateAuctionRequest request = new UpdatePrivateAuctionRequest
{
    PrivateAuction = new PrivateAuction(),
    UpdateMask = new FieldMask(),
};
// Make the request
PrivateAuction response = await privateAuctionServiceClient.UpdatePrivateAuctionAsync(request);

UpdatePrivateAuctionAsync(UpdatePrivateAuctionRequest, CancellationToken)

API to update a PrivateAuction object.

Declaration

public virtual Task<PrivateAuction> UpdatePrivateAuctionAsync(UpdatePrivateAuctionRequest request, CancellationToken cancellationToken)

Parameters

Type	Name	Description
UpdatePrivateAuctionRequest	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<PrivateAuction>	A Task containing the RPC response.

Sample code

// Create client
PrivateAuctionServiceClient privateAuctionServiceClient = await PrivateAuctionServiceClient.CreateAsync();
// Initialize request argument(s)
UpdatePrivateAuctionRequest request = new UpdatePrivateAuctionRequest
{
    PrivateAuction = new PrivateAuction(),
    UpdateMask = new FieldMask(),
};
// Make the request
PrivateAuction response = await privateAuctionServiceClient.UpdatePrivateAuctionAsync(request);