Area120 Tables API . workspaces

Instance Methods

close()

Close httplib2 connections.

get(name, x__xgafv=None)

Gets a workspace. Returns NOT_FOUND if the workspace does not exist.

list(pageSize=None, pageToken=None, x__xgafv=None)

Lists workspaces for the user.

list_next()

Retrieves the next page of results.

Method Details

close()
Close httplib2 connections.
get(name, x__xgafv=None)
Gets a workspace. Returns NOT_FOUND if the workspace does not exist.

Args:
  name: string, Required. The name of the workspace to retrieve. Format: workspaces/{workspace} (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A single workspace.
  "createTime": "A String", # Time when the workspace was created.
  "displayName": "A String", # The human readable title of the workspace.
  "name": "A String", # The resource name of the workspace. Workspace names have the form `workspaces/{workspace}`.
  "tables": [ # The list of tables in the workspace.
    { # A single table. NextId: 8
      "columns": [ # List of columns in this table. Order of columns matches the display order.
        { # Details on a column in the table.
          "dataType": "A String", # Data type of the column Supported types are auto_id, boolean, boolean_list, creator, create_timestamp, date, dropdown, location, integer, integer_list, number, number_list, person, person_list, tags, check_list, text, text_list, update_timestamp, updater, relationship, file_attachment_list. These types directly map to the column types supported on Tables website.
          "dateDetails": { # Details about a date column. # Optional. Additional details about a date column.
            "hasTime": True or False, # Whether the date column includes time.
          },
          "id": "A String", # Internal id for a column.
          "labels": [ # Optional. Range of labeled values for the column. Some columns like tags and drop-downs limit the values to a set of possible values. We return the range of values in such cases to help clients implement better user data validation.
            { # A single item in a labeled column.
              "id": "A String", # Internal id associated with the item.
              "name": "A String", # Display string as entered by user.
            },
          ],
          "lookupDetails": { # Details about a lookup column whose value comes from the associated relationship. # Optional. Indicates that this is a lookup column whose value is derived from the relationship column specified in the details. Lookup columns can not be updated directly. To change the value you must update the associated relationship column.
            "relationshipColumn": "A String", # The name of the relationship column associated with the lookup.
            "relationshipColumnId": "A String", # The id of the relationship column.
          },
          "multipleValuesDisallowed": True or False, # Optional. Indicates whether or not multiple values are allowed for array types where such a restriction is possible.
          "name": "A String", # column name
          "readonly": True or False, # Optional. Indicates that values for the column cannot be set by the user.
          "relationshipDetails": { # Details about a relationship column. # Optional. Additional details about a relationship column. Specified when data_type is relationship.
            "linkedTable": "A String", # The name of the table this relationship is linked to.
          },
        },
      ],
      "createTime": "A String", # Time when the table was created.
      "displayName": "A String", # The human readable title of the table.
      "name": "A String", # The resource name of the table. Table names have the form `tables/{table}`.
      "savedViews": [ # Saved views for this table.
        { # A saved view of a table. NextId: 3
          "id": "A String", # Internal id associated with the saved view.
          "name": "A String", # Display name of the saved view.
        },
      ],
      "timeZone": "A String", # The time zone of the table. IANA Time Zone Database time zone, e.g. "America/New_York".
      "updateTime": "A String", # Time when the table was last updated excluding updates to individual rows
    },
  ],
  "updateTime": "A String", # Time when the workspace was last updated.
}
list(pageSize=None, pageToken=None, x__xgafv=None)
Lists workspaces for the user.

Args:
  pageSize: integer, The maximum number of workspaces to return. The service may return fewer than this value. If unspecified, at most 10 workspaces are returned. The maximum value is 25; values above 25 are coerced to 25.
  pageToken: string, A page token, received from a previous `ListWorkspaces` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListWorkspaces` 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 TablesService.ListWorkspaces.
  "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is empty, there are no subsequent pages.
  "workspaces": [ # The list of workspaces.
    { # A single workspace.
      "createTime": "A String", # Time when the workspace was created.
      "displayName": "A String", # The human readable title of the workspace.
      "name": "A String", # The resource name of the workspace. Workspace names have the form `workspaces/{workspace}`.
      "tables": [ # The list of tables in the workspace.
        { # A single table. NextId: 8
          "columns": [ # List of columns in this table. Order of columns matches the display order.
            { # Details on a column in the table.
              "dataType": "A String", # Data type of the column Supported types are auto_id, boolean, boolean_list, creator, create_timestamp, date, dropdown, location, integer, integer_list, number, number_list, person, person_list, tags, check_list, text, text_list, update_timestamp, updater, relationship, file_attachment_list. These types directly map to the column types supported on Tables website.
              "dateDetails": { # Details about a date column. # Optional. Additional details about a date column.
                "hasTime": True or False, # Whether the date column includes time.
              },
              "id": "A String", # Internal id for a column.
              "labels": [ # Optional. Range of labeled values for the column. Some columns like tags and drop-downs limit the values to a set of possible values. We return the range of values in such cases to help clients implement better user data validation.
                { # A single item in a labeled column.
                  "id": "A String", # Internal id associated with the item.
                  "name": "A String", # Display string as entered by user.
                },
              ],
              "lookupDetails": { # Details about a lookup column whose value comes from the associated relationship. # Optional. Indicates that this is a lookup column whose value is derived from the relationship column specified in the details. Lookup columns can not be updated directly. To change the value you must update the associated relationship column.
                "relationshipColumn": "A String", # The name of the relationship column associated with the lookup.
                "relationshipColumnId": "A String", # The id of the relationship column.
              },
              "multipleValuesDisallowed": True or False, # Optional. Indicates whether or not multiple values are allowed for array types where such a restriction is possible.
              "name": "A String", # column name
              "readonly": True or False, # Optional. Indicates that values for the column cannot be set by the user.
              "relationshipDetails": { # Details about a relationship column. # Optional. Additional details about a relationship column. Specified when data_type is relationship.
                "linkedTable": "A String", # The name of the table this relationship is linked to.
              },
            },
          ],
          "createTime": "A String", # Time when the table was created.
          "displayName": "A String", # The human readable title of the table.
          "name": "A String", # The resource name of the table. Table names have the form `tables/{table}`.
          "savedViews": [ # Saved views for this table.
            { # A saved view of a table. NextId: 3
              "id": "A String", # Internal id associated with the saved view.
              "name": "A String", # Display name of the saved view.
            },
          ],
          "timeZone": "A String", # The time zone of the table. IANA Time Zone Database time zone, e.g. "America/New_York".
          "updateTime": "A String", # Time when the table was last updated excluding updates to individual rows
        },
      ],
      "updateTime": "A String", # Time when the workspace was last updated.
    },
  ],
}
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.