Class ReportService.ReportServiceClient

Client for ReportService

Inheritance

object

ClientBase

ClientBase<ReportService.ReportServiceClient>

ReportService.ReportServiceClient

Inherited Members

ClientBase<ReportService.ReportServiceClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace: Google.Ads.AdManager.V1

Assembly: Google.Ads.AdManager.V1.dll

Syntax

public class ReportService.ReportServiceClient : ClientBase<ReportService.ReportServiceClient>

Constructors

ReportServiceClient()

Protected parameterless constructor to allow creation of test doubles.

Declaration

protected ReportServiceClient()

ReportServiceClient(CallInvoker)

Creates a new client for ReportService that uses a custom CallInvoker.

Declaration

public ReportServiceClient(CallInvoker callInvoker)

Parameters

Type	Name	Description
CallInvoker	callInvoker	The callInvoker to use to make remote calls.

ReportServiceClient(ChannelBase)

Creates a new client for ReportService

Declaration

public ReportServiceClient(ChannelBase channel)

Parameters

Type	Name	Description
ChannelBase	channel	The channel to use to make remote calls.

ReportServiceClient(ClientBaseConfiguration)

Protected constructor to allow creation of configured clients.

Declaration

protected ReportServiceClient(ClientBase.ClientBaseConfiguration configuration)

Parameters

Type	Name	Description
ClientBase.ClientBaseConfiguration	configuration	The client configuration.

Methods

CreateOperationsClient()

Creates a new instance of Google.LongRunning.Operations.OperationsClient using the same call invoker as this client.

Declaration

public virtual Operations.OperationsClient CreateOperationsClient()

Returns

Type	Description
Operations.OperationsClient	A new Operations client for the same target as this client.

CreateReport(CreateReportRequest, CallOptions)

API to create a Report object.

Declaration

public virtual Report CreateReport(CreateReportRequest request, CallOptions options)

Parameters

Type	Name	Description
CreateReportRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
Report	The response received from the server.

CreateReport(CreateReportRequest, Metadata, DateTime?, CancellationToken)

API to create a Report object.

Declaration

public virtual Report CreateReport(CreateReportRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CreateReportRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
Report	The response received from the server.

CreateReportAsync(CreateReportRequest, CallOptions)

API to create a Report object.

Declaration

public virtual AsyncUnaryCall<Report> CreateReportAsync(CreateReportRequest request, CallOptions options)

Parameters

Type	Name	Description
CreateReportRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
AsyncUnaryCall<Report>	The call object.

CreateReportAsync(CreateReportRequest, Metadata, DateTime?, CancellationToken)

API to create a Report object.

Declaration

public virtual AsyncUnaryCall<Report> CreateReportAsync(CreateReportRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CreateReportRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
AsyncUnaryCall<Report>	The call object.

FetchReportResultRows(FetchReportResultRowsRequest, CallOptions)

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 FetchReportResultRowsResponse FetchReportResultRows(FetchReportResultRowsRequest request, CallOptions options)

Parameters

Type	Name	Description
FetchReportResultRowsRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
FetchReportResultRowsResponse	The response received from the server.

FetchReportResultRows(FetchReportResultRowsRequest, Metadata, DateTime?, CancellationToken)

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 FetchReportResultRowsResponse FetchReportResultRows(FetchReportResultRowsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
FetchReportResultRowsRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
FetchReportResultRowsResponse	The response received from the server.

FetchReportResultRowsAsync(FetchReportResultRowsRequest, CallOptions)

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 AsyncUnaryCall<FetchReportResultRowsResponse> FetchReportResultRowsAsync(FetchReportResultRowsRequest request, CallOptions options)

Parameters

Type	Name	Description
FetchReportResultRowsRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
AsyncUnaryCall<FetchReportResultRowsResponse>	The call object.

FetchReportResultRowsAsync(FetchReportResultRowsRequest, Metadata, DateTime?, CancellationToken)

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 AsyncUnaryCall<FetchReportResultRowsResponse> FetchReportResultRowsAsync(FetchReportResultRowsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
FetchReportResultRowsRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
AsyncUnaryCall<FetchReportResultRowsResponse>	The call object.

GetReport(GetReportRequest, CallOptions)

API to retrieve a Report object.

Declaration

public virtual Report GetReport(GetReportRequest request, CallOptions options)

Parameters

Type	Name	Description
GetReportRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
Report	The response received from the server.

GetReport(GetReportRequest, Metadata, DateTime?, CancellationToken)

API to retrieve a Report object.

Declaration

public virtual Report GetReport(GetReportRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
GetReportRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
Report	The response received from the server.

GetReportAsync(GetReportRequest, CallOptions)

API to retrieve a Report object.

Declaration

public virtual AsyncUnaryCall<Report> GetReportAsync(GetReportRequest request, CallOptions options)

Parameters

Type	Name	Description
GetReportRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
AsyncUnaryCall<Report>	The call object.

GetReportAsync(GetReportRequest, Metadata, DateTime?, CancellationToken)

API to retrieve a Report object.

Declaration

public virtual AsyncUnaryCall<Report> GetReportAsync(GetReportRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
GetReportRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
AsyncUnaryCall<Report>	The call object.

ListReports(ListReportsRequest, CallOptions)

API to retrieve a list of Report objects.

Declaration

public virtual ListReportsResponse ListReports(ListReportsRequest request, CallOptions options)

Parameters

Type	Name	Description
ListReportsRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
ListReportsResponse	The response received from the server.

ListReports(ListReportsRequest, Metadata, DateTime?, CancellationToken)

API to retrieve a list of Report objects.

Declaration

public virtual ListReportsResponse ListReports(ListReportsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListReportsRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
ListReportsResponse	The response received from the server.

ListReportsAsync(ListReportsRequest, CallOptions)

API to retrieve a list of Report objects.

Declaration

public virtual AsyncUnaryCall<ListReportsResponse> ListReportsAsync(ListReportsRequest request, CallOptions options)

Parameters

Type	Name	Description
ListReportsRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
AsyncUnaryCall<ListReportsResponse>	The call object.

ListReportsAsync(ListReportsRequest, Metadata, DateTime?, CancellationToken)

API to retrieve a list of Report objects.

Declaration

public virtual AsyncUnaryCall<ListReportsResponse> ListReportsAsync(ListReportsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListReportsRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
AsyncUnaryCall<ListReportsResponse>	The call object.

NewInstance(ClientBaseConfiguration)

Creates a new instance of client from given ClientBaseConfiguration.

Declaration

protected override ReportService.ReportServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Parameters

Type	Name	Description
ClientBase.ClientBaseConfiguration	configuration

Returns

Type	Description
ReportService.ReportServiceClient

Overrides

Grpc.Core.ClientBase<Google.Ads.AdManager.V1.ReportService.ReportServiceClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

RunReport(RunReportRequest, CallOptions)

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 RunReport(RunReportRequest request, CallOptions options)

Parameters

Type	Name	Description
RunReportRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
Operation	The response received from the server.

RunReport(RunReportRequest, Metadata, DateTime?, CancellationToken)

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 RunReport(RunReportRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
RunReportRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
Operation	The response received from the server.

RunReportAsync(RunReportRequest, CallOptions)

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 AsyncUnaryCall<Operation> RunReportAsync(RunReportRequest request, CallOptions options)

Parameters

Type	Name	Description
RunReportRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
AsyncUnaryCall<Operation>	The call object.

RunReportAsync(RunReportRequest, Metadata, DateTime?, CancellationToken)

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 AsyncUnaryCall<Operation> RunReportAsync(RunReportRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
RunReportRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
AsyncUnaryCall<Operation>	The call object.

UpdateReport(UpdateReportRequest, CallOptions)

API to update a Report object.

Declaration

public virtual Report UpdateReport(UpdateReportRequest request, CallOptions options)

Parameters

Type	Name	Description
UpdateReportRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
Report	The response received from the server.

UpdateReport(UpdateReportRequest, Metadata, DateTime?, CancellationToken)

API to update a Report object.

Declaration

public virtual Report UpdateReport(UpdateReportRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
UpdateReportRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
Report	The response received from the server.

UpdateReportAsync(UpdateReportRequest, CallOptions)

API to update a Report object.

Declaration

public virtual AsyncUnaryCall<Report> UpdateReportAsync(UpdateReportRequest request, CallOptions options)

Parameters

Type	Name	Description
UpdateReportRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
AsyncUnaryCall<Report>	The call object.

UpdateReportAsync(UpdateReportRequest, Metadata, DateTime?, CancellationToken)

API to update a Report object.

Declaration

public virtual AsyncUnaryCall<Report> UpdateReportAsync(UpdateReportRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
UpdateReportRequest	request	The request to send to the server.
Metadata	headers	The initial metadata to send with the call. This parameter is optional.
DateTime?	deadline	An optional deadline for the call. The call will be cancelled if deadline is hit.
CancellationToken	cancellationToken	An optional token for canceling the call.

Returns

Type	Description
AsyncUnaryCall<Report>	The call object.