Class LineItemServiceClient

LineItemService client wrapper, for convenient use.

Inheritance

object

LineItemServiceClient

LineItemServiceClientImpl

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 LineItemServiceClient

Remarks

Provides methods for handling LineItem objects.

Properties

DefaultEndpoint

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

Declaration

public static IReadOnlyList<string> DefaultScopes { get; }

Property Value

Type	Description
IReadOnlyList<string>

Remarks

The default LineItemService scopes are:

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

GrpcClient

The underlying gRPC LineItemService client

Declaration

public virtual LineItemService.LineItemServiceClient GrpcClient { get; }

Property Value

Type	Description
LineItemService.LineItemServiceClient

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

Declaration

public static LineItemServiceClient Create()

Returns

Type	Description
LineItemServiceClient	The created LineItemServiceClient.

CreateAsync(CancellationToken)

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

Declaration

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

Parameters

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

Returns

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

GetLineItem(GetLineItemRequest, CallSettings)

API to retrieve a LineItem object.

Declaration

public virtual LineItem GetLineItem(GetLineItemRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
GetLineItemRequest	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
LineItem	The RPC response.

Sample code

// Create client
LineItemServiceClient lineItemServiceClient = LineItemServiceClient.Create();
// Initialize request argument(s)
GetLineItemRequest request = new GetLineItemRequest
{
    LineItemName = LineItemName.FromNetworkCodeLineItem("[NETWORK_CODE]", "[LINE_ITEM]"),
};
// Make the request
LineItem response = lineItemServiceClient.GetLineItem(request);

GetLineItem(LineItemName, CallSettings)

API to retrieve a LineItem object.

Declaration

public virtual LineItem GetLineItem(LineItemName name, CallSettings callSettings = null)

Parameters

Type	Name	Description
LineItemName	name	Required. The resource name of the LineItem. Format: networks/{network_code}/lineItems/{line_item_id}
CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

Type	Description
LineItem	The RPC response.

Sample code

// Create client
LineItemServiceClient lineItemServiceClient = LineItemServiceClient.Create();
// Initialize request argument(s)
LineItemName name = LineItemName.FromNetworkCodeLineItem("[NETWORK_CODE]", "[LINE_ITEM]");
// Make the request
LineItem response = lineItemServiceClient.GetLineItem(name);

GetLineItem(string, CallSettings)

API to retrieve a LineItem object.

Declaration

public virtual LineItem GetLineItem(string name, CallSettings callSettings = null)

Parameters

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

Returns

Type	Description
LineItem	The RPC response.

Sample code

// Create client
LineItemServiceClient lineItemServiceClient = LineItemServiceClient.Create();
// Initialize request argument(s)
string name = "networks/[NETWORK_CODE]/lineItems/[LINE_ITEM]";
// Make the request
LineItem response = lineItemServiceClient.GetLineItem(name);

GetLineItemAsync(GetLineItemRequest, CallSettings)

API to retrieve a LineItem object.

Declaration

public virtual Task<LineItem> GetLineItemAsync(GetLineItemRequest request, CallSettings callSettings = null)

Parameters

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

Sample code

// Create client
LineItemServiceClient lineItemServiceClient = await LineItemServiceClient.CreateAsync();
// Initialize request argument(s)
GetLineItemRequest request = new GetLineItemRequest
{
    LineItemName = LineItemName.FromNetworkCodeLineItem("[NETWORK_CODE]", "[LINE_ITEM]"),
};
// Make the request
LineItem response = await lineItemServiceClient.GetLineItemAsync(request);

GetLineItemAsync(GetLineItemRequest, CancellationToken)

API to retrieve a LineItem object.

Declaration

public virtual Task<LineItem> GetLineItemAsync(GetLineItemRequest request, CancellationToken cancellationToken)

Parameters

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

Sample code

// Create client
LineItemServiceClient lineItemServiceClient = await LineItemServiceClient.CreateAsync();
// Initialize request argument(s)
GetLineItemRequest request = new GetLineItemRequest
{
    LineItemName = LineItemName.FromNetworkCodeLineItem("[NETWORK_CODE]", "[LINE_ITEM]"),
};
// Make the request
LineItem response = await lineItemServiceClient.GetLineItemAsync(request);

GetLineItemAsync(LineItemName, CallSettings)

API to retrieve a LineItem object.

Declaration

public virtual Task<LineItem> GetLineItemAsync(LineItemName name, CallSettings callSettings = null)

Parameters

Type	Name	Description
LineItemName	name	Required. The resource name of the LineItem. Format: networks/{network_code}/lineItems/{line_item_id}
CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

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

Sample code

// Create client
LineItemServiceClient lineItemServiceClient = await LineItemServiceClient.CreateAsync();
// Initialize request argument(s)
LineItemName name = LineItemName.FromNetworkCodeLineItem("[NETWORK_CODE]", "[LINE_ITEM]");
// Make the request
LineItem response = await lineItemServiceClient.GetLineItemAsync(name);

GetLineItemAsync(LineItemName, CancellationToken)

API to retrieve a LineItem object.

Declaration

public virtual Task<LineItem> GetLineItemAsync(LineItemName name, CancellationToken cancellationToken)

Parameters

Type	Name	Description
LineItemName	name	Required. The resource name of the LineItem. Format: networks/{network_code}/lineItems/{line_item_id}
CancellationToken	cancellationToken	A CancellationToken to use for this RPC.

Returns

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

Sample code

// Create client
LineItemServiceClient lineItemServiceClient = await LineItemServiceClient.CreateAsync();
// Initialize request argument(s)
LineItemName name = LineItemName.FromNetworkCodeLineItem("[NETWORK_CODE]", "[LINE_ITEM]");
// Make the request
LineItem response = await lineItemServiceClient.GetLineItemAsync(name);

GetLineItemAsync(string, CallSettings)

API to retrieve a LineItem object.

Declaration

public virtual Task<LineItem> GetLineItemAsync(string name, CallSettings callSettings = null)

Parameters

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

Returns

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

Sample code

// Create client
LineItemServiceClient lineItemServiceClient = await LineItemServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "networks/[NETWORK_CODE]/lineItems/[LINE_ITEM]";
// Make the request
LineItem response = await lineItemServiceClient.GetLineItemAsync(name);

GetLineItemAsync(string, CancellationToken)

API to retrieve a LineItem object.

Declaration

public virtual Task<LineItem> GetLineItemAsync(string name, CancellationToken cancellationToken)

Parameters

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

Returns

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

Sample code

// Create client
LineItemServiceClient lineItemServiceClient = await LineItemServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "networks/[NETWORK_CODE]/lineItems/[LINE_ITEM]";
// Make the request
LineItem response = await lineItemServiceClient.GetLineItemAsync(name);

ListLineItems(ListLineItemsRequest, CallSettings)

API to retrieve a list of LineItem objects.

Declaration

public virtual PagedEnumerable<ListLineItemsResponse, LineItem> ListLineItems(ListLineItemsRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
ListLineItemsRequest	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<ListLineItemsResponse, LineItem>	A pageable sequence of LineItem resources.

Sample code

// Create client
LineItemServiceClient lineItemServiceClient = LineItemServiceClient.Create();
// Initialize request argument(s)
ListLineItemsRequest request = new ListLineItemsRequest
{
    ParentAsNetworkName = NetworkName.FromNetworkCode("[NETWORK_CODE]"),
    Filter = "",
    OrderBy = "",
    Skip = 0,
};
// Make the request
PagedEnumerable<ListLineItemsResponse, LineItem> response = lineItemServiceClient.ListLineItems(request);

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

ListLineItems(NetworkName, string, int?, CallSettings)

API to retrieve a list of LineItem objects.

Declaration

public virtual PagedEnumerable<ListLineItemsResponse, LineItem> ListLineItems(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 LineItems. 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<ListLineItemsResponse, LineItem>	A pageable sequence of LineItem resources.

Sample code

// Create client
LineItemServiceClient lineItemServiceClient = LineItemServiceClient.Create();
// Initialize request argument(s)
NetworkName parent = NetworkName.FromNetworkCode("[NETWORK_CODE]");
// Make the request
PagedEnumerable<ListLineItemsResponse, LineItem> response = lineItemServiceClient.ListLineItems(parent);

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

ListLineItems(string, string, int?, CallSettings)

API to retrieve a list of LineItem objects.

Declaration

public virtual PagedEnumerable<ListLineItemsResponse, LineItem> ListLineItems(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 LineItems. 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<ListLineItemsResponse, LineItem>	A pageable sequence of LineItem resources.

Sample code

// Create client
LineItemServiceClient lineItemServiceClient = LineItemServiceClient.Create();
// Initialize request argument(s)
string parent = "networks/[NETWORK_CODE]";
// Make the request
PagedEnumerable<ListLineItemsResponse, LineItem> response = lineItemServiceClient.ListLineItems(parent);

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

ListLineItemsAsync(ListLineItemsRequest, CallSettings)

API to retrieve a list of LineItem objects.

Declaration

public virtual PagedAsyncEnumerable<ListLineItemsResponse, LineItem> ListLineItemsAsync(ListLineItemsRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
ListLineItemsRequest	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<ListLineItemsResponse, LineItem>	A pageable asynchronous sequence of LineItem resources.

Sample code

// Create client
LineItemServiceClient lineItemServiceClient = await LineItemServiceClient.CreateAsync();
// Initialize request argument(s)
ListLineItemsRequest request = new ListLineItemsRequest
{
    ParentAsNetworkName = NetworkName.FromNetworkCode("[NETWORK_CODE]"),
    Filter = "",
    OrderBy = "",
    Skip = 0,
};
// Make the request
PagedAsyncEnumerable<ListLineItemsResponse, LineItem> response = lineItemServiceClient.ListLineItemsAsync(request);

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

ListLineItemsAsync(NetworkName, string, int?, CallSettings)

API to retrieve a list of LineItem objects.

Declaration

public virtual PagedAsyncEnumerable<ListLineItemsResponse, LineItem> ListLineItemsAsync(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 LineItems. 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<ListLineItemsResponse, LineItem>	A pageable asynchronous sequence of LineItem resources.

Sample code

// Create client
LineItemServiceClient lineItemServiceClient = await LineItemServiceClient.CreateAsync();
// Initialize request argument(s)
NetworkName parent = NetworkName.FromNetworkCode("[NETWORK_CODE]");
// Make the request
PagedAsyncEnumerable<ListLineItemsResponse, LineItem> response = lineItemServiceClient.ListLineItemsAsync(parent);

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

ListLineItemsAsync(string, string, int?, CallSettings)

API to retrieve a list of LineItem objects.

Declaration

public virtual PagedAsyncEnumerable<ListLineItemsResponse, LineItem> ListLineItemsAsync(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 LineItems. 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<ListLineItemsResponse, LineItem>	A pageable asynchronous sequence of LineItem resources.

Sample code

// Create client
LineItemServiceClient lineItemServiceClient = await LineItemServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "networks/[NETWORK_CODE]";
// Make the request
PagedAsyncEnumerable<ListLineItemsResponse, LineItem> response = lineItemServiceClient.ListLineItemsAsync(parent);

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