Dimension : region

Dans cette rubrique, vous découvrirez les Analytics API region dimension. Les region dimension fournit des informations sur le navigateur dans lequel les vidéos ont été visionnées. Il renvoie les codes de région ISO-3611-2 (exemple : US-WA). La définition des régions varie selon les pays

Paramètres d'URL

Les rapports de l'API Analytics prennent en charge les paramètres d'URL suivants.

Paramètres d'URL
Paramètre Description Obligatoire Valeurs Défaut
account Les comptes sur lesquels vous souhaitez créer un rapport Oui un ou plusieurs identifiants de compte sous forme de liste délimitée par des virgules aucun
dimensions La ou les dimensions à signaler Oui une ou plusieurs dimensions sous forme de liste délimitée par des virgules (certaines combinaisons ne sont pas valables - utilisez l'outil interactif ici pour déterminer si une combinaison est valable) aucun
where Utilisé pour spécifier des filtres pour les rapports non {dimension}=={valeur} - un ou plusieurs éléments sous forme de liste délimitée par des points-virgules. La valeur sera une ou plusieurs valeurs pour la métrique primaire de cette dimension. Par exemple : video==video_id country=country-code, ou viewer=viewer_id(dans ce dernier cas, la forme du viewer_id varie selon que vous capturez et envoyez vous-même une sorte de viewer_id ou selon la valeur générée par le système d'analyse). aucun
limit Nombre d'articles à retourner non entier positif 10
offset Nombre d'éléments à ignorer non entier positif 0
sort Champ sur lequel trier les éléments non tout champ renvoyé par la requête Video_View
fields Champs à retourner non varie en fonction de la dimension sur laquelle vous créez un rapport video,video_view
format Format pour renvoyer les résultats dans non json (par défaut) | csv | xlxs json
reconciled Si elle est incluse, elle limitera les résultats aux données historiques ou en temps réel. Les données analytiques proviennent de plusieurs sources : certaines sont envoyées par le lecteur, mais d'autres sont collectées à partir des CDN et du système Video Cloud. Afin de fournir des analyses le plus rapidement possible, nous commençons à fournir des données « en temps réel » dès qu'elles sont disponibles, puis nous ajustons les analyses ultérieurement lorsque les données de toutes les sources ont été collectées et traitées. Les données entièrement traitées sont appelées réconciliées non vrai | faux true
from Le début de la plage de dates de la demande non L'un des éléments suivants :
  • Une date ISO 8601 (AAAA-MM-JJ)
  • Heure de l'époque en millisecondes (exemple : 1659641316719 [= jeudi 4 août 2022 7:28:36.719 PM GMT]). Voir le convertisseur d'époque.
  • Une chaîne : from=alltime
  • +/- dates relatives en jours (d), semaines (w) ou mois (m) - exemple : from=-6m&to=%2B2w(la période allant d'il y a 6 mois à 2 semaines plus tard -- notez que le signe + doit être codé en URI sous la forme %2B)

Seules les dates des 32 derniers jours sont autorisées pour les points finaux d'engagement ou si reconciled=false.

-30d
to La fin de la plage de dates pour la demande non L'un des éléments suivants :
  • Une date ISO 8601 (AAAA-MM-JJ)
  • Heure de l'époque en millisecondes (exemple : 1659641316719 [= jeudi 4 août 2022 7:28:36.719 PM GMT]). Voir le convertisseur d'époque.
  • Une chaîne : to=now
  • +/- dates relatives en jours (d), semaines (w) ou mois (m) - exemple : from=-6m&to=%2B2w(la période allant d'il y a 6 mois à 2 semaines plus tard -- notez que le signe + doit être codé en URI sous la forme %2B)

Seules les dates des 32 derniers jours sont autorisées pour les points finaux d'engagement ou si reconciled=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 publicité
  • ad_mode_complete- le nombre de fois où le joueur a terminé le mode publicité
  • engagement_score- le score d'engagement moyen pour une vidéo jouée dans un player
  • play_request- nombre total de fois où la lecture vidéo a été demandée
  • play_rate- le taux de lecture moyen (vues vidéo divisées par impressions) pour une vidéo
  • player_load- le nombre de fois qu'un joueur a été chargé
  • region- abréviation de région standard - ce qui compte comme "région" varie selon les pays
  • region_name- le nom de la région, si déclaré
  • video_impression- le nombre total de vidéos chargées dans le lecteur
  • video_percent_viewed- la somme des pourcentages visionnés des vidéos dans le lecteur
  • video_seconds_viewed- nombre total de secondes de vidéos visionnées dans le lecteur
  • video_view- nombre total de fois où la lecture vidéo a commencé dans le lecteur

Filtrer les valeurs

Utilisée comme filtre, une dimension permet d'affiner les résultats.

Valeurs de filtre : liste délimitée par des virgules du code de région ISO-3611-2 - par exemple US-WA

Combinaison de dimensions

Pour voir avec quelles dimensions cet élément peut être combiné et quels champs sont disponibles pour la combinaison, voir Dimension et champs.

Exemples de demandes

Demande de dimension

    https ://analytics.api.brightcove.com/v1/data?accounts=1752604059001&dimensions=region

Demande de filtre

    https ://analytics.api.brightcove.com/v1/data?accounts=1752604059001&dimensions=country&where=region==US-MA
Exemple de réponse
{
  "item_count" : 583,
  "items" : [
    {
      "video_view" : 1,
      "région" : "MX-SIN
    },
    {
      "video_view" : 1,
      "région" : "MX-GUA
    },
    {
      "video_view" : 1,
      "région" : "PL-04"
    },
    {
      "video_view" : 1,
      "région" : "NG-AN"
    },
    {
      "video_view" : 1,
      "région" : "US-RI
    },
    {
      "video_view" : 1,
      "région" : "RO-HR
    },
    {
      "video_view" : 1,
      "région" : "UG-C
    },
    {
      "video_view" : 1,
      "région" : "NG-KN
    },
    {
      "video_view" : 1,
      "région" : "PL-22
    },
    {
      "video_view" : 1,
      "région" : "BG-01
    }
  ],
  "summary" : {
    "video_view" : 45072
  }
}