How-to Guides

Setting up

• Setting Up Your Development Environment

  Learn how to set up your environment for developing Python 2.7 apps that run on the Google App Engine Standard Environment.

• Setting up your Google Cloud project for App Engine

  Create a Google Cloud Platform project and set up App Engine resources.

Developing Python Apps on App Engine

• Using the Local Development Server

  Run the development server locally to simulate your application running in production.

• Local Unit Testing

  Run tests inside your own development environment without involving remote components.

• Testing Handlers

  Test your request handlers without requiring a full App Engine environment.

• Monitoring Latency with Cloud Trace

  Collect latency data from your application and view it in the Google Cloud Platform Console.

• Detecting Outages and Downtime with the Capabilities API

  Reduce downtime in your application by detecting when a capability is unavailable and then bypassing it.

• Configuring Dashboards and Alerts with Cloud Monitoring

  Collect metrics, events, and metadata from Google Cloud Platform to generate insights via dashboards, charts, and alerts.

• Integrating with Google Analytics

  Measure user interactions with your business across various devices and environments.

• Downloading Logs

  Download log data to perform more detailed analysis of your application.

Managing and Configuring Your App

• Deploying Your App

  Use the appconfig command to deploy your app.

• Splitting Traffic

  Distribute traffic across two or more versions of a module to control roll out of features or conduct A/B testing.

• Migrating Traffic

  Gradually move traffic from an old version of a service to a new version of the service.

• Granting Project Access

  Provide role-based access to your Google Cloud Platform project and its resources.

• Using Custom Domains and SSL

  Add a custom domain for your application and optional set up SSL for the custom domain.

• Managing App Resources

  Understand your application's performance and manage the resources your application is using.

• Configuring Your App With app.yaml

  Configure your application's settings.

• Using the Admin API

  Provision and manage your application using the Admin API.

• Using the Modules API

  Programmatically retrieve information about the current operating environment, modules (now called "services"), or instances.

• Downloading Your Source Code

  Download the source code of your deployed app.

Storing Data

• Choosing a Storage Option

  Decide which storage option to use in your app.

• Datastore Overview

  Understand Datastore.

• Creating, Retrieving, Updating, and Deleting Entities

  Store, delete and retrieve entities in Datastore.

• Manage Datastore from the Console

  Perform Datastore administration, backups and restores from the Google Cloud Platform Console.

• Configuring Datastore Indexes

  Create and manage the indexes used in your application.

• DB to NDB Client Library Migration

  Migrate your application from the DB Client Library to the NDB Client Library.

• Using Cloud SQL for MySQL

  Store application data from your App Engine app in Cloud SQL for MySQL.

• Django Guide

  Use Cloud SQL instances with the Django web framework in your application.

• Setting Up Cloud Storage

  Set up Cloud Storage for your application's use.

• Reading and Writing to Cloud Storage

  Store and retrieve data using Cloud Storage in your app.

• Using Third-Party Databases

  Use third-party databases in your app.

Superseded Storage Options

• Blobstore Overview

  Understand the Blobstore API.

• Overview

  Understand the DB Client Library for Datastore.

• Entities, Properties, and Keys

  Work with data objects using the DB Client Library.

• Datastore Queries

  Understand queries using the DB Client Library.

• Retrieving Query Results

  Run queries using the DB Client Library.

• Query Data Consistency

  Understand consistency levels for results returned by queries.

• Query Cursors

  Retrieve a query's results in convenient batches.

• Query Restrictions

  Understand restrictions for queries in your application.

• Projection Queries

  Query Datastore for just the specific properties of an entity that you actually need.

• Datastore Indexes

  Understand how indexes are defined and structured.

• Datastore Transactions

  Perform multiple operations and calculations in a single transaction.

• Data Modeling

  Understand how to define data models and create instances of those models to be stored as entities.

• GQL Reference

  Understand the grammar used for GQL queries.

• Structuring Data for Strong Consistency

  Understand how to structure your application's data for strong consistency.

• Metadata

  Programmatically access metadata to support metaprogramming, implement backend administrative functions, and simplify consistent caching.

• Datastore Statistics

  Programmatically access the Datastore statistics for your application.

• Types and Property Classes

  Understand the datatypes and property classes in the DB Client Library.

• GQL Reference

  Understand the grammar used for GQL queries.

• Model

  Learn about the superclass class for data models in the DB Client Library.

• Expando

  Learn about the superclass for data model definitions whose properties are determined dynamically.

• PolyModel

  Learn about the superclass for data model definitions that can themselves be superclasses for other data model definitions.

• Property

  Learn about the superclass of property definitions for data models.

• Query

  Learn about the class that represents a query for retrieving entities from Datastore.

• GqlQuery

  Learn about the class that represents a GQL query for retrieving entities from Datastore.

• Metadata Entities

  Learn about classes that represent the results of getting or querying metadata kinds.

• Key

  Learn about the class that represents a unique key for a Datastore entity.

• Datastore Functions

  Learn about the functions available in the DB Client Library.

• Exceptions

  Learn about the exceptions provided by the DB Client Library.

• Async Datastore API

  Make parallel, non-blocking asynchronous calls using the DB Client Library.

Authenticating Users

• User Authentication Options

  Understand the different ways to authenticate users of your application.

• Users API Overview

  Learn about the Users API.

• User Objects

  Learn about the class that represents a user.

• Login URLs

  Construct URLs that allow the user to sign in or sign out.

• Admin Users

  Determine whether the currently signed-in user is a registered administrator.

Caching Application Data

• Memcache Overview

  Learn about the memcache service.

• Using Memcache

  Set and retrieve cached values.

• Memcache Examples

  Learn how to cache data.

Connecting to and from Your App

• Issuing HTTP(S) Requests

  Use the URL Fetch service to issue HTTP(S) requests.

• Connecting to a VPC network

  Learn how to use Serverless VPC Access to connect your App Engine standard environment app directly to your VPC.

• Connecting to a Shared VPC network

  Learn how to use Serverless VPC Access to connect your App Engine standard environment app directly to your Shared VPC.

• Outbound IP Addresses

  Learn about the outbound IP addresses App Engine uses.

• Identifying Your App to APIs and Services

  Discover and assert your application's project ID.

• Sockets API Overview

  Learn about the Sockets API.

• SSL Support

  Use Python OpenSSL in your application.

Manipulating Images

• Images API Overview

  Learn about the Images API.

• Images API Examples

  Perform common transforms on images.

Namespace-enabled Apps

• Namespaces API Overview

  Learn about the Namespaces API.

• Multitenancy with Namespaces

  Enable multitenancy in your application.

Sending Email

• Mail API Overview

  Learn about the Mail API.

• Sending Mail

  Send email from your application.

• Receiving Mail

  Processing incoming email.

• Receiving Bounce Notification

  Receive and handle email bounce notifications.

• Attachments

  Include attachments in email sent from your application.

• Headers

  Include headers in email sent from your application.

• Sending Email with SendGrid

  Send email from your application using SendGrid.

• Sending Email with Mailgun

  Send email from your application using MailGun.

• Sending Email with Mailjet

  Send email from your application using Mailjet.

Scheduling Work Outside of User Requests

• Scheduling Jobs with cron.yaml

  Configure regularly scheduled tasks to run in your application.

• Task Queue API Overview

  Learn about the Task Queue API.

• Using Push Queues

  Learn about push queues.

• Using Pull Queues

  Learn about pull queues.

Searchable Document Indexes

• Search API Overview

  Learn about the Search API.

• Installing an Example Search API Application

  Install and run a Search API sample.

• Search API Basics

  Create a search index, add content to it, and run a simple full-text search query.

• Getting Information About Your Search Indexes

  View the structure and content of your search indexes.

• Advanced Features of Search API

  Learn about advanced features of the Search API.

• More Complex Search API Queries

  Learn about complex queries supported by the Search API.

• Sorting Search Query Results

  Sort the results of a search query.

• Retrieving, Deleting, and Reindexing Documents

  Learn how to retrieve, delete, and re-index documents using the Search API.

• Documents and Indexes

  Learn about documents and indexes in the Search API.

• Query Strings

  Learn about query strings in the Search API.

• Query and Sorting Options

  Change how results are returned and sorted.

• Handling Search Results

  Handle query results and any exceptions returned by the Search API.

• Faceted Search

  Attach categorical information to your documents.

• Best Practices

  Learn about best practices for using the Search API.

• Using the Python Development Server

  Run the development server locally to emulate the Search API.

• Cursor

  Learn about the class that represents a cursor in the current set query results.

• Document

  Learn about the class that represents a document containing searchable content.

• Facet Classes

  Learn about the abstract base class and subclasses that represent facets of a document.

• FacetOptions

  Learn about the class that represents options for processing facet results of a query.

• FacetRange

  Learn about the class that provides a numeric range for a facet.

• FacetRefinement

  Learn about the class used to narrow search results based on a facet value.

• FacetResult

  Learn about the class that represents a result returned from a faceted search.

• FacetResultValue

  Learn about the class that represents a facet value as part of search result.

• Field Classes

  Learn about the abstract base class and subclasses that represent fields of a document.

• FieldExpression

  Learn about the class that allows you to compute customized content snippets for each result returned by a search.

• GeoPoint

  Learn about the class that represents a point on the earth's surface represented by latitude and longitude coordinates.

• GetResponse

  Learn about the class that represents the results of methods invoked to return information about documents and indexes.

• Index

  Learn about the class that represents an index allowing documents to be indexed, deleted, and searched.

• MatchScorer

  Learn about the class that allows you to sort documents based on the quality of query match.

• Query

  Learn about the class that represents a request on the search service to query.

• QueryOptions

  Learn about the class that provides options for post-processing query results.

• RescoringMatchScorer

  Learn about the class that allows you to sort documents based on the quality of query match with a more complex scoring algorithm than provided by MatchScorer.

• ScoredDocument

  Learn about the class that represents a scored document returned from a search.

• SearchResults

  Learn about the class that represents the result of executing a search request.

• SortExpression

  Learn about the class that allows you to customize how your search results are sorted.

• SortOptions

  Learn about the class that represents a multi-dimensional sort of documents returned from a search.

• Functions

  Learn about the functions available in the Search API.

• Exceptions

  Learn about the exceptions provided by the Search API.

Reading and Writing Logs

• Reading and Writing Logs

  Learn how to read request logs and read and write application logs.