Get Started Contact sales

    Method: videos.lookupVideo

    • Fetches a video using its address or videoId, returning playback URIs for active videos or a processing state for pending ones.

    • The response includes a set of URIs for different media types if the video is active, along with its current state and metadata.

    • A 404 error is returned if the video does not exist, and receiving a video is a billable event.

    • The request utilizes a GET method with the endpoint https://aerialview.googleapis.com/v1/videos:lookupVideo and requires either a videoId or address as a query parameter.

    • The response body provides the video's URIs (if active), state, and metadata.

    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.

    HTTP request

    GET https://aerialview.googleapis.com/v1/videos:lookupVideo

    The URL uses gRPC Transcoding syntax.

    Query parameters

    Parameters
    Union parameter key . Required. A key used to look-up a video. key can be only one of the following:
    videoId

    string

    An ID returned from videos.renderVideo .

    address

    string

    A US postal address.

    Request body

    The request body must be empty.

    Response body

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

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

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

    map (key: string, value: object ( 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 .

    An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" } .
    state

    enum ( State )

    Current state of the render request.
    metadata

    object ( VideoMetadata )

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

    Uris

    Contains all the uris for a given video format.

    JSON representation 
     { 
 "landscapeUri" 
 : 
 string 
 , 
 "portraitUri" 
 : 
 string 
 }
    Fields
    landscapeUri

    string

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

    string

    A signed short-lived URI for the media in a portrait orientation.
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: