LogoLogo
HomeAcademyLoginTry for free
  • Welcome
  • What's new
    • Q2 2025
    • Q1 2025
    • Q4 2024
    • Q3 2024
    • Q2 2024
    • Q1 2024
    • Q4 2023
    • Q3 2023
    • Q2 2023
    • Q1 2023
    • Q4 2022
    • Q3 2022
  • FAQs
    • Accounts
    • Migration to the new platform
    • User & organization setup
    • General
    • Builder
    • Workflows
    • Data Observatory
    • Analytics Toolbox
    • Development Tools
    • Deployment Options
    • CARTO Basemaps
    • CARTO for Education
    • Support Packages
    • Security and Compliance
  • Getting started
    • What is CARTO?
    • Quickstart guides
      • Connecting to your data
      • Creating your first map
      • Creating your first workflow
      • Developing your first application
    • CARTO Academy
  • CARTO User Manual
    • Overview
      • Creating your CARTO organization
      • CARTO Cloud Regions
      • CARTO Workspace overview
    • Maps
      • Data sources
        • Simple features
        • Spatial Indexes
        • Pre-generated tilesets
        • Rasters
        • Defining source spatial data
        • Managing data freshness
        • Changing data source location
      • Layers
        • Point
          • Grid point aggregation
          • H3 point aggregation
          • Heatmap point aggregation
          • Cluster point aggregation
        • Polygon
        • Line
        • Grid
        • H3
        • Raster
        • Zoom to layer
      • Widgets
        • Formula widget
        • Category widget
        • Pie widget
        • Histogram widget
        • Range widget
        • Time Series widget
        • Table widget
      • SQL Parameters
        • Date parameter
        • Text parameter
        • Numeric parameter
        • Publishing SQL parameters
      • Interactions
      • Legend
      • Basemaps
        • Basemap selector
      • AI Agents
      • SQL analyses
      • Map view modes
      • Map description
      • Feature selection tool
      • Search locations
      • Measure distances
      • Exporting data
      • Download PDF reports
      • Managing maps
      • Sharing and collaboration
        • Editor collaboration
        • Map preview for editors
        • Map settings for viewers
        • Comments
        • Embedding maps
        • URL parameters
      • Performance considerations
    • Workflows
      • Workflow canvas
      • Results panel
      • Components
        • Aggregation
        • Custom
        • Data Enrichment
        • Data Preparation
        • Generative AI
        • Input / Output
        • Joins
        • Parsers
        • Raster Operations
        • Spatial Accessors
        • Spatial Analysis
        • Spatial Constructors
        • Spatial Indexes
        • Spatial Operations
        • Statistics
        • Tileset Creation
        • BigQuery ML
        • Snowflake ML
        • Google Earth Engine
        • Google Environment APIs
        • Telco Signal Propagation Models
      • Data Sources
      • Scheduling workflows
      • Sharing workflows
      • Using variables in workflows
      • Executing workflows via API
      • Temporary data in Workflows
      • Extension Packages
      • Managing workflows
      • Workflows best practices
    • Data Explorer
      • Creating a map from your data
      • Importing data
        • Importing rasters
      • Geocoding data
      • Optimizing your data
    • Data Observatory
      • Terminology
      • Browsing the Spatial Data Catalog
      • Subscribing to public and premium datasets
      • Accessing free data samples
      • Managing your subscriptions
      • Accessing your subscriptions from your data warehouse
        • Access data in BigQuery
        • Access data in Snowflake
        • Access data in Databricks
        • Access data in Redshift
        • Access data in PostgreSQL
    • Connections
      • Google BigQuery
      • Snowflake
      • Databricks
      • Amazon Redshift
      • PostgreSQL
      • CARTO Data Warehouse
      • Sharing connections
      • Deleting a connection
      • Required permissions
      • IP whitelisting
      • Customer data responsibilities
    • Applications
    • Settings
      • Understanding your organization quotas
      • Activity Data
        • Activity Data Reference
        • Activity Data Examples
        • Activity Data Changelog
      • Users and Groups
        • Inviting users to your organization
        • Managing user roles
        • Deleting users
        • SSO
        • Groups
        • Mapping groups to user roles
      • CARTO Support Access
      • Customizations
        • Customizing appearance and branding
        • Configuring custom color palettes
        • Configuring your organization basemaps
        • Enabling AI Agents
      • Advanced Settings
        • Managing applications
        • Configuring S3 Bucket for Redshift Imports
        • Configuring OAuth connections to Snowflake
        • Configuring OAuth U2M connections to Databricks
        • Configuring S3 Bucket integration for RDS for PostgreSQL Exports in Builder
        • Configuring Workload Identity Federation for BigQuery
      • Data Observatory
      • Deleting your organization
    • Developers
      • Managing Credentials
        • API Base URL
        • API Access Tokens
        • SPA OAuth Clients
        • M2M OAuth Clients
      • Named Sources
  • Data and Analysis
    • Analytics Toolbox Overview
    • Analytics Toolbox for BigQuery
      • Getting access
        • Projects maintained by CARTO in different BigQuery regions
        • Manual installation in your own project
        • Installation in a Google Cloud VPC
        • Core module
      • Key concepts
        • Tilesets
        • Spatial indexes
      • SQL Reference
        • accessors
        • clustering
        • constructors
        • cpg
        • data
        • http_request
        • import
        • geohash
        • h3
        • lds
        • measurements
        • placekey
        • processing
        • quadbin
        • random
        • raster
        • retail
        • routing
        • s2
        • statistics
        • telco
        • tiler
        • transformations
      • Guides
        • Running queries from Builder
        • Working with Raster data
      • Release notes
      • About Analytics Toolbox regions
    • Analytics Toolbox for Snowflake
      • Getting access
        • Native App from Snowflake's Marketplace
        • Manual installation
      • Key concepts
        • Spatial indexes
        • Tilesets
      • SQL Reference
        • accessors
        • clustering
        • constructors
        • data
        • http_request
        • import
        • h3
        • lds
        • measurements
        • placekey
        • processing
        • quadbin
        • random
        • raster
        • retail
        • s2
        • statistics
        • tiler
        • transformations
      • Guides
        • Running queries from Builder
        • Working with Raster data
      • Release Notes
    • Analytics Toolbox for Databricks
      • Getting access
        • Personal (former Single User) cluster
        • Standard (former Shared) cluster
      • Reference
        • lds
        • tiler
      • Guides
      • Release Notes
    • Analytics Toolbox for Redshift
      • Getting access
        • Manual installation in your database
        • Installation in an Amazon Web Services VPC
        • Core version
      • Key concepts
        • Tilesets
        • Spatial indexes
      • SQL Reference
        • clustering
        • constructors
        • data
        • http_request
        • import
        • lds
        • placekey
        • processing
        • quadbin
        • random
        • s2
        • statistics
        • tiler
        • transformations
      • Guides
        • Running queries from Builder
      • Release Notes
    • Analytics Toolbox for PostgreSQL
      • Getting access
        • Manual installation
        • Core version
      • Key concepts
        • Tilesets
        • Spatial Indexes
      • SQL Reference
        • h3
        • quadbin
        • tiler
      • Guides
        • Creating spatial index tilesets
        • Running queries from Builder
      • Release Notes
    • CARTO + Python
      • Installation
      • Authentication Methods
      • Visualizing Data
      • Working with Data
        • How to work with your data in the CARTO Data Warehouse
        • How to access your Data Observatory subscriptions
        • How to access CARTO's Analytics Toolbox for BigQuery and create visualizations via Python notebooks
        • How to access CARTO’s Analytics Toolbox for Snowflake and create visualizations via Python notebooks
        • How to visualize data from Databricks
      • Reference
    • CARTO QGIS Plugin
  • CARTO for Developers
    • Overview
    • Key concepts
      • Architecture
      • Libraries and APIs
      • Authentication methods
        • API Access Tokens
        • OAuth Access Tokens
        • OAuth Clients
      • Connections
      • Data sources
      • Visualization with deck.gl
        • Basemaps
          • CARTO Basemap
          • Google Maps
            • Examples
              • Gallery
              • Getting Started
              • Basic Examples
                • Hello World
                • BigQuery Tileset Layer
                • Data Observatory Tileset Layer
              • Advanced Examples
                • Arc Layer
                • Extrusion
                • Trips Layer
            • What's New
          • Amazon Location
            • Examples
              • Hello World
              • CartoLayer
            • What's New
        • Rapid Map Prototyping
      • Charts and widgets
      • Filtering and interactivity
      • Summary
    • Quickstart
      • Make your first API call
      • Visualize your first dataset
      • Create your first widget
    • Guides
      • Build a public application
      • Build a private application
      • Build a private application using SSO
      • Visualize massive datasets
      • Integrate CARTO in your existing application
      • Use Boundaries in your application
      • Avoid exposing SQL queries with Named Sources
      • Managing cache in your CARTO applications
    • Reference
      • Deck (@deck.gl reference)
      • Data Sources
        • vectorTableSource
        • vectorQuerySource
        • vectorTilesetSource
        • h3TableSource
        • h3QuerySource
        • h3TilesetSource
        • quadbinTableSource
        • quadbinQuerySource
        • quadbinTilesetSource
        • rasterSource
        • boundaryTableSource
        • boundaryQuerySource
      • Layers (@deck.gl/carto)
      • Widgets
        • Data Sources
        • Server-side vs. client-side
        • Models
          • getFormula
          • getCategories
          • getHistogram
          • getRange
          • getScatter
          • getTimeSeries
          • getTable
      • Filters
        • Column filters
        • Spatial filters
      • CARTO APIs Reference
    • Release Notes
    • Examples
    • CARTO for React
      • Guides
        • Getting Started
        • Views
        • Data Sources
        • Layers
        • Widgets
        • Authentication and Authorization
        • Basemaps
        • Look and Feel
        • Query Parameters
        • Code Generator
        • Sample Applications
        • Deployment
        • Upgrade Guide
      • Examples
      • Library Reference
        • Introduction
        • API
        • Auth
        • Basemaps
        • Core
        • Redux
        • UI
        • Widgets
      • Release Notes
  • CARTO Self-Hosted
    • Overview
    • Key concepts
      • Architecture
      • Deployment requirements
    • Quickstarts
      • Single VM deployment (Kots)
      • Orchestrated container deployment (Kots)
      • Advanced Orchestrated container deployment (Helm)
    • Guides
      • Guides (Kots)
        • Configure your own buckets
        • Configure an external in-memory cache
        • Enable Google Basemaps
        • Enable the CARTO Data Warehouse
        • Configure an external proxy
        • Enable BigQuery OAuth connections
        • Configure Single Sign-On (SSO)
        • Use Workload Identity in GCP
        • High availability configuration for CARTO Self-hosted
        • Configure your custom service account
      • Guides (Helm)
        • Configure your own buckets (Helm)
        • Configure an external in-memory cache (Helm)
        • Enable Google Basemaps (Helm)
        • Enable the CARTO Data Warehouse (Helm)
        • Configure an external proxy (Helm)
        • Enable BigQuery OAuth connections (Helm)
        • Configure Single Sign-On (SSO) (Helm)
        • Use Workload Identity in GCP (Helm)
        • Use EKS Pod Identity in AWS (Helm)
        • Enable Redshift imports (Helm)
        • Migrating CARTO Self-hosted installation to an external database (Helm)
        • Advanced customizations (Helm)
        • Configure your custom service account (Helm)
    • Maintenance
      • Maintenance (Kots)
        • Updates
        • Backups
        • Uninstall
        • Rotating keys
        • Monitoring
        • Change the Admin Console password
      • Maintenance (Helm)
        • Monitoring (Helm)
        • Rotating keys (Helm)
        • Uninstall (Helm)
        • Backups (Helm)
        • Updates (Helm)
    • Support
      • Get debug information for Support (Kots)
      • Get debug information for Support (Helm)
    • CARTO Self-hosted Legacy
      • Key concepts
        • Architecture
        • Deployment requirements
      • Quickstarts
        • Single VM deployment (docker-compose)
      • Guides
        • Configure your own buckets
        • Configure an external in-memory cache
        • Enable Google Basemaps
        • Enable the CARTO Data Warehouse
        • Configure an external proxy
        • Enable BigQuery OAuth connections
        • Configure Single Sign-On (SSO)
        • Enable Redshift imports
        • Configure your custom service account
        • Advanced customizations
        • Migrating CARTO Self-Hosted installation to an external database
      • Maintenance
        • Updates
        • Backups
        • Uninstall
        • Rotating keys
        • Monitoring
      • Support
    • Release Notes
  • CARTO Native App for Snowflake Containers
    • Deploying CARTO using Snowflake Container Services
  • Get Help
    • Legal & Compliance
    • Previous libraries and components
    • Migrating your content to the new CARTO platform
Powered by GitBook
On this page
  • Solar API Building Insights
  • Air Quality API Current Conditions
  • Air Quality API Forecast
  • Air Quality API History
  • Pollen API Forecast

Was this helpful?

Export as PDF
  1. CARTO User Manual
  2. Workflows
  3. Components

Google Environment APIs

Extension Package provided by CARTO

PreviousGoogle Earth EngineNextTelco Signal Propagation Models

Last updated 2 months ago

Was this helpful?

This extension provides powerful Google Environment APIs integration for spatial analysis.

It includes components for integrating usage of Google Solar API, Air Quality API and Pollen API into geospatial analytics pipelines created with Workflows.

These component make use of cloud functions deployed and maintained by CARTO on a GCP project.

Usage of these functions is limited to 1000/month per connection.

These functions are available for the US BigQuery region.

Please get in touch with us at if you need to deploy your own version of the functions.

Solar API Building Insights

Description

This component retrieves data from the Building Insights endpoint in Google Solar API for a set of points in a table. It will return data from buildings that intersects with the points in the input table. Find more information about Solar API .

Inputs

  • Source table: A table that contains points that will be used to get data from Solar API

Settings

  • Geography column: A column in the the input table that contains the points to be used to get data from Solar API.

  • Google Maps Platform API Key: A with access to Solar API

  • Required quality: The minimum quality level allowed in the results. No result with lower quality than this will be returned. Not specifying this is equivalent to restricting to HIGH quality only.

  • Fields from response: A list of fields to be included in the JSON response. Each field should follow the JSON path of the , and the result will preserve the same structure. Find a complete reference of available values . Example: imageryDate, solarPotential.panelCapacityWatts, solarPotential.buildingStats.areaMeters2

Output

  • Result table: A table with the same columns as the source table plus a column that contains a JSON object with the requested properties.

Air Quality API Current Conditions

Description

Inputs

  • Source table: A table that contains points that will be used to get data from Air Quality API

Settings

  • Geography column: A column in the the input table that contains the points to be used to get data from Solar API.

  • Universal Air Quality Index: Optional. Check this option to include the Universal Air Quality Index in the response.

  • Local Air Quality Index: Optional. Check this option to include a Local Air Quality Index in the response, based on each point location. Checking this option automatically adds the LOCAL_AQI extra computation.

  • Universal AQI color palette: Optional. Select a color palette for the Universal Air Quality Index. Only applies if Universal AQI is requested.

Output

Air Quality API Forecast

Description

Inputs

  • Source table: A table that contains points that will be used to get data from Air Quality API

Settings

  • Geography column: A column in the the input table that contains the points to be used to get data from Solar API.

  • Range Type: Select 'Period' or 'Date time' to define the type of forecast to be obtained from the API.

  • Start Time: Defines a start time. Only applies if 'Period' is selected.

  • End Time: Defines an end time. Only applies if 'Period' is selected.

  • Date Time: Defines a specific timestamp to be used for the forescast. Only applies if 'Date time' is selected.

  • Universal Air Quality Index: Optional. Check this option to include the Universal Air Quality Index in the response.

  • Local Air Quality Index: Optional. Check this option to include a Local Air Quality Index in the response, based on each point location. Checking this option automatically adds the LOCAL_AQI extra computation.

  • Universal AQI color palette: Optional. Select a color palette for the Universal Air Quality Index. Only applies if Universal AQI is requested.

Output

Air Quality API History

Description

Inputs

  • Source table: A table that contains points that will be used to get data from Air Quality API

Settings

  • Geography column: A column in the the input table that contains the points to be used to get data from Solar API.

  • Range Type: Select 'Period', 'Date time', or 'Hours' to define the type of forecast to be obtained from the API.

  • Start Time: Defines a start time. Only applies if 'Period' is selected.

  • End Time: Defines an end time. Only applies if 'Period' is selected.

  • Date Time: Defines a specific timestamp to be used for the forescast. Only applies if 'Date time' is selected.

  • Hours: Defines a number of hours starting from the current time to the get the forecast. Only applies if 'Hours' is selected.

  • Universal Air Quality Index: Optional. Check this option to include the Universal Air Quality Index in the response.

  • Local Air Quality Index: Optional. Check this option to include a Local Air Quality Index in the response, based on each point location. Checking this option automatically adds the LOCAL_AQI extra computation.

  • Universal AQI color palette: Optional. Select a color palette for the Universal Air Quality Index. Only applies if Universal AQI is requested.

Output

Pollen API Forecast

Description

This component retrieves data from the Forecast endpoint in Google Pollen API for a set of points in a table.

Inputs

  • Source table: A table that contains points that will be used to get data from Pollen API

Settings

  • Geography column: A column in the the input table that contains the points to be used to get data from Solar API.

  • Days: Set a number of days (up to 4) to get a Pollen forecast.

Output

This component retrieves data from the Current Conditions endpoint in Google Air Quality API for a set of points in a table. Find more information about Air Quality API .

Google Maps Platform API Key: A with access to Air Quality API

Additional computations: Optional. Add a list of to be added to the result. Example: HEALTH_RECOMMENDATIONS, DOMINANT_POLLUTANT_CONCENTRATION

Language Code: Optional. Type a to be used in the response. Example: es for Spanish.

Custom Local AQI: Optional. Type a JSON object that defines a custom local AQI. Only applies if Local AQI is requested. Find a complete reference of custom local AQIs . Example: {"regionCode": "us", "aqi": "usa_epa_nowcast"}

Result table: A table with the same columns as the source table plus a column that contains a JSON object with the response. Find a reference of the expected response .

This component retrieves data from the Forecast endpoint in Google Air Quality API for a set of points in a table. Find more information about Air Quality API .

Google Maps Platform API Key: A with access to Air Quality API.

Additional computations: Optional. Add a list of to be added to the result. Example: HEALTH_RECOMMENDATIONS, DOMINANT_POLLUTANT_CONCENTRATION

Language Code: Optional. Type a to be used in the response. Example: es for Spanish.

Custom Local AQI: Optional. Type a JSON object that defines a custom local AQI. Only applies if Local AQI is requested. Find a complete reference of custom local AQIs . Example: {"regionCode": "us", "aqi": "usa_epa_nowcast"}

Result table: A table with the same columns as the source table plus a column that contains a JSON object with the response. Find a reference of the expected response .

This component retrieves data from the History endpoint in Google Air Quality API for a set of points in a table. Find more information about Air Quality API .

Google Maps Platform API Key: A with access to Air Quality API

Additional computations: Optional. Add a list of to be added to the result. Example: HEALTH_RECOMMENDATIONS, DOMINANT_POLLUTANT_CONCENTRATION

Language Code: Optional. Type a to be used in the response. Example: es for Spanish.

Custom Local AQI: Optional. Type a JSON object that defines a custom local AQI. Only applies if Local AQI is requested. Find a complete reference of custom local AQIs . Example: {"regionCode": "us", "aqi": "usa_epa_nowcast"}

Result table: A table with the same columns as the source table plus a column that contains a JSON object with the response. Find a reference of the expected response .

Google Maps Platform API Key: A with access to Pollen API

Language Code: Optional. Type a to be used in the response. Example: es for Spanish.

Include Plants Description: Check this option to include a in the response.

Result table: A table with the same columns as the source table plus a column that contains a JSON object with the response. Find a reference of the expected response .

support@carto.com
here
Google Maps Platform API Key
full response object
here
here
Google Maps Platform API Key
additional computations
IETF standard language code
here
here
here
Google Maps Platform API Key
additional computations
IETF standard language code
here
here
here
Google Maps Platform API Key
additional computations
IETF standard language code
here
here
Google Maps Platform API Key
IETF standard language code
plant's description
here