Class ReportServiceClientImpl

ReportService client wrapper implementation, for convenient use.

Inheritance

object

ReportServiceClient

ReportServiceClientImpl

Inherited Members

ReportServiceClient.DefaultEndpoint

ReportServiceClient.DefaultScopes

ReportServiceClient.ServiceMetadata

ReportServiceClient.CreateAsync(CancellationToken)

ReportServiceClient.Create()

ReportServiceClient.ShutdownDefaultChannelsAsync()

ReportServiceClient.GetReportAsync(GetReportRequest, CancellationToken)

ReportServiceClient.GetReport(string, CallSettings)

ReportServiceClient.GetReportAsync(string, CallSettings)

ReportServiceClient.GetReportAsync(string, CancellationToken)

ReportServiceClient.GetReport(ReportName, CallSettings)

ReportServiceClient.GetReportAsync(ReportName, CallSettings)

ReportServiceClient.GetReportAsync(ReportName, CancellationToken)

ReportServiceClient.ListReports(string, string, int?, CallSettings)

ReportServiceClient.ListReportsAsync(string, string, int?, CallSettings)

ReportServiceClient.ListReports(NetworkName, string, int?, CallSettings)

ReportServiceClient.ListReportsAsync(NetworkName, string, int?, CallSettings)

ReportServiceClient.CreateReportAsync(CreateReportRequest, CancellationToken)

ReportServiceClient.CreateReport(string, Report, CallSettings)

ReportServiceClient.CreateReportAsync(string, Report, CallSettings)

ReportServiceClient.CreateReportAsync(string, Report, CancellationToken)

ReportServiceClient.CreateReport(NetworkName, Report, CallSettings)

ReportServiceClient.CreateReportAsync(NetworkName, Report, CallSettings)

ReportServiceClient.CreateReportAsync(NetworkName, Report, CancellationToken)

ReportServiceClient.UpdateReportAsync(UpdateReportRequest, CancellationToken)

ReportServiceClient.UpdateReport(Report, FieldMask, CallSettings)

ReportServiceClient.UpdateReportAsync(Report, FieldMask, CallSettings)

ReportServiceClient.UpdateReportAsync(Report, FieldMask, CancellationToken)

ReportServiceClient.RunReportAsync(RunReportRequest, CancellationToken)

ReportServiceClient.PollOnceRunReport(string, CallSettings)

ReportServiceClient.PollOnceRunReportAsync(string, CallSettings)

ReportServiceClient.RunReport(string, CallSettings)

ReportServiceClient.RunReportAsync(string, CallSettings)

ReportServiceClient.RunReportAsync(string, CancellationToken)

ReportServiceClient.RunReport(ReportName, CallSettings)

ReportServiceClient.RunReportAsync(ReportName, CallSettings)

ReportServiceClient.RunReportAsync(ReportName, CancellationToken)

ReportServiceClient.FetchReportResultRows(string, string, int?, CallSettings)

ReportServiceClient.FetchReportResultRowsAsync(string, string, int?, CallSettings)

object.GetHashCode()

object.GetType()

object.ToString()

Namespace: Google.Ads.AdManager.V1

Assembly: Google.Ads.AdManager.V1.dll

Syntax

public sealed class ReportServiceClientImpl : ReportServiceClient

Remarks

Provides methods for interacting with reports.

Constructors

ReportServiceClientImpl(ReportServiceClient, ReportServiceSettings, ILogger)

Constructs a client wrapper for the ReportService service, with the specified gRPC client and settings.

Declaration

public ReportServiceClientImpl(ReportService.ReportServiceClient grpcClient, ReportServiceSettings settings, ILogger logger)

Parameters

Type	Name	Description
ReportService.ReportServiceClient	grpcClient	The underlying gRPC client.
ReportServiceSettings	settings	The base ReportServiceSettings used within this client.
ILogger	logger	Optional ILogger to use within this client.

Properties

GrpcClient

The underlying gRPC ReportService client

Declaration

public override ReportService.ReportServiceClient GrpcClient { get; }

Property Value

Type	Description
ReportService.ReportServiceClient

Overrides

ReportServiceClient.GrpcClient

RunReportOperationsClient

The long-running operations client for RunReport.

Declaration

public override OperationsClient RunReportOperationsClient { get; }

Property Value

Type	Description
OperationsClient

Overrides

ReportServiceClient.RunReportOperationsClient

Methods

CreateReport(CreateReportRequest, CallSettings)

API to create a Report object.

Declaration

public override 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.

Overrides

ReportServiceClient.CreateReport(CreateReportRequest, CallSettings)

CreateReportAsync(CreateReportRequest, CallSettings)

API to create a Report object.

Declaration

public override 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.

Overrides

ReportServiceClient.CreateReportAsync(CreateReportRequest, CallSettings)

FetchReportResultRows(FetchReportResultRowsRequest, CallSettings)

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 override 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.

Overrides

ReportServiceClient.FetchReportResultRows(FetchReportResultRowsRequest, CallSettings)

FetchReportResultRowsAsync(FetchReportResultRowsRequest, CallSettings)

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 override 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.

Overrides

ReportServiceClient.FetchReportResultRowsAsync(FetchReportResultRowsRequest, CallSettings)

GetReport(GetReportRequest, CallSettings)

API to retrieve a Report object.

Declaration

public override 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.

Overrides

ReportServiceClient.GetReport(GetReportRequest, CallSettings)

GetReportAsync(GetReportRequest, CallSettings)

API to retrieve a Report object.

Declaration

public override 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.

Overrides

ReportServiceClient.GetReportAsync(GetReportRequest, CallSettings)

ListReports(ListReportsRequest, CallSettings)

API to retrieve a list of Report objects.

Declaration

public override 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.

Overrides

ReportServiceClient.ListReports(ListReportsRequest, CallSettings)

ListReportsAsync(ListReportsRequest, CallSettings)

API to retrieve a list of Report objects.

Declaration

public override 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.

Overrides

ReportServiceClient.ListReportsAsync(ListReportsRequest, CallSettings)

RunReport(RunReportRequest, CallSettings)

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 override 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.

Overrides

ReportServiceClient.RunReport(RunReportRequest, CallSettings)

RunReportAsync(RunReportRequest, CallSettings)

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 override 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.

Overrides

ReportServiceClient.RunReportAsync(RunReportRequest, CallSettings)

UpdateReport(UpdateReportRequest, CallSettings)

API to update a Report object.

Declaration

public override 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.

Overrides

ReportServiceClient.UpdateReport(UpdateReportRequest, CallSettings)

UpdateReportAsync(UpdateReportRequest, CallSettings)

API to update a Report object.

Declaration

public override 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.

Overrides

ReportServiceClient.UpdateReportAsync(UpdateReportRequest, CallSettings)