Class CustomTargetingKeyServiceClient

CustomTargetingKeyService client wrapper, for convenient use.

Inheritance

object

CustomTargetingKeyServiceClient

CustomTargetingKeyServiceClientImpl

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 CustomTargetingKeyServiceClient

Remarks

Provides methods for handling CustomTargetingKey objects.

Properties

DefaultEndpoint

The default endpoint for the CustomTargetingKeyService 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 CustomTargetingKeyService scopes.

Declaration

public static IReadOnlyList<string> DefaultScopes { get; }

Property Value

Type	Description
IReadOnlyList<string>

Remarks

The default CustomTargetingKeyService scopes are:

GrpcClient

The underlying gRPC CustomTargetingKeyService client

Declaration

public virtual CustomTargetingKeyService.CustomTargetingKeyServiceClient GrpcClient { get; }

Property Value

Type	Description
CustomTargetingKeyService.CustomTargetingKeyServiceClient

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

Declaration

public static CustomTargetingKeyServiceClient Create()

Returns

Type	Description
CustomTargetingKeyServiceClient	The created CustomTargetingKeyServiceClient.

CreateAsync(CancellationToken)

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

Declaration

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

Parameters

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

Returns

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

GetCustomTargetingKey(CustomTargetingKeyName, CallSettings)

API to retrieve a CustomTargetingKey object.

Declaration

public virtual CustomTargetingKey GetCustomTargetingKey(CustomTargetingKeyName name, CallSettings callSettings = null)

Parameters

Type	Name	Description
CustomTargetingKeyName	name	Required. The resource name of the CustomTargetingKey. Format: networks/{network_code}/customTargetingKeys/{custom_targeting_key_id}
CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

Type	Description
CustomTargetingKey	The RPC response.

Sample code

// Create client
CustomTargetingKeyServiceClient customTargetingKeyServiceClient = CustomTargetingKeyServiceClient.Create();
// Initialize request argument(s)
CustomTargetingKeyName name = CustomTargetingKeyName.FromNetworkCodeCustomTargetingKey("[NETWORK_CODE]", "[CUSTOM_TARGETING_KEY]");
// Make the request
CustomTargetingKey response = customTargetingKeyServiceClient.GetCustomTargetingKey(name);

GetCustomTargetingKey(GetCustomTargetingKeyRequest, CallSettings)

API to retrieve a CustomTargetingKey object.

Declaration

public virtual CustomTargetingKey GetCustomTargetingKey(GetCustomTargetingKeyRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
GetCustomTargetingKeyRequest	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
CustomTargetingKey	The RPC response.

Sample code

// Create client
CustomTargetingKeyServiceClient customTargetingKeyServiceClient = CustomTargetingKeyServiceClient.Create();
// Initialize request argument(s)
GetCustomTargetingKeyRequest request = new GetCustomTargetingKeyRequest
{
    CustomTargetingKeyName = CustomTargetingKeyName.FromNetworkCodeCustomTargetingKey("[NETWORK_CODE]", "[CUSTOM_TARGETING_KEY]"),
};
// Make the request
CustomTargetingKey response = customTargetingKeyServiceClient.GetCustomTargetingKey(request);

GetCustomTargetingKey(string, CallSettings)

API to retrieve a CustomTargetingKey object.

Declaration

public virtual CustomTargetingKey GetCustomTargetingKey(string name, CallSettings callSettings = null)

Parameters

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

Returns

Type	Description
CustomTargetingKey	The RPC response.

Sample code

// Create client
CustomTargetingKeyServiceClient customTargetingKeyServiceClient = CustomTargetingKeyServiceClient.Create();
// Initialize request argument(s)
string name = "networks/[NETWORK_CODE]/customTargetingKeys/[CUSTOM_TARGETING_KEY]";
// Make the request
CustomTargetingKey response = customTargetingKeyServiceClient.GetCustomTargetingKey(name);

GetCustomTargetingKeyAsync(CustomTargetingKeyName, CallSettings)

API to retrieve a CustomTargetingKey object.

Declaration

public virtual Task<CustomTargetingKey> GetCustomTargetingKeyAsync(CustomTargetingKeyName name, CallSettings callSettings = null)

Parameters

Type	Name	Description
CustomTargetingKeyName	name	Required. The resource name of the CustomTargetingKey. Format: networks/{network_code}/customTargetingKeys/{custom_targeting_key_id}
CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

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

Sample code

// Create client
CustomTargetingKeyServiceClient customTargetingKeyServiceClient = await CustomTargetingKeyServiceClient.CreateAsync();
// Initialize request argument(s)
CustomTargetingKeyName name = CustomTargetingKeyName.FromNetworkCodeCustomTargetingKey("[NETWORK_CODE]", "[CUSTOM_TARGETING_KEY]");
// Make the request
CustomTargetingKey response = await customTargetingKeyServiceClient.GetCustomTargetingKeyAsync(name);

GetCustomTargetingKeyAsync(CustomTargetingKeyName, CancellationToken)

API to retrieve a CustomTargetingKey object.

Declaration

public virtual Task<CustomTargetingKey> GetCustomTargetingKeyAsync(CustomTargetingKeyName name, CancellationToken cancellationToken)

Parameters

Type	Name	Description
CustomTargetingKeyName	name	Required. The resource name of the CustomTargetingKey. Format: networks/{network_code}/customTargetingKeys/{custom_targeting_key_id}
CancellationToken	cancellationToken	A CancellationToken to use for this RPC.

Returns

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

Sample code

// Create client
CustomTargetingKeyServiceClient customTargetingKeyServiceClient = await CustomTargetingKeyServiceClient.CreateAsync();
// Initialize request argument(s)
CustomTargetingKeyName name = CustomTargetingKeyName.FromNetworkCodeCustomTargetingKey("[NETWORK_CODE]", "[CUSTOM_TARGETING_KEY]");
// Make the request
CustomTargetingKey response = await customTargetingKeyServiceClient.GetCustomTargetingKeyAsync(name);

GetCustomTargetingKeyAsync(GetCustomTargetingKeyRequest, CallSettings)

API to retrieve a CustomTargetingKey object.

Declaration

public virtual Task<CustomTargetingKey> GetCustomTargetingKeyAsync(GetCustomTargetingKeyRequest request, CallSettings callSettings = null)

Parameters

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

Sample code

// Create client
CustomTargetingKeyServiceClient customTargetingKeyServiceClient = await CustomTargetingKeyServiceClient.CreateAsync();
// Initialize request argument(s)
GetCustomTargetingKeyRequest request = new GetCustomTargetingKeyRequest
{
    CustomTargetingKeyName = CustomTargetingKeyName.FromNetworkCodeCustomTargetingKey("[NETWORK_CODE]", "[CUSTOM_TARGETING_KEY]"),
};
// Make the request
CustomTargetingKey response = await customTargetingKeyServiceClient.GetCustomTargetingKeyAsync(request);

GetCustomTargetingKeyAsync(GetCustomTargetingKeyRequest, CancellationToken)

API to retrieve a CustomTargetingKey object.

Declaration

public virtual Task<CustomTargetingKey> GetCustomTargetingKeyAsync(GetCustomTargetingKeyRequest request, CancellationToken cancellationToken)

Parameters

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

Sample code

// Create client
CustomTargetingKeyServiceClient customTargetingKeyServiceClient = await CustomTargetingKeyServiceClient.CreateAsync();
// Initialize request argument(s)
GetCustomTargetingKeyRequest request = new GetCustomTargetingKeyRequest
{
    CustomTargetingKeyName = CustomTargetingKeyName.FromNetworkCodeCustomTargetingKey("[NETWORK_CODE]", "[CUSTOM_TARGETING_KEY]"),
};
// Make the request
CustomTargetingKey response = await customTargetingKeyServiceClient.GetCustomTargetingKeyAsync(request);

GetCustomTargetingKeyAsync(string, CallSettings)

API to retrieve a CustomTargetingKey object.

Declaration

public virtual Task<CustomTargetingKey> GetCustomTargetingKeyAsync(string name, CallSettings callSettings = null)

Parameters

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

Returns

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

Sample code

// Create client
CustomTargetingKeyServiceClient customTargetingKeyServiceClient = await CustomTargetingKeyServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "networks/[NETWORK_CODE]/customTargetingKeys/[CUSTOM_TARGETING_KEY]";
// Make the request
CustomTargetingKey response = await customTargetingKeyServiceClient.GetCustomTargetingKeyAsync(name);

GetCustomTargetingKeyAsync(string, CancellationToken)

API to retrieve a CustomTargetingKey object.

Declaration

public virtual Task<CustomTargetingKey> GetCustomTargetingKeyAsync(string name, CancellationToken cancellationToken)

Parameters

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

Returns

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

Sample code

// Create client
CustomTargetingKeyServiceClient customTargetingKeyServiceClient = await CustomTargetingKeyServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "networks/[NETWORK_CODE]/customTargetingKeys/[CUSTOM_TARGETING_KEY]";
// Make the request
CustomTargetingKey response = await customTargetingKeyServiceClient.GetCustomTargetingKeyAsync(name);

ListCustomTargetingKeys(ListCustomTargetingKeysRequest, CallSettings)

API to retrieve a list of CustomTargetingKey objects.

Declaration

public virtual PagedEnumerable<ListCustomTargetingKeysResponse, CustomTargetingKey> ListCustomTargetingKeys(ListCustomTargetingKeysRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
ListCustomTargetingKeysRequest	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<ListCustomTargetingKeysResponse, CustomTargetingKey>	A pageable sequence of CustomTargetingKey resources.

Sample code

// Create client
CustomTargetingKeyServiceClient customTargetingKeyServiceClient = CustomTargetingKeyServiceClient.Create();
// Initialize request argument(s)
ListCustomTargetingKeysRequest request = new ListCustomTargetingKeysRequest
{
    ParentAsNetworkName = NetworkName.FromNetworkCode("[NETWORK_CODE]"),
    Filter = "",
    OrderBy = "",
    Skip = 0,
};
// Make the request
PagedEnumerable<ListCustomTargetingKeysResponse, CustomTargetingKey> response = customTargetingKeyServiceClient.ListCustomTargetingKeys(request);

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

ListCustomTargetingKeys(NetworkName, string, int?, CallSettings)

API to retrieve a list of CustomTargetingKey objects.

Declaration

public virtual PagedEnumerable<ListCustomTargetingKeysResponse, CustomTargetingKey> ListCustomTargetingKeys(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 CustomTargetingKeys. 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<ListCustomTargetingKeysResponse, CustomTargetingKey>	A pageable sequence of CustomTargetingKey resources.

Sample code

// Create client
CustomTargetingKeyServiceClient customTargetingKeyServiceClient = CustomTargetingKeyServiceClient.Create();
// Initialize request argument(s)
NetworkName parent = NetworkName.FromNetworkCode("[NETWORK_CODE]");
// Make the request
PagedEnumerable<ListCustomTargetingKeysResponse, CustomTargetingKey> response = customTargetingKeyServiceClient.ListCustomTargetingKeys(parent);

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

ListCustomTargetingKeys(string, string, int?, CallSettings)

API to retrieve a list of CustomTargetingKey objects.

Declaration

public virtual PagedEnumerable<ListCustomTargetingKeysResponse, CustomTargetingKey> ListCustomTargetingKeys(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 CustomTargetingKeys. 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<ListCustomTargetingKeysResponse, CustomTargetingKey>	A pageable sequence of CustomTargetingKey resources.

Sample code

// Create client
CustomTargetingKeyServiceClient customTargetingKeyServiceClient = CustomTargetingKeyServiceClient.Create();
// Initialize request argument(s)
string parent = "networks/[NETWORK_CODE]";
// Make the request
PagedEnumerable<ListCustomTargetingKeysResponse, CustomTargetingKey> response = customTargetingKeyServiceClient.ListCustomTargetingKeys(parent);

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

ListCustomTargetingKeysAsync(ListCustomTargetingKeysRequest, CallSettings)

API to retrieve a list of CustomTargetingKey objects.

Declaration

public virtual PagedAsyncEnumerable<ListCustomTargetingKeysResponse, CustomTargetingKey> ListCustomTargetingKeysAsync(ListCustomTargetingKeysRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
ListCustomTargetingKeysRequest	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<ListCustomTargetingKeysResponse, CustomTargetingKey>	A pageable asynchronous sequence of CustomTargetingKey resources.

Sample code

// Create client
CustomTargetingKeyServiceClient customTargetingKeyServiceClient = await CustomTargetingKeyServiceClient.CreateAsync();
// Initialize request argument(s)
ListCustomTargetingKeysRequest request = new ListCustomTargetingKeysRequest
{
    ParentAsNetworkName = NetworkName.FromNetworkCode("[NETWORK_CODE]"),
    Filter = "",
    OrderBy = "",
    Skip = 0,
};
// Make the request
PagedAsyncEnumerable<ListCustomTargetingKeysResponse, CustomTargetingKey> response = customTargetingKeyServiceClient.ListCustomTargetingKeysAsync(request);

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

ListCustomTargetingKeysAsync(NetworkName, string, int?, CallSettings)

API to retrieve a list of CustomTargetingKey objects.

Declaration

public virtual PagedAsyncEnumerable<ListCustomTargetingKeysResponse, CustomTargetingKey> ListCustomTargetingKeysAsync(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 CustomTargetingKeys. 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<ListCustomTargetingKeysResponse, CustomTargetingKey>	A pageable asynchronous sequence of CustomTargetingKey resources.

Sample code

// Create client
CustomTargetingKeyServiceClient customTargetingKeyServiceClient = await CustomTargetingKeyServiceClient.CreateAsync();
// Initialize request argument(s)
NetworkName parent = NetworkName.FromNetworkCode("[NETWORK_CODE]");
// Make the request
PagedAsyncEnumerable<ListCustomTargetingKeysResponse, CustomTargetingKey> response = customTargetingKeyServiceClient.ListCustomTargetingKeysAsync(parent);

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

ListCustomTargetingKeysAsync(string, string, int?, CallSettings)

API to retrieve a list of CustomTargetingKey objects.

Declaration

public virtual PagedAsyncEnumerable<ListCustomTargetingKeysResponse, CustomTargetingKey> ListCustomTargetingKeysAsync(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 CustomTargetingKeys. 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<ListCustomTargetingKeysResponse, CustomTargetingKey>	A pageable asynchronous sequence of CustomTargetingKey resources.

Sample code

// Create client
CustomTargetingKeyServiceClient customTargetingKeyServiceClient = await CustomTargetingKeyServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "networks/[NETWORK_CODE]";
// Make the request
PagedAsyncEnumerable<ListCustomTargetingKeysResponse, CustomTargetingKey> response = customTargetingKeyServiceClient.ListCustomTargetingKeysAsync(parent);

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