Cloud Channel API (cloudchannel:v1)

Additions

Methods


• ▼ ▲ cloudchannel.accounts.reportJobs.fetchReportResults

  Description: Retrieves data generated by CloudChannelReportsService.RunReportJob.

  Flat Path: v1/accounts/{accountsId}/reportJobs/{reportJobsId}:fetchReportResults

  Path: v1/{+reportJob}:fetchReportResults

  Scopes: https://www.googleapis.com/auth/apps.reports.usage.readonly

  Parameters:

  reportJob

  Location: path

  Description: Required. The report job created by CloudChannelReportsService.RunReportJob. Report_job uses the format: accounts/{account_id}/reportJobs/{report_job_id}

  Type: string

  Required: Yes

  Pattern: ^accounts/[^/]+/reportJobs/[^/]+$

  HTTP Method: POST

  Parameter Order: reportJob

• ▼ ▲ cloudchannel.accounts.reports.list

  Flat Path: v1/accounts/{accountsId}/reports

  HTTP Method: GET

  Parameter Order: parent

  Scopes: https://www.googleapis.com/auth/apps.reports.usage.readonly

  Description: Lists the reports that RunReportJob can run. These reports include an ID, a description, and the list of columns that will be in the result.

  Parameters:

  languageCode

  Type: string

  Location: query

  Description: Optional. The BCP-47 language code, such as "en-US". If specified, the response is localized to the corresponding language code if the original data sources support it. Default is "en-US".

  pageToken

  Description: Optional. A token that specifies a page of results beyond the first page. Obtained through ListReportsResponse.next_page_token of the previous CloudChannelReportsService.ListReports call.

  Location: query

  Type: string

  pageSize

  Type: integer

  Description: Optional. Requested page size of the report. The server might return fewer results than requested. If unspecified, returns 20 reports. The maximum value is 100.

  Location: query

  Format: int32

  parent

  Required: Yes

  Location: path

  Type: string

  Description: Required. The resource name of the partner account to list available reports for. Parent uses the format: accounts/{account_id}

  Pattern: ^accounts/[^/]+$

  Path: v1/{+parent}/reports

• ▼ ▲ cloudchannel.accounts.reports.run

  HTTP Method: POST

  Description: Begins generation of data for a given report. The report identifier is a UID (for example, `613bf59q`). Possible error codes: * PERMISSION_DENIED: The user doesn't have access to this report. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The report identifier was not found. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata contains an instance of OperationMetadata. To get the results of report generation, call CloudChannelReportsService.FetchReportResults with the RunReportJobResponse.report_job.

  Path: v1/{+name}:run

  Flat Path: v1/accounts/{accountsId}/reports/{reportsId}:run

  Parameters:

  name

  Pattern: ^accounts/[^/]+/reports/[^/]+$

  Type: string

  Location: path

  Required: Yes

  Description: Required. The report's resource name. Specifies the account and report used to generate report data. The report_id identifier is a UID (for example, `613bf59q`). Name uses the format: accounts/{account_id}/reports/{report_id}

  Parameter Order: name

  Scopes: https://www.googleapis.com/auth/apps.reports.usage.readonly