Skip to main content

admin_schemav2

Creates, updates, deletes, gets or lists an admin_schemav2 resource.

Overview

Nameadmin_schemav2
TypeResource
Idgoogle.apigee.admin_schemav2

Fields

The following fields are returned by SELECT queries:

Successful response

NameDatatypeDescription
dimensionsarrayList of schema fields grouped as dimensions.
metaarrayAdditional metadata associated with schema. This is a legacy field and usually consists of an empty array of strings.
metricsarrayList of schema fields grouped as dimensions that can be used with an aggregate function such as sum, avg, min, and max.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
organizations_environments_analytics_admin_get_schemav2selectorganizationsId, environmentsIdtype, disableCacheGets a list of metrics and dimensions that can be used to create analytics queries and reports. Each schema element contains the name of the field, its associated type, and a flag indicating whether it is a standard or custom field.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
environmentsIdstring
organizationsIdstring
disableCacheboolean
typestring

SELECT examples

Gets a list of metrics and dimensions that can be used to create analytics queries and reports. Each schema element contains the name of the field, its associated type, and a flag indicating whether it is a standard or custom field.

SELECT
dimensions,
meta,
metrics
FROM google.apigee.admin_schemav2
WHERE organizationsId = '{{ organizationsId }}' -- required
AND environmentsId = '{{ environmentsId }}' -- required
AND type = '{{ type }}'
AND disableCache = '{{ disableCache }}';