L'API Video Stitcher vous permet de créer une session en direct chaque fois que vous lancez la lecture d'une diffusion en direct au cours de laquelle des annonces diffusées par Google Ad Manager sont assemblées de manière dynamique pendant les coupures publicitaires. La réponse contient l'URL de lecture et la configuration de la session en direct.
Cette page explique comment créer et gérer une session en direct activée par Google Ad Manager. Pour en savoir plus sur les sessions en direct qui n'utilisent pas Google Ad Manager, consultez Gérer une session en direct.
Avant de commencer
- Créez une configuration active. Pour l'intégration à Google Ad Manager, assurez-vous que l'objet
gamLiveConfig
est défini. - Si vous spécifiez un écran, assurez-vous que l'objet
gamSlate
est défini sur l'écran que vous enregistrez.
Créer une session en direct
Vous pouvez créer une session en direct à l'aide du SDK IMA (qui appelle l'API Video Stitcher) ou en utilisant directement l'API Video Stitcher.
Utiliser le SDK IMA
Si vous intégrez le SDK IMA, celui-ci crée la session en direct.
function requestVideoStitcherStream() { const streamRequest = new google.ima.dai.api.VideoStitcherLiveStreamRequest(); streamRequest.liveStreamEventId = 'LIVE_CONFIG_ID'; streamRequest.region = 'LOCATION'; streamRequest.projectNumber = 'PROJECT_NUMBER'; streamRequest.oAuthToken = 'OAUTH_TOKEN'; streamRequest.networkCode = 'NETWORK_CODE'; streamRequest.customAssetKey = 'CUSTOM_ASSET_KEY'; streamManager.requestStream(streamRequest); }
Vous pouvez définir ou remplacer les paramètres facultatifs suivants par session:
manifestOptions
: spécifie les rendus vidéo générés dans le fichier manifeste vidéo assemblé et l'ordre des rendus. Consultez la documentation sur les options du fichier manifeste.adTracking
: sélectionnez le suivi des annonces côté client ou côté serveur.targetingParameters
: un tag d'emplacement publicitaire Google Ad Manager peut contenir des paramètres de ciblage pouvant être mis à jour par session. Découvrez comment définir des paramètres de ciblage avec le SDK IMA.
Consultez la section suivante pour savoir comment définir ces paramètres à l'aide du SDK IMA.
Paramètres et remplacements facultatifs
Vous pouvez définir des paramètres facultatifs par session, comme le champ manifestOptions
.
Ce champ n'est pas disponible dans la configuration active. Vous pouvez également ignorer certains paramètres définis dans la configuration active pour une session donnée.
Par exemple, si la valeur par défaut adTracking
dans la configuration en ligne est définie sur SERVER
, vous pouvez remplacer cette valeur par CLIENT
et également définir le champ manifestOptions
dans le SDK IMA en définissant le champ d'objet JSON videoStitcherSessionOptions
.
function requestVideoStitcherStream() { const streamRequest = new google.ima.dai.api.VideoStitcherLiveStreamRequest(); streamRequest.liveStreamEventId = 'LIVE_CONFIG_ID'; streamRequest.region = 'LOCATION'; streamRequest.projectNumber = 'PROJECT_NUMBER'; streamRequest.oAuthToken = 'OAUTH_TOKEN'; streamRequest.networkCode = 'NETWORK_CODE'; streamRequest.customAssetKey = 'CUSTOM_ASSET_KEY'; streamRequest.videoStitcherSessionOptions = { adTracking: 'CLIENT', 'manifestOptions': { 'includeRenditions': [ { 'bitrateBps': 150000, 'codecs': 'hvc1.1.4.L126.B0' }, { 'bitrateBps': 440000, 'codecs': 'hvc1.1.4.L126.B0' }, ], 'bitrateOrder': 'descending' } }; streamManager.requestStream(streamRequest); }
Pour en savoir plus, consultez la section Ajouter des options de session de streaming.
Utiliser directement l'API
Pour créer une session en direct à l'aide de l'API directement, utilisez la méthode projects.locations.liveSessions.create
.
Le champ liveConfig
est le seul champ obligatoire du corps JSON. Vous pouvez définir ou remplacer les paramètres facultatifs suivants par session en direct (comme illustré dans l'exemple REST suivant):
manifestOptions
: spécifie les rendus vidéo générés dans le fichier manifeste vidéo assemblé et l'ordre des rendus. Consultez la documentation sur les options du fichier manifeste.adTracking
: permet de sélectionner le suivi des annonces côté client ou le suivi des annonces côté serveur. Cette option remplace la valeur de la configuration active pour la session.targetingParameters
: un tag d'emplacement publicitaire Google Ad Manager peut contenir des paramètres de ciblage qui peuvent être mis à jour par session. Fournissez un mappage dans ce champ (par exemple, pour remplacer la macro[my_key]
par la chaînemy_value
, consultez l'exemple REST).
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 IAMLOCATION
: emplacement dans lequel créer votre session (utilisez l'une des régions compatibles)Afficher les lieuxus-central1
us-east1
us-west1
asia-east1
asia-south1
asia-southeast1
europe-west1
southamerica-east1
LIVE_CONFIG_ID
: identifiant défini par l'utilisateur pour la configuration active
Pour envoyer votre requête, développez l'une des options suivantes :
Vous devriez recevoir une réponse JSON de ce type :
{ "name": "projects/PROJECT_NUMBER/locations/LOCATION/liveSessions/SESSION_ID", "playUri": "PLAY_URI", "manifestOptions": { "includeRenditions": [ { "bitrateBps": 150000, "codecs": "hvc1.1.4.L126.B0" }, { "bitrateBps": 440000, "codecs": "hvc1.1.4.L126.B0" } ], "bitrateOrder": "DESCENDING" }, "gamSettings": { "streamId": "STREAM_ID" }, "liveConfig": "projects/PROJECT_NUMBER/locations/LOCATION/liveConfigs/LIVE_CONFIG_ID", "adTracking": "SERVER" }
C#
Avant d'essayer cet exemple, suivez les instructions de configuration de C# dans le guide de démarrage rapide de l'API Video Stitcher à l'aide de bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Video Stitcher C#.
Pour vous authentifier auprès de l'API Video Stitcher, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
Go
Avant d'essayer cet exemple, suivez les instructions de configuration de Go dans le guide de démarrage rapide de l'API Video Stitcher à l'aide de bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Video Stitcher Go.
Pour vous authentifier auprès de l'API Video Stitcher, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
Java
Avant d'essayer cet exemple, suivez les instructions de configuration de Java dans le guide de démarrage rapide de l'API Video Stitcher à l'aide de bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Video Stitcher Java.
Pour vous authentifier auprès de l'API Video Stitcher, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
Node.js
Avant d'essayer cet exemple, suivez les instructions de configuration de Node.js dans le guide de démarrage rapide de l'API Video Stitcher à l'aide de bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Video Stitcher Node.js.
Pour vous authentifier auprès de l'API Video Stitcher, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
PHP
Avant d'essayer cet exemple, suivez les instructions de configuration de PHP dans le guide de démarrage rapide de l'API Video Stitcher à l'aide de bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Video Stitcher PHP.
Pour vous authentifier auprès de l'API Video Stitcher, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
Python
Avant d'essayer cet exemple, suivez les instructions de configuration de Python dans le guide de démarrage rapide de l'API Video Stitcher à l'aide de bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Video Stitcher Python.
Pour vous authentifier auprès de l'API Video Stitcher, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
Ruby
Avant d'essayer cet exemple, suivez les instructions de configuration de Ruby dans le guide de démarrage rapide de l'API Video Stitcher à l'aide de bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Video Stitcher Ruby.
Pour vous authentifier auprès de l'API Video Stitcher, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
La réponse est un objet de session en direct. playUri
est l'URL utilisée par l'appareil client pour lire le flux associé à l'annonce pour cette session en direct.
L'API Video Stitcher génère un ID de session unique pour chaque requête. Une session expire si l'playUri
n'est pas demandée au cours des cinq dernières minutes.
Si vous générez une session au nom des appareils de vos clients, vous pouvez définir les paramètres suivants à l'aide des en-têtes HTTP:
Paramètres | En-tête HTTP |
---|---|
CLIENT_IP | x-forwarded-for |
REFERRER_URL | referer |
USER_AGENT | user-agent |
Vous pouvez ajouter les en-têtes suivants à la requête curl
précédente:
-H "x-forwarded-for: CLIENT_IP" \ -H "referer: REFERRER_URL" \ -H "user-agent: USER_AGENT" \
Si l'en-tête x-forwarded-for
n'est pas fourni, l'API Video Stitcher utilise l'adresse IP du client dans les requêtes de métadonnées d'annonce. Sachez que l'adresse IP du client peut ne pas correspondre à l'adresse IP des appareils de vos clients si les sessions sont générées pour le compte de ces appareils.
Obtenir une session
Pour obtenir la session en direct, utilisez la méthode projects.locations.liveSessions.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 IAMLOCATION
: emplacement dans lequel créer votre session (utilisez l'une des régions compatibles)Afficher les lieuxus-central1
us-east1
us-west1
asia-east1
asia-south1
asia-southeast1
europe-west1
southamerica-east1
SESSION_ID
: identifiant de la session en direct.
Pour envoyer votre requête, développez l'une des options suivantes :
Vous devriez recevoir une réponse JSON de ce type :
{ "name": "projects/PROJECT_NUMBER/locations/LOCATION/liveSessions/SESSION_ID", "playUri": "ad-stitched-live-stream-uri", "manifestOptions": { "includeRenditions": [ { "bitrateBps": 150000, "codecs": "hvc1.1.4.L126.B0" }, { "bitrateBps": 440000, "codecs": "hvc1.1.4.L126.B0" } ], "bitrateOrder": "DESCENDING" }, "gamSettings": { "streamId": "STREAM_ID", "targetingParameters": { "my_key": "my_value" } }, "liveConfig": "projects/PROJECT_NUMBER/locations/LOCATION/liveConfigs/LIVE_CONFIG_ID", "adTracking": "SERVER" }
C#
Avant d'essayer cet exemple, suivez les instructions de configuration de C# dans le guide de démarrage rapide de l'API Video Stitcher à l'aide de bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Video Stitcher C#.
Pour vous authentifier auprès de l'API Video Stitcher, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
Go
Avant d'essayer cet exemple, suivez les instructions de configuration de Go dans le guide de démarrage rapide de l'API Video Stitcher à l'aide de bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Video Stitcher Go.
Pour vous authentifier auprès de l'API Video Stitcher, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
Java
Avant d'essayer cet exemple, suivez les instructions de configuration de Java dans le guide de démarrage rapide de l'API Video Stitcher à l'aide de bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Video Stitcher Java.
Pour vous authentifier auprès de l'API Video Stitcher, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
Node.js
Avant d'essayer cet exemple, suivez les instructions de configuration de Node.js dans le guide de démarrage rapide de l'API Video Stitcher à l'aide de bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Video Stitcher Node.js.
Pour vous authentifier auprès de l'API Video Stitcher, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
PHP
Avant d'essayer cet exemple, suivez les instructions de configuration de PHP dans le guide de démarrage rapide de l'API Video Stitcher à l'aide de bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Video Stitcher PHP.
Pour vous authentifier auprès de l'API Video Stitcher, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
Python
Avant d'essayer cet exemple, suivez les instructions de configuration de Python dans le guide de démarrage rapide de l'API Video Stitcher à l'aide de bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Video Stitcher Python.
Pour vous authentifier auprès de l'API Video Stitcher, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
Ruby
Avant d'essayer cet exemple, suivez les instructions de configuration de Ruby dans le guide de démarrage rapide de l'API Video Stitcher à l'aide de bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Video Stitcher Ruby.
Pour vous authentifier auprès de l'API Video Stitcher, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
Exemple de playlist composée d'annonces
Voici un exemple de playlist en direct source avant l'assemblage des annonces:
#EXTM3U
#EXT-X-TARGETDURATION:10
#EXT-X-VERSION:4
#EXT-X-MEDIA-SEQUENCE:5
#EXTINF:10.010
segment_00005.ts
#EXTINF:10.010
segment_00006.ts
#EXT-X-DATERANGE:ID="2415919105",START-DATE="2021-06-22T08:32:00Z",DURATION=60,SCTE35-OUT=0xF...
#EXTINF:10.010
segment_00007.ts
#EXTINF:10.010
segment_00008.ts
#EXT-X-DATERANGE:ID="2415919105",START-DATE="2021-06-22T08:39:20Z",SCTE35-IN=0xF...
#EXTINF:10.010
segment_00009.ts
Voici un exemple de playlist en direct source après assemblage des annonces:
#EXTM3U
#EXT-X-TARGETDURATION:10
#EXT-X-VERSION:4
#EXT-X-MEDIA-SEQUENCE:5
#EXTINF:10.010
segment_00005.ts
#EXTINF:10.010
segment_00006.ts
#EXT-X-DISCONTINUITY
#EXTINF:6.000
https://dai.google.com/.../ad-1/seg-1.ts
#EXTINF:5.000
https://dai.google.com/.../ad-1/seg-2.ts
#EXT-X-DISCONTINUITY
#EXTINF:6.000
https://dai.google.com/.../ad-2/seg-1.ts
#EXTINF:5.000
https://dai.google.com/.../ad-2/seg-2.ts
#EXT-X-DISCONTINUITY
#EXTINF:10.010
segment_00009.ts
Inspecter les sessions en direct activées par Google Ad Manager
Pour afficher les détails des tags d'emplacement publicitaire pour les sessions, utilisez l'outil de contrôle de l'activité des flux dans Ad Manager afin de consulter les détails sur les demandes d'annonces.