Admin SDK API . resources . features

close()

Close httplib2 connections.

delete(customer, featureKey, x__xgafv=None)

Deletes a feature.

Args:
  customer: string, The unique ID for the customer's Google Workspace 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)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

get(customer, featureKey, x__xgafv=None)

Retrieves a feature.

Args:
  customer: string, The unique ID for the customer's Google Workspace 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)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

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

insert(customer, body=None, x__xgafv=None)

Inserts a feature.

Args:
  customer: string, The unique ID for the customer's Google Workspace 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.
    The object takes the form of:

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

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

Returns:
  An object of the form:

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

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

Retrieves a list of features for an account.

Args:
  customer: string, The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID. (required)
  maxResults: integer, Maximum number of results to return.
  pageToken: string, Token to specify the next page in the list.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Public API: Resources.features
  "etag": "A String", # ETag of the resource.
  "features": [ # The Features in this page of results.
    { # JSON template for Feature object in Directory API.
      "etags": "A String", # ETag of the resource.
      "kind": "admin#directory#resources#features#Feature", # Kind of resource this is.
      "name": "A String", # The name of the feature.
    },
  ],
  "kind": "admin#directory#resources#features#featuresList", # Kind of resource this is.
  "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.
}

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(customer, featureKey, body=None, x__xgafv=None)

Patches a feature.

Args:
  customer: string, The unique ID for the customer's Google Workspace 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.
    The object takes the form of:

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

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

Returns:
  An object of the form:

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

rename(customer, oldName, body=None, x__xgafv=None)

Renames a feature.

Args:
  customer: string, The unique ID for the customer's Google Workspace 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.
    The object takes the form of:

{
  "newName": "A String", # New name of the feature.
}

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

update(customer, featureKey, body=None, x__xgafv=None)

Updates a feature.

Args:
  customer: string, The unique ID for the customer's Google Workspace 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.
    The object takes the form of:

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

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

Returns:
  An object of the form:

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