Package google.maps.aerialview.v1

Index

AerialView(interface)
LookupVideoMetadataRequest(message)
LookupVideoRequest(message)
MediaFormat(enum)
RenderVideoRequest(message)
RenderVideoResponse(message)
Uris(message)
Video(message)
Video.State(enum)
VideoMetadata(message)

AerialView

Service definition for the Aerial View API.

LookupVideo

LookupVideo
`rpc LookupVideo(LookupVideoRequest) returns (Video)` Fetches a video given its address or videoId. The response will either be a video with a set of playback URIs for ACTIVE videos, a PROCESSING state for pending videos, or a 404 error if the video does not exist. Receiving a video is a billable event, so callers of this method should be ready to use the returned URIs at the time of request. Authorization scopes Requires the following OAuth scope: `https:// googleapis /auth/cloud-platform`

rpc LookupVideo(LookupVideoRequest) returns (Video)

Fetches a video given its address or videoId. The response will either be a video with a set of playback URIs for ACTIVE videos, a PROCESSING state for pending videos, or a 404 error if the video does not exist. Receiving a video is a billable event, so callers of this method should be ready to use the returned URIs at the time of request.

Authorization scopes

Requires the following OAuth scope:

https:// googleapis /auth/cloud-platform

LookupVideoMetadata

rpc LookupVideoMetadata(LookupVideoMetadataRequest) returns (VideoMetadata)

Fetches metadata for a video given its address or videoId. This method is a free-to-call alternative toLookupVideo,and returns all available video data excluding playback URIs.

Authorization scopes

Requires the following OAuth scope:

https:// googleapis /auth/cloud-platform

RenderVideo

RenderVideo
`rpc RenderVideo(RenderVideoRequest) returns (RenderVideoResponse)` Adds an address to the renderer's queue if a video hasn't already been rendered. Otherwise, returns metadata about the video. Authorization scopes Requires the following OAuth scope: `https:// googleapis /auth/cloud-platform`

rpc RenderVideo(RenderVideoRequest) returns (RenderVideoResponse)

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

Authorization scopes

Requires the following OAuth scope:

https:// googleapis /auth/cloud-platform

LookupVideoMetadataRequest

Request message forAerialView.LookupVideoMetadata.

Fields

Union fieldkey.Required.keycan be only one of the following:

video_id

string

An ID returned fromRenderVideo.

address

string

A US postal address.

LookupVideoRequest

Request message forAerialView.LookupVideo.

Fields

Fields
Union field`key`.Required. A key used to look-up a video.`key`can be only one of the following:
`video_id`	`string` An ID returned from`RenderVideo`.
`address`	`string` A US postal address.

Union fieldkey.Required. A key used to look-up a video.keycan be only one of the following:

video_id

string

An ID returned fromRenderVideo.

address

string

A US postal address.

MediaFormat

Enumerates the various media formats supported by the API.

Enums
`MEDIA_FORMAT_UNSPECIFIED`	Default value.
`IMAGE`	A thumbnail image.
`MP4_HIGH`	High quality MP4 video.
`MP4_MEDIUM`	Medium quality MP4 video.
`MP4_LOW`	Low quality MP4 video.
`DASH`	MPEG-DASH for adaptive bitrate streaming on most devices.
`HLS`	HLS for adaptive bitrate streaming on Apple devices.

RenderVideoRequest

Request message forAerialView.RenderVideo.

Fields

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

address

string

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

RenderVideoResponse

Response message forAerialView.RenderVideo.

Fields

Fields
`state`	`State` Current state of the render request.
`metadata`	`VideoMetadata` Contains the video's metadata, only set if the state is`ACTIVE`.

state

State

Current state of the render request.

metadata

VideoMetadata

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

Uris

Contains all the uris for a given video format.

Fields

Fields
`landscape_uri`	`string` A signed short-lived URI for the media in a landscape orientation.
`portrait_uri`	`string` A signed short-lived URI for the media in a portrait orientation.

landscape_uri

string

A signed short-lived URI for the media in a landscape orientation.

portrait_uri

string

A signed short-lived URI for the media in a portrait orientation.

Video

An object that encapsulates all of the data about a video.

Fields

Fields
`uris`	`map<string,Uris>` A mapping of media types to their URIs. This field is only included for`ACTIVE`videos. The key is an enum value from`MediaFormat`.
`state`	`State` Current state of the render request.
`metadata`	`VideoMetadata` Contains the video's metadata, only set if the state is`ACTIVE`.

uris

map<string,Uris>

A mapping of media types to their URIs. This field is only included forACTIVEvideos. The key is an enum value fromMediaFormat.

state

State

Current state of the render request.

metadata

VideoMetadata

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

State

The different states a video can be in.

Enums
`STATE_UNSPECIFIED`	Default value. This value is unused.
`PROCESSING`	The video is currently processing.
`ACTIVE`	The video has finished rendering, and can be viewed through`LookupVideo`.
`FAILED`	The video has failed to render.

VideoMetadata

Contains metadata about a video, such as its videoId and duration.

Fields
`video_id`	`string` Output only. An ID for the video, and the recommended way to retrieve a video.
`capture_date`	`Date` Output only. The date at which the imagery used in the video was captured. This will be at a month-level granularity.
`duration`	`Duration` Output only. The length of the video.
`state`	`State` Output only. Current state of the render request.