GoogleSheets.jl Documentation

GoogleSheets.jl Documentation

Enums
Types
Functions
Index

Enums

GoogleSheets.AuthScope — Type

An authorization scope for accessing Google resources.

AUTH_SCOPE_READONLY: Allows read-only access to the user's sheets and their properties.
AUTH_SCOPE_READWRITE: Allows read/write access to the user's sheets and their properties.

source

GoogleSheets.ValueType — Type

A Google Sheets value type.

VALUE_TYPE_MIN: minimum value in a range
VALUE_TYPE_MAX: maximum value in a range
VALUE_TYPE_NUMBER: exact number
VALUE_TYPE_PERCENT: percentage of a range
VALUE_TYPE_PERCENTILE: percentile of a range

source

GoogleSheets.ConditionType — Type

A Google Sheets condition type.

CONDITION_TYPE_NUMBER_GREATER: value must be greater than the condition value.
CONDITION_TYPE_NUMBER_GREATER_THAN_EQ: value must be greater than or equal to the condition value.
CONDITION_TYPE_NUMBER_LESS: value must be less than the condition value.
CONDITION_TYPE_NUMBER_LESS_THAN_EQ: value must be less than or equal to the condition value.
CONDITION_TYPE_NUMBER_EQ: value must be equal to the condition value.
CONDITION_TYPE_NUMBER_NOT_EQ: value must not be equal to the condition value.
CONDITION_TYPE_NUMBER_BETWEEN: value must be between the two condition values.
CONDITION_TYPE_NUMBER_NOT_BETWEEN: value must not be between the two condition values.
CONDITION_TYPE_TEXT_CONTAINS: value must contain the condition value.
CONDITION_TYPE_TEXT_NOT_CONTAINS: value must not contain the condition value.
CONDITION_TYPE_TEXT_STARTS_WITH: value must start with the condition value.
CONDITION_TYPE_TEXT_ENDS_WITH: value must end with the condition value.
CONDITION_TYPE_TEXT_EQ: value must equal the condition value.
CONDITION_TYPE_TEXT_NOT_EQ: value must not equal the condition value.
CONDITION_TYPE_TEXT_IS_EMAIL: value must be a valid email address.
CONDITION_TYPE_TEXT_IS_URL: value must be a valid URL.
CONDITION_TYPE_DATE_EQ: value must have the same date as the condition value.
CONDITION_TYPE_DATE_NOT_EQ: value must not have the same date as the condition value.
CONDITION_TYPE_DATE_BEFORE: value's date must be before the date of the condition value.
CONDITION_TYPE_DATE_AFTER: value's date must be before the date of the condition value.
CONDITION_TYPE_DATE_ON_OR_BEFORE: value's date must be on or before the date of the condition value.
CONDITION_TYPE_DATE_ON_OR_AFTER: value's date must be on or after the date of the condition value.
CONDITION_TYPE_DATE_BETWEEN: value's date must be between the dates of the condition values.
CONDITION_TYPE_DATE_NOT_BETWEEN: value's date must not be between the dates of the condition values.
CONDITION_TYPE_DATE_IS_VALID: value must be a date.
CONDITION_TYPE_ONE_OF_LIST: value must be present in the condition values.
CONDITION_TYPE_BLANK: value must be empty.
CONDITION_TYPE_NOT_BLANK: value must not be empty.
CONDITION_TYPE_CUSTOM_FORMULA: condition formula must evaluate to true.
CONDITION_TYPE_BOOLEAN: value must be TRUE/FALSE.
CONDITION_TYPE_ONE_OF_RANGE: value is present in the condition value's cell range.

source

GoogleSheets.NumberFormatType — Type

A Google Sheets number format type.

NUMBER_FORMAT_TYPE_TEXT: text formatting, e.g. 1000.12
NUMBER_FORMAT_TYPE_NUMBER: number formatting, e.g. 1,000.12
NUMBER_FORMAT_TYPE_PERCENT: percent formatting, e.g. 10.12%
NUMBER_FORMAT_TYPE_CURRENCY: currency formatting, e.g. $ 1,000.12
NUMBER_FORMAT_TYPE_DATE: date formatting, e.g. 9/26/2008
NUMBER_FORMAT_TYPE_TIME: time formatting, e.g. 3:59:00 PM
NUMBER_FORMAT_TYPE_DATE_TIME: date+time formatting, e.g. 9/26/08 15:59:00
NUMBER_FORMAT_TYPE_SCIENTIFIC: scientific number formatting, e.g. 1.01E+03

source

Types

GoogleSheets.GoogleSheetsClient — Type

A Google Sheets client.

source

GoogleSheets.Spreadsheet — Type

A spreadsheet.

source

GoogleSheets.Sheet — Type

A sheet in a spreadsheet.

source

GoogleSheets.CellRange — Type

A range of cells within a spreadsheet.

source

GoogleSheets.CellRanges — Type

Multiple ranges of cells within a spreadsheet.

source

GoogleSheets.CellRangeValues — Type

A range of cell values within a spreadsheet.

source

GoogleSheets.UpdateSummary — Type

Summary of updated updated cells.

source

GoogleSheets.CellIndexRange1D — Type

1D Range of cell values.

source

GoogleSheets.CellIndexRange2D — Type

2D Range of cell values.

source

GoogleSheets.CellFormat — Type

Formatting for a cell.

source

DataFrames.DataFrame — Type

DataFrame(values::CellRangeValues)::Union{Nothing,DataFrame}

Creates a DataFrame from spreadsheet range values. The first row is converted to column names. All other rows are converted to string values.

Arguments

values::CellRangeValues: cell values

source

Functions

GoogleSheets.sheets_client — Function

sheets_client(scopes::Union{AuthScope,Array{AuthScope,1}}; 
    rate_limiter_read::AbstractRateLimiter=default_rate_limiter_read, 
    rate_limiter_write::AbstractRateLimiter=default_rate_limiter_write)::GoogleSheetsClient

Creates a client for accessing Google Sheets.

Arguments

scopes::Union{AuthScope,Array{AuthScope,1}}: authorization scopes.
rate_limiter_read::AbstractRateLimiter=default_rate_limiter_read: rate limiter for reading.
rate_limiter_write::AbstractRateLimiter=default_rate_limiter_write: rate limiter for writing.

source

GoogleSheets.sheet_names — Function

sheet_names(client::GoogleSheetsClient, spreadsheet::Spreadsheet)::Vector{String}

Gets the names of the sheets in the spreadsheet.

Arguments

client::GoogleSheetsClient: client
spreadsheet::Spreadsheet: spreadsheet

source

GoogleSheets.sheets — Function

sheets(client::GoogleSheetsClient, spreadsheet::Spreadsheet)::Vector{Sheet}

Gets the sheets in the spreadsheet.

Arguments

client::GoogleSheetsClient: client
spreadsheet::Spreadsheet: spreadsheet

source

GoogleSheets.batch_update! — Function

batch_update!(client::GoogleSheetsClient, spreadsheet::Spreadsheet, body::Dict)::Dict{Any,Any}

Applies one or more updates to a spreadsheet.

Each request is validated before being applied. If any request is not valid then the entire request will fail and nothing will be applied.

Common batch_update! functionality: Charts: https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/charts Filters: https://developers.google.com/sheets/api/guides/filters Basic formatting: https://developers.google.com/sheets/api/samples/formatting Conditional formatting: https://developers.google.com/sheets/api/samples/conditional-formatting Conditional formatting: https://developers.google.com/sheets/api/guides/conditional-format

Arguments

client::GoogleSheetsClient: client
spreadsheet::Spreadsheet: spreadsheet
body::Dict: updte body

source

GoogleSheets.add_sheet! — Function

add_sheet!(client::GoogleSheetsClient, spreadsheet::Spreadsheet, title::AbstractString)::Dict{Any,Any}

Adds a new sheet to a spreadsheet.

Arguments

client::GoogleSheetsClient: client
spreadsheet::Spreadsheet: spreadsheet
title::AbstractString: sheet title

source

GoogleSheets.delete_sheet! — Function

delete_sheet!(client::GoogleSheetsClient, spreadsheet::Spreadsheet, title::AbstractString)::Dict{Any,Any}

Removes a sheet from a spreadsheet.

Arguments

client::GoogleSheetsClient: client
spreadsheet::Spreadsheet: spreadsheet
title::AbstractString: sheet title

source

delete_sheet!(client::GoogleSheetsClient, spreadsheet::Spreadsheet, sheet_id::Int64)::Dict{Any,Any}

Removes a sheet from a spreadsheet.

Arguments

client::GoogleSheetsClient: client
spreadsheet::Spreadsheet: spreadsheet
sheet_id::Int64: sheet id

source

GoogleSheets.freeze! — Function

freeze!(client::GoogleSheetsClient, sheet::Sheet, rows::Int64=0, cols::Int64=0)::Dict{Any,Any}

Freeze rows and columns in a sheet.

Arguments

client::GoogleSheetsClient: client
sheet::Sheet: sheet
rows::Int64=0: number of rows
cols::Int64=0: number of columns

source

Base.append! — Function

append!(client::GoogleSheetsClient, sheet::Sheet, rows::Int64=0, cols::Int64=0)::Dict{Any,Any}

Append rows and columns to a sheet.

Arguments

client::GoogleSheetsClient: client
sheet::Sheet: sheet
rows::Int64=0: number of rows
cols::Int64=0: number of columns

source

GoogleSheets.insert_rows! — Function

insert_rows!(client::GoogleSheetsClient, range::CellIndexRange1D)::Dict{Any,Any}

Insert rows into to a sheet.

Arguments

client::GoogleSheetsClient: client
range::CellIndexRange1D: cell index range

source

GoogleSheets.insert_cols! — Function

insert_cols!(client::GoogleSheetsClient, range::CellIndexRange1D)::Dict{Any,Any}

Insert columns into to a sheet.

Arguments

client::GoogleSheetsClient: client
range::CellIndexRange1D: cell index range

source

GoogleSheets.delete_rows! — Function

Delete rows from a sheet.

Arguments

client::GoogleSheetsClient: client
range::CellIndexRange1D: cell index range

source

GoogleSheets.delete_cols! — Function

delete_cols!(client::GoogleSheetsClient, range::CellIndexRange1D)::Dict{Any,Any}

Delete columns from a sheet.

Arguments

client::GoogleSheetsClient: client
range::CellIndexRange1D: cell index range

source

GoogleSheets.meta — Function

meta(client::GoogleSheetsClient, spreadsheet::Spreadsheet)::Dict{Any,Any}

Gets metadata about a spreadsheet.

Arguments

client::GoogleSheetsClient: client
spreadsheet::Spreadsheet: spreadsheet

source

meta(client::GoogleSheetsClient, spreadsheet::Spreadsheet, key::AbstractString, value)::Dict{Any,Any}

Gets metadata about a spreadsheet key-value pair.

Arguments

client::GoogleSheetsClient: client
spreadsheet::Spreadsheet: spreadsheet
key:AbstractString: key
value: value

source

meta(client::GoogleSheetsClient, spreadsheet::Spreadsheet, title::AbstractString)::Dict{Any,Any}

Gets metadata about a spreadsheet sheet.

Arguments

client::GoogleSheetsClient: client
spreadsheet::Spreadsheet: spreadsheet
title::AbstractString: sheet title

source

meta(client::GoogleSheetsClient, spreadsheet::Spreadsheet, sheet_id::Int64)::Dict{Any,Any}

Gets metadata about a spreadsheet sheet.

Arguments

client::GoogleSheetsClient: client
spreadsheet::Spreadsheet: spreadsheet
sheet_id::Int64: sheet id

source

meta(client::GoogleSheetsClient, sheet::Sheet)::Dict{Any,Any}

Gets metadata about a spreadsheet sheet.

Arguments

client::GoogleSheetsClient: client
sheet::Sheet: sheet

source

Base.show — Function

show(client::GoogleSheetsClient, spreadsheet::Spreadsheet)

Prints metadata about a spreadsheet.

Arguments

client::GoogleSheetsClient: client
spreadsheet::Spreadsheet: spreadsheet

source

show(client::GoogleSheetsClient, spreadsheet::Spreadsheet, title::AbstractString)

Prints metadata about a spreadsheet sheet.

Arguments

client::GoogleSheetsClient: client
spreadsheet::Spreadsheet: spreadsheet
title::AbstractString: sheet title

source

show(client::GoogleSheetsClient, spreadsheet::Spreadsheet, sheet_id::Int64)

Prints metadata about a spreadsheet sheet.

Arguments

client::GoogleSheetsClient: client
spreadsheet::Spreadsheet: spreadsheet
sheet_id::Int64: sheet id

source

show(client::GoogleSheetsClient, sheet::Sheet)

Prints metadata about a spreadsheet sheet.

Arguments

client::GoogleSheetsClient: client
sheet::Sheet: sheet

source

Base.get — Function

get(client::GoogleSheetsClient, range::CellRange)::CellRangeValues

Gets a range of cell values from a spreadsheet.

Arguments

client::GoogleSheetsClient: client
range::CellRange: cell range

source

get(client::GoogleSheetsClient, ranges::CellRanges)::Vector{CellRangeValues}

Gets multiple ranges of cell values from a spreadsheet.

Arguments

client::GoogleSheetsClient: client
ranges::CellRanges: cell ranges

source

GoogleSheets.update! — Function

update!(client::GoogleSheetsClient, range::CellRange, values::Array{<:Any,2}; raw::Bool=false)::UpdateSummary

Updates a range of cell values in a spreadsheet.

Arguments

client::GoogleSheetsClient: client for interacting with Google Sheets.
range::CellRange: cell range to modify.
values::Array{<:Any,2}: values to place in the spreadsheet.
raw::Bool=false: true treats values as raw, unparsed values and and are simply inserted as a string. false treats values exactly as if they were entered into the Google Sheets UI, for example "=A1+B1" is a formula.

source

update!(client::GoogleSheetsClient, range::CellRange, df::DataFrame; kwargs...)::UpdateSummary

Updates a range of cell values in a spreadsheet.

Arguments

client::GoogleSheetsClient: client for interacting with Google Sheets.
range::CellRange: cell range to modify.
df::DataFrame: dataframe of values.
kwargs...: keyword arguments.

source

GoogleSheets.clear! — Function

clear!(client::GoogleSheetsClient, range::CellRange)::UpdateSummary

Clears a range of cell values in a spreadsheet.

Arguments

client::GoogleSheetsClient: client
range::CellRange: cell range

source

GoogleSheets.format! — Function

format!(client::GoogleSheetsClient, range::CellIndexRange2D, format::CellFormat)::Dict{Any,Any}

Formats a range of cells.

Arguments

client::GoogleSheetsClient: client.
range::CellIndexRange2D: cell index range.
format::CellFormat: cell format.

source

GoogleSheets.format_conditional! — Function

format_conditional!(client::GoogleSheetsClient, range::CellIndexRange2D, format::CellFormat, 
    condition_type::ConditionType, values...)::Dict{Any,Any}

Formats a range of cells if a condition is met.

Arguments

client::GoogleSheetsClient: client.
range::CellIndexRange2D: cell index range.
format::CellFormat: cell format.
condition_type::ConditionType: type of condition.
values...: values for the condition.

source

GoogleSheets.format_color_gradient! — Function

format_color_gradient!(client::GoogleSheetsClient, range::CellIndexRange2D; 
    min_color::Colorant=colorant"salmon", min_value_type::ValueType=VALUE_TYPE_MIN, min_value::Union{Nothing,Number}=nothing, 
    mid_color::Union{Nothing,Colorant}=nothing, mid_value_type::Union{Nothing,ValueType}=nothing, mid_value::Union{Nothing,Number}=nothing, 
    max_color::Colorant=colorant"springgreen", max_value_type::ValueType=VALUE_TYPE_MAX, max_value::Union{Nothing,Number}=nothing)::Dict{Any,Any}

Sets color gradient formatting.

Arguments

client::GoogleSheetsClient: client.
range::CellIndexRange2D: cell index range.
min_color::Colorant=colorant"salmon": color for the minimum value.
min_value_type::ValueType=VALUE_TYPE_MIN: minimum value type.
min_value::Union{Nothing,Number}=nothing: minimum value.
mid_color::Union{Nothing,Colorant}=nothing: color for the mid value.
mid_value_type::Union{Nothing,ValueType}=nothing: mid value type.
mid_value::Union{Nothing,Number}=nothing: mid value.
max_color::Colorant=colorant"springgreen": color for the maximum value.
max_value_type::ValueType=VALUE_TYPE_MAX: maximum value type.
max_value::Union{Nothing,Number}=nothing: maximum value.

source

GoogleSheets.update_default_rate_limiter — Function

update_default_rate_limiter(rate_limiter_tokens_per_sec::Float64; rate_limiter_max_tokens::Float64=5)

Update the default rate limiter.

Arguments

rate_limiter_tokens_per_sec::Float64: rate limiter number of tokens per second.
rate_limiter_max_tokens::Float64=5: rate limiter max number of tokens.

source

update_default_rate_limiter(rate_limiter_read::AbstractRateLimiter, rate_limiter_write::AbstractRateLimiter)

Update the default rate limiter.

Arguments

rate_limiter_read::AbstractRateLimiter: rate limiter for reading.
rate_limiter_write::AbstractRateLimiter: rate limiter for writing.

source

GoogleSheets.credentials_file — Function

credentials_file()::String

Gets the credentials file needed to log into Google. The file is loaded from the GOOGLESHEETSCREDENTIALS environment variable if it is present; otherwise, it is loaded from the configuration directory, which defaults to ~/.julia/config/google_sheets/.

See the python quick start reference for a link to generate credentials. https://developers.google.com/sheets/api/quickstart/python

See the API credentials page to create or revoke credentials. https://console.developers.google.com/apis/credentials

source

Index

DataFrames.DataFrame
GoogleSheets.AuthScope
GoogleSheets.CellFormat
GoogleSheets.CellIndexRange1D
GoogleSheets.CellIndexRange2D
GoogleSheets.CellRange
GoogleSheets.CellRangeValues
GoogleSheets.CellRanges
GoogleSheets.ConditionType
GoogleSheets.GoogleSheetsClient
GoogleSheets.NumberFormatType
GoogleSheets.Sheet
GoogleSheets.Spreadsheet
GoogleSheets.UpdateSummary
GoogleSheets.ValueType
Base.append!
Base.get
Base.show
GoogleSheets.add_sheet!
GoogleSheets.batch_update!
GoogleSheets.clear!
GoogleSheets.credentials_file
GoogleSheets.delete_cols!
GoogleSheets.delete_rows!
GoogleSheets.delete_sheet!
GoogleSheets.format!
GoogleSheets.format_color_gradient!
GoogleSheets.format_conditional!
GoogleSheets.freeze!
GoogleSheets.insert_cols!
GoogleSheets.insert_rows!
GoogleSheets.meta
GoogleSheets.sheet_names
GoogleSheets.sheets
GoogleSheets.sheets_client
GoogleSheets.update!
GoogleSheets.update_default_rate_limiter