Admin Directory API . resources . features

Instance Methods

delete(customer, featureKey)

Deletes a feature.

get(customer, featureKey)

Retrieves a feature.

insert(customer, body)

Inserts a feature.

list(customer, pageToken=None, maxResults=None)

Retrieves a list of features for an account.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(customer, featureKey, body)

Updates a feature. This method supports patch semantics.

rename(customer, oldName, body)

Renames a feature.

update(customer, featureKey, body)

Updates a feature.

Method Details

delete(customer, featureKey)
Deletes a feature.

Args:
  customer: string, The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID. (required)
  featureKey: string, The unique ID of the feature to delete. (required)
get(customer, featureKey)
Retrieves a feature.

Args:
  customer: string, The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID. (required)
  featureKey: string, The unique ID of the feature to retrieve. (required)

Returns:
  An object of the form:

    { # JSON template for Feature object in Directory API.
      "kind": "admin#directory#resources#features#Feature", # Kind of resource this is.
      "etags": "A String", # ETag of the resource.
      "name": "A String", # The name of the feature.
    }
insert(customer, body)
Inserts a feature.

Args:
  customer: string, The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # JSON template for Feature object in Directory API.
    "kind": "admin#directory#resources#features#Feature", # Kind of resource this is.
    "etags": "A String", # ETag of the resource.
    "name": "A String", # The name of the feature.
  }


Returns:
  An object of the form:

    { # JSON template for Feature object in Directory API.
      "kind": "admin#directory#resources#features#Feature", # Kind of resource this is.
      "etags": "A String", # ETag of the resource.
      "name": "A String", # The name of the feature.
    }
list(customer, pageToken=None, maxResults=None)
Retrieves a list of features for an account.

Args:
  customer: string, The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID. (required)
  pageToken: string, Token to specify the next page in the list.
  maxResults: integer, Maximum number of results to return.

Returns:
  An object of the form:

    { # JSON template for Feature List Response object in Directory API.
    "nextPageToken": "A String", # The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
    "kind": "admin#directory#resources#features#featuresList", # Kind of resource this is.
    "etag": "A String", # ETag of the resource.
    "features": [ # The Features in this page of results.
      { # JSON template for Feature object in Directory API.
          "kind": "admin#directory#resources#features#Feature", # Kind of resource this is.
          "etags": "A String", # ETag of the resource.
          "name": "A String", # The name of the feature.
        },
    ],
  }
list_next(previous_request, previous_response)
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(customer, featureKey, body)
Updates a feature. This method supports patch semantics.

Args:
  customer: string, The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID. (required)
  featureKey: string, The unique ID of the feature to update. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # JSON template for Feature object in Directory API.
    "kind": "admin#directory#resources#features#Feature", # Kind of resource this is.
    "etags": "A String", # ETag of the resource.
    "name": "A String", # The name of the feature.
  }


Returns:
  An object of the form:

    { # JSON template for Feature object in Directory API.
      "kind": "admin#directory#resources#features#Feature", # Kind of resource this is.
      "etags": "A String", # ETag of the resource.
      "name": "A String", # The name of the feature.
    }
rename(customer, oldName, body)
Renames a feature.

Args:
  customer: string, The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID. (required)
  oldName: string, The unique ID of the feature to rename. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # JSON request template for renaming a feature.
    "newName": "A String", # New name of the feature.
  }

update(customer, featureKey, body)
Updates a feature.

Args:
  customer: string, The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID. (required)
  featureKey: string, The unique ID of the feature to update. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # JSON template for Feature object in Directory API.
    "kind": "admin#directory#resources#features#Feature", # Kind of resource this is.
    "etags": "A String", # ETag of the resource.
    "name": "A String", # The name of the feature.
  }


Returns:
  An object of the form:

    { # JSON template for Feature object in Directory API.
      "kind": "admin#directory#resources#features#Feature", # Kind of resource this is.
      "etags": "A String", # ETag of the resource.
      "name": "A String", # The name of the feature.
    }