Method: videos.renderVideo
Stay organized with collections
Save and categorize content based on your preferences.
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:
| 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.
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-27 UTC.
[null,null,["Last updated 2025-08-27 UTC."],[[["\u003cp\u003eSends a POST request to render a video of a US postal address using the Aerial View API.\u003c/p\u003e\n"],["\u003cp\u003eThe request body requires a JSON object with a mandatory "address" field containing the US postal address.\u003c/p\u003e\n"],["\u003cp\u003eThe response indicates the render request status and, if successful, includes video metadata in the response body.\u003c/p\u003e\n"],["\u003cp\u003eIf a video for the given address has already been rendered, the response returns metadata directly without initiating a new render.\u003c/p\u003e\n"]]],[],null,["# Method: videos.renderVideo\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n - [JSON representation](#body.RenderVideoResponse.SCHEMA_REPRESENTATION)\n\nAdds an address to the renderer's queue if a video hasn't already been rendered. Otherwise, returns metadata about the video.\n\n### HTTP request\n\n`POST https://aerialview.googleapis.com/v1/videos:renderVideo`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation |\n|-------------------------------|\n| ``` { \"address\": string } ``` |\n\n| Fields ||\n|-----------|--------------------------------------------------------------------------------------|\n| `address` | `string` Required. A US postal address for the location to be rendered in the video. |\n\n### Response body\n\nResponse message for `AerialView.RenderVideo`.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"state\": enum (/maps/documentation/aerial-view/reference/rest/v1/State), \"metadata\": { object (/maps/documentation/aerial-view/reference/rest/v1/VideoMetadata) } } ``` |\n\n| Fields ||\n|------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `state` | `enum (`[State](/maps/documentation/aerial-view/reference/rest/v1/State)`)` Current state of the render request. |\n| `metadata` | `object (`[VideoMetadata](/maps/documentation/aerial-view/reference/rest/v1/VideoMetadata)`)` Contains the video's metadata, only set if the state is `ACTIVE`. |"]]
