Class ReportServiceClient

ReportService client wrapper, for convenient use.

Inheritance
object
ReportServiceClient
ReportServiceClientImpl
Inherited Members
Namespace: Google.Ads.AdManager.V1
Assembly: Google.Ads.AdManager.V1.dll
public abstract class ReportServiceClient

Provides methods for interacting with reports.

Properties

The default endpoint for the ReportService 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

The default ReportService scopes.

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

The default ReportService scopes are:

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

The underlying gRPC ReportService client

Declaration
public virtual ReportService.ReportServiceClient GrpcClient { get; }
Property Value
Type Description
ReportService.ReportServiceClient

The long-running operations client for RunReport.

Declaration
public virtual OperationsClient RunReportOperationsClient { get; }
Property Value
Type Description
OperationsClient

The service metadata associated with this client type.

Declaration
public static ServiceMetadata ServiceMetadata { get; }
Property Value
Type Description
ServiceMetadata

Methods

Synchronously creates a ReportServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use ReportServiceClientBuilder.

Declaration
public static ReportServiceClient Create()
Returns
Type Description
ReportServiceClient

The created ReportServiceClient.

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

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

The CancellationToken to use while creating the client.
Returns
Type Description
Task<ReportServiceClient>

The task representing the created ReportServiceClient.

API to create a Report object.

Declaration
public virtual Report CreateReport(CreateReportRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
CreateReportRequest 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
Report

The RPC response.

 
// Create client
ReportServiceClient reportServiceClient = ReportServiceClient.Create();
// Initialize request argument(s)
CreateReportRequest request = new CreateReportRequest
{
    ParentAsNetworkName = NetworkName.FromNetworkCode("[NETWORK_CODE]"),
    Report = new Report(),
};
// Make the request
Report response = reportServiceClient.CreateReport(request);

API to create a Report object.

Declaration
public virtual Report CreateReport(NetworkName parent, Report report, CallSettings callSettings = null)
Parameters
Type Name Description
NetworkName parent

Required. The parent resource where this Report will be created. Format: networks/{network_code}
Report report

Required. The Report to create.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Report

The RPC response.

 
// Create client
ReportServiceClient reportServiceClient = ReportServiceClient.Create();
// Initialize request argument(s)
NetworkName parent = NetworkName.FromNetworkCode("[NETWORK_CODE]");
Report report = new Report();
// Make the request
Report response = reportServiceClient.CreateReport(parent, report);

API to create a Report object.

Declaration
public virtual Report CreateReport(string parent, Report report, CallSettings callSettings = null)
Parameters
Type Name Description
string parent

Required. The parent resource where this Report will be created. Format: networks/{network_code}
Report report

Required. The Report to create.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Report

The RPC response.

 
// Create client
ReportServiceClient reportServiceClient = ReportServiceClient.Create();
// Initialize request argument(s)
string parent = "networks/[NETWORK_CODE]";
Report report = new Report();
// Make the request
Report response = reportServiceClient.CreateReport(parent, report);

API to create a Report object.

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

A Task containing the RPC response.

 
// Create client
ReportServiceClient reportServiceClient = await ReportServiceClient.CreateAsync();
// Initialize request argument(s)
CreateReportRequest request = new CreateReportRequest
{
    ParentAsNetworkName = NetworkName.FromNetworkCode("[NETWORK_CODE]"),
    Report = new Report(),
};
// Make the request
Report response = await reportServiceClient.CreateReportAsync(request);

API to create a Report object.

Declaration
public virtual Task<Report> CreateReportAsync(CreateReportRequest request, CancellationToken cancellationToken)
Parameters
Type Name Description
CreateReportRequest 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<Report>

A Task containing the RPC response.

 
// Create client
ReportServiceClient reportServiceClient = await ReportServiceClient.CreateAsync();
// Initialize request argument(s)
CreateReportRequest request = new CreateReportRequest
{
    ParentAsNetworkName = NetworkName.FromNetworkCode("[NETWORK_CODE]"),
    Report = new Report(),
};
// Make the request
Report response = await reportServiceClient.CreateReportAsync(request);

API to create a Report object.

Declaration
public virtual Task<Report> CreateReportAsync(NetworkName parent, Report report, CallSettings callSettings = null)
Parameters
Type Name Description
NetworkName parent

Required. The parent resource where this Report will be created. Format: networks/{network_code}
Report report

Required. The Report to create.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<Report>

A Task containing the RPC response.

 
// Create client
ReportServiceClient reportServiceClient = await ReportServiceClient.CreateAsync();
// Initialize request argument(s)
NetworkName parent = NetworkName.FromNetworkCode("[NETWORK_CODE]");
Report report = new Report();
// Make the request
Report response = await reportServiceClient.CreateReportAsync(parent, report);

API to create a Report object.

Declaration
public virtual Task<Report> CreateReportAsync(NetworkName parent, Report report, CancellationToken cancellationToken)
Parameters
Type Name Description
NetworkName parent

Required. The parent resource where this Report will be created. Format: networks/{network_code}
Report report

Required. The Report to create.
CancellationToken cancellationToken

A CancellationToken to use for this RPC.
Returns
Type Description
Task<Report>

A Task containing the RPC response.

 
// Create client
ReportServiceClient reportServiceClient = await ReportServiceClient.CreateAsync();
// Initialize request argument(s)
NetworkName parent = NetworkName.FromNetworkCode("[NETWORK_CODE]");
Report report = new Report();
// Make the request
Report response = await reportServiceClient.CreateReportAsync(parent, report);

API to create a Report object.

Declaration
public virtual Task<Report> CreateReportAsync(string parent, Report report, CallSettings callSettings = null)
Parameters
Type Name Description
string parent

Required. The parent resource where this Report will be created. Format: networks/{network_code}
Report report

Required. The Report to create.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<Report>

A Task containing the RPC response.

 
// Create client
ReportServiceClient reportServiceClient = await ReportServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "networks/[NETWORK_CODE]";
Report report = new Report();
// Make the request
Report response = await reportServiceClient.CreateReportAsync(parent, report);

API to create a Report object.

Declaration
public virtual Task<Report> CreateReportAsync(string parent, Report report, CancellationToken cancellationToken)
Parameters
Type Name Description
string parent

Required. The parent resource where this Report will be created. Format: networks/{network_code}
Report report

Required. The Report to create.
CancellationToken cancellationToken

A CancellationToken to use for this RPC.
Returns
Type Description
Task<Report>

A Task containing the RPC response.

 
// Create client
ReportServiceClient reportServiceClient = await ReportServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "networks/[NETWORK_CODE]";
Report report = new Report();
// Make the request
Report response = await reportServiceClient.CreateReportAsync(parent, report);

Returns the result rows from a completed report. The caller must have previously called RunReport and waited for that operation to complete. The rows will be returned according to the order specified by the sorts member of the report definition.

Declaration
public virtual PagedEnumerable<FetchReportResultRowsResponse, ReportDataTable.Types.Row> FetchReportResultRows(FetchReportResultRowsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
FetchReportResultRowsRequest 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<FetchReportResultRowsResponse, ReportDataTable.Types.Row>

A pageable sequence of ReportDataTable.Types.Row resources.

 
// Create client
ReportServiceClient reportServiceClient = ReportServiceClient.Create();
// Initialize request argument(s)
FetchReportResultRowsRequest request = new FetchReportResultRowsRequest { Name = "", };
// Make the request
PagedEnumerable<FetchReportResultRowsResponse, ReportDataTable.Types.Row> response = reportServiceClient.FetchReportResultRows(request);

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

Returns the result rows from a completed report. The caller must have previously called RunReport and waited for that operation to complete. The rows will be returned according to the order specified by the sorts member of the report definition.

Declaration
public virtual PagedEnumerable<FetchReportResultRowsResponse, ReportDataTable.Types.Row> FetchReportResultRows(string name, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Parameters
Type Name Description
string name

The report result being fetched. Format: networks/{network_code}/reports/{report_id}/results/{report_result_id}
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<FetchReportResultRowsResponse, ReportDataTable.Types.Row>

A pageable sequence of ReportDataTable.Types.Row resources.

 
// Create client
ReportServiceClient reportServiceClient = ReportServiceClient.Create();
// Initialize request argument(s)
string name = "";
// Make the request
PagedEnumerable<FetchReportResultRowsResponse, ReportDataTable.Types.Row> response = reportServiceClient.FetchReportResultRows(name);

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

Returns the result rows from a completed report. The caller must have previously called RunReport and waited for that operation to complete. The rows will be returned according to the order specified by the sorts member of the report definition.

Declaration
public virtual PagedAsyncEnumerable<FetchReportResultRowsResponse, ReportDataTable.Types.Row> FetchReportResultRowsAsync(FetchReportResultRowsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
FetchReportResultRowsRequest 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<FetchReportResultRowsResponse, ReportDataTable.Types.Row>

A pageable asynchronous sequence of ReportDataTable.Types.Row resources.

 
// Create client
ReportServiceClient reportServiceClient = await ReportServiceClient.CreateAsync();
// Initialize request argument(s)
FetchReportResultRowsRequest request = new FetchReportResultRowsRequest { Name = "", };
// Make the request
PagedAsyncEnumerable<FetchReportResultRowsResponse, ReportDataTable.Types.Row> response = reportServiceClient.FetchReportResultRowsAsync(request);

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

Returns the result rows from a completed report. The caller must have previously called RunReport and waited for that operation to complete. The rows will be returned according to the order specified by the sorts member of the report definition.

Declaration
public virtual PagedAsyncEnumerable<FetchReportResultRowsResponse, ReportDataTable.Types.Row> FetchReportResultRowsAsync(string name, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Parameters
Type Name Description
string name

The report result being fetched. Format: networks/{network_code}/reports/{report_id}/results/{report_result_id}
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<FetchReportResultRowsResponse, ReportDataTable.Types.Row>

A pageable asynchronous sequence of ReportDataTable.Types.Row resources.

 
// Create client
ReportServiceClient reportServiceClient = await ReportServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "";
// Make the request
PagedAsyncEnumerable<FetchReportResultRowsResponse, ReportDataTable.Types.Row> response = reportServiceClient.FetchReportResultRowsAsync(name);

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

API to retrieve a Report object.

Declaration
public virtual Report GetReport(GetReportRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
GetReportRequest 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
Report

The RPC response.

 
// Create client
ReportServiceClient reportServiceClient = ReportServiceClient.Create();
// Initialize request argument(s)
GetReportRequest request = new GetReportRequest
{
    ReportName = ReportName.FromNetworkCodeReport("[NETWORK_CODE]", "[REPORT]"),
};
// Make the request
Report response = reportServiceClient.GetReport(request);

API to retrieve a Report object.

Declaration
public virtual Report GetReport(ReportName name, CallSettings callSettings = null)
Parameters
Type Name Description
ReportName name

Required. The resource name of the report. Format: networks/{network_code}/reports/{report_id}
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Report

The RPC response.

 
// Create client
ReportServiceClient reportServiceClient = ReportServiceClient.Create();
// Initialize request argument(s)
ReportName name = ReportName.FromNetworkCodeReport("[NETWORK_CODE]", "[REPORT]");
// Make the request
Report response = reportServiceClient.GetReport(name);

API to retrieve a Report object.

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

Required. The resource name of the report. Format: networks/{network_code}/reports/{report_id}
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Report

The RPC response.

 
// Create client
ReportServiceClient reportServiceClient = ReportServiceClient.Create();
// Initialize request argument(s)
string name = "networks/[NETWORK_CODE]/reports/[REPORT]";
// Make the request
Report response = reportServiceClient.GetReport(name);

API to retrieve a Report object.

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

A Task containing the RPC response.

 
// Create client
ReportServiceClient reportServiceClient = await ReportServiceClient.CreateAsync();
// Initialize request argument(s)
GetReportRequest request = new GetReportRequest
{
    ReportName = ReportName.FromNetworkCodeReport("[NETWORK_CODE]", "[REPORT]"),
};
// Make the request
Report response = await reportServiceClient.GetReportAsync(request);

API to retrieve a Report object.

Declaration
public virtual Task<Report> GetReportAsync(GetReportRequest request, CancellationToken cancellationToken)
Parameters
Type Name Description
GetReportRequest 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<Report>

A Task containing the RPC response.

 
// Create client
ReportServiceClient reportServiceClient = await ReportServiceClient.CreateAsync();
// Initialize request argument(s)
GetReportRequest request = new GetReportRequest
{
    ReportName = ReportName.FromNetworkCodeReport("[NETWORK_CODE]", "[REPORT]"),
};
// Make the request
Report response = await reportServiceClient.GetReportAsync(request);

API to retrieve a Report object.

Declaration
public virtual Task<Report> GetReportAsync(ReportName name, CallSettings callSettings = null)
Parameters
Type Name Description
ReportName name

Required. The resource name of the report. Format: networks/{network_code}/reports/{report_id}
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<Report>

A Task containing the RPC response.

 
// Create client
ReportServiceClient reportServiceClient = await ReportServiceClient.CreateAsync();
// Initialize request argument(s)
ReportName name = ReportName.FromNetworkCodeReport("[NETWORK_CODE]", "[REPORT]");
// Make the request
Report response = await reportServiceClient.GetReportAsync(name);

API to retrieve a Report object.

Declaration
public virtual Task<Report> GetReportAsync(ReportName name, CancellationToken cancellationToken)
Parameters
Type Name Description
ReportName name

Required. The resource name of the report. Format: networks/{network_code}/reports/{report_id}
CancellationToken cancellationToken

A CancellationToken to use for this RPC.
Returns
Type Description
Task<Report>

A Task containing the RPC response.

 
// Create client
ReportServiceClient reportServiceClient = await ReportServiceClient.CreateAsync();
// Initialize request argument(s)
ReportName name = ReportName.FromNetworkCodeReport("[NETWORK_CODE]", "[REPORT]");
// Make the request
Report response = await reportServiceClient.GetReportAsync(name);

API to retrieve a Report object.

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

Required. The resource name of the report. Format: networks/{network_code}/reports/{report_id}
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<Report>

A Task containing the RPC response.

 
// Create client
ReportServiceClient reportServiceClient = await ReportServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "networks/[NETWORK_CODE]/reports/[REPORT]";
// Make the request
Report response = await reportServiceClient.GetReportAsync(name);

API to retrieve a Report object.

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

Required. The resource name of the report. Format: networks/{network_code}/reports/{report_id}
CancellationToken cancellationToken

A CancellationToken to use for this RPC.
Returns
Type Description
Task<Report>

A Task containing the RPC response.

 
// Create client
ReportServiceClient reportServiceClient = await ReportServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "networks/[NETWORK_CODE]/reports/[REPORT]";
// Make the request
Report response = await reportServiceClient.GetReportAsync(name);

API to retrieve a list of Report objects.

Declaration
public virtual PagedEnumerable<ListReportsResponse, Report> ListReports(ListReportsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ListReportsRequest 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<ListReportsResponse, Report>

A pageable sequence of Report resources.

 
// Create client
ReportServiceClient reportServiceClient = ReportServiceClient.Create();
// Initialize request argument(s)
ListReportsRequest request = new ListReportsRequest
{
    ParentAsNetworkName = NetworkName.FromNetworkCode("[NETWORK_CODE]"),
    Filter = "",
    OrderBy = "",
    Skip = 0,
};
// Make the request
PagedEnumerable<ListReportsResponse, Report> response = reportServiceClient.ListReports(request);

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

API to retrieve a list of Report objects.

Declaration
public virtual PagedEnumerable<ListReportsResponse, Report> ListReports(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 reports. 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<ListReportsResponse, Report>

A pageable sequence of Report resources.

 
// Create client
ReportServiceClient reportServiceClient = ReportServiceClient.Create();
// Initialize request argument(s)
NetworkName parent = NetworkName.FromNetworkCode("[NETWORK_CODE]");
// Make the request
PagedEnumerable<ListReportsResponse, Report> response = reportServiceClient.ListReports(parent);

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

API to retrieve a list of Report objects.

Declaration
public virtual PagedEnumerable<ListReportsResponse, Report> ListReports(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 reports. 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<ListReportsResponse, Report>

A pageable sequence of Report resources.

 
// Create client
ReportServiceClient reportServiceClient = ReportServiceClient.Create();
// Initialize request argument(s)
string parent = "networks/[NETWORK_CODE]";
// Make the request
PagedEnumerable<ListReportsResponse, Report> response = reportServiceClient.ListReports(parent);

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

API to retrieve a list of Report objects.

Declaration
public virtual PagedAsyncEnumerable<ListReportsResponse, Report> ListReportsAsync(ListReportsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ListReportsRequest 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<ListReportsResponse, Report>

A pageable asynchronous sequence of Report resources.

 
// Create client
ReportServiceClient reportServiceClient = await ReportServiceClient.CreateAsync();
// Initialize request argument(s)
ListReportsRequest request = new ListReportsRequest
{
    ParentAsNetworkName = NetworkName.FromNetworkCode("[NETWORK_CODE]"),
    Filter = "",
    OrderBy = "",
    Skip = 0,
};
// Make the request
PagedAsyncEnumerable<ListReportsResponse, Report> response = reportServiceClient.ListReportsAsync(request);

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

API to retrieve a list of Report objects.

Declaration
public virtual PagedAsyncEnumerable<ListReportsResponse, Report> ListReportsAsync(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 reports. 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<ListReportsResponse, Report>

A pageable asynchronous sequence of Report resources.

 
// Create client
ReportServiceClient reportServiceClient = await ReportServiceClient.CreateAsync();
// Initialize request argument(s)
NetworkName parent = NetworkName.FromNetworkCode("[NETWORK_CODE]");
// Make the request
PagedAsyncEnumerable<ListReportsResponse, Report> response = reportServiceClient.ListReportsAsync(parent);

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

API to retrieve a list of Report objects.

Declaration
public virtual PagedAsyncEnumerable<ListReportsResponse, Report> ListReportsAsync(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 reports. 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<ListReportsResponse, Report>

A pageable asynchronous sequence of Report resources.

 
// Create client
ReportServiceClient reportServiceClient = await ReportServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "networks/[NETWORK_CODE]";
// Make the request
PagedAsyncEnumerable<ListReportsResponse, Report> response = reportServiceClient.ListReportsAsync(parent);

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

Poll an operation once, using an operationName from a previous invocation of RunReport.

Declaration
public virtual Operation<RunReportResponse, RunReportMetadata> PollOnceRunReport(string operationName, CallSettings callSettings = null)
Parameters
Type Name Description
string operationName

The name of a previously invoked operation. Must not be null or empty.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Operation<RunReportResponse, RunReportMetadata>

The result of polling the operation.

Asynchronously poll an operation once, using an operationName from a previous invocation of RunReport.

Declaration
public virtual Task<Operation<RunReportResponse, RunReportMetadata>> PollOnceRunReportAsync(string operationName, CallSettings callSettings = null)
Parameters
Type Name Description
string operationName

The name of a previously invoked operation. Must not be null or empty.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<Operation<RunReportResponse, RunReportMetadata>>

A task representing the result of polling the operation.

Initiates the execution of an existing report asynchronously. Users can get the report by polling this operation using OperationsService.GetOperation. Poll every 5 seconds initially, with an exponential backoff. Once a report is complete, the operation will contain a RunReportResponse in its response field containing a report_result that can be passed to the FetchReportResultRows method to retrieve the report data.

Declaration
public virtual Operation<RunReportResponse, RunReportMetadata> RunReport(ReportName name, CallSettings callSettings = null)
Parameters
Type Name Description
ReportName name

Required. The report to run. Format: networks/{network_code}/reports/{report_id}
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Operation<RunReportResponse, RunReportMetadata>

The RPC response.

 
// Create client
ReportServiceClient reportServiceClient = ReportServiceClient.Create();
// Initialize request argument(s)
ReportName name = ReportName.FromNetworkCodeReport("[NETWORK_CODE]", "[REPORT]");
// Make the request
Operation<RunReportResponse, RunReportMetadata> response = reportServiceClient.RunReport(name);

// Poll until the returned long-running operation is complete
Operation<RunReportResponse, RunReportMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
RunReportResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<RunReportResponse, RunReportMetadata> retrievedResponse = reportServiceClient.PollOnceRunReport(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    RunReportResponse retrievedResult = retrievedResponse.Result;
}

Initiates the execution of an existing report asynchronously. Users can get the report by polling this operation using OperationsService.GetOperation. Poll every 5 seconds initially, with an exponential backoff. Once a report is complete, the operation will contain a RunReportResponse in its response field containing a report_result that can be passed to the FetchReportResultRows method to retrieve the report data.

Declaration
public virtual Operation<RunReportResponse, RunReportMetadata> RunReport(RunReportRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
RunReportRequest 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
Operation<RunReportResponse, RunReportMetadata>

The RPC response.

 
// Create client
ReportServiceClient reportServiceClient = ReportServiceClient.Create();
// Initialize request argument(s)
RunReportRequest request = new RunReportRequest
{
    ReportName = ReportName.FromNetworkCodeReport("[NETWORK_CODE]", "[REPORT]"),
};
// Make the request
Operation<RunReportResponse, RunReportMetadata> response = reportServiceClient.RunReport(request);

// Poll until the returned long-running operation is complete
Operation<RunReportResponse, RunReportMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
RunReportResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<RunReportResponse, RunReportMetadata> retrievedResponse = reportServiceClient.PollOnceRunReport(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    RunReportResponse retrievedResult = retrievedResponse.Result;
}

Initiates the execution of an existing report asynchronously. Users can get the report by polling this operation using OperationsService.GetOperation. Poll every 5 seconds initially, with an exponential backoff. Once a report is complete, the operation will contain a RunReportResponse in its response field containing a report_result that can be passed to the FetchReportResultRows method to retrieve the report data.

Declaration
public virtual Operation<RunReportResponse, RunReportMetadata> RunReport(string name, CallSettings callSettings = null)
Parameters
Type Name Description
string name

Required. The report to run. Format: networks/{network_code}/reports/{report_id}
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Operation<RunReportResponse, RunReportMetadata>

The RPC response.

 
// Create client
ReportServiceClient reportServiceClient = ReportServiceClient.Create();
// Initialize request argument(s)
string name = "networks/[NETWORK_CODE]/reports/[REPORT]";
// Make the request
Operation<RunReportResponse, RunReportMetadata> response = reportServiceClient.RunReport(name);

// Poll until the returned long-running operation is complete
Operation<RunReportResponse, RunReportMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
RunReportResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<RunReportResponse, RunReportMetadata> retrievedResponse = reportServiceClient.PollOnceRunReport(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    RunReportResponse retrievedResult = retrievedResponse.Result;
}

Initiates the execution of an existing report asynchronously. Users can get the report by polling this operation using OperationsService.GetOperation. Poll every 5 seconds initially, with an exponential backoff. Once a report is complete, the operation will contain a RunReportResponse in its response field containing a report_result that can be passed to the FetchReportResultRows method to retrieve the report data.

Declaration
public virtual Task<Operation<RunReportResponse, RunReportMetadata>> RunReportAsync(ReportName name, CallSettings callSettings = null)
Parameters
Type Name Description
ReportName name

Required. The report to run. Format: networks/{network_code}/reports/{report_id}
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<Operation<RunReportResponse, RunReportMetadata>>

A Task containing the RPC response.

 
// Create client
ReportServiceClient reportServiceClient = await ReportServiceClient.CreateAsync();
// Initialize request argument(s)
ReportName name = ReportName.FromNetworkCodeReport("[NETWORK_CODE]", "[REPORT]");
// Make the request
Operation<RunReportResponse, RunReportMetadata> response = await reportServiceClient.RunReportAsync(name);

// Poll until the returned long-running operation is complete
Operation<RunReportResponse, RunReportMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
RunReportResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<RunReportResponse, RunReportMetadata> retrievedResponse = await reportServiceClient.PollOnceRunReportAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    RunReportResponse retrievedResult = retrievedResponse.Result;
}

Initiates the execution of an existing report asynchronously. Users can get the report by polling this operation using OperationsService.GetOperation. Poll every 5 seconds initially, with an exponential backoff. Once a report is complete, the operation will contain a RunReportResponse in its response field containing a report_result that can be passed to the FetchReportResultRows method to retrieve the report data.

Declaration
public virtual Task<Operation<RunReportResponse, RunReportMetadata>> RunReportAsync(ReportName name, CancellationToken cancellationToken)
Parameters
Type Name Description
ReportName name

Required. The report to run. Format: networks/{network_code}/reports/{report_id}
CancellationToken cancellationToken

A CancellationToken to use for this RPC.
Returns
Type Description
Task<Operation<RunReportResponse, RunReportMetadata>>

A Task containing the RPC response.

 
// Create client
ReportServiceClient reportServiceClient = await ReportServiceClient.CreateAsync();
// Initialize request argument(s)
ReportName name = ReportName.FromNetworkCodeReport("[NETWORK_CODE]", "[REPORT]");
// Make the request
Operation<RunReportResponse, RunReportMetadata> response = await reportServiceClient.RunReportAsync(name);

// Poll until the returned long-running operation is complete
Operation<RunReportResponse, RunReportMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
RunReportResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<RunReportResponse, RunReportMetadata> retrievedResponse = await reportServiceClient.PollOnceRunReportAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    RunReportResponse retrievedResult = retrievedResponse.Result;
}

Initiates the execution of an existing report asynchronously. Users can get the report by polling this operation using OperationsService.GetOperation. Poll every 5 seconds initially, with an exponential backoff. Once a report is complete, the operation will contain a RunReportResponse in its response field containing a report_result that can be passed to the FetchReportResultRows method to retrieve the report data.

Declaration
public virtual Task<Operation<RunReportResponse, RunReportMetadata>> RunReportAsync(RunReportRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
RunReportRequest 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<Operation<RunReportResponse, RunReportMetadata>>

A Task containing the RPC response.

 
// Create client
ReportServiceClient reportServiceClient = await ReportServiceClient.CreateAsync();
// Initialize request argument(s)
RunReportRequest request = new RunReportRequest
{
    ReportName = ReportName.FromNetworkCodeReport("[NETWORK_CODE]", "[REPORT]"),
};
// Make the request
Operation<RunReportResponse, RunReportMetadata> response = await reportServiceClient.RunReportAsync(request);

// Poll until the returned long-running operation is complete
Operation<RunReportResponse, RunReportMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
RunReportResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<RunReportResponse, RunReportMetadata> retrievedResponse = await reportServiceClient.PollOnceRunReportAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    RunReportResponse retrievedResult = retrievedResponse.Result;
}

Initiates the execution of an existing report asynchronously. Users can get the report by polling this operation using OperationsService.GetOperation. Poll every 5 seconds initially, with an exponential backoff. Once a report is complete, the operation will contain a RunReportResponse in its response field containing a report_result that can be passed to the FetchReportResultRows method to retrieve the report data.

Declaration
public virtual Task<Operation<RunReportResponse, RunReportMetadata>> RunReportAsync(RunReportRequest request, CancellationToken cancellationToken)
Parameters
Type Name Description
RunReportRequest 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<Operation<RunReportResponse, RunReportMetadata>>

A Task containing the RPC response.

 
// Create client
ReportServiceClient reportServiceClient = await ReportServiceClient.CreateAsync();
// Initialize request argument(s)
RunReportRequest request = new RunReportRequest
{
    ReportName = ReportName.FromNetworkCodeReport("[NETWORK_CODE]", "[REPORT]"),
};
// Make the request
Operation<RunReportResponse, RunReportMetadata> response = await reportServiceClient.RunReportAsync(request);

// Poll until the returned long-running operation is complete
Operation<RunReportResponse, RunReportMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
RunReportResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<RunReportResponse, RunReportMetadata> retrievedResponse = await reportServiceClient.PollOnceRunReportAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    RunReportResponse retrievedResult = retrievedResponse.Result;
}

Initiates the execution of an existing report asynchronously. Users can get the report by polling this operation using OperationsService.GetOperation. Poll every 5 seconds initially, with an exponential backoff. Once a report is complete, the operation will contain a RunReportResponse in its response field containing a report_result that can be passed to the FetchReportResultRows method to retrieve the report data.

Declaration
public virtual Task<Operation<RunReportResponse, RunReportMetadata>> RunReportAsync(string name, CallSettings callSettings = null)
Parameters
Type Name Description
string name

Required. The report to run. Format: networks/{network_code}/reports/{report_id}
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<Operation<RunReportResponse, RunReportMetadata>>

A Task containing the RPC response.

 
// Create client
ReportServiceClient reportServiceClient = await ReportServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "networks/[NETWORK_CODE]/reports/[REPORT]";
// Make the request
Operation<RunReportResponse, RunReportMetadata> response = await reportServiceClient.RunReportAsync(name);

// Poll until the returned long-running operation is complete
Operation<RunReportResponse, RunReportMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
RunReportResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<RunReportResponse, RunReportMetadata> retrievedResponse = await reportServiceClient.PollOnceRunReportAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    RunReportResponse retrievedResult = retrievedResponse.Result;
}

Initiates the execution of an existing report asynchronously. Users can get the report by polling this operation using OperationsService.GetOperation. Poll every 5 seconds initially, with an exponential backoff. Once a report is complete, the operation will contain a RunReportResponse in its response field containing a report_result that can be passed to the FetchReportResultRows method to retrieve the report data.

Declaration
public virtual Task<Operation<RunReportResponse, RunReportMetadata>> RunReportAsync(string name, CancellationToken cancellationToken)
Parameters
Type Name Description
string name

Required. The report to run. Format: networks/{network_code}/reports/{report_id}
CancellationToken cancellationToken

A CancellationToken to use for this RPC.
Returns
Type Description
Task<Operation<RunReportResponse, RunReportMetadata>>

A Task containing the RPC response.

 
// Create client
ReportServiceClient reportServiceClient = await ReportServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "networks/[NETWORK_CODE]/reports/[REPORT]";
// Make the request
Operation<RunReportResponse, RunReportMetadata> response = await reportServiceClient.RunReportAsync(name);

// Poll until the returned long-running operation is complete
Operation<RunReportResponse, RunReportMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
RunReportResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<RunReportResponse, RunReportMetadata> retrievedResponse = await reportServiceClient.PollOnceRunReportAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    RunReportResponse retrievedResult = retrievedResponse.Result;
}

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.

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.

API to update a Report object.

Declaration
public virtual Report UpdateReport(Report report, FieldMask updateMask, CallSettings callSettings = null)
Parameters
Type Name Description
Report report

Required. The Report to update.
FieldMask updateMask

Required. The list of fields to update.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Report

The RPC response.

 
// Create client
ReportServiceClient reportServiceClient = ReportServiceClient.Create();
// Initialize request argument(s)
Report report = new Report();
FieldMask updateMask = new FieldMask();
// Make the request
Report response = reportServiceClient.UpdateReport(report, updateMask);

API to update a Report object.

Declaration
public virtual Report UpdateReport(UpdateReportRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
UpdateReportRequest 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
Report

The RPC response.

 
// Create client
ReportServiceClient reportServiceClient = ReportServiceClient.Create();
// Initialize request argument(s)
UpdateReportRequest request = new UpdateReportRequest
{
    Report = new Report(),
    UpdateMask = new FieldMask(),
};
// Make the request
Report response = reportServiceClient.UpdateReport(request);

API to update a Report object.

Declaration
public virtual Task<Report> UpdateReportAsync(Report report, FieldMask updateMask, CallSettings callSettings = null)
Parameters
Type Name Description
Report report

Required. The Report to update.
FieldMask updateMask

Required. The list of fields to update.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<Report>

A Task containing the RPC response.

 
// Create client
ReportServiceClient reportServiceClient = await ReportServiceClient.CreateAsync();
// Initialize request argument(s)
Report report = new Report();
FieldMask updateMask = new FieldMask();
// Make the request
Report response = await reportServiceClient.UpdateReportAsync(report, updateMask);

API to update a Report object.

Declaration
public virtual Task<Report> UpdateReportAsync(Report report, FieldMask updateMask, CancellationToken cancellationToken)
Parameters
Type Name Description
Report report

Required. The Report to update.
FieldMask updateMask

Required. The list of fields to update.
CancellationToken cancellationToken

A CancellationToken to use for this RPC.
Returns
Type Description
Task<Report>

A Task containing the RPC response.

 
// Create client
ReportServiceClient reportServiceClient = await ReportServiceClient.CreateAsync();
// Initialize request argument(s)
Report report = new Report();
FieldMask updateMask = new FieldMask();
// Make the request
Report response = await reportServiceClient.UpdateReportAsync(report, updateMask);

API to update a Report object.

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

A Task containing the RPC response.

 
// Create client
ReportServiceClient reportServiceClient = await ReportServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateReportRequest request = new UpdateReportRequest
{
    Report = new Report(),
    UpdateMask = new FieldMask(),
};
// Make the request
Report response = await reportServiceClient.UpdateReportAsync(request);

API to update a Report object.

Declaration
public virtual Task<Report> UpdateReportAsync(UpdateReportRequest request, CancellationToken cancellationToken)
Parameters
Type Name Description
UpdateReportRequest 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<Report>

A Task containing the RPC response.

 
// Create client
ReportServiceClient reportServiceClient = await ReportServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateReportRequest request = new UpdateReportRequest
{
    Report = new Report(),
    UpdateMask = new FieldMask(),
};
// Make the request
Report response = await reportServiceClient.UpdateReportAsync(request);