Créer et gérer une configuration de vidéo à la demande

Cette page explique comment gérer les configurations de VOD. Les configurations de vidéo à la demande permettent de configurer les sessions à la demande. Pour en savoir plus, consultez la documentation REST.

Avant de commencer

Pour créer une session de vidéo à la demande, vous devez d'abord configurer un encodeur qui génère un fichier manifeste HLS ou DASH source pour l'élément de vidéo à la demande. Ces fichiers manifestes contiennent certains repères d'annonce aux limites des coupures publicitaires, identifiés par l'API Video Stitcher à des fins d'assemblage d'annonces. Vous pouvez utiliser l'API Transcoder pour créer une tâche de transcodage afin de générer des fichiers manifestes à partir de types de fichiers multimédias tels que MP4 ou MOV.

Pour en savoir plus sur les repères d'annonce HLS et DASH compatibles, consultez la documentation sur les repères d'annonce.

Définir une configuration de vidéo à la demande

Lorsque vous définissez une configuration de vidéo à la demande, les champs suivants sont obligatoires:

• sourceUri
• adTagUri

sourceUri spécifie l'URL du fichier HLS ou DASH de l'élément VOD source dans lequel insérer des annonces. L'API Video Stitcher renvoie une URL de lecture HLS si l'URL fournie fait référence à un fichier manifeste HLS et à une URL de lecture DASH si l'URL fournie fait référence à un fichier manifeste DASH. Vous pouvez utiliser un fichier manifeste existant ou créer vos propres fichiers sources de VOD.

adTagUri spécifie l'URL de l'ad server qui renvoie les métadonnées de l'annonce.

La configuration de vidéo à la demande contient un champ facultatif permettant de définir des en-têtes personnalisés.

Enregistrer une configuration de vidéo à la demande

Pour enregistrer une configuration de vidéo à la demande, utilisez la méthode projects.locations.vodConfigs.create.

REST

Avant d'utiliser les données de requête, effectuez les remplacements suivants:

• PROJECT_NUMBER: numéro de votre projet Google Cloud, situé dans le champ Numéro du projet sur la page Paramètres IAM.
• LOCATION: emplacement dans lequel créer votre configuration de vidéo à la demande. Utilisez l'une des régions compatibles.
  Afficher les lieux
  • us-central1
  • us-east1
  • us-west1
  • asia-east1
  • asia-south1
  • asia-southeast1
  • europe-west1
  • southamerica-east1
• VOD_CONFIG_ID: identifiant défini par l'utilisateur pour la configuration de vidéo à la demande. Cet ID ne peut contenir que des lettres minuscules, des chiffres et des traits d'union. Le premier caractère doit être une lettre, le dernier doit être une lettre ou un chiffre, et l'ID ne doit pas dépasser 63 caractères.
• VOD_URI: URI du contenu multimédia à assembler. Cet URI doit faire référence à un fichier manifeste MPEG-DASH (MPD) ou HLS (M3U8). Utilisez un URI public ou un URI non signé pour lequel vous avez enregistré une clé CDN.
  Remarque:Vous pouvez utiliser l'API Transcoder pour créer ces fichiers manifestes. Pour en savoir plus, consultez Créer des fichiers sources pour la vidéo à la demande. Vous devez rendre les fichiers manifestes publics pour que l'API Video Stitcher puisse y accéder.

• AD_TAG_URI

  URI public du tag d'emplacement publicitaire. Si vous n'en avez pas, vous pouvez utiliser un exemple d'annonce vidéo pré-roll VMAP.

Corps JSON de la requête :

{
  "sourceUri": "VOD_URI",
  "adTagUri": "AD_TAG_URI"
}

Pour envoyer votre requête, développez l'une des options suivantes :

curl (Linux, macOS ou Cloud Shell)

Remarque : La commande suivante suppose que vous êtes connecté à la CLI gcloud avec votre compte utilisateur en exécutant la commande gcloud init ou gcloud auth login, ou en utilisant Cloud Shell, qui vous connecte automatiquement à la CLI gcloud. Vous pouvez exécuter la commande gcloud auth list pour vérifier quel est le compte actuellement actif.

Enregistrez le corps de la requête dans un fichier nommé request.json. Exécutez la commande suivante dans le terminal pour créer ou écraser ce fichier dans le répertoire actuel :

cat > request.json << 'EOF'
{
  "sourceUri": "VOD_URI",
  "adTagUri": "AD_TAG_URI"
}
EOF

Exécutez ensuite la commande suivante pour envoyer votre requête REST :

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://videostitcher.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION/vodConfigs?vodConfigId=VOD_CONFIG_ID"

PowerShell (Windows)

Remarque : La commande suivante suppose que vous vous êtes connecté à la CLI gcloud avec votre compte utilisateur en exécutant la commande gcloud init ou gcloud auth login. Vous pouvez exécuter la commande gcloud auth list pour vérifier quel est le compte actuellement actif.

Enregistrez le corps de la requête dans un fichier nommé request.json. Exécutez la commande suivante dans le terminal pour créer ou écraser ce fichier dans le répertoire actuel :

@'
{
  "sourceUri": "VOD_URI",
  "adTagUri": "AD_TAG_URI"
}
'@  | Out-File -FilePath request.json -Encoding utf8

Exécutez ensuite la commande suivante pour envoyer votre requête REST :

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://videostitcher.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION/vodConfigs?vodConfigId=VOD_CONFIG_ID" | Select-Object -Expand Content

Vous devriez recevoir une réponse JSON de ce type :

{
  "name": "projects/PROJECT_NUMBER/locations/LOCATION/operations/OPERATION_ID",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.common.OperationMetadata",
    "createTime": CREATE_TIME,
    "target": "projects/PROJECT_NUMBER/locations/LOCATION/vodConfigs/VOD_CONFIG_ID",
    "verb": "create",
    "cancelRequested": false,
    "apiVersion": "v1"
  },
  "done": false
}

Cette commande crée une opération de longue durée (LRO) que vous pouvez interroger pour suivre la progression. Copiez le OPERATION_ID renvoyé, qui correspond à la dernière partie du champ name. Vous l'utiliserez dans la section suivante.

Vérifier le résultat

Pour vérifier si la configuration de vidéo à la demande a été créée, utilisez la méthode projects.locations.operations.get. Si la réponse contient "done: false", répétez la commande jusqu'à ce qu'elle contienne "done: true".

Avant d'utiliser les données de requête, effectuez les remplacements suivants:

• PROJECT_NUMBER: numéro de votre projet Google Cloud, situé dans le champ Numéro du projet sur la page Paramètres IAM.
• LOCATION: emplacement des données. Utilisez l'une des régions compatibles.
  Afficher les lieux
  • us-central1
  • us-east1
  • us-west1
  • asia-east1
  • asia-south1
  • asia-southeast1
  • europe-west1
  • southamerica-east1
• OPERATION_ID: identifiant de l'opération.

Pour envoyer votre requête, développez l'une des options suivantes :

curl (Linux, macOS ou Cloud Shell)

Remarque : La commande suivante suppose que vous êtes connecté à la CLI gcloud avec votre compte utilisateur en exécutant la commande gcloud init ou gcloud auth login, ou en utilisant Cloud Shell, qui vous connecte automatiquement à la CLI gcloud. Vous pouvez exécuter la commande gcloud auth list pour vérifier quel est le compte actuellement actif.

exécutez la commande suivante :

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://videostitcher.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION/operations/OPERATION_ID"

PowerShell (Windows)

Remarque : La commande suivante suppose que vous vous êtes connecté à la CLI gcloud avec votre compte utilisateur en exécutant la commande gcloud init ou gcloud auth login. Vous pouvez exécuter la commande gcloud auth list pour vérifier quel est le compte actuellement actif.

exécutez la commande suivante :

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://videostitcher.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION/operations/OPERATION_ID" | Select-Object -Expand Content

Vous devriez recevoir une réponse JSON de ce type :

{
  "name": "projects/PROJECT_NUMBER/locations/LOCATION/operations/OPERATION_ID",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.common.OperationMetadata",
    "createTime": CREATE_TIME,
    "endTime": END_TIME,
    "target": "projects/PROJECT_NUMBER/locations/LOCATION/vodConfigs/VOD_CONFIG_ID",
    "verb": "create"
  },
  "done": true,
  "response": {
    "@type": "type.googleapis.com/google.cloud.video.stitcher.v1.VodConfig",
    "name": "projects/PROJECT_NUMBER/locations/LOCATION/vodConfigs/VOD_CONFIG_ID",
    "sourceUri": "VOD_URI",
    "adTagUri": "AD_TAG_URI",
    "state": "READY"
  }
}

Obtenir une configuration de vidéo à la demande

Pour obtenir les détails d'une configuration de vidéo à la demande spécifique, utilisez la méthode projects.locations.vodConfigs.get.

REST

Avant d'utiliser les données de requête, effectuez les remplacements suivants:

• PROJECT_NUMBER: numéro de votre projet Google Cloud, situé dans le champ Numéro du projet sur la page Paramètres IAM.
• LOCATION: emplacement de la configuration de vidéo à la demande. Utilisez l'une des régions compatibles.
  Afficher les lieux
  • us-central1
  • us-east1
  • us-west1
  • asia-east1
  • asia-south1
  • asia-southeast1
  • europe-west1
  • southamerica-east1
• VOD_CONFIG_ID: identifiant défini par l'utilisateur pour la configuration de vidéo à la demande

Pour envoyer votre requête, développez l'une des options suivantes :

curl (Linux, macOS ou Cloud Shell)

Remarque : La commande suivante suppose que vous êtes connecté à la CLI gcloud avec votre compte utilisateur en exécutant la commande gcloud init ou gcloud auth login, ou en utilisant Cloud Shell, qui vous connecte automatiquement à la CLI gcloud. Vous pouvez exécuter la commande gcloud auth list pour vérifier quel est le compte actuellement actif.

exécutez la commande suivante :

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://videostitcher.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION/vodConfigs/VOD_CONFIG_ID"

PowerShell (Windows)

Remarque : La commande suivante suppose que vous vous êtes connecté à la CLI gcloud avec votre compte utilisateur en exécutant la commande gcloud init ou gcloud auth login. Vous pouvez exécuter la commande gcloud auth list pour vérifier quel est le compte actuellement actif.

exécutez la commande suivante :

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://videostitcher.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION/vodConfigs/VOD_CONFIG_ID" | Select-Object -Expand Content

Vous devriez recevoir une réponse JSON de ce type :

{
  "name": "projects/PROJECT_NUMBER/locations/LOCATION/vodConfigs/VOD_CONFIG_ID",
  "sourceUri": "VOD_URI",
  "adTagUri": "AD_TAG_URI",
  "state": "READY"
}

Modifier une configuration de vidéo à la demande

Pour mettre à jour une configuration de vidéo à la demande, utilisez la méthode projects.locations.vodConfigs.patch. L'exemple suivant met à jour le champ sourceUri.

REST

Avant d'utiliser les données de requête, effectuez les remplacements suivants:

• PROJECT_NUMBER: numéro de votre projet Google Cloud, situé dans le champ Numéro du projet sur la page Paramètres IAM.
• LOCATION: emplacement de la configuration de vidéo à la demande. Utilisez l'une des régions compatibles.
  Afficher les lieux
  • us-central1
  • us-east1
  • us-west1
  • asia-east1
  • asia-south1
  • asia-southeast1
  • europe-west1
  • southamerica-east1
• VOD_CONFIG_ID: identifiant défini par l'utilisateur pour la configuration de vidéo à la demande
• VOD_URI: URI mis à jour du contenu multimédia à assembler.

Corps JSON de la requête :

{
  "sourceUri": "VOD_URI"
}

Pour envoyer votre requête, développez l'une des options suivantes :

curl (Linux, macOS ou Cloud Shell)

Remarque : La commande suivante suppose que vous êtes connecté à la CLI gcloud avec votre compte utilisateur en exécutant la commande gcloud init ou gcloud auth login, ou en utilisant Cloud Shell, qui vous connecte automatiquement à la CLI gcloud. Vous pouvez exécuter la commande gcloud auth list pour vérifier quel est le compte actuellement actif.

Enregistrez le corps de la requête dans un fichier nommé request.json. Exécutez la commande suivante dans le terminal pour créer ou écraser ce fichier dans le répertoire actuel :

cat > request.json << 'EOF'
{
  "sourceUri": "VOD_URI"
}
EOF

Exécutez ensuite la commande suivante pour envoyer votre requête REST :

curl -X PATCH \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://videostitcher.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION/vodConfigs/VOD_CONFIG_ID?updateMask=sourceUri"

PowerShell (Windows)

Remarque : La commande suivante suppose que vous vous êtes connecté à la CLI gcloud avec votre compte utilisateur en exécutant la commande gcloud init ou gcloud auth login. Vous pouvez exécuter la commande gcloud auth list pour vérifier quel est le compte actuellement actif.

Enregistrez le corps de la requête dans un fichier nommé request.json. Exécutez la commande suivante dans le terminal pour créer ou écraser ce fichier dans le répertoire actuel :

@'
{
  "sourceUri": "VOD_URI"
}
'@  | Out-File -FilePath request.json -Encoding utf8

Exécutez ensuite la commande suivante pour envoyer votre requête REST :

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method PATCH `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://videostitcher.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION/vodConfigs/VOD_CONFIG_ID?updateMask=sourceUri" | Select-Object -Expand Content

Vous devriez recevoir une réponse JSON de ce type :

{
  "name": "projects/PROJECT_NUMBER/locations/LOCATION/operations/OPERATION_ID",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.common.OperationMetadata",
    "createTime": CREATE_TIME,
    "target": "projects/PROJECT_NUMBER/locations/LOCATION/vodConfigs/VOD_CONFIG_ID",
    "verb": "update"
  },
  "done": false
}

Cette commande crée une opération de longue durée (LRO) que vous pouvez interroger pour suivre la progression. Pour en savoir plus, consultez la section Rechercher le résultat.

Lister toutes les configurations de VOD enregistrées

Pour répertorier toutes les configurations de vidéo à la demande enregistrées pour un emplacement donné dans un projet, utilisez la méthode projects.locations.vodConfigs.list.

REST

Avant d'utiliser les données de requête, effectuez les remplacements suivants:

• PROJECT_NUMBER: numéro de votre projet Google Cloud, situé dans le champ Numéro du projet sur la page Paramètres IAM.
• LOCATION: emplacement des configurations de vidéo à la demande. Utilisez l'une des régions compatibles.
  Afficher les lieux
  • us-central1
  • us-east1
  • us-west1
  • asia-east1
  • asia-south1
  • asia-southeast1
  • europe-west1
  • southamerica-east1

Pour envoyer votre requête, développez l'une des options suivantes :

curl (Linux, macOS ou Cloud Shell)

Remarque : La commande suivante suppose que vous êtes connecté à la CLI gcloud avec votre compte utilisateur en exécutant la commande gcloud init ou gcloud auth login, ou en utilisant Cloud Shell, qui vous connecte automatiquement à la CLI gcloud. Vous pouvez exécuter la commande gcloud auth list pour vérifier quel est le compte actuellement actif.

exécutez la commande suivante :

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://videostitcher.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION/vodConfigs"

PowerShell (Windows)

Remarque : La commande suivante suppose que vous vous êtes connecté à la CLI gcloud avec votre compte utilisateur en exécutant la commande gcloud init ou gcloud auth login. Vous pouvez exécuter la commande gcloud auth list pour vérifier quel est le compte actuellement actif.

exécutez la commande suivante :

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://videostitcher.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION/vodConfigs" | Select-Object -Expand Content

Vous devriez recevoir une réponse JSON de ce type :

{
  "vodConfigs": [
    {
      "name": "projects/PROJECT_NUMBER/locations/LOCATION/vodConfigs/VOD_CONFIG_ID",
      "sourceUri": "VOD_URI",
      "adTagUri": "AD_TAG_URI",
      "state": "READY"
    },
    {
      "name": "projects/PROJECT_NUMBER/locations/LOCATION/vodConfigs/my-other-vod-config",
      "sourceUri": "my-other-vod-stream-uri",
      "adTagUri": "my-other-ad-tag-uri",
      "state": "READY"
    }
}

Résultats supplémentaires

La réponse curl peut inclure un nextPageToken, que vous pouvez utiliser pour récupérer des résultats supplémentaires:

{
  "vodConfigs": [
    ...
  ],
  "nextPageToken": "NEXT_PAGE_TOKEN"
}

Vous pouvez envoyer une autre requête curl, y compris la valeur de NEXT_PAGE_TOKEN, pour répertorier les configurations supplémentaires. Ajoutez le code suivant à l'URL de l'appel d'API précédent:

?pageToken=NEXT_PAGE_TOKEN

Pour en savoir plus sur l'utilisation de ce jeton, consultez la bibliothèque cliente correspondante.

Supprimer une configuration de vidéo à la demande

Si une configuration de vidéo à la demande enregistrée n'est plus nécessaire, supprimez-la à l'aide de la méthode projects.locations.vodConfigs.delete.

REST

Avant d'utiliser les données de requête, effectuez les remplacements suivants:

• PROJECT_NUMBER: numéro de votre projet Google Cloud, situé dans le champ Numéro du projet sur la page Paramètres IAM.
• LOCATION: emplacement de la configuration de vidéo à la demande. Utilisez l'une des régions compatibles.
  Afficher les lieux
  • us-central1
  • us-east1
  • us-west1
  • asia-east1
  • asia-south1
  • asia-southeast1
  • europe-west1
  • southamerica-east1
• VOD_CONFIG_ID: identifiant défini par l'utilisateur pour la configuration de vidéo à la demande

Pour envoyer votre requête, développez l'une des options suivantes :

curl (Linux, macOS ou Cloud Shell)

Remarque : La commande suivante suppose que vous êtes connecté à la CLI gcloud avec votre compte utilisateur en exécutant la commande gcloud init ou gcloud auth login, ou en utilisant Cloud Shell, qui vous connecte automatiquement à la CLI gcloud. Vous pouvez exécuter la commande gcloud auth list pour vérifier quel est le compte actuellement actif.

exécutez la commande suivante :

curl -X DELETE \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://videostitcher.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION/vodConfigs/VOD_CONFIG_ID"

PowerShell (Windows)

Remarque : La commande suivante suppose que vous vous êtes connecté à la CLI gcloud avec votre compte utilisateur en exécutant la commande gcloud init ou gcloud auth login. Vous pouvez exécuter la commande gcloud auth list pour vérifier quel est le compte actuellement actif.

exécutez la commande suivante :

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method DELETE `
    -Headers $headers `
    -Uri "https://videostitcher.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION/vodConfigs/VOD_CONFIG_ID" | Select-Object -Expand Content

Vous devriez recevoir une réponse JSON de ce type :

{
  "name": "projects/PROJECT_NUMBER/locations/LOCATION/operations/OPERATION_ID",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.common.OperationMetadata",
    "createTime": CREATE_TIME,
    "target": "projects/PROJECT_NUMBER/locations/LOCATION/vodConfigs/VOD_CONFIG_ID",
    "verb": "delete"
  },
  "done": false
}

Cette commande crée une opération de longue durée (LRO) que vous pouvez interroger pour suivre la progression. Pour en savoir plus, consultez la section Rechercher le résultat.