checkEnablementStatus(customer, x__xgafv=None)
Gets the setting state of the insights feature for the customer.
Close httplib2 connections.
disable(customer, body=None, x__xgafv=None)
Disables insights for the customer.
enable(customer, body=None, x__xgafv=None)
Enables insights for the customer and sets up required chrome connectors.
queryContentTransfers(customer, filter=None, x__xgafv=None)
Returns a high-level summary of content transfers for a given customer.
Returns summaries of content transfers for a given metric and breakdown dimension.
queryContentTransfersBreakdowns_next()
Retrieves the next page of results.
queryUrlVisits(customer, filter=None, x__xgafv=None)
Returns a high-level summary of URL visits for a given customer.
Returns summaries of URL visits for a given metric and breakdown dimension.
queryUrlVisitsBreakdowns_next()
Retrieves the next page of results.
checkEnablementStatus(customer, x__xgafv=None)
Gets the setting state of the insights feature for the customer.
Args:
customer: string, Required. The customer to check the enablement status for. Format: customers/{customer_id} (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response from checking the enablement status of insights for the customer.
"insightsState": "A String", # The state of the insights feature.
}
close()
Close httplib2 connections.
disable(customer, body=None, x__xgafv=None)
Disables insights for the customer.
Args:
customer: string, Required. The customer to disable insights for. Format: customers/{customer} (required)
body: object, The request body.
The object takes the form of:
{ # Request to disable insights for the customer.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response from disabling insights for the customer.
"insightsState": "A String", # The state of the insights feature.
}
enable(customer, body=None, x__xgafv=None)
Enables insights for the customer and sets up required chrome connectors.
Args:
customer: string, Required. The customer to enable insights for. Format: customers/{customer} (required)
body: object, The request body.
The object takes the form of:
{ # Request to enable insights for the customer.
"targetOus": [ # Optional. The Organizational Units to set up required connectors for. Organizational Units are provided as paths relative to root. If this field is not set, connectors will be set up at root OU (as if it were set to ["/"]). Example: ["/corp/sales", "/eng"]
"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 from enabling insights for the customer.
"insightsState": "A String", # The state of the insights feature.
}
queryContentTransfers(customer, filter=None, x__xgafv=None)
Returns a high-level summary of content transfers for a given customer.
Args:
customer: string, Required. The customer ID in the format "customers/{customer_id}". (required)
filter: string, Optional. The filter to apply to the request. For syntax, see AIP-160. Data is not available for events older than 180 days, and may be unavailable or inaccurate for time ranges less than 4 hours. If `event_time` is not specified, results will be returned for the last 30 days. Supported fields for filtering: - `event_time` Supported operators: - `>=` and `<=` for `event_time` Supported conjunctions: - `AND` Example: `event_time >= "2024-01-01T00:00:00Z" AND event_time <= "2024-01-02T00:00:00Z"`
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 QueryContentTransfers.
"summaries": [ # A collection of summaries for various content transfers metrics.
{ # Summary of content transfers for a given metric.
"count": "A String", # The count of the content transfers metric.
"metric": "A String", # The type of content transfers metric.
},
],
}
queryContentTransfersBreakdowns(customer, breakdown=None, filter=None, fixedTimeRange=None, metric=None, pageSize=None, pageToken=None, x__xgafv=None)
Returns summaries of content transfers for a given metric and breakdown dimension.
Args:
customer: string, Required. The customer ID in the format "customers/{customer_id}". (required)
breakdown: string, Optional. The dimension to break down the content transfers by. Defaults to USER.
Allowed values
CONTENT_TRANSFERS_BREAKDOWN_DIMENSION_UNSPECIFIED - Unspecified breakdown dimension. Defaults to USER.
USER - Breakdown by user.
EVENT_DOMAIN - Breakdown by event domain.
CONTENT_CATEGORY - Breakdown by content category.
filter: string, Optional. The filter to apply to the request. For syntax, see AIP-160. Data is not available for events older than 180 days or more recent than 48 hours ago. If `event_time` is not specified, results will end 48 hours ago. Supported fields for filtering: - `user` - `event_domain` - `content_category` - `event_time` Filtering by `user` or `event_domain` requires the `breakdown` dimension to be set to the corresponding value (e.g., you must set `breakdown = USER` to filter by `user`). Supported operators: - `=` for `user`, `event_domain`, and `content_category`. - `<=` for `event_time`. Supported conjunctions: - `AND` Example: `user = "testuser" AND event_time <= "2024-01-02T00:00:00Z"`
fixedTimeRange: string, Optional. The fixed time range to return the breakdowns for. Defaults to FIXED_TIME_RANGE_FOUR_WEEKS. Fixed time ranges are used to allow for precomputation and optimize response times.
Allowed values
FIXED_TIME_RANGE_UNSPECIFIED - Unspecified fixed time range. Defaults to FIXED_TIME_RANGE_FOUR_WEEKS.
FIXED_TIME_RANGE_FOUR_HOURS - Four hours.
FIXED_TIME_RANGE_ONE_DAY - One day.
FIXED_TIME_RANGE_ONE_WEEK - One week.
FIXED_TIME_RANGE_FOUR_WEEKS - Four weeks.
metric: string, Optional. The metric to return the breakdowns for. Defaults to CONTENT_TRANSFERS_METRIC_TOTAL_TRANSFERS.
Allowed values
CONTENT_TRANSFERS_METRIC_UNSPECIFIED - Unspecified content transfers metric. Defaults to CONTENT_TRANSFERS_METRIC_TOTAL_TRANSFERS.
CONTENT_TRANSFERS_METRIC_TOTAL_TRANSFERS - The total number of content transfers (sensitive and non-sensitive). This is the sum of the total_uploads, total_downloads, and total_prints.
CONTENT_TRANSFERS_METRIC_TOTAL_UPLOADS - The total number of content uploads (sensitive and non-sensitive).
CONTENT_TRANSFERS_METRIC_TOTAL_DOWNLOADS - The total number of content downloads (sensitive and non-sensitive).
CONTENT_TRANSFERS_METRIC_TOTAL_PRINTS - The total number of content prints (sensitive and non-sensitive).
CONTENT_TRANSFERS_METRIC_TOTAL_SENSITIVE_TRANSFERS - The total number of sensitive content transfers. This is the sum of the sensitive_uploads, sensitive_downloads, and sensitive_prints.
CONTENT_TRANSFERS_METRIC_SENSITIVE_UPLOADS - The number of sensitive content uploads.
CONTENT_TRANSFERS_METRIC_SENSITIVE_DOWNLOADS - The number of sensitive content downloads.
CONTENT_TRANSFERS_METRIC_SENSITIVE_PRINTS - The number of sensitive content prints.
pageSize: integer, Optional. The maximum number of breakdowns to return. The service may return fewer than this value. If unspecified, at most 50 breakdowns will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken: string, Optional. A page token, received from a previous `QueryContentTransfersBreakdowns` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryContentTransfersBreakdowns` must match the call that provided the page token.
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 QueryContentTransfersBreakdowns.
"contentTransfersBreakdowns": [ # The content transfer breakdowns from the specified insight.
{ # A content transfers summary for a given breakdown dimension.
"contentCategory": "A String", # The content category of the content transfers.
"eventDomain": "A String", # The event domain of the content transfers.
"summary": { # Summary of content transfers for a given metric. # The summary of content transfers for the breakdown dimension.
"count": "A String", # The count of the content transfers metric.
"metric": "A String", # The type of content transfers metric.
},
"user": "A String", # The user that transferred the content.
},
],
"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.
}
queryContentTransfersBreakdowns_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.
queryUrlVisits(customer, filter=None, x__xgafv=None)
Returns a high-level summary of URL visits for a given customer.
Args:
customer: string, Required. The customer ID in the format "customers/{customer_id}". (required)
filter: string, Optional. The filter to apply to the request. For syntax, see AIP-160. Data is not available for events older than 180 days, and may be unavailable or inaccurate for time ranges less than 4 hours. If `event_time` is not specified, results will be returned for the last 30 days. Supported fields for filtering: - `event_time` Supported operators: - `>=` and `<=` for `event_time` Supported conjunctions: - `AND` Example: `event_time >= "2024-01-01T00:00:00Z" AND event_time <= "2024-01-02T00:00:00Z"`
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 QueryUrlVisits.
"summaries": [ # A collection of summaries for various URL visit metrics.
{ # Summary of URL visits for a given metric.
"count": "A String", # The count of the URL visits metric.
"metric": "A String", # The type of URL visits metric.
},
],
}
queryUrlVisitsBreakdowns(customer, breakdown=None, filter=None, fixedTimeRange=None, metric=None, pageSize=None, pageToken=None, x__xgafv=None)
Returns summaries of URL visits for a given metric and breakdown dimension.
Args:
customer: string, Required. The customer ID in the format "customers/{customer_id}". (required)
breakdown: string, Optional. The dimension to break down the URL visits by. Defaults to USER.
Allowed values
URL_VISITS_BREAKDOWN_DIMENSION_UNSPECIFIED - Unspecified breakdown dimension. Defaults to USER.
USER - Breakdown by user.
EVENT_DOMAIN - Breakdown by event domain.
filter: string, Optional. The filter to apply to the request. For syntax, see AIP-160. Data is not available for events older than 180 days or more recent than 48 hours ago. If `event_time` is not specified, results will end 48 hours ago. Supported fields for filtering: - `user` - `event_domain` - `event_time` Filtering by `user` or `event_domain` requires the `breakdown` dimension to be set to the corresponding value (e.g., you must set `breakdown = USER` to filter by `user`). Supported operators: - `=` for `user` and `event_domain`. - `<=` for `event_time`. Supported conjunctions: - `AND` Example: `user = "testuser" AND event_time <= "2024-01-02T00:00:00Z"`
fixedTimeRange: string, Optional. The fixed time range to return the breakdowns for. Defaults to FIXED_TIME_RANGE_FOUR_WEEKS. Fixed time ranges are used to allow for precomputation and optimize response times.
Allowed values
FIXED_TIME_RANGE_UNSPECIFIED - Unspecified fixed time range. Defaults to FIXED_TIME_RANGE_FOUR_WEEKS.
FIXED_TIME_RANGE_FOUR_HOURS - Four hours.
FIXED_TIME_RANGE_ONE_DAY - One day.
FIXED_TIME_RANGE_ONE_WEEK - One week.
FIXED_TIME_RANGE_FOUR_WEEKS - Four weeks.
metric: string, Optional. The metric to return the breakdowns for. Defaults to URL_VISITS_METRIC_TOTAL_SUSPICIOUS_URL_VISITS.
Allowed values
URL_VISITS_METRIC_UNSPECIFIED - Unspecified URL visits metric. Defaults to URL_VISITS_METRIC_TOTAL_SUSPICIOUS_URL_VISITS.
URL_VISITS_METRIC_TOTAL_SUSPICIOUS_URL_VISITS - The total number of suspicious URL visits. This is the sum of the high_risk_url_visits, medium_risk_url_visits, and low_risk_url_visits.
URL_VISITS_METRIC_HIGH_RISK_URL_VISITS - The number of suspicious URL visits with high risk.
URL_VISITS_METRIC_MEDIUM_RISK_URL_VISITS - The number of suspicious URL visits with medium risk.
URL_VISITS_METRIC_LOW_RISK_URL_VISITS - The number of suspicious URL visits with low risk.
pageSize: integer, Optional. The maximum number of breakdowns to return. The service may return fewer than this value. If unspecified, at most 50 breakdowns will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken: string, Optional. A page token, received from a previous `QueryUrlVisitsBreakdowns` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryUrlVisitsBreakdowns` must match the call that provided the page token.
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 QueryUrlVisitsBreakdowns.
"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.
"urlVisitsBreakdowns": [ # The URL visit breakdowns from the specified insight.
{ # A URL visits summary for a given breakdown dimension.
"eventDomain": "A String", # The event domain of the URL visits.
"summary": { # Summary of URL visits for a given metric. # The summary of URL visits for the breakdown dimension.
"count": "A String", # The count of the URL visits metric.
"metric": "A String", # The type of URL visits metric.
},
"user": "A String", # The user that visited the URL.
},
],
}
queryUrlVisitsBreakdowns_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.