Show / Hide Table of Contents

Class LinkedDeviceServiceClient

LinkedDeviceService client wrapper, for convenient use.

Inheritance
object
LinkedDeviceServiceClient
LinkedDeviceServiceClientImpl
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 LinkedDeviceServiceClient
Remarks

Provides methods for handling LinkedDevice objects.

Properties

DefaultEndpoint

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

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

The default LinkedDeviceService scopes are:

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

GrpcClient

The underlying gRPC LinkedDeviceService client

Declaration
public virtual LinkedDeviceService.LinkedDeviceServiceClient GrpcClient { get; }
Property Value
Type Description
LinkedDeviceService.LinkedDeviceServiceClient

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

Declaration
public static LinkedDeviceServiceClient Create()
Returns
Type Description
LinkedDeviceServiceClient

The created LinkedDeviceServiceClient.

CreateAsync(CancellationToken)

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

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

The CancellationToken to use while creating the client.

Returns
Type Description
Task<LinkedDeviceServiceClient>

The task representing the created LinkedDeviceServiceClient.

GetLinkedDevice(GetLinkedDeviceRequest, CallSettings)

Gets a LinkedDevice.

Declaration
public virtual LinkedDevice GetLinkedDevice(GetLinkedDeviceRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
GetLinkedDeviceRequest 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
LinkedDevice

The RPC response.

Sample code
// Create client
LinkedDeviceServiceClient linkedDeviceServiceClient = LinkedDeviceServiceClient.Create();
// Initialize request argument(s)
GetLinkedDeviceRequest request = new GetLinkedDeviceRequest
{
    LinkedDeviceName = LinkedDeviceName.FromNetworkCodeLinkedDevice("[NETWORK_CODE]", "[LINKED_DEVICE]"),
};
// Make the request
LinkedDevice response = linkedDeviceServiceClient.GetLinkedDevice(request);

GetLinkedDevice(LinkedDeviceName, CallSettings)

Gets a LinkedDevice.

Declaration
public virtual LinkedDevice GetLinkedDevice(LinkedDeviceName name, CallSettings callSettings = null)
Parameters
Type Name Description
LinkedDeviceName name

Required. The resource name of the LinkedDevice. Format: networks/{network_code}/linkedDevices/{linked_device_id}

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
LinkedDevice

The RPC response.

Sample code
// Create client
LinkedDeviceServiceClient linkedDeviceServiceClient = LinkedDeviceServiceClient.Create();
// Initialize request argument(s)
LinkedDeviceName name = LinkedDeviceName.FromNetworkCodeLinkedDevice("[NETWORK_CODE]", "[LINKED_DEVICE]");
// Make the request
LinkedDevice response = linkedDeviceServiceClient.GetLinkedDevice(name);

GetLinkedDevice(string, CallSettings)

Gets a LinkedDevice.

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

Required. The resource name of the LinkedDevice. Format: networks/{network_code}/linkedDevices/{linked_device_id}

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
LinkedDevice

The RPC response.

Sample code
// Create client
LinkedDeviceServiceClient linkedDeviceServiceClient = LinkedDeviceServiceClient.Create();
// Initialize request argument(s)
string name = "networks/[NETWORK_CODE]/linkedDevices/[LINKED_DEVICE]";
// Make the request
LinkedDevice response = linkedDeviceServiceClient.GetLinkedDevice(name);

GetLinkedDeviceAsync(GetLinkedDeviceRequest, CallSettings)

Gets a LinkedDevice.

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

A Task containing the RPC response.

Sample code
// Create client
LinkedDeviceServiceClient linkedDeviceServiceClient = await LinkedDeviceServiceClient.CreateAsync();
// Initialize request argument(s)
GetLinkedDeviceRequest request = new GetLinkedDeviceRequest
{
    LinkedDeviceName = LinkedDeviceName.FromNetworkCodeLinkedDevice("[NETWORK_CODE]", "[LINKED_DEVICE]"),
};
// Make the request
LinkedDevice response = await linkedDeviceServiceClient.GetLinkedDeviceAsync(request);

GetLinkedDeviceAsync(GetLinkedDeviceRequest, CancellationToken)

Gets a LinkedDevice.

Declaration
public virtual Task<LinkedDevice> GetLinkedDeviceAsync(GetLinkedDeviceRequest request, CancellationToken cancellationToken)
Parameters
Type Name Description
GetLinkedDeviceRequest 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<LinkedDevice>

A Task containing the RPC response.

Sample code
// Create client
LinkedDeviceServiceClient linkedDeviceServiceClient = await LinkedDeviceServiceClient.CreateAsync();
// Initialize request argument(s)
GetLinkedDeviceRequest request = new GetLinkedDeviceRequest
{
    LinkedDeviceName = LinkedDeviceName.FromNetworkCodeLinkedDevice("[NETWORK_CODE]", "[LINKED_DEVICE]"),
};
// Make the request
LinkedDevice response = await linkedDeviceServiceClient.GetLinkedDeviceAsync(request);

GetLinkedDeviceAsync(LinkedDeviceName, CallSettings)

Gets a LinkedDevice.

Declaration
public virtual Task<LinkedDevice> GetLinkedDeviceAsync(LinkedDeviceName name, CallSettings callSettings = null)
Parameters
Type Name Description
LinkedDeviceName name

Required. The resource name of the LinkedDevice. Format: networks/{network_code}/linkedDevices/{linked_device_id}

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task<LinkedDevice>

A Task containing the RPC response.

Sample code
// Create client
LinkedDeviceServiceClient linkedDeviceServiceClient = await LinkedDeviceServiceClient.CreateAsync();
// Initialize request argument(s)
LinkedDeviceName name = LinkedDeviceName.FromNetworkCodeLinkedDevice("[NETWORK_CODE]", "[LINKED_DEVICE]");
// Make the request
LinkedDevice response = await linkedDeviceServiceClient.GetLinkedDeviceAsync(name);

GetLinkedDeviceAsync(LinkedDeviceName, CancellationToken)

Gets a LinkedDevice.

Declaration
public virtual Task<LinkedDevice> GetLinkedDeviceAsync(LinkedDeviceName name, CancellationToken cancellationToken)
Parameters
Type Name Description
LinkedDeviceName name

Required. The resource name of the LinkedDevice. Format: networks/{network_code}/linkedDevices/{linked_device_id}

CancellationToken cancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task<LinkedDevice>

A Task containing the RPC response.

Sample code
// Create client
LinkedDeviceServiceClient linkedDeviceServiceClient = await LinkedDeviceServiceClient.CreateAsync();
// Initialize request argument(s)
LinkedDeviceName name = LinkedDeviceName.FromNetworkCodeLinkedDevice("[NETWORK_CODE]", "[LINKED_DEVICE]");
// Make the request
LinkedDevice response = await linkedDeviceServiceClient.GetLinkedDeviceAsync(name);

GetLinkedDeviceAsync(string, CallSettings)

Gets a LinkedDevice.

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

Required. The resource name of the LinkedDevice. Format: networks/{network_code}/linkedDevices/{linked_device_id}

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task<LinkedDevice>

A Task containing the RPC response.

Sample code
// Create client
LinkedDeviceServiceClient linkedDeviceServiceClient = await LinkedDeviceServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "networks/[NETWORK_CODE]/linkedDevices/[LINKED_DEVICE]";
// Make the request
LinkedDevice response = await linkedDeviceServiceClient.GetLinkedDeviceAsync(name);

GetLinkedDeviceAsync(string, CancellationToken)

Gets a LinkedDevice.

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

Required. The resource name of the LinkedDevice. Format: networks/{network_code}/linkedDevices/{linked_device_id}

CancellationToken cancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task<LinkedDevice>

A Task containing the RPC response.

Sample code
// Create client
LinkedDeviceServiceClient linkedDeviceServiceClient = await LinkedDeviceServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "networks/[NETWORK_CODE]/linkedDevices/[LINKED_DEVICE]";
// Make the request
LinkedDevice response = await linkedDeviceServiceClient.GetLinkedDeviceAsync(name);

ListLinkedDevices(ListLinkedDevicesRequest, CallSettings)

Lists LinkedDevice objects.

Declaration
public virtual PagedEnumerable<ListLinkedDevicesResponse, LinkedDevice> ListLinkedDevices(ListLinkedDevicesRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ListLinkedDevicesRequest 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<ListLinkedDevicesResponse, LinkedDevice>

A pageable sequence of LinkedDevice resources.

Sample code
// Create client
LinkedDeviceServiceClient linkedDeviceServiceClient = LinkedDeviceServiceClient.Create();
// Initialize request argument(s)
ListLinkedDevicesRequest request = new ListLinkedDevicesRequest
{
    ParentAsNetworkName = NetworkName.FromNetworkCode("[NETWORK_CODE]"),
    Filter = "",
    OrderBy = "",
    Skip = 0,
};
// Make the request
PagedEnumerable<ListLinkedDevicesResponse, LinkedDevice> response = linkedDeviceServiceClient.ListLinkedDevices(request);

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

ListLinkedDevices(NetworkName, string, int?, CallSettings)

Lists LinkedDevice objects.

Declaration
public virtual PagedEnumerable<ListLinkedDevicesResponse, LinkedDevice> ListLinkedDevices(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 LinkedDevices. 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<ListLinkedDevicesResponse, LinkedDevice>

A pageable sequence of LinkedDevice resources.

Sample code
// Create client
LinkedDeviceServiceClient linkedDeviceServiceClient = LinkedDeviceServiceClient.Create();
// Initialize request argument(s)
NetworkName parent = NetworkName.FromNetworkCode("[NETWORK_CODE]");
// Make the request
PagedEnumerable<ListLinkedDevicesResponse, LinkedDevice> response = linkedDeviceServiceClient.ListLinkedDevices(parent);

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

ListLinkedDevices(string, string, int?, CallSettings)

Lists LinkedDevice objects.

Declaration
public virtual PagedEnumerable<ListLinkedDevicesResponse, LinkedDevice> ListLinkedDevices(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 LinkedDevices. 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<ListLinkedDevicesResponse, LinkedDevice>

A pageable sequence of LinkedDevice resources.

Sample code
// Create client
LinkedDeviceServiceClient linkedDeviceServiceClient = LinkedDeviceServiceClient.Create();
// Initialize request argument(s)
string parent = "networks/[NETWORK_CODE]";
// Make the request
PagedEnumerable<ListLinkedDevicesResponse, LinkedDevice> response = linkedDeviceServiceClient.ListLinkedDevices(parent);

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

ListLinkedDevicesAsync(ListLinkedDevicesRequest, CallSettings)

Lists LinkedDevice objects.

Declaration
public virtual PagedAsyncEnumerable<ListLinkedDevicesResponse, LinkedDevice> ListLinkedDevicesAsync(ListLinkedDevicesRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ListLinkedDevicesRequest 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<ListLinkedDevicesResponse, LinkedDevice>

A pageable asynchronous sequence of LinkedDevice resources.

Sample code
// Create client
LinkedDeviceServiceClient linkedDeviceServiceClient = await LinkedDeviceServiceClient.CreateAsync();
// Initialize request argument(s)
ListLinkedDevicesRequest request = new ListLinkedDevicesRequest
{
    ParentAsNetworkName = NetworkName.FromNetworkCode("[NETWORK_CODE]"),
    Filter = "",
    OrderBy = "",
    Skip = 0,
};
// Make the request
PagedAsyncEnumerable<ListLinkedDevicesResponse, LinkedDevice> response = linkedDeviceServiceClient.ListLinkedDevicesAsync(request);

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

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

ListLinkedDevicesAsync(NetworkName, string, int?, CallSettings)

Lists LinkedDevice objects.

Declaration
public virtual PagedAsyncEnumerable<ListLinkedDevicesResponse, LinkedDevice> ListLinkedDevicesAsync(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 LinkedDevices. 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<ListLinkedDevicesResponse, LinkedDevice>

A pageable asynchronous sequence of LinkedDevice resources.

Sample code
// Create client
LinkedDeviceServiceClient linkedDeviceServiceClient = await LinkedDeviceServiceClient.CreateAsync();
// Initialize request argument(s)
NetworkName parent = NetworkName.FromNetworkCode("[NETWORK_CODE]");
// Make the request
PagedAsyncEnumerable<ListLinkedDevicesResponse, LinkedDevice> response = linkedDeviceServiceClient.ListLinkedDevicesAsync(parent);

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

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

ListLinkedDevicesAsync(string, string, int?, CallSettings)

Lists LinkedDevice objects.

Declaration
public virtual PagedAsyncEnumerable<ListLinkedDevicesResponse, LinkedDevice> ListLinkedDevicesAsync(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 LinkedDevices. 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<ListLinkedDevicesResponse, LinkedDevice>

A pageable asynchronous sequence of LinkedDevice resources.

Sample code
// Create client
LinkedDeviceServiceClient linkedDeviceServiceClient = await LinkedDeviceServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "networks/[NETWORK_CODE]";
// Make the request
PagedAsyncEnumerable<ListLinkedDevicesResponse, LinkedDevice> response = linkedDeviceServiceClient.ListLinkedDevicesAsync(parent);

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

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

In this article
Back to top Generated by DocFX