Class ReportService.ReportServiceBase

Base class for server-side implementations of ReportService

Inheritance

object

ReportService.ReportServiceBase

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace: Google.Ads.AdManager.V1

Assembly: Google.Ads.AdManager.V1.dll

Syntax

[BindServiceMethod(typeof(ReportService), "BindService")]
public abstract class ReportService.ReportServiceBase

Methods

CreateReport(CreateReportRequest, ServerCallContext)

API to create a Report object.

Declaration

public virtual Task<Report> CreateReport(CreateReportRequest request, ServerCallContext context)

Parameters

Type	Name	Description
CreateReportRequest	request	The request received from the client.
ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
Task<Report>	The response to send back to the client (wrapped by a task).

FetchReportResultRows(FetchReportResultRowsRequest, ServerCallContext)

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 Task<FetchReportResultRowsResponse> FetchReportResultRows(FetchReportResultRowsRequest request, ServerCallContext context)

Parameters

Type	Name	Description
FetchReportResultRowsRequest	request	The request received from the client.
ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
Task<FetchReportResultRowsResponse>	The response to send back to the client (wrapped by a task).

GetReport(GetReportRequest, ServerCallContext)

API to retrieve a Report object.

Declaration

public virtual Task<Report> GetReport(GetReportRequest request, ServerCallContext context)

Parameters

Type	Name	Description
GetReportRequest	request	The request received from the client.
ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
Task<Report>	The response to send back to the client (wrapped by a task).

ListReports(ListReportsRequest, ServerCallContext)

API to retrieve a list of Report objects.

Declaration

public virtual Task<ListReportsResponse> ListReports(ListReportsRequest request, ServerCallContext context)

Parameters

Type	Name	Description
ListReportsRequest	request	The request received from the client.
ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
Task<ListReportsResponse>	The response to send back to the client (wrapped by a task).

RunReport(RunReportRequest, ServerCallContext)

Initiates the execution of an existing report asynchronously. Users can get the report by polling this operation via 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> RunReport(RunReportRequest request, ServerCallContext context)

Parameters

Type	Name	Description
RunReportRequest	request	The request received from the client.
ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
Task<Operation>	The response to send back to the client (wrapped by a task).

UpdateReport(UpdateReportRequest, ServerCallContext)

API to update a Report object.

Declaration

public virtual Task<Report> UpdateReport(UpdateReportRequest request, ServerCallContext context)

Parameters

Type	Name	Description
UpdateReportRequest	request	The request received from the client.
ServerCallContext	context	The context of the server-side call handler being invoked.

Returns

Type	Description
Task<Report>	The response to send back to the client (wrapped by a task).