video
dimension. La video
dimension fournit des analyses par vidéo. REMARQUE : si vous souhaitez inclure des champs « vidéo » (tels que video.name
) dans la réponse, vos informations d'identification client doivent inclure le CMS : Autorisation de lecture vidéo. Notez également que même si vous ne pouvez pas revenir video.custom_fields
, vous pouvez revenir video.custom_fields.{field_name}
.Paramètres d'URL
Les rapports d'API Analytics prennent en charge les paramètres d'URL suivants.
Paramètre | Description | Obligatoire | Valeurs | Par défaut |
---|---|---|---|---|
account |
Les comptes sur lesquels vous souhaitez signaler | oui | un ou plusieurs identifiants de compte en tant que liste délimitée par des virgules | aucun |
dimensions |
La (les) dimension (s) à signaler | oui | une ou plusieurs dimensions en tant que liste délimitée par des virgules (certaines combinaisons ne sont pas valides) | aucun |
where |
Utilisé pour spécifier des filtres pour les rapports | non | {dimension} == {value} - une ou plusieurs en tant que liste délimitée par des points-virgules | aucun |
limit |
Nombre d'articles à retourner | non | entier positif | 10 |
offset |
Nombre d'éléments à ignorer | non | entier positif | 0 |
sort |
Champ pour trier les éléments sur | non | un champ valide pour la demande | video_view |
fields |
Champs à renvoyer | non | varie en fonction de la dimension sur laquelle vous signalez | video_view |
format |
Formater pour renvoyer les résultats dans | non | json | csv | xlxs | Jason |
reconciled |
S'ils sont inclus, limiteront les résultats aux données historiques ou en temps réel | non | vrai | faux | true |
from |
Début de la plage de dates pour la demande | non | Une date ISO 8601 (AAAA-MM-JJ), une heure d'époque en millisecondes, la chaîne alltime ou une date relative (-1m) ; seules les dates des 32 derniers jours sont autorisées pour les points de terminaison d'engagement ou si elles sont rapprochées = false. | 30 jours avant maintenant |
to |
Fin de la plage de dates de la demande | non | Une date ISO 8601 (AAAA-MM-JJ), une heure d'époque en millisecondes, la chaîne maintenant ou des données relatives (+7d) ; seules les dates au cours des 32 derniers jours sont autorisées pour les points de terminaison d'engagement ou si rapproché = false. | maintenant |
Champs disponibles
Les champs suivants peuvent être renvoyés pour la dimension.
ad_mode_begin
- le nombre de fois où le joueur est entré en mode publicitairead_mode_complete
- le nombre de fois où le joueur a terminé le mode publicitairebytes_delivered
- nombre total d'octets livrés aux machines clientes pour le lecteur et les supports associésengagement_score
- le score de fiançailles pour une vidéoplay_request
- nombre total de fois que la lecture vidéo a été demandéeplay_rate
- le taux de lecture moyen (vues vidéo divisées par impressions) pour une vidéovideo
- l'ID de la vidéovideo_duration
- la durée de la vidéo (si signalée)video_engagement_1
- le nombre de vues au point 1 pour cent de la vidéovideo_engagement_100
- le nombre total de vues au point de 100 % de la durée de la vidéovideo_engagement_25
- le nombre total de vues au point de 25 % de la durée de la vidéovideo_engagement_50
- le nombre total de vues au point de 50% de la durée de la vidéovideo_engagement_75
- le nombre total de vues au point de 75 % de la durée de la vidéo <video_impression
- le nombre total de fois que la vidéo a été chargée dans les lecteursvideo_name
- le nom de la vidéo au moment de l'impression la plus récente dans le laps de tempsvideo_percent_viewed
- la somme du pourcentage de la vidéo affichée pour toutes les vues vidéo. Par exemple, s'il y avait deux vues au cours de la période, et que le pourcentage affiché dans une vue était de 78 % et de 59 % dans l'autre, levideo_percent_viewed
retour serait 137.video_seconds_viewed
- nombre total de secondes vues pour chaque vue vidéovideo_view
- le nombre de fois où la lecture vidéo a commencévideo.reference_id
- l'identifiant de référence de la vidéovideo.name
- le nom actuel de la vidéovideo.description
- la description actuelle de la vidéovideo.complete
- si le traitement vidéo est completvideo.created_at
- la date/heure de création de la vidéovideo.duration
- la durée actuelle de la vidéovideo.economics
- si la vidéo est activée pour les annoncesvideo.long_description
- la description longue de la vidéovideo.state
- si la vidéo est actuellementACTIVE
ouINACTIVE
video.tags
- les tags de la vidéovideo.updated_at
- date/heure de la dernière modification de la vidéovideo.custom_fields.{field_name}
- valeur pour le champ personnalisé de la vidéo nommé{field_name}
video_download_request
- nombre de demandes de téléchargement pour une vidéo activée pour la lecture hors lignevideo_download_complete
- nombre de fois où une vidéo activée pour la lecture hors ligne a été complètement téléchargéevideo_download_cancellation
- nombre de fois que le téléchargement d'une vidéo activé pour la lecture hors ligne a été annulé (y compris les fois où la page a été fermée avant la fin du téléchargement)video_download_error
- nombre de fois où le téléchargement d'une vidéo activée pour la lecture hors ligne a échoué en raison d'une erreur
Valeurs de filtre
Utilisée comme filtre, une cote permet de réduire les résultats.
Valeurs de filtre : ID vidéo en tant que liste délimitée par des virgules ou video.q== {video field} : {value}
Combinaison des
Pour voir quelles dimensions cette option peut être combinée et quels champs sont disponibles pour cette combinaison, reportez-vous à la section Dimension et champs.
Exemples de demande
Demande de dimension
https ://analytics.api.brightcove.com/v1/data ? accounts=1752604059001&dimensions=video
Demande de filtre
https ://analytics.api.brightcove.com/v1/data ? accounts=1752604059001&dimensions=video&where=vidéo==4093643993001,1754276206001
Réponse
La réponse apparaîtra ici lorsque vous testez une demande