delete(customerId=*, schemaKey=*)
Delete schema
get(customerId=*, schemaKey=*)
Retrieve schema
insert(customerId=*, body=None)
Create schema.
Retrieve all schemas for a customer
patch(customerId=*, schemaKey=*, body=None)
Update schema. This method supports patch semantics.
update(customerId=*, schemaKey=*, body=None)
Update schema
delete(customerId=*, schemaKey=*)
Delete schema Args: customerId: string, Immutable ID of the G Suite account (required) schemaKey: string, Name or immutable ID of the schema (required)
get(customerId=*, schemaKey=*)
Retrieve schema
Args:
customerId: string, Immutable ID of the G Suite account (required)
schemaKey: string, Name or immutable ID of the schema (required)
Returns:
An object of the form:
{ # JSON template for Schema resource in Directory API.
"kind": "admin#directory#schema", # Kind of resource this is.
"displayName": "A String", # Display name for the schema.
"fields": [ # Fields of Schema
{ # JSON template for FieldSpec resource for Schemas in Directory API.
"kind": "admin#directory#schema#fieldspec", # Kind of resource this is.
"displayName": "A String", # Display Name of the field.
"etag": "A String", # ETag of the resource.
"fieldName": "A String", # Name of the field.
"fieldType": "A String", # Type of the field.
"indexed": true, # Boolean specifying whether the field is indexed or not.
"readAccessType": "ALL_DOMAIN_USERS", # Read ACLs on the field specifying who can view values of this field. Valid values are "ALL_DOMAIN_USERS" and "ADMINS_AND_SELF".
"numericIndexingSpec": { # Indexing spec for a numeric field. By default, only exact match queries will be supported for numeric fields. Setting the numericIndexingSpec allows range queries to be supported.
"maxValue": 3.14, # Maximum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
"minValue": 3.14, # Minimum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
},
"fieldId": "A String", # Unique identifier of Field (Read-only)
"multiValued": True or False, # Boolean specifying whether this is a multi-valued field or not.
},
],
"schemaId": "A String", # Unique identifier of Schema (Read-only)
"etag": "A String", # ETag of the resource.
"schemaName": "A String", # Schema name
}
insert(customerId=*, body=None)
Create schema.
Args:
customerId: string, Immutable ID of the G Suite account (required)
body: object, The request body.
The object takes the form of:
{ # JSON template for Schema resource in Directory API.
"kind": "admin#directory#schema", # Kind of resource this is.
"displayName": "A String", # Display name for the schema.
"fields": [ # Fields of Schema
{ # JSON template for FieldSpec resource for Schemas in Directory API.
"kind": "admin#directory#schema#fieldspec", # Kind of resource this is.
"displayName": "A String", # Display Name of the field.
"etag": "A String", # ETag of the resource.
"fieldName": "A String", # Name of the field.
"fieldType": "A String", # Type of the field.
"indexed": true, # Boolean specifying whether the field is indexed or not.
"readAccessType": "ALL_DOMAIN_USERS", # Read ACLs on the field specifying who can view values of this field. Valid values are "ALL_DOMAIN_USERS" and "ADMINS_AND_SELF".
"numericIndexingSpec": { # Indexing spec for a numeric field. By default, only exact match queries will be supported for numeric fields. Setting the numericIndexingSpec allows range queries to be supported.
"maxValue": 3.14, # Maximum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
"minValue": 3.14, # Minimum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
},
"fieldId": "A String", # Unique identifier of Field (Read-only)
"multiValued": True or False, # Boolean specifying whether this is a multi-valued field or not.
},
],
"schemaId": "A String", # Unique identifier of Schema (Read-only)
"etag": "A String", # ETag of the resource.
"schemaName": "A String", # Schema name
}
Returns:
An object of the form:
{ # JSON template for Schema resource in Directory API.
"kind": "admin#directory#schema", # Kind of resource this is.
"displayName": "A String", # Display name for the schema.
"fields": [ # Fields of Schema
{ # JSON template for FieldSpec resource for Schemas in Directory API.
"kind": "admin#directory#schema#fieldspec", # Kind of resource this is.
"displayName": "A String", # Display Name of the field.
"etag": "A String", # ETag of the resource.
"fieldName": "A String", # Name of the field.
"fieldType": "A String", # Type of the field.
"indexed": true, # Boolean specifying whether the field is indexed or not.
"readAccessType": "ALL_DOMAIN_USERS", # Read ACLs on the field specifying who can view values of this field. Valid values are "ALL_DOMAIN_USERS" and "ADMINS_AND_SELF".
"numericIndexingSpec": { # Indexing spec for a numeric field. By default, only exact match queries will be supported for numeric fields. Setting the numericIndexingSpec allows range queries to be supported.
"maxValue": 3.14, # Maximum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
"minValue": 3.14, # Minimum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
},
"fieldId": "A String", # Unique identifier of Field (Read-only)
"multiValued": True or False, # Boolean specifying whether this is a multi-valued field or not.
},
],
"schemaId": "A String", # Unique identifier of Schema (Read-only)
"etag": "A String", # ETag of the resource.
"schemaName": "A String", # Schema name
}
list(customerId=*)
Retrieve all schemas for a customer
Args:
customerId: string, Immutable ID of the G Suite account (required)
Returns:
An object of the form:
{ # JSON response template for List Schema operation in Directory API.
"kind": "admin#directory#schemas", # Kind of resource this is.
"etag": "A String", # ETag of the resource.
"schemas": [ # List of UserSchema objects.
{ # JSON template for Schema resource in Directory API.
"kind": "admin#directory#schema", # Kind of resource this is.
"displayName": "A String", # Display name for the schema.
"fields": [ # Fields of Schema
{ # JSON template for FieldSpec resource for Schemas in Directory API.
"kind": "admin#directory#schema#fieldspec", # Kind of resource this is.
"displayName": "A String", # Display Name of the field.
"etag": "A String", # ETag of the resource.
"fieldName": "A String", # Name of the field.
"fieldType": "A String", # Type of the field.
"indexed": true, # Boolean specifying whether the field is indexed or not.
"readAccessType": "ALL_DOMAIN_USERS", # Read ACLs on the field specifying who can view values of this field. Valid values are "ALL_DOMAIN_USERS" and "ADMINS_AND_SELF".
"numericIndexingSpec": { # Indexing spec for a numeric field. By default, only exact match queries will be supported for numeric fields. Setting the numericIndexingSpec allows range queries to be supported.
"maxValue": 3.14, # Maximum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
"minValue": 3.14, # Minimum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
},
"fieldId": "A String", # Unique identifier of Field (Read-only)
"multiValued": True or False, # Boolean specifying whether this is a multi-valued field or not.
},
],
"schemaId": "A String", # Unique identifier of Schema (Read-only)
"etag": "A String", # ETag of the resource.
"schemaName": "A String", # Schema name
},
],
}
patch(customerId=*, schemaKey=*, body=None)
Update schema. This method supports patch semantics.
Args:
customerId: string, Immutable ID of the G Suite account (required)
schemaKey: string, Name or immutable ID of the schema. (required)
body: object, The request body.
The object takes the form of:
{ # JSON template for Schema resource in Directory API.
"kind": "admin#directory#schema", # Kind of resource this is.
"displayName": "A String", # Display name for the schema.
"fields": [ # Fields of Schema
{ # JSON template for FieldSpec resource for Schemas in Directory API.
"kind": "admin#directory#schema#fieldspec", # Kind of resource this is.
"displayName": "A String", # Display Name of the field.
"etag": "A String", # ETag of the resource.
"fieldName": "A String", # Name of the field.
"fieldType": "A String", # Type of the field.
"indexed": true, # Boolean specifying whether the field is indexed or not.
"readAccessType": "ALL_DOMAIN_USERS", # Read ACLs on the field specifying who can view values of this field. Valid values are "ALL_DOMAIN_USERS" and "ADMINS_AND_SELF".
"numericIndexingSpec": { # Indexing spec for a numeric field. By default, only exact match queries will be supported for numeric fields. Setting the numericIndexingSpec allows range queries to be supported.
"maxValue": 3.14, # Maximum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
"minValue": 3.14, # Minimum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
},
"fieldId": "A String", # Unique identifier of Field (Read-only)
"multiValued": True or False, # Boolean specifying whether this is a multi-valued field or not.
},
],
"schemaId": "A String", # Unique identifier of Schema (Read-only)
"etag": "A String", # ETag of the resource.
"schemaName": "A String", # Schema name
}
Returns:
An object of the form:
{ # JSON template for Schema resource in Directory API.
"kind": "admin#directory#schema", # Kind of resource this is.
"displayName": "A String", # Display name for the schema.
"fields": [ # Fields of Schema
{ # JSON template for FieldSpec resource for Schemas in Directory API.
"kind": "admin#directory#schema#fieldspec", # Kind of resource this is.
"displayName": "A String", # Display Name of the field.
"etag": "A String", # ETag of the resource.
"fieldName": "A String", # Name of the field.
"fieldType": "A String", # Type of the field.
"indexed": true, # Boolean specifying whether the field is indexed or not.
"readAccessType": "ALL_DOMAIN_USERS", # Read ACLs on the field specifying who can view values of this field. Valid values are "ALL_DOMAIN_USERS" and "ADMINS_AND_SELF".
"numericIndexingSpec": { # Indexing spec for a numeric field. By default, only exact match queries will be supported for numeric fields. Setting the numericIndexingSpec allows range queries to be supported.
"maxValue": 3.14, # Maximum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
"minValue": 3.14, # Minimum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
},
"fieldId": "A String", # Unique identifier of Field (Read-only)
"multiValued": True or False, # Boolean specifying whether this is a multi-valued field or not.
},
],
"schemaId": "A String", # Unique identifier of Schema (Read-only)
"etag": "A String", # ETag of the resource.
"schemaName": "A String", # Schema name
}
update(customerId=*, schemaKey=*, body=None)
Update schema
Args:
customerId: string, Immutable ID of the G Suite account (required)
schemaKey: string, Name or immutable ID of the schema. (required)
body: object, The request body.
The object takes the form of:
{ # JSON template for Schema resource in Directory API.
"kind": "admin#directory#schema", # Kind of resource this is.
"displayName": "A String", # Display name for the schema.
"fields": [ # Fields of Schema
{ # JSON template for FieldSpec resource for Schemas in Directory API.
"kind": "admin#directory#schema#fieldspec", # Kind of resource this is.
"displayName": "A String", # Display Name of the field.
"etag": "A String", # ETag of the resource.
"fieldName": "A String", # Name of the field.
"fieldType": "A String", # Type of the field.
"indexed": true, # Boolean specifying whether the field is indexed or not.
"readAccessType": "ALL_DOMAIN_USERS", # Read ACLs on the field specifying who can view values of this field. Valid values are "ALL_DOMAIN_USERS" and "ADMINS_AND_SELF".
"numericIndexingSpec": { # Indexing spec for a numeric field. By default, only exact match queries will be supported for numeric fields. Setting the numericIndexingSpec allows range queries to be supported.
"maxValue": 3.14, # Maximum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
"minValue": 3.14, # Minimum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
},
"fieldId": "A String", # Unique identifier of Field (Read-only)
"multiValued": True or False, # Boolean specifying whether this is a multi-valued field or not.
},
],
"schemaId": "A String", # Unique identifier of Schema (Read-only)
"etag": "A String", # ETag of the resource.
"schemaName": "A String", # Schema name
}
Returns:
An object of the form:
{ # JSON template for Schema resource in Directory API.
"kind": "admin#directory#schema", # Kind of resource this is.
"displayName": "A String", # Display name for the schema.
"fields": [ # Fields of Schema
{ # JSON template for FieldSpec resource for Schemas in Directory API.
"kind": "admin#directory#schema#fieldspec", # Kind of resource this is.
"displayName": "A String", # Display Name of the field.
"etag": "A String", # ETag of the resource.
"fieldName": "A String", # Name of the field.
"fieldType": "A String", # Type of the field.
"indexed": true, # Boolean specifying whether the field is indexed or not.
"readAccessType": "ALL_DOMAIN_USERS", # Read ACLs on the field specifying who can view values of this field. Valid values are "ALL_DOMAIN_USERS" and "ADMINS_AND_SELF".
"numericIndexingSpec": { # Indexing spec for a numeric field. By default, only exact match queries will be supported for numeric fields. Setting the numericIndexingSpec allows range queries to be supported.
"maxValue": 3.14, # Maximum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
"minValue": 3.14, # Minimum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
},
"fieldId": "A String", # Unique identifier of Field (Read-only)
"multiValued": True or False, # Boolean specifying whether this is a multi-valued field or not.
},
],
"schemaId": "A String", # Unique identifier of Schema (Read-only)
"etag": "A String", # ETag of the resource.
"schemaName": "A String", # Schema name
}