Method: videos.renderVideo

  • Sends a POST request to render a video of a US postal address using the Aerial View API.

  • The request body requires a JSON object with a mandatory "address" field containing the US postal address.

  • The response indicates the render request status and, if successful, includes video metadata in the response body.

  • If a video for the given address has already been rendered, the response returns metadata directly without initiating a new render.

Adds an address to the renderer's queue if a video hasn't already been rendered. Otherwise, returns metadata about the video.

HTTP request

POST https://aerialview.googleapis.com/v1/videos:renderVideo

The URL uses gRPC Transcoding syntax.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "address": string
}
Fields
address

string

Required. A US postal address for the location to be rendered in the video.

Response body

Response message for AerialView.RenderVideo.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "state": enum (State),
  "metadata": {
    object (VideoMetadata)
  }
}
Fields
state

enum (State)

Current state of the render request.
metadata

object (VideoMetadata)

Contains the video's metadata, only set if the state is ACTIVE.