openapi: 3.0.0 servers: - url: https://analyticsadmin.googleapis.com/ info: contact: name: Google url: https://google.com x-twitter: youtube description: "Manage properties 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 Admin 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://analyticsadmin.googleapis.com/$discovery/rest?version=v1beta version: v1 x-preferred: true x-providerName: googleapis.com x-serviceName: analyticsadmin externalDocs: url: http://code.google.com/apis/analytics/docs/mgmt/home.html tags: - name: accounts - name: accountSummaries - name: properties paths: /v1beta/accountSummaries: get: description: Returns summaries of all accounts accessible by the caller. operationId: analyticsadmin.accountSummaries.list parameters: - description: The maximum number of AccountSummary resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum) in: query name: pageSize schema: type: integer example: 10 - description: A page token, received from a previous `ListAccountSummaries` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccountSummaries` must match the call that provided the page token. in: query name: pageToken schema: type: string example: abc123token responses: "200": content: application/json: schema: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaListAccountSummariesResponse" description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/analytics.edit Oauth2c: - https://www.googleapis.com/auth/analytics.edit - Oauth2: - https://www.googleapis.com/auth/analytics.readonly Oauth2c: - https://www.googleapis.com/auth/analytics.readonly tags: - accountSummaries x-microcks-operation: delay: 0 dispatcher: FALLBACK 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/accounts: get: description: 'Returns all accounts accessible by the caller. Note that these accounts might not currently have GA4 properties. Soft-deleted (ie: "trashed") accounts are excluded by default. Returns an empty list if no relevant accounts are found.' operationId: analyticsadmin.accounts.list parameters: - description: The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum) in: query name: pageSize schema: type: integer example: 10 - description: A page token, received from a previous `ListAccounts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccounts` must match the call that provided the page token. in: query name: pageToken schema: type: string example: abc123token - description: 'Whether to include soft-deleted (ie: "trashed") Accounts in the results. Accounts can be inspected to determine whether they are deleted or not.' in: query name: showDeleted schema: type: boolean example: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaListAccountsResponse" description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/analytics.edit Oauth2c: - https://www.googleapis.com/auth/analytics.edit - Oauth2: - https://www.googleapis.com/auth/analytics.readonly Oauth2c: - https://www.googleapis.com/auth/analytics.readonly tags: - accounts x-microcks-operation: delay: 0 dispatcher: FALLBACK 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/accounts:provisionAccountTicket: 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: Requests a ticket for creating an account. operationId: analyticsadmin.accounts.provisionAccountTicket requestBody: content: application/json: schema: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaProvisionAccountTicketRequest" responses: "200": content: application/json: schema: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaProvisionAccountTicketResponse" description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/analytics.edit Oauth2c: - https://www.googleapis.com/auth/analytics.edit tags: - accounts x-microcks-operation: delay: 0 dispatcher: FALLBACK /v1beta/properties: get: description: 'Returns child Properties under the specified parent Account. Only "GA4" properties will be returned. Properties will be excluded if the caller does not have access. Soft-deleted (ie: "trashed") properties are excluded by default. Returns an empty list if no relevant properties are found.' operationId: analyticsadmin.properties.list parameters: - description: "Required. An expression for filtering the results of the request. Fields eligible for filtering are: `parent:`(The resource name of the parent account/property) or `ancestor:`(The resource name of the parent account) or `firebase_project:`(The id or number of the linked firebase project). Some examples of filters: ``` | Filter | Description | |-----------------------------|-------------------------------------------| | parent:accounts/123 | The account with account id: 123. | | parent:properties/123 | The property with property id: 123. | | ancestor:accounts/123 | The account with account id: 123. | | firebase_project:project-id | The firebase project with id: project-id. | | firebase_project:123 | The firebase project with number: 123. | ```" in: query name: filter schema: type: string example: example_value - description: The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum) in: query name: pageSize schema: type: integer example: 10 - description: A page token, received from a previous `ListProperties` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListProperties` must match the call that provided the page token. in: query name: pageToken schema: type: string example: abc123token - description: 'Whether to include soft-deleted (ie: "trashed") Properties in the results. Properties can be inspected to determine whether they are deleted or not.' in: query name: showDeleted schema: type: boolean example: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaListPropertiesResponse" description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/analytics.edit Oauth2c: - https://www.googleapis.com/auth/analytics.edit - Oauth2: - https://www.googleapis.com/auth/analytics.readonly Oauth2c: - https://www.googleapis.com/auth/analytics.readonly tags: - properties x-microcks-operation: delay: 0 dispatcher: FALLBACK 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 "GA4" property with the specified location and attributes. operationId: analyticsadmin.properties.create requestBody: content: application/json: schema: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaProperty" responses: "200": content: application/json: schema: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaProperty" description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/analytics.edit Oauth2c: - https://www.googleapis.com/auth/analytics.edit tags: - properties x-microcks-operation: delay: 0 dispatcher: FALLBACK /v1beta/{account}:searchChangeHistoryEvents: 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: Searches through all changes to an account or its children given the specified set of filters. operationId: analyticsadmin.accounts.searchChangeHistoryEvents parameters: - description: 'Required. The account resource for which to return change history resources. Format: accounts/{account} Example: "accounts/100"' in: path name: account required: true schema: type: string example: example_value requestBody: content: application/json: schema: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaSearchChangeHistoryEventsRequest" responses: "200": content: application/json: schema: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaSearchChangeHistoryEventsResponse" description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/analytics.edit Oauth2c: - https://www.googleapis.com/auth/analytics.edit tags: - accounts x-microcks-operation: delay: 0 dispatcher: FALLBACK /v1beta/{entity}:runAccessReport: 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 data access records. The report provides records of each time a user reads Google Analytics reporting data. Access records are retained for up to 2 years. Data Access Reports can be requested for a property. Reports may be requested for any property, but dimensions that aren't related to quota can only be requested on Google Analytics 360 properties. This method is only available to Administrators. These data access records include GA4 UI Reporting, GA4 UI Explorations, GA4 Data API, and other products like Firebase & Admob that can retrieve data from Google Analytics through a linkage. These records don't include property configuration changes like adding a stream or changing a property's time zone. For configuration change history, see [searchChangeHistoryEvents](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/accounts/searchChangeHistoryEvents). operationId: analyticsadmin.properties.runAccessReport parameters: - description: The Data Access Report supports requesting at the property level or account level. If requested at the account level, Data Access Reports include all access for all properties under that account. To request at the property level, entity should be for example 'properties/123' if "123" is your GA4 property ID. To request at the account level, entity should be for example 'accounts/1234' if "1234" is your GA4 Account ID. in: path name: entity required: true schema: type: string example: example_value requestBody: content: application/json: schema: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaRunAccessReportRequest" responses: "200": content: application/json: schema: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaRunAccessReportResponse" description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/analytics.edit Oauth2c: - https://www.googleapis.com/auth/analytics.edit - Oauth2: - https://www.googleapis.com/auth/analytics.readonly Oauth2c: - https://www.googleapis.com/auth/analytics.readonly tags: - properties x-microcks-operation: delay: 0 dispatcher: FALLBACK /v1beta/{name}: delete: description: Deletes a GoogleAdsLink on a property operationId: analyticsadmin.properties.googleAdsLinks.delete parameters: - description: "Required. Example format: properties/1234/googleAdsLinks/5678" in: path name: name required: true schema: type: string example: Example Name responses: "200": content: application/json: schema: $ref: "#/components/schemas/GoogleProtobufEmpty" description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/analytics.edit Oauth2c: - https://www.googleapis.com/auth/analytics.edit tags: - properties x-microcks-operation: delay: 0 dispatcher: FALLBACK get: description: Lookup for a single "GA4" MeasurementProtocolSecret. operationId: analyticsadmin.properties.dataStreams.measurementProtocolSecrets.get parameters: - description: "Required. The name of the measurement protocol secret to lookup. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}" in: path name: name required: true schema: type: string example: Example Name responses: "200": content: application/json: schema: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaMeasurementProtocolSecret" description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/analytics.edit Oauth2c: - https://www.googleapis.com/auth/analytics.edit - Oauth2: - https://www.googleapis.com/auth/analytics.readonly Oauth2c: - https://www.googleapis.com/auth/analytics.readonly tags: - properties x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" patch: description: Updates a GoogleAdsLink on a property operationId: analyticsadmin.properties.googleAdsLinks.patch parameters: - description: "Output only. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID." in: path name: name required: true schema: type: string example: Example Name - description: Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields. in: query name: updateMask schema: type: string example: '2026-04-17' requestBody: content: application/json: schema: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaGoogleAdsLink" responses: "200": content: application/json: schema: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaGoogleAdsLink" description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/analytics.edit Oauth2c: - https://www.googleapis.com/auth/analytics.edit tags: - properties x-microcks-operation: delay: 0 dispatcher: FALLBACK /v1beta/{name}:archive: 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: Archives a CustomMetric on a property. operationId: analyticsadmin.properties.customMetrics.archive parameters: - description: "Required. The name of the CustomMetric to archive. Example format: properties/1234/customMetrics/5678" in: path name: name required: true schema: type: string example: Example Name requestBody: content: application/json: schema: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaArchiveCustomMetricRequest" responses: "200": content: application/json: schema: $ref: "#/components/schemas/GoogleProtobufEmpty" description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/analytics.edit Oauth2c: - https://www.googleapis.com/auth/analytics.edit tags: - properties x-microcks-operation: delay: 0 dispatcher: FALLBACK /v1beta/{parent}/conversionEvents: get: description: Returns a list of conversion events in the specified parent property. Returns an empty list if no conversion events are found. operationId: analyticsadmin.properties.conversionEvents.list parameters: - description: "Required. The resource name of the parent property. Example: 'properties/123'" in: path name: parent required: true schema: type: string example: example_value - description: The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum) in: query name: pageSize schema: type: integer example: 10 - description: A page token, received from a previous `ListConversionEvents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListConversionEvents` must match the call that provided the page token. in: query name: pageToken schema: type: string example: abc123token responses: "200": content: application/json: schema: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaListConversionEventsResponse" description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/analytics.edit Oauth2c: - https://www.googleapis.com/auth/analytics.edit - Oauth2: - https://www.googleapis.com/auth/analytics.readonly Oauth2c: - https://www.googleapis.com/auth/analytics.readonly tags: - properties x-microcks-operation: delay: 0 dispatcher: FALLBACK 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 a conversion event with the specified attributes. operationId: analyticsadmin.properties.conversionEvents.create parameters: - description: "Required. The resource name of the parent property where this conversion event will be created. Format: properties/123" in: path name: parent required: true schema: type: string example: example_value requestBody: content: application/json: schema: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaConversionEvent" responses: "200": content: application/json: schema: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaConversionEvent" description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/analytics.edit Oauth2c: - https://www.googleapis.com/auth/analytics.edit tags: - properties x-microcks-operation: delay: 0 dispatcher: FALLBACK /v1beta/{parent}/customDimensions: get: description: Lists CustomDimensions on a property. operationId: analyticsadmin.properties.customDimensions.list parameters: - description: "Required. Example format: properties/1234" in: path name: parent required: true schema: type: string example: example_value - description: The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum). in: query name: pageSize schema: type: integer example: 10 - description: A page token, received from a previous `ListCustomDimensions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCustomDimensions` must match the call that provided the page token. in: query name: pageToken schema: type: string example: abc123token responses: "200": content: application/json: schema: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaListCustomDimensionsResponse" description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/analytics.edit Oauth2c: - https://www.googleapis.com/auth/analytics.edit - Oauth2: - https://www.googleapis.com/auth/analytics.readonly Oauth2c: - https://www.googleapis.com/auth/analytics.readonly tags: - properties x-microcks-operation: delay: 0 dispatcher: FALLBACK 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 a CustomDimension. operationId: analyticsadmin.properties.customDimensions.create parameters: - description: "Required. Example format: properties/1234" in: path name: parent required: true schema: type: string example: example_value requestBody: content: application/json: schema: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaCustomDimension" responses: "200": content: application/json: schema: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaCustomDimension" description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/analytics.edit Oauth2c: - https://www.googleapis.com/auth/analytics.edit tags: - properties x-microcks-operation: delay: 0 dispatcher: FALLBACK /v1beta/{parent}/customMetrics: get: description: Lists CustomMetrics on a property. operationId: analyticsadmin.properties.customMetrics.list parameters: - description: "Required. Example format: properties/1234" in: path name: parent required: true schema: type: string example: example_value - description: The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum). in: query name: pageSize schema: type: integer example: 10 - description: A page token, received from a previous `ListCustomMetrics` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCustomMetrics` must match the call that provided the page token. in: query name: pageToken schema: type: string example: abc123token responses: "200": content: application/json: schema: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaListCustomMetricsResponse" description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/analytics.edit Oauth2c: - https://www.googleapis.com/auth/analytics.edit - Oauth2: - https://www.googleapis.com/auth/analytics.readonly Oauth2c: - https://www.googleapis.com/auth/analytics.readonly tags: - properties x-microcks-operation: delay: 0 dispatcher: FALLBACK 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 a CustomMetric. operationId: analyticsadmin.properties.customMetrics.create parameters: - description: "Required. Example format: properties/1234" in: path name: parent required: true schema: type: string example: example_value requestBody: content: application/json: schema: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaCustomMetric" responses: "200": content: application/json: schema: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaCustomMetric" description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/analytics.edit Oauth2c: - https://www.googleapis.com/auth/analytics.edit tags: - properties x-microcks-operation: delay: 0 dispatcher: FALLBACK /v1beta/{parent}/dataStreams: get: description: Lists DataStreams on a property. operationId: analyticsadmin.properties.dataStreams.list parameters: - description: "Required. Example format: properties/1234" in: path name: parent required: true schema: type: string example: example_value - description: The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum). in: query name: pageSize schema: type: integer example: 10 - description: A page token, received from a previous `ListDataStreams` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDataStreams` must match the call that provided the page token. in: query name: pageToken schema: type: string example: abc123token responses: "200": content: application/json: schema: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaListDataStreamsResponse" description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/analytics.edit Oauth2c: - https://www.googleapis.com/auth/analytics.edit - Oauth2: - https://www.googleapis.com/auth/analytics.readonly Oauth2c: - https://www.googleapis.com/auth/analytics.readonly tags: - properties x-microcks-operation: delay: 0 dispatcher: FALLBACK 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 a DataStream. operationId: analyticsadmin.properties.dataStreams.create parameters: - description: "Required. Example format: properties/1234" in: path name: parent required: true schema: type: string example: example_value requestBody: content: application/json: schema: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaDataStream" responses: "200": content: application/json: schema: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaDataStream" description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/analytics.edit Oauth2c: - https://www.googleapis.com/auth/analytics.edit tags: - properties x-microcks-operation: delay: 0 dispatcher: FALLBACK /v1beta/{parent}/firebaseLinks: get: description: Lists FirebaseLinks on a property. Properties can have at most one FirebaseLink. operationId: analyticsadmin.properties.firebaseLinks.list parameters: - description: "Required. Format: properties/{property_id} Example: properties/1234" in: path name: parent required: true schema: type: string example: example_value - description: The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum) in: query name: pageSize schema: type: integer example: 10 - description: A page token, received from a previous `ListFirebaseLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListFirebaseLinks` must match the call that provided the page token. in: query name: pageToken schema: type: string example: abc123token responses: "200": content: application/json: schema: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaListFirebaseLinksResponse" description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/analytics.edit Oauth2c: - https://www.googleapis.com/auth/analytics.edit - Oauth2: - https://www.googleapis.com/auth/analytics.readonly Oauth2c: - https://www.googleapis.com/auth/analytics.readonly tags: - properties x-microcks-operation: delay: 0 dispatcher: FALLBACK 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 a FirebaseLink. Properties can have at most one FirebaseLink. operationId: analyticsadmin.properties.firebaseLinks.create parameters: - description: "Required. Format: properties/{property_id} Example: properties/1234" in: path name: parent required: true schema: type: string example: example_value requestBody: content: application/json: schema: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaFirebaseLink" responses: "200": content: application/json: schema: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaFirebaseLink" description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/analytics.edit Oauth2c: - https://www.googleapis.com/auth/analytics.edit tags: - properties x-microcks-operation: delay: 0 dispatcher: FALLBACK /v1beta/{parent}/googleAdsLinks: get: description: Lists GoogleAdsLinks on a property. operationId: analyticsadmin.properties.googleAdsLinks.list parameters: - description: "Required. Example format: properties/1234" in: path name: parent required: true schema: type: string example: example_value - description: The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum). in: query name: pageSize schema: type: integer example: 10 - description: A page token, received from a previous `ListGoogleAdsLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListGoogleAdsLinks` must match the call that provided the page token. in: query name: pageToken schema: type: string example: abc123token responses: "200": content: application/json: schema: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaListGoogleAdsLinksResponse" description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/analytics.edit Oauth2c: - https://www.googleapis.com/auth/analytics.edit - Oauth2: - https://www.googleapis.com/auth/analytics.readonly Oauth2c: - https://www.googleapis.com/auth/analytics.readonly tags: - properties x-microcks-operation: delay: 0 dispatcher: FALLBACK 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 a GoogleAdsLink. operationId: analyticsadmin.properties.googleAdsLinks.create parameters: - description: "Required. Example format: properties/1234" in: path name: parent required: true schema: type: string example: example_value requestBody: content: application/json: schema: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaGoogleAdsLink" responses: "200": content: application/json: schema: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaGoogleAdsLink" description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/analytics.edit Oauth2c: - https://www.googleapis.com/auth/analytics.edit tags: - properties x-microcks-operation: delay: 0 dispatcher: FALLBACK /v1beta/{parent}/measurementProtocolSecrets: get: description: Returns child MeasurementProtocolSecrets under the specified parent Property. operationId: analyticsadmin.properties.dataStreams.measurementProtocolSecrets.list parameters: - description: "Required. The resource name of the parent stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets" in: path name: parent required: true schema: type: string example: example_value - description: The maximum number of resources to return. If unspecified, at most 10 resources will be returned. The maximum value is 10. Higher values will be coerced to the maximum. in: query name: pageSize schema: type: integer example: 10 - description: A page token, received from a previous `ListMeasurementProtocolSecrets` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListMeasurementProtocolSecrets` must match the call that provided the page token. in: query name: pageToken schema: type: string example: abc123token responses: "200": content: application/json: schema: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaListMeasurementProtocolSecretsResponse" description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/analytics.edit Oauth2c: - https://www.googleapis.com/auth/analytics.edit - Oauth2: - https://www.googleapis.com/auth/analytics.readonly Oauth2c: - https://www.googleapis.com/auth/analytics.readonly tags: - properties x-microcks-operation: delay: 0 dispatcher: FALLBACK 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 a measurement protocol secret. operationId: analyticsadmin.properties.dataStreams.measurementProtocolSecrets.create parameters: - description: "Required. The parent resource where this secret will be created. Format: properties/{property}/dataStreams/{dataStream}" in: path name: parent required: true schema: type: string example: example_value requestBody: content: application/json: schema: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaMeasurementProtocolSecret" responses: "200": content: application/json: schema: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaMeasurementProtocolSecret" description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/analytics.edit Oauth2c: - https://www.googleapis.com/auth/analytics.edit tags: - properties x-microcks-operation: delay: 0 dispatcher: FALLBACK /v1beta/{property}:acknowledgeUserDataCollection: 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: Acknowledges the terms of user data collection for the specified property. This acknowledgement must be completed (either in the Google Analytics UI or through this API) before MeasurementProtocolSecret resources may be created. operationId: analyticsadmin.properties.acknowledgeUserDataCollection parameters: - description: Required. The property for which to acknowledge user data collection. in: path name: property required: true schema: type: string example: example_value requestBody: content: application/json: schema: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaAcknowledgeUserDataCollectionRequest" responses: "200": content: application/json: schema: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaAcknowledgeUserDataCollectionResponse" description: Successful response security: - Oauth2: - https://www.googleapis.com/auth/analytics.edit Oauth2c: - https://www.googleapis.com/auth/analytics.edit tags: - properties x-microcks-operation: delay: 0 dispatcher: FALLBACK 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: GoogleAnalyticsAdminV1betaAccessBetweenFilter: description: To express that the result needs to be between two numbers (inclusive). properties: fromValue: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaNumericValue" description: Begins with this number. toValue: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaNumericValue" description: Ends with this number. type: object GoogleAnalyticsAdminV1betaAccessDateRange: description: "A contiguous range of days: startDate, startDate + 1, ..., endDate." properties: endDate: description: The inclusive end date for the query in the format `YYYY-MM-DD`. Cannot be before `startDate`. The format `NdaysAgo`, `yesterday`, or `today` is also accepted, and in that case, the date is inferred based on the current time in the request's time zone. type: string example: '2026-04-17' startDate: description: The inclusive start date for the query in the format `YYYY-MM-DD`. Cannot be after `endDate`. The format `NdaysAgo`, `yesterday`, or `today` is also accepted, and in that case, the date is inferred based on the current time in the request's time zone. type: string example: '2026-04-17' type: object GoogleAnalyticsAdminV1betaAccessDimension: description: Dimensions are attributes of your data. For example, the dimension `userEmail` indicates the email of the user that accessed reporting data. Dimension values in report responses are strings. properties: dimensionName: description: The API name of the dimension. See [Data Access Schema](https://developers.google.com/analytics/devguides/config/admin/v1/access-api-schema) for the list of dimensions supported in this API. Dimensions are referenced by name in `dimensionFilter` and `orderBys`. type: string example: Example Name type: object GoogleAnalyticsAdminV1betaAccessDimensionHeader: 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: dimensionName: description: The dimension's name; for example 'userEmail'. type: string example: Example Name type: object GoogleAnalyticsAdminV1betaAccessDimensionValue: description: The value of a dimension. properties: value: description: The dimension value. For example, this value may be 'France' for the 'country' dimension. type: string example: example_value type: object GoogleAnalyticsAdminV1betaAccessFilter: description: An expression to filter dimension or metric values. properties: betweenFilter: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaAccessBetweenFilter" description: A filter for two values. fieldName: description: The dimension name or metric name. type: string example: Example Name inListFilter: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaAccessInListFilter" description: A filter for in list values. numericFilter: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaAccessNumericFilter" description: A filter for numeric or date values. stringFilter: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaAccessStringFilter" description: Strings related filter. type: object GoogleAnalyticsAdminV1betaAccessFilterExpression: description: Expresses dimension or metric filters. The fields in the same expression need to be either all dimensions or all metrics. properties: accessFilter: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaAccessFilter" description: A primitive filter. In the same FilterExpression, all of the filter's field names need to be either all dimensions or all metrics. andGroup: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaAccessFilterExpressionList" description: Each of the FilterExpressions in the and_group has an AND relationship. notExpression: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaAccessFilterExpression" description: The FilterExpression is NOT of not_expression. orGroup: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaAccessFilterExpressionList" description: Each of the FilterExpressions in the or_group has an OR relationship. type: object GoogleAnalyticsAdminV1betaAccessFilterExpressionList: description: A list of filter expressions. properties: expressions: description: A list of filter expressions. items: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaAccessFilterExpression" type: array type: object GoogleAnalyticsAdminV1betaAccessInListFilter: 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 example: true values: description: The list of string values. Must be non-empty. items: type: string type: array type: object GoogleAnalyticsAdminV1betaAccessMetric: description: The quantitative measurements of a report. For example, the metric `accessCount` is the total number of data access records. properties: metricName: description: The API name of the metric. See [Data Access Schema](https://developers.google.com/analytics/devguides/config/admin/v1/access-api-schema) for the list of metrics supported in this API. Metrics are referenced by name in `metricFilter` & `orderBys`. type: string example: Example Name type: object GoogleAnalyticsAdminV1betaAccessMetricHeader: 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: metricName: description: The metric's name; for example 'accessCount'. type: string example: Example Name type: object GoogleAnalyticsAdminV1betaAccessMetricValue: description: The value of a metric. properties: value: description: The measurement value. For example, this value may be '13'. type: string example: example_value type: object GoogleAnalyticsAdminV1betaAccessNumericFilter: description: Filters for numeric or date values. properties: operation: description: The operation type for this filter. enum: - OPERATION_UNSPECIFIED - EQUAL - LESS_THAN - LESS_THAN_OR_EQUAL - GREATER_THAN - GREATER_THAN_OR_EQUAL type: string example: OPERATION_UNSPECIFIED value: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaNumericValue" description: A numeric value or a date value. type: object GoogleAnalyticsAdminV1betaAccessOrderBy: description: Order bys define how rows will be sorted in the response. For example, ordering rows by descending access count is one ordering, and ordering rows by the country string is a different ordering. properties: desc: description: If true, sorts by descending order. If false or unspecified, sorts in ascending order. type: boolean example: true dimension: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaAccessOrderByDimensionOrderBy" description: Sorts results by a dimension's values. metric: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaAccessOrderByMetricOrderBy" description: Sorts results by a metric's values. type: object GoogleAnalyticsAdminV1betaAccessOrderByDimensionOrderBy: description: Sorts by dimension values. properties: dimensionName: description: A dimension name in the request to order by. type: string example: Example Name orderType: description: Controls the rule for dimension value ordering. enum: - ORDER_TYPE_UNSPECIFIED - ALPHANUMERIC - CASE_INSENSITIVE_ALPHANUMERIC - NUMERIC type: string example: ORDER_TYPE_UNSPECIFIED type: object GoogleAnalyticsAdminV1betaAccessOrderByMetricOrderBy: description: Sorts by metric values. properties: metricName: description: A metric name in the request to order by. type: string example: Example Name type: object GoogleAnalyticsAdminV1betaAccessQuota: description: Current state of all quotas for this Analytics property. If any quota for a property is exhausted, all requests to that property will return Resource Exhausted errors. properties: concurrentRequests: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaAccessQuotaStatus" description: Properties can use up to 50 concurrent requests. serverErrorsPerProjectPerHour: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaAccessQuotaStatus" description: Properties and cloud project pairs can have up to 50 server errors per hour. tokensPerDay: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaAccessQuotaStatus" description: Properties can use 250,000 tokens per day. Most requests consume fewer than 10 tokens. tokensPerHour: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaAccessQuotaStatus" description: 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. tokensPerProjectPerHour: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaAccessQuotaStatus" description: Properties can use up to 25% of their tokens per project per hour. This amounts to 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. type: object GoogleAnalyticsAdminV1betaAccessQuotaStatus: description: Current state for a particular quota group. properties: consumed: description: Quota consumed by this request. format: int32 type: integer example: 42 remaining: description: Quota remaining after this request. format: int32 type: integer example: 42 type: object GoogleAnalyticsAdminV1betaAccessRow: description: Access report data for each row. properties: dimensionValues: description: List of dimension values. These values are in the same order as specified in the request. items: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaAccessDimensionValue" type: array metricValues: description: List of metric values. These values are in the same order as specified in the request. items: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaAccessMetricValue" type: array type: object GoogleAnalyticsAdminV1betaAccessStringFilter: description: The filter for strings. properties: caseSensitive: description: If true, the string value is case sensitive. type: boolean example: true matchType: description: The match type for this filter. enum: - MATCH_TYPE_UNSPECIFIED - EXACT - BEGINS_WITH - ENDS_WITH - CONTAINS - FULL_REGEXP - PARTIAL_REGEXP type: string example: MATCH_TYPE_UNSPECIFIED value: description: The string value used for the matching. type: string example: example_value type: object GoogleAnalyticsAdminV1betaAccount: description: A resource message representing a Google Analytics account. properties: createTime: description: Output only. Time when this account was originally created. format: google-datetime readOnly: true type: string example: '2026-04-17T12:00:00Z' deleted: description: Output only. Indicates whether this Account is soft-deleted or not. Deleted accounts are excluded from List results unless specifically requested. readOnly: true type: boolean example: true displayName: description: Required. Human-readable display name for this account. type: string example: Example Name name: description: 'Output only. Resource name of this account. Format: accounts/{account} Example: "accounts/100"' readOnly: true type: string example: Example Name regionCode: description: Country of business. Must be a Unicode CLDR region code. type: string example: example_value updateTime: description: Output only. Time when account payload fields were last updated. format: google-datetime readOnly: true type: string example: '2026-04-17T12:00:00Z' type: object GoogleAnalyticsAdminV1betaAccountSummary: description: A virtual resource representing an overview of an account and all its child GA4 properties. properties: account: description: 'Resource name of account referred to by this account summary Format: accounts/{account_id} Example: "accounts/1000"' type: string example: example_value displayName: description: Display name for the account referred to in this account summary. type: string example: Example Name name: description: 'Resource name for this account summary. Format: accountSummaries/{account_id} Example: "accountSummaries/1000"' type: string example: Example Name propertySummaries: description: List of summaries for child accounts of this account. items: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaPropertySummary" type: array type: object GoogleAnalyticsAdminV1betaAcknowledgeUserDataCollectionRequest: description: Request message for AcknowledgeUserDataCollection RPC. properties: acknowledgement: description: 'Required. An acknowledgement that the caller of this method understands the terms of user data collection. This field must contain the exact value: "I acknowledge that I have the necessary privacy disclosures and rights from my end users for the collection and processing of their data, including the association of such data with the visitation information Google Analytics collects from my site and/or app property."' type: string example: example_value type: object GoogleAnalyticsAdminV1betaAcknowledgeUserDataCollectionResponse: description: Response message for AcknowledgeUserDataCollection RPC. properties: {} type: object GoogleAnalyticsAdminV1betaArchiveCustomDimensionRequest: description: Request message for ArchiveCustomDimension RPC. properties: {} type: object GoogleAnalyticsAdminV1betaArchiveCustomMetricRequest: description: Request message for ArchiveCustomMetric RPC. properties: {} type: object GoogleAnalyticsAdminV1betaChangeHistoryChange: description: A description of a change to a single Google Analytics resource. properties: action: description: The type of action that changed this resource. enum: - ACTION_TYPE_UNSPECIFIED - CREATED - UPDATED - DELETED type: string example: ACTION_TYPE_UNSPECIFIED resource: description: Resource name of the resource whose changes are described by this entry. type: string example: example_value resourceAfterChange: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaChangeHistoryChangeChangeHistoryResource" description: Resource contents from after the change was made. If this resource was deleted in this change, this field will be missing. resourceBeforeChange: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaChangeHistoryChangeChangeHistoryResource" description: Resource contents from before the change was made. If this resource was created in this change, this field will be missing. type: object GoogleAnalyticsAdminV1betaChangeHistoryChangeChangeHistoryResource: description: A snapshot of a resource as before or after the result of a change in change history. properties: account: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaAccount" description: A snapshot of an Account resource in change history. conversionEvent: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaConversionEvent" description: A snapshot of a ConversionEvent resource in change history. dataRetentionSettings: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaDataRetentionSettings" description: A snapshot of a data retention settings resource in change history. dataStream: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaDataStream" description: A snapshot of a DataStream resource in change history. firebaseLink: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaFirebaseLink" description: A snapshot of a FirebaseLink resource in change history. googleAdsLink: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaGoogleAdsLink" description: A snapshot of a GoogleAdsLink resource in change history. measurementProtocolSecret: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaMeasurementProtocolSecret" description: A snapshot of a MeasurementProtocolSecret resource in change history. property: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaProperty" description: A snapshot of a Property resource in change history. type: object GoogleAnalyticsAdminV1betaChangeHistoryEvent: description: A set of changes within a Google Analytics account or its child properties that resulted from the same cause. Common causes would be updates made in the Google Analytics UI, changes from customer support, or automatic Google Analytics system changes. properties: actorType: description: The type of actor that made this change. enum: - ACTOR_TYPE_UNSPECIFIED - USER - SYSTEM - SUPPORT type: string example: ACTOR_TYPE_UNSPECIFIED changeTime: description: Time when change was made. format: google-datetime type: string example: '2026-04-17T12:00:00Z' changes: description: A list of changes made in this change history event that fit the filters specified in SearchChangeHistoryEventsRequest. items: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaChangeHistoryChange" type: array changesFiltered: description: If true, then the list of changes returned was filtered, and does not represent all changes that occurred in this event. type: boolean example: true id: description: ID of this change history event. This ID is unique across Google Analytics. type: string example: '123456' userActorEmail: description: Email address of the Google account that made the change. This will be a valid email address if the actor field is set to USER, and empty otherwise. Google accounts that have been deleted will cause an error. type: string example: user@example.com type: object GoogleAnalyticsAdminV1betaConversionEvent: description: A conversion event in a Google Analytics property. properties: countingMethod: description: Optional. The method by which conversions will be counted across multiple events within a session. If this value is not provided, it will be set to `ONCE_PER_EVENT`. enum: - CONVERSION_COUNTING_METHOD_UNSPECIFIED - ONCE_PER_EVENT - ONCE_PER_SESSION type: string example: CONVERSION_COUNTING_METHOD_UNSPECIFIED createTime: description: Output only. Time when this conversion event was created in the property. format: google-datetime readOnly: true type: string example: '2026-04-17T12:00:00Z' custom: description: Output only. If set to true, this conversion event refers to a custom event. If set to false, this conversion event refers to a default event in GA. Default events typically have special meaning in GA. Default events are usually created for you by the GA system, but in some cases can be created by property admins. Custom events count towards the maximum number of custom conversion events that may be created per property. readOnly: true type: boolean example: true defaultConversionValue: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaConversionEventDefaultConversionValue" description: Optional. Defines a default value/currency for a conversion event. deletable: description: Output only. If set, this event can currently be deleted with DeleteConversionEvent. readOnly: true type: boolean example: true eventName: description: "Immutable. The event name for this conversion event. Examples: 'click', 'purchase'" type: string example: Example Name name: description: "Output only. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event}" readOnly: true type: string example: Example Name type: object GoogleAnalyticsAdminV1betaConversionEventDefaultConversionValue: description: Defines a default value/currency for a conversion event. Both value and currency must be provided. properties: currencyCode: description: When a conversion event for this event_name has no set currency, this currency will be applied as the default. Must be in ISO 4217 currency code format. See https://en.wikipedia.org/wiki/ISO_4217 for more information. type: string value: description: This value will be used to populate the value for all conversions of the specified event_name where the event "value" parameter is unset. format: double type: number type: object GoogleAnalyticsAdminV1betaCustomDimension: description: A definition for a CustomDimension. properties: description: description: Optional. Description for this custom dimension. Max length of 150 characters. type: string disallowAdsPersonalization: description: Optional. If set to true, sets this dimension as NPA and excludes it from ads personalization. This is currently only supported by user-scoped custom dimensions. type: boolean displayName: description: Required. Display name for this custom dimension as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets. type: string name: description: "Output only. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension}" readOnly: true type: string parameterName: description: Required. Immutable. Tagging parameter name for this custom dimension. If this is a user-scoped dimension, then this is the user property name. If this is an event-scoped dimension, then this is the event parameter name. If this is an item-scoped dimension, then this is the parameter name found in the eCommerce items array. May only contain alphanumeric and underscore characters, starting with a letter. Max length of 24 characters for user-scoped dimensions, 40 characters for event-scoped dimensions. type: string scope: description: Required. Immutable. The scope of this dimension. enum: - DIMENSION_SCOPE_UNSPECIFIED - EVENT - USER - ITEM type: string type: object GoogleAnalyticsAdminV1betaCustomMetric: description: A definition for a custom metric. properties: description: description: Optional. Description for this custom dimension. Max length of 150 characters. type: string displayName: description: Required. Display name for this custom metric as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets. type: string measurementUnit: description: Required. The type for the custom metric's value. enum: - MEASUREMENT_UNIT_UNSPECIFIED - STANDARD - CURRENCY - FEET - METERS - KILOMETERS - MILES - MILLISECONDS - SECONDS - MINUTES - HOURS type: string name: description: "Output only. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric}" readOnly: true type: string parameterName: description: Required. Immutable. Tagging name for this custom metric. If this is an event-scoped metric, then this is the event parameter name. May only contain alphanumeric and underscore charactes, starting with a letter. Max length of 40 characters for event-scoped metrics. type: string restrictedMetricType: description: Optional. Types of restricted data that this metric may contain. Required for metrics with CURRENCY measurement unit. Must be empty for metrics with a non-CURRENCY measurement unit. items: enum: - RESTRICTED_METRIC_TYPE_UNSPECIFIED - COST_DATA - REVENUE_DATA type: string type: array scope: description: Required. Immutable. The scope of this custom metric. enum: - METRIC_SCOPE_UNSPECIFIED - EVENT type: string type: object GoogleAnalyticsAdminV1betaDataRetentionSettings: description: Settings values for data retention. This is a singleton resource. properties: eventDataRetention: description: The length of time that event-level data is retained. enum: - RETENTION_DURATION_UNSPECIFIED - TWO_MONTHS - FOURTEEN_MONTHS - TWENTY_SIX_MONTHS - THIRTY_EIGHT_MONTHS - FIFTY_MONTHS type: string name: description: "Output only. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings" readOnly: true type: string resetUserDataOnNewActivity: description: If true, reset the retention period for the user identifier with every event from that user. type: boolean type: object GoogleAnalyticsAdminV1betaDataSharingSettings: description: A resource message representing data sharing settings of a Google Analytics account. properties: name: description: 'Output only. Resource name. Format: accounts/{account}/dataSharingSettings Example: "accounts/1000/dataSharingSettings"' readOnly: true type: string sharingWithGoogleAnySalesEnabled: description: Allows any of Google sales to access the data in order to suggest configuration changes to improve results. type: boolean sharingWithGoogleAssignedSalesEnabled: description: Allows Google sales teams that are assigned to the customer to access the data in order to suggest configuration changes to improve results. Sales team restrictions still apply when enabled. type: boolean sharingWithGoogleProductsEnabled: description: Allows Google to use the data to improve other Google products or services. type: boolean sharingWithGoogleSupportEnabled: description: Allows Google support to access the data in order to help troubleshoot issues. type: boolean sharingWithOthersEnabled: description: Allows Google to share the data anonymously in aggregate form with others. type: boolean type: object GoogleAnalyticsAdminV1betaDataStream: description: A resource message representing a data stream. properties: androidAppStreamData: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaDataStreamAndroidAppStreamData" description: Data specific to Android app streams. Must be populated if type is ANDROID_APP_DATA_STREAM. createTime: description: Output only. Time when this stream was originally created. format: google-datetime readOnly: true type: string displayName: description: Human-readable display name for the Data Stream. Required for web data streams. The max allowed display name length is 255 UTF-16 code units. type: string iosAppStreamData: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaDataStreamIosAppStreamData" description: Data specific to iOS app streams. Must be populated if type is IOS_APP_DATA_STREAM. name: description: 'Output only. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: "properties/1000/dataStreams/2000"' readOnly: true type: string type: description: Required. Immutable. The type of this DataStream resource. enum: - DATA_STREAM_TYPE_UNSPECIFIED - WEB_DATA_STREAM - ANDROID_APP_DATA_STREAM - IOS_APP_DATA_STREAM type: string updateTime: description: Output only. Time when stream payload fields were last updated. format: google-datetime readOnly: true type: string webStreamData: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaDataStreamWebStreamData" description: Data specific to web streams. Must be populated if type is WEB_DATA_STREAM. type: object GoogleAnalyticsAdminV1betaDataStreamAndroidAppStreamData: description: Data specific to Android app streams. properties: firebaseAppId: description: Output only. ID of the corresponding Android app in Firebase, if any. This ID can change if the Android app is deleted and recreated. readOnly: true type: string packageName: description: 'Immutable. The package name for the app being measured. Example: "com.example.myandroidapp"' type: string type: object GoogleAnalyticsAdminV1betaDataStreamIosAppStreamData: description: Data specific to iOS app streams. properties: bundleId: description: 'Required. Immutable. The Apple App Store Bundle ID for the app Example: "com.example.myiosapp"' type: string firebaseAppId: description: Output only. ID of the corresponding iOS app in Firebase, if any. This ID can change if the iOS app is deleted and recreated. readOnly: true type: string type: object GoogleAnalyticsAdminV1betaDataStreamWebStreamData: description: Data specific to web streams. properties: defaultUri: description: 'Domain name of the web app being measured, or empty. Example: "http://www.google.com", "https://www.google.com"' type: string firebaseAppId: description: Output only. ID of the corresponding web app in Firebase, if any. This ID can change if the web app is deleted and recreated. readOnly: true type: string measurementId: description: 'Output only. Analytics Measurement ID. Example: "G-1A2BCD345E"' readOnly: true type: string type: object GoogleAnalyticsAdminV1betaFirebaseLink: description: A link between a GA4 property and a Firebase project. properties: createTime: description: Output only. Time when this FirebaseLink was originally created. format: google-datetime readOnly: true type: string name: description: "Output only. Example format: properties/1234/firebaseLinks/5678" readOnly: true type: string project: description: "Immutable. Firebase project resource name. When creating a FirebaseLink, you may provide this resource name using either a project number or project ID. Once this resource has been created, returned FirebaseLinks will always have a project_name that contains a project number. Format: 'projects/{project number}' Example: 'projects/1234'" type: string type: object GoogleAnalyticsAdminV1betaGoogleAdsLink: description: A link between a GA4 property and a Google Ads account. properties: adsPersonalizationEnabled: description: Enable personalized advertising features with this integration. Automatically publish my Google Analytics audience lists and Google Analytics remarketing events/parameters to the linked Google Ads account. If this field is not set on create/update, it will be defaulted to true. type: boolean canManageClients: description: Output only. If true, this link is for a Google Ads manager account. readOnly: true type: boolean createTime: description: Output only. Time when this link was originally created. format: google-datetime readOnly: true type: string creatorEmailAddress: description: Output only. Email address of the user that created the link. An empty string will be returned if the email address can't be retrieved. readOnly: true type: string customerId: description: Immutable. Google Ads customer ID. type: string name: description: "Output only. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID." readOnly: true type: string updateTime: description: Output only. Time when this link was last updated. format: google-datetime readOnly: true type: string type: object GoogleAnalyticsAdminV1betaListAccountSummariesResponse: description: Response message for ListAccountSummaries RPC. properties: accountSummaries: description: Account summaries of all accounts the caller has access to. items: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaAccountSummary" 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 GoogleAnalyticsAdminV1betaListAccountsResponse: description: Request message for ListAccounts RPC. properties: accounts: description: Results that were accessible to the caller. items: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaAccount" 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 GoogleAnalyticsAdminV1betaListConversionEventsResponse: description: Response message for ListConversionEvents RPC. properties: conversionEvents: description: The requested conversion events items: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaConversionEvent" 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 GoogleAnalyticsAdminV1betaListCustomDimensionsResponse: description: Response message for ListCustomDimensions RPC. properties: customDimensions: description: List of CustomDimensions. items: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaCustomDimension" 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 GoogleAnalyticsAdminV1betaListCustomMetricsResponse: description: Response message for ListCustomMetrics RPC. properties: customMetrics: description: List of CustomMetrics. items: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaCustomMetric" 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 GoogleAnalyticsAdminV1betaListDataStreamsResponse: description: Response message for ListDataStreams RPC. properties: dataStreams: description: List of DataStreams. items: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaDataStream" 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 GoogleAnalyticsAdminV1betaListFirebaseLinksResponse: description: Response message for ListFirebaseLinks RPC properties: firebaseLinks: description: List of FirebaseLinks. This will have at most one value. items: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaFirebaseLink" 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. Currently, Google Analytics supports only one FirebaseLink per property, so this will never be populated. type: string type: object GoogleAnalyticsAdminV1betaListGoogleAdsLinksResponse: description: Response message for ListGoogleAdsLinks RPC. properties: googleAdsLinks: description: List of GoogleAdsLinks. items: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaGoogleAdsLink" 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 GoogleAnalyticsAdminV1betaListMeasurementProtocolSecretsResponse: description: Response message for ListMeasurementProtocolSecret RPC properties: measurementProtocolSecrets: description: A list of secrets for the parent stream specified in the request. items: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaMeasurementProtocolSecret" 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 GoogleAnalyticsAdminV1betaListPropertiesResponse: description: Response message for ListProperties RPC. properties: 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 properties: description: Results that matched the filter criteria and were accessible to the caller. items: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaProperty" type: array type: object GoogleAnalyticsAdminV1betaMeasurementProtocolSecret: description: A secret value used for sending hits to Measurement Protocol. properties: displayName: description: Required. Human-readable display name for this secret. type: string name: description: "Output only. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}" readOnly: true type: string secretValue: description: Output only. The measurement protocol secret value. Pass this value to the api_secret field of the Measurement Protocol API when sending hits to this secret's parent property. readOnly: true type: string type: object GoogleAnalyticsAdminV1betaNumericValue: description: To represent a number. properties: doubleValue: description: Double value format: double type: number int64Value: description: Integer value format: int64 type: string type: object GoogleAnalyticsAdminV1betaProperty: description: A resource message representing a Google Analytics GA4 property. properties: account: description: 'Immutable. The resource name of the parent account Format: accounts/{account_id} Example: "accounts/123"' type: string createTime: description: Output only. Time when the entity was originally created. format: google-datetime readOnly: true type: string currencyCode: description: 'The currency type used in reports involving monetary values. Format: https://en.wikipedia.org/wiki/ISO_4217 Examples: "USD", "EUR", "JPY"' type: string deleteTime: description: Output only. If set, the time at which this property was trashed. If not set, then this property is not currently in the trash can. format: google-datetime readOnly: true type: string displayName: description: Required. Human-readable display name for this property. The max allowed display name length is 100 UTF-16 code units. type: string expireTime: description: Output only. If set, the time at which this trashed property will be permanently deleted. If not set, then this property is not currently in the trash can and is not slated to be deleted. format: google-datetime readOnly: true type: string industryCategory: description: "Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK" enum: - INDUSTRY_CATEGORY_UNSPECIFIED - AUTOMOTIVE - BUSINESS_AND_INDUSTRIAL_MARKETS - FINANCE - HEALTHCARE - TECHNOLOGY - TRAVEL - OTHER - ARTS_AND_ENTERTAINMENT - BEAUTY_AND_FITNESS - BOOKS_AND_LITERATURE - FOOD_AND_DRINK - GAMES - HOBBIES_AND_LEISURE - HOME_AND_GARDEN - INTERNET_AND_TELECOM - LAW_AND_GOVERNMENT - NEWS - ONLINE_COMMUNITIES - PEOPLE_AND_SOCIETY - PETS_AND_ANIMALS - REAL_ESTATE - REFERENCE - SCIENCE - SPORTS - JOBS_AND_EDUCATION - SHOPPING type: string name: description: 'Output only. Resource name of this property. Format: properties/{property_id} Example: "properties/1000"' readOnly: true type: string parent: description: "Immutable. Resource name of this property's logical parent. Note: The Property-Moving UI can be used to change the parent. Format: accounts/{account}, properties/{property} Example: \"accounts/100\", \"properties/101\"" type: string propertyType: description: Immutable. The property type for this Property resource. When creating a property, if the type is "PROPERTY_TYPE_UNSPECIFIED", then "ORDINARY_PROPERTY" will be implied. enum: - PROPERTY_TYPE_UNSPECIFIED - PROPERTY_TYPE_ORDINARY - PROPERTY_TYPE_SUBPROPERTY - PROPERTY_TYPE_ROLLUP type: string serviceLevel: description: Output only. The Google Analytics service level that applies to this property. enum: - SERVICE_LEVEL_UNSPECIFIED - GOOGLE_ANALYTICS_STANDARD - GOOGLE_ANALYTICS_360 readOnly: true type: string timeZone: description: 'Required. Reporting Time Zone, used as the day boundary for reports, regardless of where the data originates. If the time zone honors DST, Analytics will automatically adjust for the changes. NOTE: Changing the time zone only affects data going forward, and is not applied retroactively. Format: https://www.iana.org/time-zones Example: "America/Los_Angeles"' type: string updateTime: description: Output only. Time when entity payload fields were last updated. format: google-datetime readOnly: true type: string type: object GoogleAnalyticsAdminV1betaPropertySummary: description: A virtual resource representing metadata for a GA4 property. properties: displayName: description: Display name for the property referred to in this property summary. type: string parent: description: "Resource name of this property's logical parent. Note: The Property-Moving UI can be used to change the parent. Format: accounts/{account}, properties/{property} Example: \"accounts/100\"\ , \"properties/200\"" type: string property: description: 'Resource name of property referred to by this property summary Format: properties/{property_id} Example: "properties/1000"' type: string propertyType: description: The property's property type. enum: - PROPERTY_TYPE_UNSPECIFIED - PROPERTY_TYPE_ORDINARY - PROPERTY_TYPE_SUBPROPERTY - PROPERTY_TYPE_ROLLUP type: string type: object GoogleAnalyticsAdminV1betaProvisionAccountTicketRequest: description: Request message for ProvisionAccountTicket RPC. properties: account: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaAccount" description: The account to create. redirectUri: description: Redirect URI where the user will be sent after accepting Terms of Service. Must be configured in Cloud Console as a Redirect URI. type: string type: object GoogleAnalyticsAdminV1betaProvisionAccountTicketResponse: description: Response message for ProvisionAccountTicket RPC. properties: accountTicketId: description: The param to be passed in the ToS link. type: string type: object GoogleAnalyticsAdminV1betaRunAccessReportRequest: description: The request for a Data Access Record Report. properties: dateRanges: description: Date ranges of access records to read. If multiple date ranges are requested, each response row will contain a zero based date range index. If two date ranges overlap, the access records for the overlapping days is included in the response rows for both date ranges. Requests are allowed up to 2 date ranges. items: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaAccessDateRange" type: array dimensionFilter: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaAccessFilterExpression" description: Dimension filters let you restrict report response to specific dimension values which match the filter. For example, filtering on access records of a single user. 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 in the response. Requests are allowed up to 9 dimensions. items: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaAccessDimension" type: array expandGroups: description: Optional. Decides whether to return the users within user groups. This field works only when include_all_users is set to true. If true, it will return all users with access to the specified property or account. If false, only the users with direct access will be returned. type: boolean includeAllUsers: description: Optional. Determines whether to include users who have never made an API call in the response. If true, all users with access to the specified property or account are included in the response, regardless of whether they have made an API call or not. If false, only the users who have made an API call will be included. 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 may return fewer rows than the requested `limit`, if there aren't as many remaining rows 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 metricFilter: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaAccessFilterExpression" description: Metric filters allow you to restrict report response to specific metric values which match the filter. Metric filters are applied after aggregating the report's rows, similar to SQL having-clause. Dimensions cannot be used in this filter. metrics: description: The metrics requested and displayed in the response. Requests are allowed up to 10 metrics. items: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaAccessMetric" type: array offset: description: The row count of the start row. The first row is counted as row 0. If offset is unspecified, it is treated as 0. If offset is zero, then this method will return the first page of results with `limit` entries. To learn more about this pagination parameter, see [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination). format: int64 type: string orderBys: description: Specifies how rows are ordered in the response. items: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaAccessOrderBy" type: array returnEntityQuota: description: Toggles whether to return the current state of this Analytics Property's quota. Quota is returned in [AccessQuota](#AccessQuota). For account-level requests, this field must be false. type: boolean timeZone: description: This request's time zone if specified. If unspecified, the property's time zone is used. The request's time zone is used to interpret the start & end dates of the report. Formatted as strings from the IANA Time Zone database (https://www.iana.org/time-zones); for example "America/New_York" or "Asia/Tokyo". type: string type: object GoogleAnalyticsAdminV1betaRunAccessReportResponse: description: The customized Data Access Record Report response. properties: dimensionHeaders: description: The header for a column in the report that corresponds to a specific dimension. The number of DimensionHeaders and ordering of DimensionHeaders matches the dimensions present in rows. items: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaAccessDimensionHeader" type: array metricHeaders: description: The header for a column in the report that corresponds to a specific metric. The number of MetricHeaders and ordering of MetricHeaders matches the metrics present in rows. items: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaAccessMetricHeader" type: array quota: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaAccessQuota" description: The quota state for this Analytics property including this request. This field doesn't work with account-level requests. rowCount: description: The total number of rows in the query 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 rows: description: Rows of dimension value combinations and metric values in the report. items: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaAccessRow" type: array type: object GoogleAnalyticsAdminV1betaSearchChangeHistoryEventsRequest: description: Request message for SearchChangeHistoryEvents RPC. properties: action: description: Optional. If set, only return changes that match one or more of these types of actions. items: enum: - ACTION_TYPE_UNSPECIFIED - CREATED - UPDATED - DELETED type: string type: array actorEmail: description: Optional. If set, only return changes if they are made by a user in this list. items: type: string type: array earliestChangeTime: description: Optional. If set, only return changes made after this time (inclusive). format: google-datetime type: string latestChangeTime: description: Optional. If set, only return changes made before this time (inclusive). format: google-datetime type: string pageSize: description: Optional. The maximum number of ChangeHistoryEvent items to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 items will be returned. The maximum value is 200 (higher values will be coerced to the maximum). format: int32 type: integer pageToken: description: Optional. A page token, received from a previous `SearchChangeHistoryEvents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `SearchChangeHistoryEvents` must match the call that provided the page token. type: string property: description: 'Optional. Resource name for a child property. If set, only return changes made to this property or its child resources. Format: properties/{propertyId} Example: "properties/100"' type: string resourceType: description: Optional. If set, only return changes if they are for a resource that matches at least one of these types. items: enum: - CHANGE_HISTORY_RESOURCE_TYPE_UNSPECIFIED - ACCOUNT - PROPERTY - FIREBASE_LINK - GOOGLE_ADS_LINK - GOOGLE_SIGNALS_SETTINGS - CONVERSION_EVENT - MEASUREMENT_PROTOCOL_SECRET - DATA_RETENTION_SETTINGS - DISPLAY_VIDEO_360_ADVERTISER_LINK - DISPLAY_VIDEO_360_ADVERTISER_LINK_PROPOSAL - DATA_STREAM - ATTRIBUTION_SETTINGS type: string type: array type: object GoogleAnalyticsAdminV1betaSearchChangeHistoryEventsResponse: description: Response message for SearchAccounts RPC. properties: changeHistoryEvents: description: Results that were accessible to the caller. items: $ref: "#/components/schemas/GoogleAnalyticsAdminV1betaChangeHistoryEvent" 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 GoogleProtobufEmpty: description: "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }" properties: {} type: object securitySchemes: Oauth2: description: Oauth 2.0 implicit authentication flows: implicit: authorizationUrl: https://accounts.google.com/o/oauth2/auth scopes: https://www.googleapis.com/auth/analytics.edit: Edit Google Analytics management entities https://www.googleapis.com/auth/analytics.readonly: See and download your Google Analytics data type: oauth2 Oauth2c: description: Oauth 2.0 authorizationCode authentication flows: authorizationCode: authorizationUrl: https://accounts.google.com/o/oauth2/auth scopes: https://www.googleapis.com/auth/analytics.edit: Edit Google Analytics management entities https://www.googleapis.com/auth/analytics.readonly: See and download your Google Analytics data tokenUrl: https://accounts.google.com/o/oauth2/token type: oauth2