Marks target Account as soft-deleted (ie: "trashed") and returns it. This API does not have a method to restore soft-deleted accounts. However, they can be restored using the Trash Can UI. If the accounts are not restored before the expiration time, the account and all child resources (eg: Properties, GoogleAdsLinks, Streams, AccessBindings) will be permanently purged. https://support.google.com/analytics/answer/6154772 Returns an error if the target is not found.

Returns all accounts accessible by the caller. Note that these accounts might not currently have GA properties. Soft-deleted (ie: "trashed") accounts are excluded by default. Returns an empty list if no relevant accounts are found.

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 GA UI Reporting, GA UI Explorations, GA 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). To give your feedback on this API, complete the [Google Analytics Access Reports feedback](https://docs.google.com/forms/d/e/1FAIpQLSdmEBUrMzAEdiEKk5TV5dEHvDUZDRlgWYdQdAeSdtR4hVjEhw/viewform) form.

Searches through all changes to an account or its children given the specified set of filters.

Method Details

close()

Close httplib2 connections.

delete(name, x__xgafv=None)

Marks target Account as soft-deleted (ie: "trashed") and returns it. This API does not have a method to restore soft-deleted accounts. However, they can be restored using the Trash Can UI. If the accounts are not restored before the expiration time, the account and all child resources (eg: Properties, GoogleAdsLinks, Streams, AccessBindings) will be permanently purged. https://support.google.com/analytics/answer/6154772 Returns an error if the target is not found.

Args:
  name: string, Required. The name of the Account to soft-delete. Format: accounts/{account} Example: "accounts/100" (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # 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); }
}

get(name, x__xgafv=None)

Lookup for a single Account.

Args:
  name: string, Required. The name of the account to lookup. Format: accounts/{account} Example: "accounts/100" (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A resource message representing a Google Analytics account.
  "createTime": "A String", # Output only. Time when this account was originally created.
  "deleted": True or False, # Output only. Indicates whether this Account is soft-deleted or not. Deleted accounts are excluded from List results unless specifically requested.
  "displayName": "A String", # Required. Human-readable display name for this account.
  "gmpOrganization": "A String", # Output only. The URI for a Google Marketing Platform organization resource. Only set when this account is connected to a GMP organization. Format: marketingplatformadmin.googleapis.com/organizations/{org_id}
  "name": "A String", # Output only. Resource name of this account. Format: accounts/{account} Example: "accounts/100"
  "regionCode": "A String", # Country of business. Must be a Unicode CLDR region code.
  "updateTime": "A String", # Output only. Time when account payload fields were last updated.
}

getDataSharingSettings(name, x__xgafv=None)

Get data sharing settings on an account. Data sharing settings are singletons.

Args:
  name: string, Required. The name of the settings to lookup. Format: accounts/{account}/dataSharingSettings Example: `accounts/1000/dataSharingSettings` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A resource message representing data sharing settings of a Google Analytics account.
  "name": "A String", # Output only. Resource name. Format: accounts/{account}/dataSharingSettings Example: "accounts/1000/dataSharingSettings"
  "sharingWithGoogleAnySalesEnabled": True or False, # Allows any of Google sales to access the data in order to suggest configuration changes to improve results.
  "sharingWithGoogleAssignedSalesEnabled": True or False, # 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.
  "sharingWithGoogleProductsEnabled": True or False, # Allows Google to use the data to improve other Google products or services.
  "sharingWithGoogleSupportEnabled": True or False, # Allows Google support to access the data in order to help troubleshoot issues.
  "sharingWithOthersEnabled": True or False, # Allows Google to share the data anonymously in aggregate form with others.
}

list(pageSize=None, pageToken=None, showDeleted=None, x__xgafv=None)

Args:
pageSize: integer, 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)
pageToken: string, 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.
showDeleted: boolean, Whether to include soft-deleted (ie: "trashed") Accounts in the results. Accounts can be inspected to determine whether they are deleted or not.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # Request message for ListAccounts RPC.
"accounts": [ # Results that were accessible to the caller.
{ # A resource message representing a Google Analytics account.
"createTime": "A String", # Output only. Time when this account was originally created.
"deleted": True or False, # Output only. Indicates whether this Account is soft-deleted or not. Deleted accounts are excluded from List results unless specifically requested.
"displayName": "A String", # Required. Human-readable display name for this account.
"gmpOrganization": "A String", # Output only. The URI for a Google Marketing Platform organization resource. Only set when this account is connected to a GMP organization. Format: marketingplatformadmin.googleapis.com/organizations/{org_id}
"name": "A String", # Output only. Resource name of this account. Format: accounts/{account} Example: "accounts/100"
"regionCode": "A String", # Country of business. Must be a Unicode CLDR region code.
"updateTime": "A String", # Output only. Time when account payload fields were last updated.
},
],
"nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
}

list_next()

Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.

patch(name, body=None, updateMask=None, x__xgafv=None)

Updates an account.

Args:
  name: string, Output only. Resource name of this account. Format: accounts/{account} Example: "accounts/100" (required)
  body: object, The request body.
    The object takes the form of:

{ # A resource message representing a Google Analytics account.
  "createTime": "A String", # Output only. Time when this account was originally created.
  "deleted": True or False, # Output only. Indicates whether this Account is soft-deleted or not. Deleted accounts are excluded from List results unless specifically requested.
  "displayName": "A String", # Required. Human-readable display name for this account.
  "gmpOrganization": "A String", # Output only. The URI for a Google Marketing Platform organization resource. Only set when this account is connected to a GMP organization. Format: marketingplatformadmin.googleapis.com/organizations/{org_id}
  "name": "A String", # Output only. Resource name of this account. Format: accounts/{account} Example: "accounts/100"
  "regionCode": "A String", # Country of business. Must be a Unicode CLDR region code.
  "updateTime": "A String", # Output only. Time when account payload fields were last updated.
}

  updateMask: string, Required. The list of fields to be updated. Field names must be in snake case (for example, "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A resource message representing a Google Analytics account.
  "createTime": "A String", # Output only. Time when this account was originally created.
  "deleted": True or False, # Output only. Indicates whether this Account is soft-deleted or not. Deleted accounts are excluded from List results unless specifically requested.
  "displayName": "A String", # Required. Human-readable display name for this account.
  "gmpOrganization": "A String", # Output only. The URI for a Google Marketing Platform organization resource. Only set when this account is connected to a GMP organization. Format: marketingplatformadmin.googleapis.com/organizations/{org_id}
  "name": "A String", # Output only. Resource name of this account. Format: accounts/{account} Example: "accounts/100"
  "regionCode": "A String", # Country of business. Must be a Unicode CLDR region code.
  "updateTime": "A String", # Output only. Time when account payload fields were last updated.
}

provisionAccountTicket(body=None, x__xgafv=None)

Requests a ticket for creating an account.

Args:
  body: object, The request body.
    The object takes the form of:

{ # Request message for ProvisionAccountTicket RPC.
  "account": { # A resource message representing a Google Analytics account. # The account to create.
    "createTime": "A String", # Output only. Time when this account was originally created.
    "deleted": True or False, # Output only. Indicates whether this Account is soft-deleted or not. Deleted accounts are excluded from List results unless specifically requested.
    "displayName": "A String", # Required. Human-readable display name for this account.
    "gmpOrganization": "A String", # Output only. The URI for a Google Marketing Platform organization resource. Only set when this account is connected to a GMP organization. Format: marketingplatformadmin.googleapis.com/organizations/{org_id}
    "name": "A String", # Output only. Resource name of this account. Format: accounts/{account} Example: "accounts/100"
    "regionCode": "A String", # Country of business. Must be a Unicode CLDR region code.
    "updateTime": "A String", # Output only. Time when account payload fields were last updated.
  },
  "redirectUri": "A String", # Redirect URI where the user will be sent after accepting Terms of Service. Must be configured in Cloud Console as a Redirect URI.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for ProvisionAccountTicket RPC.
  "accountTicketId": "A String", # The param to be passed in the ToS link.
}

runAccessReport(entity, body=None, x__xgafv=None)

Args:
entity: string, 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 Google Analytics property ID. To request at the account level, entity should be for example 'accounts/1234' if "1234" is your Google Analytics Account ID. (required)
body: object, The request body.
The object takes the form of:

{ # The request for a Data Access Record Report.
"dateRanges": [ # 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.
{ # A contiguous range of days: startDate, startDate + 1, ..., endDate.
"endDate": "A String", # 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.
"startDate": "A String", # 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.
},
],
"dimensionFilter": { # Expresses dimension or metric filters. The fields in the same expression need to be either all dimensions or all metrics. # 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.
"accessFilter": { # An expression to filter dimension or metric values. # A primitive filter. In the same FilterExpression, all of the filter's field names need to be either all dimensions or all metrics.
"betweenFilter": { # To express that the result needs to be between two numbers (inclusive). # A filter for two values.
"fromValue": { # To represent a number. # Begins with this number.
"doubleValue": 3.14, # Double value
"int64Value": "A String", # Integer value
},
"toValue": { # To represent a number. # Ends with this number.
"doubleValue": 3.14, # Double value
"int64Value": "A String", # Integer value
},
},
"fieldName": "A String", # The dimension name or metric name.
"inListFilter": { # The result needs to be in a list of string values. # A filter for in list values.
"caseSensitive": True or False, # If true, the string value is case sensitive.
"values": [ # The list of string values. Must be non-empty.
"A String",
],
},
"numericFilter": { # Filters for numeric or date values. # A filter for numeric or date values.
"operation": "A String", # The operation type for this filter.
"value": { # To represent a number. # A numeric value or a date value.
"doubleValue": 3.14, # Double value
"int64Value": "A String", # Integer value
},
},
"stringFilter": { # The filter for strings. # Strings related filter.
"caseSensitive": True or False, # If true, the string value is case sensitive.
"matchType": "A String", # The match type for this filter.
"value": "A String", # The string value used for the matching.
},
},
"andGroup": { # A list of filter expressions. # Each of the FilterExpressions in the and_group has an AND relationship.
"expressions": [ # A list of filter expressions.
# Object with schema name: GoogleAnalyticsAdminV1betaAccessFilterExpression
],
},
"notExpression": # Object with schema name: GoogleAnalyticsAdminV1betaAccessFilterExpression # The FilterExpression is NOT of not_expression.
"orGroup": { # A list of filter expressions. # Each of the FilterExpressions in the or_group has an OR relationship.
"expressions": [ # A list of filter expressions.
# Object with schema name: GoogleAnalyticsAdminV1betaAccessFilterExpression
],
},
},
"dimensions": [ # The dimensions requested and displayed in the response. Requests are allowed up to 9 dimensions.
{ # 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.
"dimensionName": "A String", # 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`.
},
],
"expandGroups": True or False, # 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.
"includeAllUsers": True or False, # 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.
"limit": "A String", # 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).
"metricFilter": { # Expresses dimension or metric filters. The fields in the same expression need to be either all dimensions or all metrics. # 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.
"accessFilter": { # An expression to filter dimension or metric values. # A primitive filter. In the same FilterExpression, all of the filter's field names need to be either all dimensions or all metrics.
"betweenFilter": { # To express that the result needs to be between two numbers (inclusive). # A filter for two values.
"fromValue": { # To represent a number. # Begins with this number.
"doubleValue": 3.14, # Double value
"int64Value": "A String", # Integer value
},
"toValue": { # To represent a number. # Ends with this number.
"doubleValue": 3.14, # Double value
"int64Value": "A String", # Integer value
},
},
"fieldName": "A String", # The dimension name or metric name.
"inListFilter": { # The result needs to be in a list of string values. # A filter for in list values.
"caseSensitive": True or False, # If true, the string value is case sensitive.
"values": [ # The list of string values. Must be non-empty.
"A String",
],
},
"numericFilter": { # Filters for numeric or date values. # A filter for numeric or date values.
"operation": "A String", # The operation type for this filter.
"value": { # To represent a number. # A numeric value or a date value.
"doubleValue": 3.14, # Double value
"int64Value": "A String", # Integer value
},
},
"stringFilter": { # The filter for strings. # Strings related filter.
"caseSensitive": True or False, # If true, the string value is case sensitive.
"matchType": "A String", # The match type for this filter.
"value": "A String", # The string value used for the matching.
},
},
"andGroup": { # A list of filter expressions. # Each of the FilterExpressions in the and_group has an AND relationship.
"expressions": [ # A list of filter expressions.
# Object with schema name: GoogleAnalyticsAdminV1betaAccessFilterExpression
],
},
"notExpression": # Object with schema name: GoogleAnalyticsAdminV1betaAccessFilterExpression # The FilterExpression is NOT of not_expression.
"orGroup": { # A list of filter expressions. # Each of the FilterExpressions in the or_group has an OR relationship.
"expressions": [ # A list of filter expressions.
# Object with schema name: GoogleAnalyticsAdminV1betaAccessFilterExpression
],
},
},
"metrics": [ # The metrics requested and displayed in the response. Requests are allowed up to 10 metrics.
{ # The quantitative measurements of a report. For example, the metric `accessCount` is the total number of data access records.
"metricName": "A String", # 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`.
},
],
"offset": "A String", # 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).
"orderBys": [ # Specifies how rows are ordered in the response.
{ # 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.
"desc": True or False, # If true, sorts by descending order. If false or unspecified, sorts in ascending order.
"dimension": { # Sorts by dimension values. # Sorts results by a dimension's values.
"dimensionName": "A String", # A dimension name in the request to order by.
"orderType": "A String", # Controls the rule for dimension value ordering.
},
"metric": { # Sorts by metric values. # Sorts results by a metric's values.
"metricName": "A String", # A metric name in the request to order by.
},
},
],
"returnEntityQuota": True or False, # 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.
"timeZone": "A String", # 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".
}

x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # The customized Data Access Record Report response.
"dimensionHeaders": [ # 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.
{ # 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.
"dimensionName": "A String", # The dimension's name; for example 'userEmail'.
},
],
"metricHeaders": [ # 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.
{ # 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.
"metricName": "A String", # The metric's name; for example 'accessCount'.
},
],
"quota": { # 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. # The quota state for this Analytics property including this request. This field doesn't work with account-level requests.
"concurrentRequests": { # Current state for a particular quota group. # Properties can use up to 50 concurrent requests.
"consumed": 42, # Quota consumed by this request.
"remaining": 42, # Quota remaining after this request.
},
"serverErrorsPerProjectPerHour": { # Current state for a particular quota group. # Properties and cloud project pairs can have up to 50 server errors per hour.
"consumed": 42, # Quota consumed by this request.
"remaining": 42, # Quota remaining after this request.
},
"tokensPerDay": { # Current state for a particular quota group. # Properties can use 250,000 tokens per day. Most requests consume fewer than 10 tokens.
"consumed": 42, # Quota consumed by this request.
"remaining": 42, # Quota remaining after this request.
},
"tokensPerHour": { # Current state for a particular quota group. # 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.
"consumed": 42, # Quota consumed by this request.
"remaining": 42, # Quota remaining after this request.
},
"tokensPerProjectPerHour": { # Current state for a particular quota group. # 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.
"consumed": 42, # Quota consumed by this request.
"remaining": 42, # Quota remaining after this request.
},
},
"rowCount": 42, # 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).
"rows": [ # Rows of dimension value combinations and metric values in the report.
{ # Access report data for each row.
"dimensionValues": [ # List of dimension values. These values are in the same order as specified in the request.
{ # The value of a dimension.
"value": "A String", # The dimension value. For example, this value may be 'France' for the 'country' dimension.
},
],
"metricValues": [ # List of metric values. These values are in the same order as specified in the request.
{ # The value of a metric.
"value": "A String", # The measurement value. For example, this value may be '13'.
},
],
},
],
}

searchChangeHistoryEvents(account, body=None, x__xgafv=None)

Searches through all changes to an account or its children given the specified set of filters.

Args:
  account: string, Required. The account resource for which to return change history resources. Format: accounts/{account} Example: `accounts/100` (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for SearchChangeHistoryEvents RPC.
  "action": [ # Optional. If set, only return changes that match one or more of these types of actions.
    "A String",
  ],
  "actorEmail": [ # Optional. If set, only return changes if they are made by a user in this list.
    "A String",
  ],
  "earliestChangeTime": "A String", # Optional. If set, only return changes made after this time (inclusive).
  "latestChangeTime": "A String", # Optional. If set, only return changes made before this time (inclusive).
  "pageSize": 42, # 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).
  "pageToken": "A String", # 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.
  "property": "A String", # 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`
  "resourceType": [ # Optional. If set, only return changes if they are for a resource that matches at least one of these types.
    "A String",
  ],
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for SearchAccounts RPC.
  "changeHistoryEvents": [ # Results that were accessible to the caller.
    { # 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.
      "actorType": "A String", # The type of actor that made this change.
      "changeTime": "A String", # Time when change was made.
      "changes": [ # A list of changes made in this change history event that fit the filters specified in SearchChangeHistoryEventsRequest.
        { # A description of a change to a single Google Analytics resource.
          "action": "A String", # The type of action that changed this resource.
          "resource": "A String", # Resource name of the resource whose changes are described by this entry.
          "resourceAfterChange": { # A snapshot of a resource as before or after the result of a change in change history. # Resource contents from after the change was made. If this resource was deleted in this change, this field will be missing.
            "account": { # A resource message representing a Google Analytics account. # A snapshot of an Account resource in change history.
              "createTime": "A String", # Output only. Time when this account was originally created.
              "deleted": True or False, # Output only. Indicates whether this Account is soft-deleted or not. Deleted accounts are excluded from List results unless specifically requested.
              "displayName": "A String", # Required. Human-readable display name for this account.
              "gmpOrganization": "A String", # Output only. The URI for a Google Marketing Platform organization resource. Only set when this account is connected to a GMP organization. Format: marketingplatformadmin.googleapis.com/organizations/{org_id}
              "name": "A String", # Output only. Resource name of this account. Format: accounts/{account} Example: "accounts/100"
              "regionCode": "A String", # Country of business. Must be a Unicode CLDR region code.
              "updateTime": "A String", # Output only. Time when account payload fields were last updated.
            },
            "conversionEvent": { # A conversion event in a Google Analytics property. # A snapshot of a ConversionEvent resource in change history.
              "countingMethod": "A String", # 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`.
              "createTime": "A String", # Output only. Time when this conversion event was created in the property.
              "custom": True or False, # 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.
              "defaultConversionValue": { # Defines a default value/currency for a conversion event. Both value and currency must be provided. # Optional. Defines a default value/currency for a conversion event.
                "currencyCode": "A String", # 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.
                "value": 3.14, # This value will be used to populate the value for all conversions of the specified event_name where the event "value" parameter is unset.
              },
              "deletable": True or False, # Output only. If set, this event can currently be deleted with DeleteConversionEvent.
              "eventName": "A String", # Immutable. The event name for this conversion event. Examples: 'click', 'purchase'
              "name": "A String", # Output only. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event}
            },
            "dataRetentionSettings": { # Settings values for data retention. This is a singleton resource. # A snapshot of a data retention settings resource in change history.
              "eventDataRetention": "A String", # The length of time that event-level data is retained.
              "name": "A String", # Output only. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings
              "resetUserDataOnNewActivity": True or False, # If true, reset the retention period for the user identifier with every event from that user.
            },
            "dataStream": { # A resource message representing a data stream. # A snapshot of a DataStream resource in change history.
              "androidAppStreamData": { # Data specific to Android app streams. # Data specific to Android app streams. Must be populated if type is ANDROID_APP_DATA_STREAM.
                "firebaseAppId": "A String", # Output only. ID of the corresponding Android app in Firebase, if any. This ID can change if the Android app is deleted and recreated.
                "packageName": "A String", # Immutable. The package name for the app being measured. Example: "com.example.myandroidapp"
              },
              "createTime": "A String", # Output only. Time when this stream was originally created.
              "displayName": "A String", # 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.
              "iosAppStreamData": { # Data specific to iOS app streams. # Data specific to iOS app streams. Must be populated if type is IOS_APP_DATA_STREAM.
                "bundleId": "A String", # Required. Immutable. The Apple App Store Bundle ID for the app Example: "com.example.myiosapp"
                "firebaseAppId": "A String", # Output only. ID of the corresponding iOS app in Firebase, if any. This ID can change if the iOS app is deleted and recreated.
              },
              "name": "A String", # Output only. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: "properties/1000/dataStreams/2000"
              "type": "A String", # Required. Immutable. The type of this DataStream resource.
              "updateTime": "A String", # Output only. Time when stream payload fields were last updated.
              "webStreamData": { # Data specific to web streams. # Data specific to web streams. Must be populated if type is WEB_DATA_STREAM.
                "defaultUri": "A String", # Domain name of the web app being measured, or empty. Example: "http://www.google.com", "https://www.google.com"
                "firebaseAppId": "A String", # Output only. ID of the corresponding web app in Firebase, if any. This ID can change if the web app is deleted and recreated.
                "measurementId": "A String", # Output only. Analytics Measurement ID. Example: "G-1A2BCD345E"
              },
            },
            "firebaseLink": { # A link between a Google Analytics property and a Firebase project. # A snapshot of a FirebaseLink resource in change history.
              "createTime": "A String", # Output only. Time when this FirebaseLink was originally created.
              "name": "A String", # Output only. Example format: properties/1234/firebaseLinks/5678
              "project": "A String", # 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'
            },
            "googleAdsLink": { # A link between a Google Analytics property and a Google Ads account. # A snapshot of a GoogleAdsLink resource in change history.
              "adsPersonalizationEnabled": True or False, # 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.
              "canManageClients": True or False, # Output only. If true, this link is for a Google Ads manager account.
              "createTime": "A String", # Output only. Time when this link was originally created.
              "creatorEmailAddress": "A String", # 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.
              "customerId": "A String", # Immutable. Google Ads customer ID.
              "name": "A String", # Output only. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID.
              "updateTime": "A String", # Output only. Time when this link was last updated.
            },
            "measurementProtocolSecret": { # A secret value used for sending hits to Measurement Protocol. # A snapshot of a MeasurementProtocolSecret resource in change history.
              "displayName": "A String", # Required. Human-readable display name for this secret.
              "name": "A String", # 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}
              "secretValue": "A String", # 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.
            },
            "property": { # A resource message representing a Google Analytics property. # A snapshot of a Property resource in change history.
              "account": "A String", # Immutable. The resource name of the parent account Format: accounts/{account_id} Example: "accounts/123"
              "createTime": "A String", # Output only. Time when the entity was originally created.
              "currencyCode": "A String", # The currency type used in reports involving monetary values. Format: https://en.wikipedia.org/wiki/ISO_4217 Examples: "USD", "EUR", "JPY"
              "deleteTime": "A String", # 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.
              "displayName": "A String", # Required. Human-readable display name for this property. The max allowed display name length is 100 UTF-16 code units.
              "expireTime": "A String", # 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.
              "industryCategory": "A String", # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK
              "name": "A String", # Output only. Resource name of this property. Format: properties/{property_id} Example: "properties/1000"
              "parent": "A String", # 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"
              "propertyType": "A String", # 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.
              "serviceLevel": "A String", # Output only. The Google Analytics service level that applies to this property.
              "timeZone": "A String", # 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"
              "updateTime": "A String", # Output only. Time when entity payload fields were last updated.
            },
          },
          "resourceBeforeChange": { # A snapshot of a resource as before or after the result of a change in change history. # Resource contents from before the change was made. If this resource was created in this change, this field will be missing.
            "account": { # A resource message representing a Google Analytics account. # A snapshot of an Account resource in change history.
              "createTime": "A String", # Output only. Time when this account was originally created.
              "deleted": True or False, # Output only. Indicates whether this Account is soft-deleted or not. Deleted accounts are excluded from List results unless specifically requested.
              "displayName": "A String", # Required. Human-readable display name for this account.
              "gmpOrganization": "A String", # Output only. The URI for a Google Marketing Platform organization resource. Only set when this account is connected to a GMP organization. Format: marketingplatformadmin.googleapis.com/organizations/{org_id}
              "name": "A String", # Output only. Resource name of this account. Format: accounts/{account} Example: "accounts/100"
              "regionCode": "A String", # Country of business. Must be a Unicode CLDR region code.
              "updateTime": "A String", # Output only. Time when account payload fields were last updated.
            },
            "conversionEvent": { # A conversion event in a Google Analytics property. # A snapshot of a ConversionEvent resource in change history.
              "countingMethod": "A String", # 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`.
              "createTime": "A String", # Output only. Time when this conversion event was created in the property.
              "custom": True or False, # 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.
              "defaultConversionValue": { # Defines a default value/currency for a conversion event. Both value and currency must be provided. # Optional. Defines a default value/currency for a conversion event.
                "currencyCode": "A String", # 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.
                "value": 3.14, # This value will be used to populate the value for all conversions of the specified event_name where the event "value" parameter is unset.
              },
              "deletable": True or False, # Output only. If set, this event can currently be deleted with DeleteConversionEvent.
              "eventName": "A String", # Immutable. The event name for this conversion event. Examples: 'click', 'purchase'
              "name": "A String", # Output only. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event}
            },
            "dataRetentionSettings": { # Settings values for data retention. This is a singleton resource. # A snapshot of a data retention settings resource in change history.
              "eventDataRetention": "A String", # The length of time that event-level data is retained.
              "name": "A String", # Output only. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings
              "resetUserDataOnNewActivity": True or False, # If true, reset the retention period for the user identifier with every event from that user.
            },
            "dataStream": { # A resource message representing a data stream. # A snapshot of a DataStream resource in change history.
              "androidAppStreamData": { # Data specific to Android app streams. # Data specific to Android app streams. Must be populated if type is ANDROID_APP_DATA_STREAM.
                "firebaseAppId": "A String", # Output only. ID of the corresponding Android app in Firebase, if any. This ID can change if the Android app is deleted and recreated.
                "packageName": "A String", # Immutable. The package name for the app being measured. Example: "com.example.myandroidapp"
              },
              "createTime": "A String", # Output only. Time when this stream was originally created.
              "displayName": "A String", # 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.
              "iosAppStreamData": { # Data specific to iOS app streams. # Data specific to iOS app streams. Must be populated if type is IOS_APP_DATA_STREAM.
                "bundleId": "A String", # Required. Immutable. The Apple App Store Bundle ID for the app Example: "com.example.myiosapp"
                "firebaseAppId": "A String", # Output only. ID of the corresponding iOS app in Firebase, if any. This ID can change if the iOS app is deleted and recreated.
              },
              "name": "A String", # Output only. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: "properties/1000/dataStreams/2000"
              "type": "A String", # Required. Immutable. The type of this DataStream resource.
              "updateTime": "A String", # Output only. Time when stream payload fields were last updated.
              "webStreamData": { # Data specific to web streams. # Data specific to web streams. Must be populated if type is WEB_DATA_STREAM.
                "defaultUri": "A String", # Domain name of the web app being measured, or empty. Example: "http://www.google.com", "https://www.google.com"
                "firebaseAppId": "A String", # Output only. ID of the corresponding web app in Firebase, if any. This ID can change if the web app is deleted and recreated.
                "measurementId": "A String", # Output only. Analytics Measurement ID. Example: "G-1A2BCD345E"
              },
            },
            "firebaseLink": { # A link between a Google Analytics property and a Firebase project. # A snapshot of a FirebaseLink resource in change history.
              "createTime": "A String", # Output only. Time when this FirebaseLink was originally created.
              "name": "A String", # Output only. Example format: properties/1234/firebaseLinks/5678
              "project": "A String", # 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'
            },
            "googleAdsLink": { # A link between a Google Analytics property and a Google Ads account. # A snapshot of a GoogleAdsLink resource in change history.
              "adsPersonalizationEnabled": True or False, # 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.
              "canManageClients": True or False, # Output only. If true, this link is for a Google Ads manager account.
              "createTime": "A String", # Output only. Time when this link was originally created.
              "creatorEmailAddress": "A String", # 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.
              "customerId": "A String", # Immutable. Google Ads customer ID.
              "name": "A String", # Output only. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID.
              "updateTime": "A String", # Output only. Time when this link was last updated.
            },
            "measurementProtocolSecret": { # A secret value used for sending hits to Measurement Protocol. # A snapshot of a MeasurementProtocolSecret resource in change history.
              "displayName": "A String", # Required. Human-readable display name for this secret.
              "name": "A String", # 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}
              "secretValue": "A String", # 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.
            },
            "property": { # A resource message representing a Google Analytics property. # A snapshot of a Property resource in change history.
              "account": "A String", # Immutable. The resource name of the parent account Format: accounts/{account_id} Example: "accounts/123"
              "createTime": "A String", # Output only. Time when the entity was originally created.
              "currencyCode": "A String", # The currency type used in reports involving monetary values. Format: https://en.wikipedia.org/wiki/ISO_4217 Examples: "USD", "EUR", "JPY"
              "deleteTime": "A String", # 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.
              "displayName": "A String", # Required. Human-readable display name for this property. The max allowed display name length is 100 UTF-16 code units.
              "expireTime": "A String", # 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.
              "industryCategory": "A String", # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK
              "name": "A String", # Output only. Resource name of this property. Format: properties/{property_id} Example: "properties/1000"
              "parent": "A String", # 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"
              "propertyType": "A String", # 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.
              "serviceLevel": "A String", # Output only. The Google Analytics service level that applies to this property.
              "timeZone": "A String", # 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"
              "updateTime": "A String", # Output only. Time when entity payload fields were last updated.
            },
          },
        },
      ],
      "changesFiltered": True or False, # If true, then the list of changes returned was filtered, and does not represent all changes that occurred in this event.
      "id": "A String", # ID of this change history event. This ID is unique across Google Analytics.
      "userActorEmail": "A String", # 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.
    },
  ],
  "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
}

Google Analytics Admin API . accounts

Instance Methods

Method Details