Class CustomFieldServiceClient

CustomFieldService client wrapper, for convenient use.

Inheritance

object

CustomFieldServiceClient

CustomFieldServiceClientImpl

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 CustomFieldServiceClient

Remarks

Provides methods for handling CustomField objects.

Properties

DefaultEndpoint

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

Declaration

public static IReadOnlyList<string> DefaultScopes { get; }

Property Value

Type	Description
IReadOnlyList<string>

Remarks

The default CustomFieldService scopes are:

GrpcClient

The underlying gRPC CustomFieldService client

Declaration

public virtual CustomFieldService.CustomFieldServiceClient GrpcClient { get; }

Property Value

Type	Description
CustomFieldService.CustomFieldServiceClient

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

Declaration

public static CustomFieldServiceClient Create()

Returns

Type	Description
CustomFieldServiceClient	The created CustomFieldServiceClient.

CreateAsync(CancellationToken)

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

Declaration

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

Parameters

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

Returns

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

GetCustomField(CustomFieldName, CallSettings)

API to retrieve a CustomField object.

Declaration

public virtual CustomField GetCustomField(CustomFieldName name, CallSettings callSettings = null)

Parameters

Type	Name	Description
CustomFieldName	name	Required. The resource name of the CustomField. Format: networks/{network_code}/customFields/{custom_field_id}
CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

Type	Description
CustomField	The RPC response.

Sample code

// Create client
CustomFieldServiceClient customFieldServiceClient = CustomFieldServiceClient.Create();
// Initialize request argument(s)
CustomFieldName name = CustomFieldName.FromNetworkCodeCustomField("[NETWORK_CODE]", "[CUSTOM_FIELD]");
// Make the request
CustomField response = customFieldServiceClient.GetCustomField(name);

GetCustomField(GetCustomFieldRequest, CallSettings)

API to retrieve a CustomField object.

Declaration

public virtual CustomField GetCustomField(GetCustomFieldRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
GetCustomFieldRequest	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
CustomField	The RPC response.

Sample code

// Create client
CustomFieldServiceClient customFieldServiceClient = CustomFieldServiceClient.Create();
// Initialize request argument(s)
GetCustomFieldRequest request = new GetCustomFieldRequest
{
    CustomFieldName = CustomFieldName.FromNetworkCodeCustomField("[NETWORK_CODE]", "[CUSTOM_FIELD]"),
};
// Make the request
CustomField response = customFieldServiceClient.GetCustomField(request);

GetCustomField(string, CallSettings)

API to retrieve a CustomField object.

Declaration

public virtual CustomField GetCustomField(string name, CallSettings callSettings = null)

Parameters

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

Returns

Type	Description
CustomField	The RPC response.

Sample code

// Create client
CustomFieldServiceClient customFieldServiceClient = CustomFieldServiceClient.Create();
// Initialize request argument(s)
string name = "networks/[NETWORK_CODE]/customFields/[CUSTOM_FIELD]";
// Make the request
CustomField response = customFieldServiceClient.GetCustomField(name);

GetCustomFieldAsync(CustomFieldName, CallSettings)

API to retrieve a CustomField object.

Declaration

public virtual Task<CustomField> GetCustomFieldAsync(CustomFieldName name, CallSettings callSettings = null)

Parameters

Type	Name	Description
CustomFieldName	name	Required. The resource name of the CustomField. Format: networks/{network_code}/customFields/{custom_field_id}
CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

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

Sample code

// Create client
CustomFieldServiceClient customFieldServiceClient = await CustomFieldServiceClient.CreateAsync();
// Initialize request argument(s)
CustomFieldName name = CustomFieldName.FromNetworkCodeCustomField("[NETWORK_CODE]", "[CUSTOM_FIELD]");
// Make the request
CustomField response = await customFieldServiceClient.GetCustomFieldAsync(name);

GetCustomFieldAsync(CustomFieldName, CancellationToken)

API to retrieve a CustomField object.

Declaration

public virtual Task<CustomField> GetCustomFieldAsync(CustomFieldName name, CancellationToken cancellationToken)

Parameters

Type	Name	Description
CustomFieldName	name	Required. The resource name of the CustomField. Format: networks/{network_code}/customFields/{custom_field_id}
CancellationToken	cancellationToken	A CancellationToken to use for this RPC.

Returns

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

Sample code

// Create client
CustomFieldServiceClient customFieldServiceClient = await CustomFieldServiceClient.CreateAsync();
// Initialize request argument(s)
CustomFieldName name = CustomFieldName.FromNetworkCodeCustomField("[NETWORK_CODE]", "[CUSTOM_FIELD]");
// Make the request
CustomField response = await customFieldServiceClient.GetCustomFieldAsync(name);

GetCustomFieldAsync(GetCustomFieldRequest, CallSettings)

API to retrieve a CustomField object.

Declaration

public virtual Task<CustomField> GetCustomFieldAsync(GetCustomFieldRequest request, CallSettings callSettings = null)

Parameters

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

Sample code

// Create client
CustomFieldServiceClient customFieldServiceClient = await CustomFieldServiceClient.CreateAsync();
// Initialize request argument(s)
GetCustomFieldRequest request = new GetCustomFieldRequest
{
    CustomFieldName = CustomFieldName.FromNetworkCodeCustomField("[NETWORK_CODE]", "[CUSTOM_FIELD]"),
};
// Make the request
CustomField response = await customFieldServiceClient.GetCustomFieldAsync(request);

GetCustomFieldAsync(GetCustomFieldRequest, CancellationToken)

API to retrieve a CustomField object.

Declaration

public virtual Task<CustomField> GetCustomFieldAsync(GetCustomFieldRequest request, CancellationToken cancellationToken)

Parameters

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

Sample code

// Create client
CustomFieldServiceClient customFieldServiceClient = await CustomFieldServiceClient.CreateAsync();
// Initialize request argument(s)
GetCustomFieldRequest request = new GetCustomFieldRequest
{
    CustomFieldName = CustomFieldName.FromNetworkCodeCustomField("[NETWORK_CODE]", "[CUSTOM_FIELD]"),
};
// Make the request
CustomField response = await customFieldServiceClient.GetCustomFieldAsync(request);

GetCustomFieldAsync(string, CallSettings)

API to retrieve a CustomField object.

Declaration

public virtual Task<CustomField> GetCustomFieldAsync(string name, CallSettings callSettings = null)

Parameters

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

Returns

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

Sample code

// Create client
CustomFieldServiceClient customFieldServiceClient = await CustomFieldServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "networks/[NETWORK_CODE]/customFields/[CUSTOM_FIELD]";
// Make the request
CustomField response = await customFieldServiceClient.GetCustomFieldAsync(name);

GetCustomFieldAsync(string, CancellationToken)

API to retrieve a CustomField object.

Declaration

public virtual Task<CustomField> GetCustomFieldAsync(string name, CancellationToken cancellationToken)

Parameters

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

Returns

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

Sample code

// Create client
CustomFieldServiceClient customFieldServiceClient = await CustomFieldServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "networks/[NETWORK_CODE]/customFields/[CUSTOM_FIELD]";
// Make the request
CustomField response = await customFieldServiceClient.GetCustomFieldAsync(name);

ListCustomFields(ListCustomFieldsRequest, CallSettings)

API to retrieve a list of CustomField objects.

Declaration

public virtual PagedEnumerable<ListCustomFieldsResponse, CustomField> ListCustomFields(ListCustomFieldsRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
ListCustomFieldsRequest	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<ListCustomFieldsResponse, CustomField>	A pageable sequence of CustomField resources.

Sample code

// Create client
CustomFieldServiceClient customFieldServiceClient = CustomFieldServiceClient.Create();
// Initialize request argument(s)
ListCustomFieldsRequest request = new ListCustomFieldsRequest
{
    ParentAsNetworkName = NetworkName.FromNetworkCode("[NETWORK_CODE]"),
    Filter = "",
    OrderBy = "",
    Skip = 0,
};
// Make the request
PagedEnumerable<ListCustomFieldsResponse, CustomField> response = customFieldServiceClient.ListCustomFields(request);

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

ListCustomFields(NetworkName, string, int?, CallSettings)

API to retrieve a list of CustomField objects.

Declaration

public virtual PagedEnumerable<ListCustomFieldsResponse, CustomField> ListCustomFields(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 CustomFields. 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<ListCustomFieldsResponse, CustomField>	A pageable sequence of CustomField resources.

Sample code

// Create client
CustomFieldServiceClient customFieldServiceClient = CustomFieldServiceClient.Create();
// Initialize request argument(s)
NetworkName parent = NetworkName.FromNetworkCode("[NETWORK_CODE]");
// Make the request
PagedEnumerable<ListCustomFieldsResponse, CustomField> response = customFieldServiceClient.ListCustomFields(parent);

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

ListCustomFields(string, string, int?, CallSettings)

API to retrieve a list of CustomField objects.

Declaration

public virtual PagedEnumerable<ListCustomFieldsResponse, CustomField> ListCustomFields(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 CustomFields. 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<ListCustomFieldsResponse, CustomField>	A pageable sequence of CustomField resources.

Sample code

// Create client
CustomFieldServiceClient customFieldServiceClient = CustomFieldServiceClient.Create();
// Initialize request argument(s)
string parent = "networks/[NETWORK_CODE]";
// Make the request
PagedEnumerable<ListCustomFieldsResponse, CustomField> response = customFieldServiceClient.ListCustomFields(parent);

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

ListCustomFieldsAsync(ListCustomFieldsRequest, CallSettings)

API to retrieve a list of CustomField objects.

Declaration

public virtual PagedAsyncEnumerable<ListCustomFieldsResponse, CustomField> ListCustomFieldsAsync(ListCustomFieldsRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
ListCustomFieldsRequest	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<ListCustomFieldsResponse, CustomField>	A pageable asynchronous sequence of CustomField resources.

Sample code

// Create client
CustomFieldServiceClient customFieldServiceClient = await CustomFieldServiceClient.CreateAsync();
// Initialize request argument(s)
ListCustomFieldsRequest request = new ListCustomFieldsRequest
{
    ParentAsNetworkName = NetworkName.FromNetworkCode("[NETWORK_CODE]"),
    Filter = "",
    OrderBy = "",
    Skip = 0,
};
// Make the request
PagedAsyncEnumerable<ListCustomFieldsResponse, CustomField> response = customFieldServiceClient.ListCustomFieldsAsync(request);

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

ListCustomFieldsAsync(NetworkName, string, int?, CallSettings)

API to retrieve a list of CustomField objects.

Declaration

public virtual PagedAsyncEnumerable<ListCustomFieldsResponse, CustomField> ListCustomFieldsAsync(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 CustomFields. 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<ListCustomFieldsResponse, CustomField>	A pageable asynchronous sequence of CustomField resources.

Sample code

// Create client
CustomFieldServiceClient customFieldServiceClient = await CustomFieldServiceClient.CreateAsync();
// Initialize request argument(s)
NetworkName parent = NetworkName.FromNetworkCode("[NETWORK_CODE]");
// Make the request
PagedAsyncEnumerable<ListCustomFieldsResponse, CustomField> response = customFieldServiceClient.ListCustomFieldsAsync(parent);

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

ListCustomFieldsAsync(string, string, int?, CallSettings)

API to retrieve a list of CustomField objects.

Declaration

public virtual PagedAsyncEnumerable<ListCustomFieldsResponse, CustomField> ListCustomFieldsAsync(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 CustomFields. 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<ListCustomFieldsResponse, CustomField>	A pageable asynchronous sequence of CustomField resources.

Sample code

// Create client
CustomFieldServiceClient customFieldServiceClient = await CustomFieldServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "networks/[NETWORK_CODE]";
// Make the request
PagedAsyncEnumerable<ListCustomFieldsResponse, CustomField> response = customFieldServiceClient.ListCustomFieldsAsync(parent);

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