Générer une vidéo

La méthode renderVideo demande la génération d'une vidéo de vue aérienne pour l'adresse postale américaine spécifiée. Si la vidéo existe déjà pour l'adresse spécifiée, cette méthode renvoie des métadonnées à son sujet.

Utiliser l'API

Générez une vidéo aérienne en envoyant une requête HTTPS POST au point de terminaison renderVideo, en transmettant votre clé API et une adresse postale américaine, comme indiqué dans l'exemple suivant. Le processus de rendu peut prendre entre une heure et quelques heures.

curl -X POST -d '{
  "address": "POSTAL_ADDRESS"
}' \
-H 'Content-Type: application/json' \
"https://aerialview.googleapis.com/v1/videos:renderVideo?key=YOUR_API_KEY"

Exemple de requête

L'exemple de code suivant demande la génération d'une vidéo de vue aérienne pour 500 W 2nd St, Austin, TX, 78701.

curl -X POST -d '{
  "address": "500 W 2nd St, Austin, TX 78701"
}' \
-H 'Content-Type: application/json' \
"https://aerialview.googleapis.com/v1/videos:renderVideo?key=YOUR_API_KEY"

Exemple de réponse

Les exemples de code JSON suivants montrent les réponses possibles à l'exemple de requête vidéo.

Réponse d'adresse incorrecte

L'adresse est incorrecte ou ne se trouve pas aux États-Unis.

{
  "error": {
    "code": 400,
    "message": "Address not supported.",
    "status": "INVALID_ARGUMENT"
  }
}

Traitement de la réponse

L'API Aerial View est en train de générer votre vidéo. La réponse contient l'videoId, que vous pouvez utiliser pour récupérer la vidéo.

{
  "state": "PROCESSING",
  "metadata": {
    "videoId": "x89iJAJi1wzs7DIAFQF7Va"
  }
}

Le processus de rendu peut prendre entre une et plusieurs heures. Si la vidéo est toujours en cours de traitement, vous pouvez utiliser lookupVideo pour interroger l'état de la vidéo jusqu'à ce qu'elle renvoie l'état ACTIVE.

Pour interroger, envoyez une requête à lookupVideo en transmettant videoId. Le rendu peut prendre plusieurs heures. Utilisez donc un intervalle exponentiel entre les tentatives pour espacer vos appels.

Réponse active

Lorsque renderVideo renvoie une valeur state de ACTIVE, cela signifie que le rendu de la vidéo est terminé et que vous pouvez la récupérer en appelant lookupVideo avec videoId.

{
  "state": "ACTIVE",
  "metadata": {
    "videoId": "x89iJAJi1wzs7DIAFQF7Va"
  }
}