openapi-directory
Version:
Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS
1 lines • 92.2 kB
JSON
{"openapi":"3.0.0","servers":[{"url":"https://analyticsdata.googleapis.com/"}],"info":{"contact":{"name":"Google","url":"https://google.com","x-twitter":"youtube"},"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. ","license":{"name":"Creative Commons Attribution 3.0","url":"http://creativecommons.org/licenses/by/3.0/"},"termsOfService":"https://developers.google.com/terms/","title":"Google Analytics Data API","version":"v1beta","x-apisguru-categories":["analytics","media"],"x-logo":{"url":"https://upload.wikimedia.org/wikipedia/commons/e/e1/YouTube_play_buttom_icon_%282013-2017%29.svg"},"x-origin":[{"format":"google","url":"https://analyticsdata.googleapis.com/$discovery/rest?version=v1beta","version":"v1"}],"x-providerName":"googleapis.com","x-serviceName":"analyticsdata"},"externalDocs":{"url":"https://developers.google.com/analytics/devguides/reporting/data/v1/"},"tags":[{"name":"properties"}],"paths":{"/v1beta/{name}":{"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.","operationId":"analyticsdata.properties.audienceExports.get","parameters":[{"description":"Required. The audience export resource name. Format: `properties/{property}/audienceExports/{audience_export}`","in":"path","name":"name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AudienceExport"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/analytics"],"Oauth2c":["https://www.googleapis.com/auth/analytics"]},{"Oauth2":["https://www.googleapis.com/auth/analytics.readonly"],"Oauth2c":["https://www.googleapis.com/auth/analytics.readonly"]}],"tags":["properties"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}]},"/v1beta/{name}:query":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"post":{"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.","operationId":"analyticsdata.properties.audienceExports.query","parameters":[{"description":"Required. The name of the audience export to retrieve users from. Format: `properties/{property}/audienceExports/{audience_export}`","in":"path","name":"name","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryAudienceExportRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryAudienceExportResponse"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/analytics"],"Oauth2c":["https://www.googleapis.com/auth/analytics"]},{"Oauth2":["https://www.googleapis.com/auth/analytics.readonly"],"Oauth2c":["https://www.googleapis.com/auth/analytics.readonly"]}],"tags":["properties"]}},"/v1beta/{parent}/audienceExports":{"get":{"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.","operationId":"analyticsdata.properties.audienceExports.list","parameters":[{"description":"Required. All audience exports for this property will be listed in the response. Format: `properties/{property}`","in":"path","name":"parent","required":true,"schema":{"type":"string"}},{"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).","in":"query","name":"pageSize","schema":{"type":"integer"}},{"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.","in":"query","name":"pageToken","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAudienceExportsResponse"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/analytics"],"Oauth2c":["https://www.googleapis.com/auth/analytics"]},{"Oauth2":["https://www.googleapis.com/auth/analytics.readonly"],"Oauth2c":["https://www.googleapis.com/auth/analytics.readonly"]}],"tags":["properties"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"post":{"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.","operationId":"analyticsdata.properties.audienceExports.create","parameters":[{"description":"Required. The parent resource where this audience export will be created. Format: `properties/{property}`","in":"path","name":"parent","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AudienceExport"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Operation"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/analytics"],"Oauth2c":["https://www.googleapis.com/auth/analytics"]},{"Oauth2":["https://www.googleapis.com/auth/analytics.readonly"],"Oauth2c":["https://www.googleapis.com/auth/analytics.readonly"]}],"tags":["properties"]}},"/v1beta/{property}:batchRunPivotReports":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"post":{"description":"Returns multiple pivot reports in a batch. All reports must be for the same GA4 Property.","operationId":"analyticsdata.properties.batchRunPivotReports","parameters":[{"description":"A Google Analytics GA4 property identifier whose events are tracked. Specified in the URL path and not the body. To learn more, see [where to find your Property ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id). This property must be specified for the batch. The property within RunPivotReportRequest may either be unspecified or consistent with this property. Example: properties/1234","in":"path","name":"property","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchRunPivotReportsRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchRunPivotReportsResponse"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/analytics"],"Oauth2c":["https://www.googleapis.com/auth/analytics"]},{"Oauth2":["https://www.googleapis.com/auth/analytics.readonly"],"Oauth2c":["https://www.googleapis.com/auth/analytics.readonly"]}],"tags":["properties"]}},"/v1beta/{property}:batchRunReports":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"post":{"description":"Returns multiple reports in a batch. All reports must be for the same GA4 Property.","operationId":"analyticsdata.properties.batchRunReports","parameters":[{"description":"A Google Analytics GA4 property identifier whose events are tracked. Specified in the URL path and not the body. To learn more, see [where to find your Property ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id). This property must be specified for the batch. The property within RunReportRequest may either be unspecified or consistent with this property. Example: properties/1234","in":"path","name":"property","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchRunReportsRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchRunReportsResponse"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/analytics"],"Oauth2c":["https://www.googleapis.com/auth/analytics"]},{"Oauth2":["https://www.googleapis.com/auth/analytics.readonly"],"Oauth2c":["https://www.googleapis.com/auth/analytics.readonly"]}],"tags":["properties"]}},"/v1beta/{property}:checkCompatibility":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"post":{"description":"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.","operationId":"analyticsdata.properties.checkCompatibility","parameters":[{"description":"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","in":"path","name":"property","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckCompatibilityRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckCompatibilityResponse"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/analytics"],"Oauth2c":["https://www.googleapis.com/auth/analytics"]},{"Oauth2":["https://www.googleapis.com/auth/analytics.readonly"],"Oauth2c":["https://www.googleapis.com/auth/analytics.readonly"]}],"tags":["properties"]}},"/v1beta/{property}:runPivotReport":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"post":{"description":"Returns a customized pivot report of your Google Analytics event data. Pivot reports are more advanced and expressive formats than regular reports. In a pivot report, dimensions are only visible if they are included in a pivot. Multiple pivots can be specified to further dissect your data.","operationId":"analyticsdata.properties.runPivotReport","parameters":[{"description":"A Google Analytics GA4 property identifier whose events are tracked. Specified in the URL path and not the body. To learn more, see [where to find your Property ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id). Within a batch request, this property should either be unspecified or consistent with the batch-level property. Example: properties/1234","in":"path","name":"property","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunPivotReportRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunPivotReportResponse"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/analytics"],"Oauth2c":["https://www.googleapis.com/auth/analytics"]},{"Oauth2":["https://www.googleapis.com/auth/analytics.readonly"],"Oauth2c":["https://www.googleapis.com/auth/analytics.readonly"]}],"tags":["properties"]}},"/v1beta/{property}:runRealtimeReport":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"post":{"description":"Returns a customized report of realtime event data for your property. Events appear in realtime reports seconds after they have been sent to the Google Analytics. Realtime reports show events and usage data for the periods of time ranging from the present moment to 30 minutes ago (up to 60 minutes for Google Analytics 360 properties). For a guide to constructing realtime requests & understanding responses, see [Creating a Realtime Report](https://developers.google.com/analytics/devguides/reporting/data/v1/realtime-basics).","operationId":"analyticsdata.properties.runRealtimeReport","parameters":[{"description":"A Google Analytics GA4 property identifier whose events are tracked. Specified in the URL path and not the body. To learn more, see [where to find your Property ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id). Example: properties/1234","in":"path","name":"property","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunRealtimeReportRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunRealtimeReportResponse"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/analytics"],"Oauth2c":["https://www.googleapis.com/auth/analytics"]},{"Oauth2":["https://www.googleapis.com/auth/analytics.readonly"],"Oauth2c":["https://www.googleapis.com/auth/analytics.readonly"]}],"tags":["properties"]}},"/v1beta/{property}:runReport":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"post":{"description":"Returns a customized report of your Google Analytics event data. Reports contain statistics derived from data collected by the Google Analytics tracking code. The data returned from the API is as a table with columns for the requested dimensions and metrics. Metrics are individual measurements of user activity on your property, such as active users or event count. Dimensions break down metrics across some common criteria, such as country or event name. For a guide to constructing requests & understanding responses, see [Creating a Report](https://developers.google.com/analytics/devguides/reporting/data/v1/basics).","operationId":"analyticsdata.properties.runReport","parameters":[{"description":"A Google Analytics GA4 property identifier whose events are tracked. Specified in the URL path and not the body. To learn more, see [where to find your Property ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id). Within a batch request, this property should either be unspecified or consistent with the batch-level property. Example: properties/1234","in":"path","name":"property","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunReportRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunReportResponse"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/analytics"],"Oauth2c":["https://www.googleapis.com/auth/analytics"]},{"Oauth2":["https://www.googleapis.com/auth/analytics.readonly"],"Oauth2c":["https://www.googleapis.com/auth/analytics.readonly"]}],"tags":["properties"]}}},"components":{"parameters":{"_.xgafv":{"description":"V1 error format.","in":"query","name":"$.xgafv","schema":{"enum":["1","2"],"type":"string"}},"access_token":{"description":"OAuth access token.","in":"query","name":"access_token","schema":{"type":"string"}},"alt":{"description":"Data format for response.","in":"query","name":"alt","schema":{"enum":["json","media","proto"],"type":"string"}},"callback":{"description":"JSONP","in":"query","name":"callback","schema":{"type":"string"}},"fields":{"description":"Selector specifying which fields to include in a partial response.","in":"query","name":"fields","schema":{"type":"string"}},"key":{"description":"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.","in":"query","name":"key","schema":{"type":"string"}},"oauth_token":{"description":"OAuth 2.0 token for the current user.","in":"query","name":"oauth_token","schema":{"type":"string"}},"prettyPrint":{"description":"Returns response with indentations and line breaks.","in":"query","name":"prettyPrint","schema":{"type":"boolean"}},"quotaUser":{"description":"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.","in":"query","name":"quotaUser","schema":{"type":"string"}},"uploadType":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","in":"query","name":"uploadType","schema":{"type":"string"}},"upload_protocol":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","in":"query","name":"upload_protocol","schema":{"type":"string"}}},"schemas":{"ActiveMetricRestriction":{"description":"A metric actively restricted in creating the report.","properties":{"metricName":{"description":"The name of the restricted metric.","type":"string"},"restrictedMetricTypes":{"description":"The reason for this metric's restriction.","items":{"enum":["RESTRICTED_METRIC_TYPE_UNSPECIFIED","COST_DATA","REVENUE_DATA"],"type":"string"},"type":"array"}},"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.","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":"#/components/schemas/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"],"readOnly":true,"type":"string"}},"type":"object"},"AudienceListMetadata":{"description":"This metadata is currently blank.","properties":{},"type":"object"},"BatchRunPivotReportsRequest":{"description":"The batch request containing multiple pivot report requests.","properties":{"requests":{"description":"Individual requests. Each request has a separate pivot report response. Each batch request is allowed up to 5 requests.","items":{"$ref":"#/components/schemas/RunPivotReportRequest"},"type":"array"}},"type":"object"},"BatchRunPivotReportsResponse":{"description":"The batch response containing multiple pivot reports.","properties":{"kind":{"description":"Identifies what kind of resource this message is. This `kind` is always the fixed string \"analyticsData#batchRunPivotReports\". Useful to distinguish between response types in JSON.","type":"string"},"pivotReports":{"description":"Individual responses. Each response has a separate pivot report request.","items":{"$ref":"#/components/schemas/RunPivotReportResponse"},"type":"array"}},"type":"object"},"BatchRunReportsRequest":{"description":"The batch request containing multiple report requests.","properties":{"requests":{"description":"Individual requests. Each request has a separate report response. Each batch request is allowed up to 5 requests.","items":{"$ref":"#/components/schemas/RunReportRequest"},"type":"array"}},"type":"object"},"BatchRunReportsResponse":{"description":"The batch response containing multiple reports.","properties":{"kind":{"description":"Identifies what kind of resource this message is. This `kind` is always the fixed string \"analyticsData#batchRunReports\". Useful to distinguish between response types in JSON.","type":"string"},"reports":{"description":"Individual responses. Each response has a separate report request.","items":{"$ref":"#/components/schemas/RunReportResponse"},"type":"array"}},"type":"object"},"BetweenFilter":{"description":"To express that the result needs to be between two numbers (inclusive).","properties":{"fromValue":{"$ref":"#/components/schemas/NumericValue","description":"Begins with this number."},"toValue":{"$ref":"#/components/schemas/NumericValue","description":"Ends with this number."}},"type":"object"},"CaseExpression":{"description":"Used to convert a dimension value to a single case.","properties":{"dimensionName":{"description":"Name of a dimension. The name must refer back to a name in dimensions field of the request.","type":"string"}},"type":"object"},"CheckCompatibilityRequest":{"description":"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.","properties":{"compatibilityFilter":{"description":"Filters the dimensions and metrics in the response to just this compatibility. Commonly used as `”compatibilityFilter”: “COMPATIBLE”` to only return compatible dimensions & metrics.","enum":["COMPATIBILITY_UNSPECIFIED","COMPATIBLE","INCOMPATIBLE"],"type":"string"},"dimensionFilter":{"$ref":"#/components/schemas/FilterExpression","description":"The filter clause of dimensions. `dimensionFilter` should be the same value as in your `runReport` request."},"dimensions":{"description":"The dimensions in this report. `dimensions` should be the same value as in your `runReport` request.","items":{"$ref":"#/components/schemas/Dimension"},"type":"array"},"metricFilter":{"$ref":"#/components/schemas/FilterExpression","description":"The filter clause of metrics. `metricFilter` should be the same value as in your `runReport` request"},"metrics":{"description":"The metrics in this report. `metrics` should be the same value as in your `runReport` request.","items":{"$ref":"#/components/schemas/Metric"},"type":"array"}},"type":"object"},"CheckCompatibilityResponse":{"description":"The compatibility response with the compatibility of each dimension & metric.","properties":{"dimensionCompatibilities":{"description":"The compatibility of each dimension.","items":{"$ref":"#/components/schemas/DimensionCompatibility"},"type":"array"},"metricCompatibilities":{"description":"The compatibility of each metric.","items":{"$ref":"#/components/schemas/MetricCompatibility"},"type":"array"}},"type":"object"},"Cohort":{"description":"Defines a cohort selection criteria. A cohort is a group of users who share a common characteristic. For example, users with the same `firstSessionDate` belong to the same cohort.","properties":{"dateRange":{"$ref":"#/components/schemas/DateRange","description":"The cohort selects users whose first touch date is between start date and end date defined in the `dateRange`. This `dateRange` does not specify the full date range of event data that is present in a cohort report. In a cohort report, this `dateRange` is extended by the granularity and offset present in the `cohortsRange`; event data for the extended reporting date range is present in a cohort report. In a cohort request, this `dateRange` is required and the `dateRanges` in the `RunReportRequest` or `RunPivotReportRequest` must be unspecified. This `dateRange` should generally be aligned with the cohort's granularity. If `CohortsRange` uses daily granularity, this `dateRange` can be a single day. If `CohortsRange` uses weekly granularity, this `dateRange` can be aligned to a week boundary, starting at Sunday and ending Saturday. If `CohortsRange` uses monthly granularity, this `dateRange` can be aligned to a month, starting at the first and ending on the last day of the month."},"dimension":{"description":"Dimension used by the cohort. Required and only supports `firstSessionDate`.","type":"string"},"name":{"description":"Assigns a name to this cohort. The dimension `cohort` is valued to this name in a report response. If set, cannot begin with `cohort_` or `RESERVED_`. If not set, cohorts are named by their zero based index `cohort_0`, `cohort_1`, etc.","type":"string"}},"type":"object"},"CohortReportSettings":{"description":"Optional settings of a cohort report.","properties":{"accumulate":{"description":"If true, accumulates the result from first touch day to the end day. Not supported in `RunReportRequest`.","type":"boolean"}},"type":"object"},"CohortSpec":{"description":"The specification of cohorts for a cohort report. Cohort reports create a time series of user retention for the cohort. For example, you could select the cohort of users that were acquired in the first week of September and follow that cohort for the next six weeks. Selecting the users acquired in the first week of September cohort is specified in the `cohort` object. Following that cohort for the next six weeks is specified in the `cohortsRange` object. For examples, see [Cohort Report Examples](https://developers.google.com/analytics/devguides/reporting/data/v1/advanced#cohort_report_examples). The report response could show a weekly time series where say your app has retained 60% of this cohort after three weeks and 25% of this cohort after six weeks. These two percentages can be calculated by the metric `cohortActiveUsers/cohortTotalUsers` and will be separate rows in the report.","properties":{"cohortReportSettings":{"$ref":"#/components/schemas/CohortReportSettings","description":"Optional settings for a cohort report."},"cohorts":{"description":"Defines the selection criteria to group users into cohorts. Most cohort reports define only a single cohort. If multiple cohorts are specified, each cohort can be recognized in the report by their name.","items":{"$ref":"#/components/schemas/Cohort"},"type":"array"},"cohortsRange":{"$ref":"#/components/schemas/CohortsRange","description":"Cohort reports follow cohorts over an extended reporting date range. This range specifies an offset duration to follow the cohorts over."}},"type":"object"},"CohortsRange":{"description":"Configures the extended reporting date range for a cohort report. Specifies an offset duration to follow the cohorts over.","properties":{"endOffset":{"description":"Required. `endOffset` specifies the end date of the extended reporting date range for a cohort report. `endOffset` can be any positive integer but is commonly set to 5 to 10 so that reports contain data on the cohort for the next several granularity time periods. If `granularity` is `DAILY`, the `endDate` of the extended reporting date range is `endDate` of the cohort plus `endOffset` days. If `granularity` is `WEEKLY`, the `endDate` of the extended reporting date range is `endDate` of the cohort plus `endOffset * 7` days. If `granularity` is `MONTHLY`, the `endDate` of the extended reporting date range is `endDate` of the cohort plus `endOffset * 30` days.","format":"int32","type":"integer"},"granularity":{"description":"Required. The granularity used to interpret the `startOffset` and `endOffset` for the extended reporting date range for a cohort report.","enum":["GRANULARITY_UNSPECIFIED","DAILY","WEEKLY","MONTHLY"],"type":"string"},"startOffset":{"description":"`startOffset` specifies the start date of the extended reporting date range for a cohort report. `startOffset` is commonly set to 0 so that reports contain data from the acquisition of the cohort forward. If `granularity` is `DAILY`, the `startDate` of the extended reporting date range is `startDate` of the cohort plus `startOffset` days. If `granularity` is `WEEKLY`, the `startDate` of the extended reporting date range is `startDate` of the cohort plus `startOffset * 7` days. If `granularity` is `MONTHLY`, the `startDate` of the extended reporting date range is `startDate` of the cohort plus `startOffset * 30` days.","format":"int32","type":"integer"}},"type":"object"},"ConcatenateExpression":{"description":"Used to combine dimension values to a single dimension.","properties":{"delimiter":{"description":"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\".","type":"string"},"dimensionNames":{"description":"Names of dimensions. The names must refer back to names in the dimensions field of the request.","items":{"type":"string"},"type":"array"}},"type":"object"},"DateRange":{"description":"A contiguous set of days: `startDate`, `startDate + 1`, ..., `endDate`. Requests are allowed up to 4 date ranges.","properties":{"endDate":{"description":"The inclusive end date for the query in the format `YYYY-MM-DD`. Cannot be before `start_date`. The format `NdaysAgo`, `yesterday`, or `today` is also accepted, and in that case, the date is inferred based on the property's reporting time zone.","type":"string"},"name":{"description":"Assigns a name to this date range. The dimension `dateRange` is valued to this name in a report response. If set, cannot begin with `date_range_` or `RESERVED_`. If not set, date ranges are named by their zero based index in the request: `date_range_0`, `date_range_1`, etc.","type":"string"},"startDate":{"description":"The inclusive start date for the query in the format `YYYY-MM-DD`. Cannot be after `end_date`. The format `NdaysAgo`, `yesterday`, or `today` is also accepted, and in that case, the date is inferred based on the property's reporting time zone.","type":"string"}},"type":"object"},"Dimension":{"description":"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, the city could be \"Paris\" or \"New York\". Requests are allowed up to 9 dimensions.","properties":{"dimensionExpression":{"$ref":"#/components/schemas/DimensionExpression","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 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"}},"type":"object"},"DimensionCompatibility":{"description":"The compatibility for a single dimension.","properties":{"compatibility":{"description":"The compatibility of this dimension. If the compatibility is COMPATIBLE, this dimension can be successfully added to the report.","enum":["COMPATIBILITY_UNSPECIFIED","COMPATIBLE","INCOMPATIBLE"],"type":"string"},"dimensionMetadata":{"$ref":"#/components/schemas/DimensionMetadata","description":"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."}},"type":"object"},"DimensionExpression":{"description":"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).","properties":{"concatenate":{"$ref":"#/components/schemas/ConcatenateExpression","description":"Used to combine dimension values to a single dimension. For example, dimension \"country, city\": concatenate(country, \", \", city)."},"lowerCase":{"$ref":"#/components/schemas/CaseExpression","description":"Used to convert a dimension value to lower case."},"upperCase":{"$ref":"#/components/schemas/CaseExpression","description":"Used to convert a dimension value to upper case."}},"type":"object"},"DimensionHeader":{"description":"Describes a dimension column in the report. Dimensions requested in a report produce column entries within rows and DimensionHeaders. However, dimensions used exclusively within filters or expressions do not produce columns in a report; correspondingly, those dimensions do not produce headers.","properties":{"name":{"description":"The dimension's name.","type":"string"}},"type":"object"},"DimensionMetadata":{"description":"Explains a dimension.","properties":{"apiName":{"description":"This dimension's name. Useable in [Dimension](#Dimension)'s `name`. For example, `eventName`.","type":"string"},"category":{"description":"The display name of the category that this dimension belongs to. Similar dimensions and metrics are categorized together.","type":"string"},"customDefinition":{"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":{"description":"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`.","items":{"type":"string"},"type":"array"},"description":{"description":"Description of how this dimension is used and calculated.","type":"string"},"uiName":{"description":"This dimension's name within the Google Analytics user interface. For example, `Event name`.","type":"string"}},"type":"object"},"DimensionOrderBy":{"description":"Sorts by dimension values.","properties":{"dimensionName":{"description":"A dimension name in the request to order by.","type":"string"},"orderType":{"description":"Controls the rule for dimension value ordering.","enum":["ORDER_TYPE_UNSPECIFIED","ALPHANUMERIC","CASE_INSENSITIVE_ALPHANUMERIC","NUMERIC"],"type":"string"}},"type":"object"},"DimensionValue":{"description":"The value of a dimension.","properties":{"value":{"description":"Value as a string if the dimension type is a string.","type":"string"}},"type":"object"},"Filter":{"description":"An expression to filter dimension or metric values.","properties":{"betweenFilter":{"$ref":"#/components/schemas/BetweenFilter","description":"A filter for two values."},"fieldName":{"description":"The dimension name or metric name. In most methods, dimensions & metrics can be used for the first time in this field. However in a RunPivotReportRequest, this field must be additionally specified by name in the RunPivotReportRequest's dimensions or metrics.","type":"string"},"inListFilter":{"$ref":"#/components/schemas/InListFilter","description":"A filter for in list values."},"numericFilter":{"$ref":"#/components/schemas/NumericFilter","description":"A filter for numeric or date values."},"stringFilter":{"$ref":"#/components/schemas/StringFilter","description":"Strings related filter."}},"type":"object"},"FilterExpression":{"description":"To express dimension or metric filters. The fields in the same FilterExpression need to be either all dimensions or all metrics.","properties":{"andGroup":{"$ref":"#/components/schemas/FilterExpressionList","description":"The FilterExpressions in and_group have an AND relationship."},"filter":{"$ref":"#/components/schemas/Filter","description":"A primitive filter. In the same FilterExpression, all of the filter's field names need to be either all dimensions or all metrics."},"notExpression":{"$ref":"#/components/schemas/FilterExpression","description":"The FilterExpression is NOT of not_expression."},"orGroup":{"$ref":"#/components/schemas/FilterExpressionList","description":"The FilterExpressions in or_group have an OR relationship."}},"type":"object"},"FilterExpressionList":{"description":"A list of filter expressions.","properties":{"expressions":{"description":"A list of filter expressions.","items":{"$ref":"#/components/schemas/FilterExpression"},"type":"array"}},"type":"object"},"InListFilter":{"description":"The result needs to be in a list of string values.","properties":{"caseSensitive":{"description":"If true, the string value is case sensitive.","type":"boolean"},"values":{"description":"The list of string values. Must be non-empty.","items":{"type":"string"},"type":"array"}},"type":"object"},"ListAudienceExportsResponse":{"description":"A list of all audience exports for a property.","properties":{"audienceExports":{"description":"Each audience export for a property.","items":{"$ref":"#/components/schemas/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, metrics and comparisons currently accepted in reporting methods.","properties":{"dimensions":{"description":"The dimension descriptions.","items":{"$ref":"#/components/schemas/DimensionMetadata"},"type":"array"},"metrics":{"description":"The metric descriptions.","items":{"$ref":"#/components/schemas/MetricMetadata"},"type":"array"},"name":{"description":"Resource name of this metadata.","type":"string"}},"type":"object"},"Metric":{"description":"The quantitative measurements of a report. For example, the metric `eventCount` is the total number of events. Requests are allowed up to 10 metrics.","properties":{"expression":{"description":"A mathematical expression for derived metrics. For example, the metric Event count per user is `eventCount/totalUsers`.","type":"string"},"invisible":{"description":"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`.","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 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"}},"type":"object"},"MetricCompatibility":{"description":"The compatibility for a single metric.","properties":{"compatibility":{"description":"The compatibility of this metric. If the compatibility is COMPATIBLE, this metric can be successfully added to the report.","enum":["COMPATIBILITY_UNSPECIFIED","COMPATIBLE","INCOMPATIBLE"],"type":"string"},"metricMetadata":{"$ref":"#/components/schemas/MetricMetadata","description":"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."}},"type":"object"},"MetricHeader":{"description":"Describes a metric column in the report. Visible metrics requested in a report produce column entries within rows and MetricHeaders. However, metrics used exclusively within filters or expressions do not produce columns in a report; correspondingly, those metrics do not produce headers.","properties":{"name":{"description":"The metric's name.","type":"string"},"type":{"description":"The metric's data type.","enum":["METRIC_TYPE_UNSPECIFIED","TYPE_INTEGER","TYPE_FLOAT","TYPE_SECONDS","TYPE_MILLISECONDS","TYPE_MINUTES","TYPE_HOURS","TYPE_STANDARD","TYPE_CURRENCY","TYPE_FEET","TYPE_MILES","TYPE_METERS","TYPE_KILOMETERS"],"type":"string"}},"type":"object"},