batchRunReports(property, body=None, x__xgafv=None)
Returns multiple reports in a batch. All reports must be for the same GA4 Property.
+
+ checkCompatibility(property, body=None, x__xgafv=None)
This compatibility method lists dimensions and metrics that can be added to a report request and maintain compatibility. This method fails if the request's dimensions and metrics are incompatible. In Google Analytics, reports fail if they request incompatible dimensions and/or metrics; in that case, you will need to remove dimensions and/or metrics from the incompatible report until the report is compatible. The Realtime and Core reports have different compatibility rules. This method checks compatibility for Core reports.
Close httplib2 connections.
@@ -324,7 +327,9 @@checkCompatibility(property, body=None, x__xgafv=None)
+ This compatibility method lists dimensions and metrics that can be added to a report request and maintain compatibility. This method fails if the request's dimensions and metrics are incompatible. In Google Analytics, reports fail if they request incompatible dimensions and/or metrics; in that case, you will need to remove dimensions and/or metrics from the incompatible report until the report is compatible. The Realtime and Core reports have different compatibility rules. This method checks compatibility for Core reports.
+
+Args:
+ property: string, A Google Analytics GA4 property identifier whose events are tracked. To learn more, see [where to find your Property ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id). `property` should be the same value as in your `runReport` request. Example: properties/1234 Set the Property ID to 0 for compatibility checking on dimensions and metrics common to all properties. In this special mode, this method will not return custom dimensions and metrics. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # The request for compatibility information for a report's dimensions and metrics. Check compatibility provides a preview of the compatibility of a report; fields shared with the `runReport` request should be the same values as in your `runReport` request.
+ "compatibilityFilter": "A String", # Filters the dimensions and metrics in the response to just this compatibility. Commonly used as `”compatibilityFilter”: “COMPATIBLE”` to only return compatible dimensions & metrics.
+ "dimensionFilter": { # To express dimension or metric filters. The fields in the same FilterExpression need to be either all dimensions or all metrics. # The filter clause of dimensions. `dimensionFilter` should be the same value as in your `runReport` request.
+ "andGroup": { # A list of filter expressions. # The FilterExpressions in and_group have an AND relationship.
+ "expressions": [ # A list of filter expressions.
+ # Object with schema name: FilterExpression
+ ],
+ },
+ "filter": { # An expression to filter dimension or metric values. # A primitive filter. All fields in filter in same FilterExpression needs to be either all dimensions or metrics.
+ "betweenFilter": { # To express that the result needs to be between two numbers (inclusive). # A filter for two values.
+ "fromValue": { # To represent a number. # Begins with this number.
+ "doubleValue": 3.14, # Double value
+ "int64Value": "A String", # Integer value
+ },
+ "toValue": { # To represent a number. # Ends with this number.
+ "doubleValue": 3.14, # Double value
+ "int64Value": "A String", # Integer value
+ },
+ },
+ "fieldName": "A String", # The dimension name or metric name. Must be a name defined in dimensions or metrics.
+ "inListFilter": { # The result needs to be in a list of string values. # A filter for in list values.
+ "caseSensitive": True or False, # If true, the string value is case sensitive.
+ "values": [ # The list of string values. Must be non-empty.
+ "A String",
+ ],
+ },
+ "numericFilter": { # Filters for numeric or date values. # A filter for numeric or date values.
+ "operation": "A String", # The operation type for this filter.
+ "value": { # To represent a number. # A numeric value or a date value.
+ "doubleValue": 3.14, # Double value
+ "int64Value": "A String", # Integer value
+ },
+ },
+ "stringFilter": { # The filter for string # Strings related filter.
+ "caseSensitive": True or False, # If true, the string value is case sensitive.
+ "matchType": "A String", # The match type for this filter.
+ "value": "A String", # The string value used for the matching.
+ },
+ },
+ "notExpression": # Object with schema name: FilterExpression # The FilterExpression is NOT of not_expression.
+ "orGroup": { # A list of filter expressions. # The FilterExpressions in or_group have an OR relationship.
+ "expressions": [ # A list of filter expressions.
+ # Object with schema name: FilterExpression
+ ],
+ },
+ },
+ "dimensions": [ # The dimensions in this report. `dimensions` should be the same value as in your `runReport` request.
+ { # Dimensions are attributes of your data. For example, the dimension city indicates the city from which an event originates. Dimension values in report responses are strings; for example, city could be "Paris" or "New York". Requests are allowed up to 9 dimensions.
+ "dimensionExpression": { # Used to express a dimension which is the result of a formula of multiple dimensions. Example usages: 1) lower_case(dimension) 2) concatenate(dimension1, symbol, dimension2). # One dimension can be the result of an expression of multiple dimensions. For example, dimension "country, city": concatenate(country, ", ", city).
+ "concatenate": { # Used to combine dimension values to a single dimension. # Used to combine dimension values to a single dimension. For example, dimension "country, city": concatenate(country, ", ", city).
+ "delimiter": "A String", # The delimiter placed between dimension names. Delimiters are often single characters such as "|" or "," but can be longer strings. If a dimension value contains the delimiter, both will be present in response with no distinction. For example if dimension 1 value = "US,FR", dimension 2 value = "JP", and delimiter = ",", then the response will contain "US,FR,JP".
+ "dimensionNames": [ # Names of dimensions. The names must refer back to names in the dimensions field of the request.
+ "A String",
+ ],
+ },
+ "lowerCase": { # Used to convert a dimension value to a single case. # Used to convert a dimension value to lower case.
+ "dimensionName": "A String", # Name of a dimension. The name must refer back to a name in dimensions field of the request.
+ },
+ "upperCase": { # Used to convert a dimension value to a single case. # Used to convert a dimension value to upper case.
+ "dimensionName": "A String", # Name of a dimension. The name must refer back to a name in dimensions field of the request.
+ },
+ },
+ "name": "A String", # The name of the dimension. See the [API Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#dimensions) for the list of dimension names. If `dimensionExpression` is specified, `name` can be any string that you would like within the allowed character set. For example if a `dimensionExpression` concatenates `country` and `city`, you could call that dimension `countryAndCity`. Dimension names that you choose must match the regular expression "^[a-zA-Z0-9_]$". Dimensions are referenced by `name` in `dimensionFilter`, `orderBys`, `dimensionExpression`, and `pivots`.
+ },
+ ],
+ "metricFilter": { # To express dimension or metric filters. The fields in the same FilterExpression need to be either all dimensions or all metrics. # The filter clause of metrics. `metricFilter` should be the same value as in your `runReport` request
+ "andGroup": { # A list of filter expressions. # The FilterExpressions in and_group have an AND relationship.
+ "expressions": [ # A list of filter expressions.
+ # Object with schema name: FilterExpression
+ ],
+ },
+ "filter": { # An expression to filter dimension or metric values. # A primitive filter. All fields in filter in same FilterExpression needs to be either all dimensions or metrics.
+ "betweenFilter": { # To express that the result needs to be between two numbers (inclusive). # A filter for two values.
+ "fromValue": { # To represent a number. # Begins with this number.
+ "doubleValue": 3.14, # Double value
+ "int64Value": "A String", # Integer value
+ },
+ "toValue": { # To represent a number. # Ends with this number.
+ "doubleValue": 3.14, # Double value
+ "int64Value": "A String", # Integer value
+ },
+ },
+ "fieldName": "A String", # The dimension name or metric name. Must be a name defined in dimensions or metrics.
+ "inListFilter": { # The result needs to be in a list of string values. # A filter for in list values.
+ "caseSensitive": True or False, # If true, the string value is case sensitive.
+ "values": [ # The list of string values. Must be non-empty.
+ "A String",
+ ],
+ },
+ "numericFilter": { # Filters for numeric or date values. # A filter for numeric or date values.
+ "operation": "A String", # The operation type for this filter.
+ "value": { # To represent a number. # A numeric value or a date value.
+ "doubleValue": 3.14, # Double value
+ "int64Value": "A String", # Integer value
+ },
+ },
+ "stringFilter": { # The filter for string # Strings related filter.
+ "caseSensitive": True or False, # If true, the string value is case sensitive.
+ "matchType": "A String", # The match type for this filter.
+ "value": "A String", # The string value used for the matching.
+ },
+ },
+ "notExpression": # Object with schema name: FilterExpression # The FilterExpression is NOT of not_expression.
+ "orGroup": { # A list of filter expressions. # The FilterExpressions in or_group have an OR relationship.
+ "expressions": [ # A list of filter expressions.
+ # Object with schema name: FilterExpression
+ ],
+ },
+ },
+ "metrics": [ # The metrics in this report. `metrics` should be the same value as in your `runReport` request.
+ { # The quantitative measurements of a report. For example, the metric `eventCount` is the total number of events. Requests are allowed up to 10 metrics.
+ "expression": "A String", # A mathematical expression for derived metrics. For example, the metric Event count per user is `eventCount/totalUsers`.
+ "invisible": True or False, # Indicates if a metric is invisible in the report response. If a metric is invisible, the metric will not produce a column in the response, but can be used in `metricFilter`, `orderBys`, or a metric `expression`.
+ "name": "A String", # The name of the metric. See the [API Metrics](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#metrics) for the list of metric names. If `expression` is specified, `name` can be any string that you would like within the allowed character set. For example if `expression` is `screenPageViews/sessions`, you could call that metric's name = `viewsPerSession`. Metric names that you choose must match the regular expression "^[a-zA-Z0-9_]$". Metrics are referenced by `name` in `metricFilter`, `orderBys`, and metric `expression`.
+ },
+ ],
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The compatibility response with the compatibility of each dimension & metric.
+ "dimensionCompatibilities": [ # The compatibility of each dimension.
+ { # The compatibility for a single dimension.
+ "compatibility": "A String", # The compatibility of this dimension. If the compatibility is COMPATIBLE, this dimension can be successfully added to the report.
+ "dimensionMetadata": { # Explains a dimension. # The dimension metadata contains the API name for this compatibility information. The dimension metadata also contains other helpful information like the UI name and description.
+ "apiName": "A String", # This dimension's name. Useable in [Dimension](#Dimension)'s `name`. For example, `eventName`.
+ "category": "A String", # The display name of the category that this dimension belongs to. Similar dimensions and metrics are categorized together.
+ "customDefinition": True or False, # True if the dimension is a custom dimension for this property.
+ "deprecatedApiNames": [ # Still usable but deprecated names for this dimension. If populated, this dimension is available by either `apiName` or one of `deprecatedApiNames` for a period of time. After the deprecation period, the dimension will be available only by `apiName`.
+ "A String",
+ ],
+ "description": "A String", # Description of how this dimension is used and calculated.
+ "uiName": "A String", # This dimension's name within the Google Analytics user interface. For example, `Event name`.
+ },
+ },
+ ],
+ "metricCompatibilities": [ # The compatibility of each metric.
+ { # The compatibility for a single metric.
+ "compatibility": "A String", # The compatibility of this metric. If the compatibility is COMPATIBLE, this metric can be successfully added to the report.
+ "metricMetadata": { # Explains a metric. # The metric metadata contains the API name for this compatibility information. The metric metadata also contains other helpful information like the UI name and description.
+ "apiName": "A String", # A metric name. Useable in [Metric](#Metric)'s `name`. For example, `eventCount`.
+ "category": "A String", # The display name of the category that this metrics belongs to. Similar dimensions and metrics are categorized together.
+ "customDefinition": True or False, # True if the metric is a custom metric for this property.
+ "deprecatedApiNames": [ # Still usable but deprecated names for this metric. If populated, this metric is available by either `apiName` or one of `deprecatedApiNames` for a period of time. After the deprecation period, the metric will be available only by `apiName`.
+ "A String",
+ ],
+ "description": "A String", # Description of how this metric is used and calculated.
+ "expression": "A String", # The mathematical expression for this derived metric. Can be used in [Metric](#Metric)'s `expression` field for equivalent reports. Most metrics are not expressions, and for non-expressions, this field is empty.
+ "type": "A String", # The type of this metric.
+ "uiName": "A String", # This metric's name within the Google Analytics user interface. For example, `Event count`.
+ },
+ },
+ ],
+}
+close()
Close httplib2 connections.@@ -709,6 +887,7 @@
Creates an in-app product (i.e. a managed product or a subscriptions).
list(packageName, maxResults=None, startIndex=None, token=None, x__xgafv=None)
Lists all in-app products - both managed products and subscriptions.
+Lists all in-app products - both managed products and subscriptions. If an app has a large number of in-app products, the response may be paginated. In this case the response field `tokenPagination.nextPageToken` will be set and the caller should provide its value as a `token` request parameter to retrieve the next page.
patch(packageName, sku, autoConvertMissingPrices=None, body=None, x__xgafv=None)
Patches an in-app product (i.e. a managed product or a subscriptions).
@@ -242,12 +242,12 @@list(packageName, maxResults=None, startIndex=None, token=None, x__xgafv=None)
- Lists all in-app products - both managed products and subscriptions.
+ Lists all in-app products - both managed products and subscriptions. If an app has a large number of in-app products, the response may be paginated. In this case the response field `tokenPagination.nextPageToken` will be set and the caller should provide its value as a `token` request parameter to retrieve the next page.
Args:
packageName: string, Package name of the app. (required)
- maxResults: integer, How many results the list operation should return.
- startIndex: integer, The index of the first element to return.
+ maxResults: integer, Deprecated and ignored. The page size is determined by the server.
+ startIndex: integer, Deprecated and ignored. Set the `token` parameter to rertieve the next page.
token: string, Pagination token. If empty, list starts at the first product.
x__xgafv: string, V1 error format.
Allowed values
@@ -290,7 +290,7 @@ Method Details
},
],
"kind": "A String", # The kind of this response ("androidpublisher#inappproductsListResponse").
- "pageInfo": { # Information about the current page. List operations that supports paging return only one "page" of results. This protocol buffer message describes the page that has been returned. # Information about the current page.
+ "pageInfo": { # Information about the current page. List operations that supports paging return only one "page" of results. This protocol buffer message describes the page that has been returned. # Deprecated and unset.
"resultPerPage": 42, # Maximum number of results returned in one page. ! The number of results included in the API response.
"startIndex": 42, # Index of the first result returned in the current page.
"totalResults": 42, # Total number of results available on the backend ! The total number of results in the result set.
diff --git a/docs/dyn/artifactregistry_v1.operations.html b/docs/dyn/artifactregistry_v1.operations.html
index 46c7bfb7d3e..ec99f8a6d5f 100644
--- a/docs/dyn/artifactregistry_v1.operations.html
+++ b/docs/dyn/artifactregistry_v1.operations.html
@@ -87,7 +87,7 @@ Instance Methods
get(name, x__xgafv=None)
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
- list(filter=None, name=None, pageSize=None, pageToken=None, x__xgafv=None)
+ list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/*}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
list_next(previous_request, previous_response)
@@ -176,12 +176,12 @@ Method Details
list(filter=None, name=None, pageSize=None, pageToken=None, x__xgafv=None)
+ list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/*}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
Args:
+ name: string, The name of the operation's parent resource. (required)
filter: string, The standard list filter.
- name: string, The name of the operation's parent resource.
pageSize: integer, The standard list page size.
pageToken: string, The standard list page token.
x__xgafv: string, V1 error format.
diff --git a/docs/dyn/artifactregistry_v1beta1.projects.locations.operations.html b/docs/dyn/artifactregistry_v1beta1.projects.locations.operations.html
index 977a7c48954..2c8ddf10338 100644
--- a/docs/dyn/artifactregistry_v1beta1.projects.locations.operations.html
+++ b/docs/dyn/artifactregistry_v1beta1.projects.locations.operations.html
@@ -80,12 +80,6 @@ Instance Methods
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
-
- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
-Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/*}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
-
- list_next(previous_request, previous_response)
-Retrieves the next page of results.
Method Details
close()
@@ -127,61 +121,4 @@ Method Details
}
-
- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
- Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/*}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
-
-Args:
- name: string, The name of the operation's parent resource. (required)
- filter: string, The standard list filter.
- pageSize: integer, The standard list page size.
- pageToken: string, The standard list page token.
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- { # The response message for Operations.ListOperations.
- "nextPageToken": "A String", # The standard List next-page token.
- "operations": [ # A list of operations that matches the specified filter in the request.
- { # This resource represents a long-running operation that is the result of a network API call.
- "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
- "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- ],
- "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
- },
- "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
- "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- },
- ],
-}
-
-
-
- list_next(previous_request, previous_response)
- Retrieves the next page of results.
-
-Args:
- previous_request: The request for the previous page. (required)
- previous_response: The response from the request for the previous page. (required)
-
-Returns:
- A request object that you can call 'execute()' on to request the next
- page. Returns None if there are no more items in the collection.
-
-
-