mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-07 03:56:42 +01:00
update all APIs
Like documented in the README ``` rm -f .api.deps .cli.deps && FETCH_APIS=1 make update-json -j8 ```
This commit is contained in:
Sebastian Thiel
@@ -15,7 +15,7 @@
|
||||
"baseUrl": "https://analyticsdata.googleapis.com/",
|
||||
"batchPath": "batch",
|
||||
"canonicalName": "AnalyticsData",
|
||||
"description": "Accesses report data in Google Analytics.",
|
||||
"description": "Accesses report data in Google Analytics. Warning: Creating multiple Customer Applications, Accounts, or Projects to simulate or act as a single Customer Application, Account, or Project (respectively) or to circumvent Service-specific usage limits or quotas is a direct violation of Google Cloud Platform Terms of Service as well as Google APIs Terms of Service. These actions can result in immediate termination of your GCP project(s) without any warning. ",
|
||||
"discoveryVersion": "v1",
|
||||
"documentationLink": "https://developers.google.com/analytics/devguides/reporting/data/v1/",
|
||||
"fullyEncodeReservedExpansion": true,
|
||||
@@ -310,10 +310,137 @@
|
||||
"https://www.googleapis.com/auth/analytics.readonly"
|
||||
]
|
||||
}
|
||||
},
|
||||
"resources": {
|
||||
"audienceExports": {
|
||||
"methods": {
|
||||
"create": {
|
||||
"description": "Creates an audience export for later retrieval. This method quickly returns the audience export's resource name and initiates a long running asynchronous request to form an audience export. To export the users in an audience export, first create the audience export through this method and then send the audience resource name to the `QueryAudienceExport` method. See [Creating an Audience Export](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics) for an introduction to Audience Exports with examples. An audience export is a snapshot of the users currently in the audience at the time of audience export creation. Creating audience exports for one audience on different days will return different results as users enter and exit the audience. Audiences in Google Analytics 4 allow you to segment your users in the ways that are important to your business. To learn more, see https://support.google.com/analytics/answer/9267572. Audience exports contain the users in each audience. Audience Export APIs have some methods at alpha and other methods at beta stability. The intention is to advance methods to beta stability after some feedback and adoption. To give your feedback on this API, complete the [Google Analytics Audience Export API Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.",
|
||||
"flatPath": "v1beta/properties/{propertiesId}/audienceExports",
|
||||
"httpMethod": "POST",
|
||||
"id": "analyticsdata.properties.audienceExports.create",
|
||||
"parameterOrder": [
|
||||
"parent"
|
||||
],
|
||||
"parameters": {
|
||||
"parent": {
|
||||
"description": "Required. The parent resource where this audience export will be created. Format: `properties/{property}`",
|
||||
"location": "path",
|
||||
"pattern": "^properties/[^/]+$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1beta/{+parent}/audienceExports",
|
||||
"request": {
|
||||
"$ref": "AudienceExport"
|
||||
},
|
||||
"response": {
|
||||
"$ref": "Operation"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/analytics",
|
||||
"https://www.googleapis.com/auth/analytics.readonly"
|
||||
]
|
||||
},
|
||||
"get": {
|
||||
"description": "Gets configuration metadata about a specific audience export. This method can be used to understand an audience export after it has been created. See [Creating an Audience Export](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics) for an introduction to Audience Exports with examples. Audience Export APIs have some methods at alpha and other methods at beta stability. The intention is to advance methods to beta stability after some feedback and adoption. To give your feedback on this API, complete the [Google Analytics Audience Export API Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.",
|
||||
"flatPath": "v1beta/properties/{propertiesId}/audienceExports/{audienceExportsId}",
|
||||
"httpMethod": "GET",
|
||||
"id": "analyticsdata.properties.audienceExports.get",
|
||||
"parameterOrder": [
|
||||
"name"
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "Required. The audience export resource name. Format: `properties/{property}/audienceExports/{audience_export}`",
|
||||
"location": "path",
|
||||
"pattern": "^properties/[^/]+/audienceExports/[^/]+$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1beta/{+name}",
|
||||
"response": {
|
||||
"$ref": "AudienceExport"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/analytics",
|
||||
"https://www.googleapis.com/auth/analytics.readonly"
|
||||
]
|
||||
},
|
||||
"list": {
|
||||
"description": "Lists all audience exports for a property. This method can be used for you to find and reuse existing audience exports rather than creating unnecessary new audience exports. The same audience can have multiple audience exports that represent the export of users that were in an audience on different days. See [Creating an Audience Export](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics) for an introduction to Audience Exports with examples. Audience Export APIs have some methods at alpha and other methods at beta stability. The intention is to advance methods to beta stability after some feedback and adoption. To give your feedback on this API, complete the [Google Analytics Audience Export API Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.",
|
||||
"flatPath": "v1beta/properties/{propertiesId}/audienceExports",
|
||||
"httpMethod": "GET",
|
||||
"id": "analyticsdata.properties.audienceExports.list",
|
||||
"parameterOrder": [
|
||||
"parent"
|
||||
],
|
||||
"parameters": {
|
||||
"pageSize": {
|
||||
"description": "Optional. The maximum number of audience exports to return. The service may return fewer than this value. If unspecified, at most 200 audience exports will be returned. The maximum value is 1000 (higher values will be coerced to the maximum).",
|
||||
"format": "int32",
|
||||
"location": "query",
|
||||
"type": "integer"
|
||||
},
|
||||
"pageToken": {
|
||||
"description": "Optional. A page token, received from a previous `ListAudienceExports` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAudienceExports` must match the call that provided the page token.",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
"parent": {
|
||||
"description": "Required. All audience exports for this property will be listed in the response. Format: `properties/{property}`",
|
||||
"location": "path",
|
||||
"pattern": "^properties/[^/]+$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1beta/{+parent}/audienceExports",
|
||||
"response": {
|
||||
"$ref": "ListAudienceExportsResponse"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/analytics",
|
||||
"https://www.googleapis.com/auth/analytics.readonly"
|
||||
]
|
||||
},
|
||||
"query": {
|
||||
"description": "Retrieves an audience export of users. After creating an audience, the users are not immediately available for exporting. First, a request to `CreateAudienceExport` is necessary to create an audience export of users, and then second, this method is used to retrieve the users in the audience export. See [Creating an Audience Export](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics) for an introduction to Audience Exports with examples. Audiences in Google Analytics 4 allow you to segment your users in the ways that are important to your business. To learn more, see https://support.google.com/analytics/answer/9267572. Audience Export APIs have some methods at alpha and other methods at beta stability. The intention is to advance methods to beta stability after some feedback and adoption. To give your feedback on this API, complete the [Google Analytics Audience Export API Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.",
|
||||
"flatPath": "v1beta/properties/{propertiesId}/audienceExports/{audienceExportsId}:query",
|
||||
"httpMethod": "POST",
|
||||
"id": "analyticsdata.properties.audienceExports.query",
|
||||
"parameterOrder": [
|
||||
"name"
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "Required. The name of the audience export to retrieve users from. Format: `properties/{property}/audienceExports/{audience_export}`",
|
||||
"location": "path",
|
||||
"pattern": "^properties/[^/]+/audienceExports/[^/]+$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1beta/{+name}:query",
|
||||
"request": {
|
||||
"$ref": "QueryAudienceExportRequest"
|
||||
},
|
||||
"response": {
|
||||
"$ref": "QueryAudienceExportResponse"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/analytics",
|
||||
"https://www.googleapis.com/auth/analytics.readonly"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"revision": "20230123",
|
||||
"revision": "20240304",
|
||||
"rootUrl": "https://analyticsdata.googleapis.com/",
|
||||
"schemas": {
|
||||
"ActiveMetricRestriction": {
|
||||
@@ -344,6 +471,86 @@
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"AudienceExport": {
|
||||
"description": "An audience export is a list of users in an audience at the time of the list's creation. One audience may have multiple audience exports created for different days.",
|
||||
"id": "AudienceExport",
|
||||
"properties": {
|
||||
"audience": {
|
||||
"description": "Required. The audience resource name. This resource name identifies the audience being listed and is shared between the Analytics Data & Admin APIs. Format: `properties/{property}/audiences/{audience}`",
|
||||
"type": "string"
|
||||
},
|
||||
"audienceDisplayName": {
|
||||
"description": "Output only. The descriptive display name for this audience. For example, \"Purchasers\".",
|
||||
"readOnly": true,
|
||||
"type": "string"
|
||||
},
|
||||
"beginCreatingTime": {
|
||||
"description": "Output only. The time when CreateAudienceExport was called and the AudienceExport began the `CREATING` state.",
|
||||
"format": "google-datetime",
|
||||
"readOnly": true,
|
||||
"type": "string"
|
||||
},
|
||||
"creationQuotaTokensCharged": {
|
||||
"description": "Output only. The total quota tokens charged during creation of the AudienceExport. Because this token count is based on activity from the `CREATING` state, this tokens charged will be fixed once an AudienceExport enters the `ACTIVE` or `FAILED` states.",
|
||||
"format": "int32",
|
||||
"readOnly": true,
|
||||
"type": "integer"
|
||||
},
|
||||
"dimensions": {
|
||||
"description": "Required. The dimensions requested and displayed in the query response.",
|
||||
"items": {
|
||||
"$ref": "V1betaAudienceDimension"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"errorMessage": {
|
||||
"description": "Output only. Error message is populated when an audience export fails during creation. A common reason for such a failure is quota exhaustion.",
|
||||
"readOnly": true,
|
||||
"type": "string"
|
||||
},
|
||||
"name": {
|
||||
"description": "Output only. Identifier. The audience export resource name assigned during creation. This resource name identifies this `AudienceExport`. Format: `properties/{property}/audienceExports/{audience_export}`",
|
||||
"readOnly": true,
|
||||
"type": "string"
|
||||
},
|
||||
"percentageCompleted": {
|
||||
"description": "Output only. The percentage completed for this audience export ranging between 0 to 100.",
|
||||
"format": "double",
|
||||
"readOnly": true,
|
||||
"type": "number"
|
||||
},
|
||||
"rowCount": {
|
||||
"description": "Output only. The total number of rows in the AudienceExport result.",
|
||||
"format": "int32",
|
||||
"readOnly": true,
|
||||
"type": "integer"
|
||||
},
|
||||
"state": {
|
||||
"description": "Output only. The current state for this AudienceExport.",
|
||||
"enum": [
|
||||
"STATE_UNSPECIFIED",
|
||||
"CREATING",
|
||||
"ACTIVE",
|
||||
"FAILED"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"Unspecified state will never be used.",
|
||||
"The AudienceExport is currently creating and will be available in the future. Creating occurs immediately after the CreateAudienceExport call.",
|
||||
"The AudienceExport is fully created and ready for querying. An AudienceExport is updated to active asynchronously from a request; this occurs some time (for example 15 minutes) after the initial create call.",
|
||||
"The AudienceExport failed to be created. It is possible that re-requesting this audience export will succeed."
|
||||
],
|
||||
"readOnly": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"AudienceListMetadata": {
|
||||
"description": "This metadata is currently blank.",
|
||||
"id": "AudienceListMetadata",
|
||||
"properties": {},
|
||||
"type": "object"
|
||||
},
|
||||
"BatchRunPivotReportsRequest": {
|
||||
"description": "The batch request containing multiple pivot report requests.",
|
||||
"id": "BatchRunPivotReportsRequest",
|
||||
@@ -602,7 +809,7 @@
|
||||
"type": "object"
|
||||
},
|
||||
"DateRange": {
|
||||
"description": "A contiguous set of days: startDate, startDate + 1, ..., endDate. Requests are allowed up to 4 date ranges.",
|
||||
"description": "A contiguous set of days: `startDate`, `startDate + 1`, ..., `endDate`. Requests are allowed up to 4 date ranges.",
|
||||
"id": "DateRange",
|
||||
"properties": {
|
||||
"endDate": {
|
||||
@@ -629,7 +836,7 @@
|
||||
"description": "One dimension can be the result of an expression of multiple dimensions. For example, dimension \"country, city\": concatenate(country, \", \", city)."
|
||||
},
|
||||
"name": {
|
||||
"description": "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`.",
|
||||
"description": "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 supported by core reporting methods such as `runReport` and `batchRunReports`. See [Realtime Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/realtime-api-schema#dimensions) for the list of dimension names supported by the `runRealtimeReport` method. See [Funnel Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/exploration-api-schema#dimensions) for the list of dimension names supported by the `runFunnelReport` method. 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`.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
@@ -703,7 +910,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"customDefinition": {
|
||||
"description": "True if the dimension is a custom dimension for this property.",
|
||||
"description": "True if the dimension is custom to this property. This includes user, event, & item scoped custom dimensions; to learn more about custom dimensions, see https://support.google.com/analytics/answer/14240153. This also include custom channel groups; to learn more about custom channel groups, see https://support.google.com/analytics/answer/13051316.",
|
||||
"type": "boolean"
|
||||
},
|
||||
"deprecatedApiNames": {
|
||||
@@ -844,8 +1051,26 @@
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"ListAudienceExportsResponse": {
|
||||
"description": "A list of all audience exports for a property.",
|
||||
"id": "ListAudienceExportsResponse",
|
||||
"properties": {
|
||||
"audienceExports": {
|
||||
"description": "Each audience export for a property.",
|
||||
"items": {
|
||||
"$ref": "AudienceExport"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"nextPageToken": {
|
||||
"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"Metadata": {
|
||||
"description": "The dimensions and metrics currently accepted in reporting methods.",
|
||||
"description": "The dimensions, metrics and comparisons currently accepted in reporting methods.",
|
||||
"id": "Metadata",
|
||||
"properties": {
|
||||
"dimensions": {
|
||||
@@ -882,7 +1107,7 @@
|
||||
"type": "boolean"
|
||||
},
|
||||
"name": {
|
||||
"description": "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`.",
|
||||
"description": "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 supported by core reporting methods such as `runReport` and `batchRunReports`. See [Realtime Metrics](https://developers.google.com/analytics/devguides/reporting/data/v1/realtime-api-schema#metrics) for the list of metric names supported by the `runRealtimeReport` method. See [Funnel Metrics](https://developers.google.com/analytics/devguides/reporting/data/v1/exploration-api-schema#metrics) for the list of metric names supported by the `runFunnelReport` method. 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`.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
@@ -1070,7 +1295,7 @@
|
||||
"type": "object"
|
||||
},
|
||||
"MinuteRange": {
|
||||
"description": "A contiguous set of minutes: startMinutesAgo, startMinutesAgo + 1, ..., endMinutesAgo. Requests are allowed up to 2 minute ranges.",
|
||||
"description": "A contiguous set of minutes: `startMinutesAgo`, `startMinutesAgo + 1`, ..., `endMinutesAgo`. Requests are allowed up to 2 minute ranges.",
|
||||
"id": "MinuteRange",
|
||||
"properties": {
|
||||
"endMinutesAgo": {
|
||||
@@ -1138,6 +1363,41 @@
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"Operation": {
|
||||
"description": "This resource represents a long-running operation that is the result of a network API call.",
|
||||
"id": "Operation",
|
||||
"properties": {
|
||||
"done": {
|
||||
"description": "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.",
|
||||
"type": "boolean"
|
||||
},
|
||||
"error": {
|
||||
"$ref": "Status",
|
||||
"description": "The error result of the operation in case of failure or cancellation."
|
||||
},
|
||||
"metadata": {
|
||||
"additionalProperties": {
|
||||
"description": "Properties of the object. Contains field @type with type URL.",
|
||||
"type": "any"
|
||||
},
|
||||
"description": "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.",
|
||||
"type": "object"
|
||||
},
|
||||
"name": {
|
||||
"description": "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}`.",
|
||||
"type": "string"
|
||||
},
|
||||
"response": {
|
||||
"additionalProperties": {
|
||||
"description": "Properties of the object. Contains field @type with type URL.",
|
||||
"type": "any"
|
||||
},
|
||||
"description": "The normal, successful response of the operation. 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`.",
|
||||
"type": "object"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"OrderBy": {
|
||||
"description": "Order bys define how rows will be sorted in the response. For example, ordering rows by descending event count is one ordering, and ordering rows by the event name string is a different ordering.",
|
||||
"id": "OrderBy",
|
||||
@@ -1173,7 +1433,7 @@
|
||||
"type": "array"
|
||||
},
|
||||
"limit": {
|
||||
"description": "The number of unique combinations of dimension values to return in this pivot. The `limit` parameter is required. A `limit` of 10,000 is common for single pivot requests. The product of the `limit` for each `pivot` in a `RunPivotReportRequest` must not exceed 100,000. For example, a two pivot request with `limit: 1000` in each pivot will fail because the product is `1,000,000`.",
|
||||
"description": "The number of unique combinations of dimension values to return in this pivot. The `limit` parameter is required. A `limit` of 10,000 is common for single pivot requests. The product of the `limit` for each `pivot` in a `RunPivotReportRequest` must not exceed 250,000. For example, a two pivot request with `limit: 1000` in each pivot will fail because the product is `1,000,000`.",
|
||||
"format": "int64",
|
||||
"type": "string"
|
||||
},
|
||||
@@ -1297,15 +1557,55 @@
|
||||
},
|
||||
"tokensPerDay": {
|
||||
"$ref": "QuotaStatus",
|
||||
"description": "Standard Analytics Properties can use up to 25,000 tokens per day; Analytics 360 Properties can use 250,000 tokens per day. Most requests consume fewer than 10 tokens."
|
||||
"description": "Standard Analytics Properties can use up to 200,000 tokens per day; Analytics 360 Properties can use 2,000,000 tokens per day. Most requests consume fewer than 10 tokens."
|
||||
},
|
||||
"tokensPerHour": {
|
||||
"$ref": "QuotaStatus",
|
||||
"description": "Standard Analytics Properties can use up to 5,000 tokens per hour; Analytics 360 Properties can use 50,000 tokens per hour. An API request consumes a single number of tokens, and that number is deducted from all of the hourly, daily, and per project hourly quotas."
|
||||
"description": "Standard Analytics Properties can use up to 40,000 tokens per hour; Analytics 360 Properties can use 400,000 tokens per hour. An API request consumes a single number of tokens, and that number is deducted from all of the hourly, daily, and per project hourly quotas."
|
||||
},
|
||||
"tokensPerProjectPerHour": {
|
||||
"$ref": "QuotaStatus",
|
||||
"description": "Analytics Properties can use up to 25% of their tokens per project per hour. This amounts to standard Analytics Properties can use up to 1,250 tokens per project per hour, and Analytics 360 Properties can use 12,500 tokens per project per hour. An API request consumes a single number of tokens, and that number is deducted from all of the hourly, daily, and per project hourly quotas."
|
||||
"description": "Analytics Properties can use up to 35% of their tokens per project per hour. This amounts to standard Analytics Properties can use up to 14,000 tokens per project per hour, and Analytics 360 Properties can use 140,000 tokens per project per hour. An API request consumes a single number of tokens, and that number is deducted from all of the hourly, daily, and per project hourly quotas."
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"QueryAudienceExportRequest": {
|
||||
"description": "A request to list users in an audience export.",
|
||||
"id": "QueryAudienceExportRequest",
|
||||
"properties": {
|
||||
"limit": {
|
||||
"description": "Optional. The number of rows to return. If unspecified, 10,000 rows are returned. The API returns a maximum of 250,000 rows per request, no matter how many you ask for. `limit` must be positive. The API can also return fewer rows than the requested `limit`, if there aren't as many dimension values as the `limit`. To learn more about this pagination parameter, see [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).",
|
||||
"format": "int64",
|
||||
"type": "string"
|
||||
},
|
||||
"offset": {
|
||||
"description": "Optional. The row count of the start row. The first row is counted as row 0. When paging, the first request does not specify offset; or equivalently, sets offset to 0; the first request returns the first `limit` of rows. The second request sets offset to the `limit` of the first request; the second request returns the second `limit` of rows. To learn more about this pagination parameter, see [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).",
|
||||
"format": "int64",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"QueryAudienceExportResponse": {
|
||||
"description": "A list of users in an audience export.",
|
||||
"id": "QueryAudienceExportResponse",
|
||||
"properties": {
|
||||
"audienceExport": {
|
||||
"$ref": "AudienceExport",
|
||||
"description": "Configuration data about AudienceExport being queried. Returned to help interpret the audience rows in this response. For example, the dimensions in this AudienceExport correspond to the columns in the AudienceRows."
|
||||
},
|
||||
"audienceRows": {
|
||||
"description": "Rows for each user in an audience export. The number of rows in this response will be less than or equal to request's page size.",
|
||||
"items": {
|
||||
"$ref": "V1betaAudienceRow"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"rowCount": {
|
||||
"description": "The total number of rows in the AudienceExport result. `rowCount` is independent of the number of rows returned in the response, the `limit` request parameter, and the `offset` request parameter. For example if a query returns 175 rows and includes `limit` of 50 in the API request, the response will contain `rowCount` of 175 but only 50 rows. To learn more about this pagination parameter, see [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).",
|
||||
"format": "int32",
|
||||
"type": "integer"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
@@ -1336,19 +1636,26 @@
|
||||
"type": "string"
|
||||
},
|
||||
"dataLossFromOtherRow": {
|
||||
"description": "If true, indicates some buckets of dimension combinations are rolled into \"(other)\" row. This can happen for high cardinality reports.",
|
||||
"description": "If true, indicates some buckets of dimension combinations are rolled into \"(other)\" row. This can happen for high cardinality reports. The metadata parameter dataLossFromOtherRow is populated based on the aggregated data table used in the report. The parameter will be accurately populated regardless of the filters and limits in the report. For example, the (other) row could be dropped from the report because the request contains a filter on sessionSource = google. This parameter will still be populated if data loss from other row was present in the input aggregate data used to generate this report. To learn more, see [About the (other) row and data sampling](https://support.google.com/analytics/answer/13208658#reports).",
|
||||
"type": "boolean"
|
||||
},
|
||||
"emptyReason": {
|
||||
"description": "If empty reason is specified, the report is empty for this reason.",
|
||||
"type": "string"
|
||||
},
|
||||
"samplingMetadatas": {
|
||||
"description": "If this report results is [sampled](https://support.google.com/analytics/answer/13331292), this describes the percentage of events used in this report. One `samplingMetadatas` is populated for each date range. Each `samplingMetadatas` corresponds to a date range in order that date ranges were specified in the request. However if the results are not sampled, this field will not be defined.",
|
||||
"items": {
|
||||
"$ref": "SamplingMetadata"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"schemaRestrictionResponse": {
|
||||
"$ref": "SchemaRestrictionResponse",
|
||||
"description": "Describes the schema restrictions actively enforced in creating this report. To learn more, see [Access and data-restriction management](https://support.google.com/analytics/answer/10851388)."
|
||||
},
|
||||
"subjectToThresholding": {
|
||||
"description": "If `subjectToThresholding` is true, this report is subject to thresholding and only returns data that meets the minimum aggregation thresholds. It is possible for a request to be subject to thresholding thresholding and no data is absent from the report, and this happens when all data is above the thresholds. To learn more, see [Data thresholds](https://support.google.com/analytics/answer/9383630) and [About Demographics and Interests](https://support.google.com/analytics/answer/2799357).",
|
||||
"description": "If `subjectToThresholding` is true, this report is subject to thresholding and only returns data that meets the minimum aggregation thresholds. It is possible for a request to be subject to thresholding thresholding and no data is absent from the report, and this happens when all data is above the thresholds. To learn more, see [Data thresholds](https://support.google.com/analytics/answer/9383630).",
|
||||
"type": "boolean"
|
||||
},
|
||||
"timeZone": {
|
||||
@@ -1410,7 +1717,7 @@
|
||||
"type": "array"
|
||||
},
|
||||
"keepEmptyRows": {
|
||||
"description": "If false or unspecified, each row with all metrics equal to 0 will not be returned. If true, these rows will be returned if they are not separately removed by a filter.",
|
||||
"description": "If false or unspecified, each row with all metrics equal to 0 will not be returned. If true, these rows will be returned if they are not separately removed by a filter. Regardless of this `keep_empty_rows` setting, only data recorded by the Google Analytics (GA4) property can be displayed in a report. For example if a property never logs a `purchase` event, then a query for the `eventName` dimension and `eventCount` metric will not have a row eventName: \"purchase\" and eventCount: 0.",
|
||||
"type": "boolean"
|
||||
},
|
||||
"metricFilter": {
|
||||
@@ -1512,7 +1819,7 @@
|
||||
"type": "array"
|
||||
},
|
||||
"limit": {
|
||||
"description": "The number of rows to return. If unspecified, 10,000 rows are returned. The API returns a maximum of 100,000 rows per request, no matter how many you ask for. `limit` must be positive. The API can also return fewer rows than the requested `limit`, if there aren't as many dimension values as the `limit`. For instance, there are fewer than 300 possible values for the dimension `country`, so when reporting on only `country`, you can't get more than 300 rows, even if you set `limit` to a higher value.",
|
||||
"description": "The number of rows to return. If unspecified, 10,000 rows are returned. The API returns a maximum of 250,000 rows per request, no matter how many you ask for. `limit` must be positive. The API can also return fewer rows than the requested `limit`, if there aren't as many dimension values as the `limit`. For instance, there are fewer than 300 possible values for the dimension `country`, so when reporting on only `country`, you can't get more than 300 rows, even if you set `limit` to a higher value.",
|
||||
"format": "int64",
|
||||
"type": "string"
|
||||
},
|
||||
@@ -1652,7 +1959,7 @@
|
||||
},
|
||||
"dimensionFilter": {
|
||||
"$ref": "FilterExpression",
|
||||
"description": "Dimension filters allow you to ask for only specific dimension values in the report. To learn more, see [Fundamentals of Dimension Filters](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#dimension_filters) for examples. Metrics cannot be used in this filter."
|
||||
"description": "Dimension filters let you ask for only specific dimension values in the report. To learn more, see [Fundamentals of Dimension Filters](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#dimension_filters) for examples. Metrics cannot be used in this filter."
|
||||
},
|
||||
"dimensions": {
|
||||
"description": "The dimensions requested and displayed.",
|
||||
@@ -1662,11 +1969,11 @@
|
||||
"type": "array"
|
||||
},
|
||||
"keepEmptyRows": {
|
||||
"description": "If false or unspecified, each row with all metrics equal to 0 will not be returned. If true, these rows will be returned if they are not separately removed by a filter.",
|
||||
"description": "If false or unspecified, each row with all metrics equal to 0 will not be returned. If true, these rows will be returned if they are not separately removed by a filter. Regardless of this `keep_empty_rows` setting, only data recorded by the Google Analytics (GA4) property can be displayed in a report. For example if a property never logs a `purchase` event, then a query for the `eventName` dimension and `eventCount` metric will not have a row eventName: \"purchase\" and eventCount: 0.",
|
||||
"type": "boolean"
|
||||
},
|
||||
"limit": {
|
||||
"description": "The number of rows to return. If unspecified, 10,000 rows are returned. The API returns a maximum of 100,000 rows per request, no matter how many you ask for. `limit` must be positive. The API can also return fewer rows than the requested `limit`, if there aren't as many dimension values as the `limit`. For instance, there are fewer than 300 possible values for the dimension `country`, so when reporting on only `country`, you can't get more than 300 rows, even if you set `limit` to a higher value. To learn more about this pagination parameter, see [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).",
|
||||
"description": "The number of rows to return. If unspecified, 10,000 rows are returned. The API returns a maximum of 250,000 rows per request, no matter how many you ask for. `limit` must be positive. The API can also return fewer rows than the requested `limit`, if there aren't as many dimension values as the `limit`. For instance, there are fewer than 300 possible values for the dimension `country`, so when reporting on only `country`, you can't get more than 300 rows, even if you set `limit` to a higher value. To learn more about this pagination parameter, see [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).",
|
||||
"format": "int64",
|
||||
"type": "string"
|
||||
},
|
||||
@@ -1791,6 +2098,23 @@
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"SamplingMetadata": {
|
||||
"description": "If this report results is [sampled](https://support.google.com/analytics/answer/13331292), this describes the percentage of events used in this report. Sampling is the practice of analyzing a subset of all data in order to uncover the meaningful information in the larger data set.",
|
||||
"id": "SamplingMetadata",
|
||||
"properties": {
|
||||
"samplesReadCount": {
|
||||
"description": "The total number of events read in this sampled report for a date range. This is the size of the subset this property's data that was analyzed in this report.",
|
||||
"format": "int64",
|
||||
"type": "string"
|
||||
},
|
||||
"samplingSpaceSize": {
|
||||
"description": "The total number of events present in this property's data that could have been analyzed in this report for a date range. Sampling uncovers the meaningful information about the larger data set, and this is the size of the larger data set. To calculate the percentage of available data that was used in this report, compute `samplesReadCount/samplingSpaceSize`.",
|
||||
"format": "int64",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"SchemaRestrictionResponse": {
|
||||
"description": "The schema restrictions actively enforced in creating this report. To learn more, see [Access and data-restriction management](https://support.google.com/analytics/answer/10851388).",
|
||||
"id": "SchemaRestrictionResponse",
|
||||
@@ -1805,6 +2129,33 @@
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"Status": {
|
||||
"description": "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).",
|
||||
"id": "Status",
|
||||
"properties": {
|
||||
"code": {
|
||||
"description": "The status code, which should be an enum value of google.rpc.Code.",
|
||||
"format": "int32",
|
||||
"type": "integer"
|
||||
},
|
||||
"details": {
|
||||
"description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
|
||||
"items": {
|
||||
"additionalProperties": {
|
||||
"description": "Properties of the object. Contains field @type with type URL.",
|
||||
"type": "any"
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"message": {
|
||||
"description": "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.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"StringFilter": {
|
||||
"description": "The filter for string",
|
||||
"id": "StringFilter",
|
||||
@@ -1841,6 +2192,42 @@
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"V1betaAudienceDimension": {
|
||||
"description": "An audience dimension is a user attribute. Specific user attributed are requested and then later returned in the `QueryAudienceExportResponse`.",
|
||||
"id": "V1betaAudienceDimension",
|
||||
"properties": {
|
||||
"dimensionName": {
|
||||
"description": "Optional. The API name of the dimension. See the [API Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-api-schema#dimensions) for the list of dimension names.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"V1betaAudienceDimensionValue": {
|
||||
"description": "The value of a dimension.",
|
||||
"id": "V1betaAudienceDimensionValue",
|
||||
"properties": {
|
||||
"value": {
|
||||
"description": "Value as a string if the dimension type is a string.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"V1betaAudienceRow": {
|
||||
"description": "Dimension value attributes for the audience user row.",
|
||||
"id": "V1betaAudienceRow",
|
||||
"properties": {
|
||||
"dimensionValues": {
|
||||
"description": "Each dimension value attribute for an audience user. One dimension value will be added for each dimension column requested.",
|
||||
"items": {
|
||||
"$ref": "V1betaAudienceDimensionValue"
|
||||
},
|
||||
"type": "array"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
}
|
||||
},
|
||||
"servicePath": "",
|
||||
|
||||
Reference in New Issue
Block a user