--- title: "POST /v1/{+name}:run" method: POST path: "/v1/{+name}:run" tags: ["accounts"] --- # POST /v1/{+name}:run `POST /v1/{+name}:run` 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](https://cloud.google.com/channel/docs/rebilling/export-data-to-bigquery) instead. ## Path parameters - `name` string, required ## Request body - GoogleCloudChannelV1RunReportJobRequest — Request message for CloudChannelReportsService.RunReportJob. - `languageCode` string — 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". - `dateRange` GoogleCloudChannelV1DateRange — A representation of usage or invoice date ranges. - `usageStartDateTime` GoogleTypeDateTime — Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the `time_offset` oneof is set. Consider using `Timestamp` message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations. - `year` integer — Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year. - `nanos` integer — Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999, defaults to 0. - `month` integer — Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month. - `minutes` integer — Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0. - `timeZone` GoogleTypeTimeZone — Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). - `id` string — IANA Time Zone Database time zone. For example "America/New_York". - `version` string — Optional. IANA Time Zone Database version number. For example "2019a". - `utcOffset` string, google-duration — 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 }. - `hours` integer — 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. - `day` integer — 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. - `seconds` integer — 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. - `usageEndDateTime` GoogleTypeDateTime — Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the `time_offset` oneof is set. Consider using `Timestamp` message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations. - `year` integer — Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year. - `nanos` integer — Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999, defaults to 0. - `month` integer — Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month. - `minutes` integer — Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0. - `timeZone` GoogleTypeTimeZone — Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). - `id` string — IANA Time Zone Database time zone. For example "America/New_York". - `version` string — Optional. IANA Time Zone Database version number. For example "2019a". - `utcOffset` string, google-duration — 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 }. - `hours` integer — 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. - `day` integer — 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. - `seconds` integer — 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. - `invoiceStartDate` GoogleTypeDate — Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp - `month` integer — Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. - `year` integer — Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. - `day` integer — 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. - `invoiceEndDate` GoogleTypeDate — Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp - `month` integer — Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. - `year` integer — Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. - `day` integer — 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. - `filter` string — 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` ## Response `200` Successful response --- [API](https://skmtc.net/google/apis/cloudchannel.md) · [All operations](https://skmtc.net/google/apis/cloudchannel/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/google/cloudchannel/versions/7477d1d5f236/schema)