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. Deprecated: Please use Export Channel Services data to BigQuery instead.

Scopes

You will need authorization for the https://www.googleapis.com/auth/apps.reports.usage.readonly scope to make a valid call.

If unset, the scope for this method defaults to https://www.googleapis.com/auth/apps.reports.usage.readonly. You can set the scope for this method like this: cloudchannel1 --scope <scope> accounts reports-run ...

Required Scalar Argument

• <name> (string)
  • 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}

Required Request Value

The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.

For example, a structure like this:

GoogleCloudChannelV1RunReportJobRequest:
  date-range:
    invoice-end-date:
      day: integer
      month: integer
      year: integer
    invoice-start-date:
      day: integer
      month: integer
      year: integer
    usage-end-date-time:
      day: integer
      hours: integer
      minutes: integer
      month: integer
      nanos: integer
      seconds: integer
      time-zone:
        id: string
        version: string
      utc-offset: string
      year: integer
    usage-start-date-time:
      day: integer
      hours: integer
      minutes: integer
      month: integer
      nanos: integer
      seconds: integer
      time-zone:
        id: string
        version: string
      utc-offset: string
      year: integer
  filter: string
  language-code: string

can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.

• -r .date-range.invoice-end-date day=55
  • Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
• month=29
  • Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

• year=87

  • Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

• ..invoice-start-date day=100

  • Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
• month=53
  • Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

• year=42

  • Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

• ..usage-end-date-time day=70

  • Optional. Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a datetime without a day.
• hours=59
  • Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults to 0 (midnight). An API may choose to allow the value "24:00:00" for scenarios like business closing time.
• minutes=60
  • Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0.
• month=95
  • Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month.
• nanos=24
  • Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999, defaults to 0.
• seconds=9
  • Optional. Seconds of minutes of the time. Must normally be from 0 to 59, defaults to 0. An API may allow the value 60 if it allows leap-seconds.
• time-zone id=diam
  • IANA Time Zone Database time zone, e.g. "America/New_York".

• version=sed

  • Optional. IANA Time Zone Database version number, e.g. "2019a".

• .. utc-offset=et

  • UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.

• year=84

  • Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.

• ..usage-start-date-time day=17

  • Optional. Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a datetime without a day.
• hours=46
  • Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults to 0 (midnight). An API may choose to allow the value "24:00:00" for scenarios like business closing time.
• minutes=34
  • Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0.
• month=74
  • Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month.
• nanos=48
  • Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999, defaults to 0.
• seconds=3
  • Optional. Seconds of minutes of the time. Must normally be from 0 to 59, defaults to 0. An API may allow the value 60 if it allows leap-seconds.
• time-zone id=lorem
  • IANA Time Zone Database time zone, e.g. "America/New_York".

• version=stet

  • Optional. IANA Time Zone Database version number, e.g. "2019a".

• .. utc-offset=duo

  • UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.

• year=7

  • Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.

• ... filter=aliquyam

  • Optional. A structured string that defines conditions on dimension columns to restrict the report output. Filters support logical operators (AND, OR, NOT) and conditional operators (=, !=, <, >, <=, and >=) using column_id as keys. For example: (customer:"accounts/C123abc/customers/S456def" OR customer:"accounts/C123abc/customers/S789ghi") AND invoice_start_date.year >= 2022
• language-code=erat
  • 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".

About Cursors

The cursor position is key to comfortably set complex nested structures. The following rules apply:

• The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o .
• The cursor position is set relative to the top-level structure if it starts with ., e.g. -r .s.s
• You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar.
• You can move the cursor one level up by using ... Each additional . moves it up one additional level. E.g. ... would go three levels up.

Optional Output Flags

The method's return value a JSON encoded structure, which will be written to standard output by default.

• -o out
  • out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.

Optional General Properties

The following properties can configure any call, and are not specific to this method.

• -p $-xgafv=string

  • V1 error format.

• -p access-token=string

  • OAuth access token.

• -p alt=string

  • Data format for response.

• -p callback=string

  • JSONP

• -p fields=string

  • Selector specifying which fields to include in a partial response.

• -p key=string

  • API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

• -p oauth-token=string

  • OAuth 2.0 token for the current user.

• -p pretty-print=boolean

  • Returns response with indentations and line breaks.

• -p quota-user=string

  • Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• -p upload-type=string

  • Legacy upload protocol for media (e.g. "media", "multipart").

• -p upload-protocol=string

  • Upload protocol for media (e.g. "raw", "multipart").