Événements JavaScript intégrés

Une fois que vous avez créé un élément à intégrer (publiquement, privément, avec l'intégration signée ou via l'API), vous pouvez interagir avec ces iFrames à l'aide de JavaScript. Vous pouvez rendre votre page plus dynamique en fonction de l'état de l'élément intégré. Vous pouvez même modifier l'élément intégré depuis votre page Web.

Sachez que Looker ne contrôle pas l'ordre dans lequel les navigateurs envoient les événements aux applications Web. Cela signifie que l'ordre des événements n'est pas garanti sur les différents navigateurs ou plates-formes. Veillez à écrire votre code JavaScript de manière appropriée pour tenir compte de la gestion des événements des différents navigateurs.

Vous pouvez utiliser JavaScript de l'une des manières suivantes pour le contenu Looker intégré :

Préparation

Avant de pouvoir interagir avec l'iframe intégré, procédez comme suit :

Ajouter un ID à l'iframe

Plus tard, lorsque vous récupérerez des données à partir de l'iFrame, vous devrez vérifier que les informations que vous utilisez proviennent bien de l'iFrame de Looker. Pour faciliter cette opération, veillez à ajouter un ID à votre iFrame, si ce n'est pas déjà fait. Dans l'exemple suivant, vous définissez l'ID sur looker en ajoutant id="looker" à l'iFrame :

<iframe id="looker" src="https://instance_name.looker.com/embed/dashboards/1"></iframe>

Ajouter le domaine d'intégration à l'attribut src de l'iFrame

Dans l'attribut src de l'iframe, incluez le domaine où l'iframe est utilisé. Dans l'exemple suivant, vous pouvez spécifier myownpersonaldomain.com comme domaine en ajoutant ?embed_domain=https://myownpersonaldomain.com" à la fin de l'URL dans l'attribut src :

<iframe
  id="looker"
  src="https://instance_name.looker.com/embed/dashboards/1?embed_domain=https://myownpersonaldomain.com">
</iframe>

Si vous utilisez l'intégration signée, assurez-vous d'ajouter embed_domain à l'URL d'intégration.

Si vous utilisez le SDK Embed, ajoutez sdk=3 à la fin de l'URL d'intégration. Le paramètre sdk=3 indique que le SDK est présent et que Looker peut profiter des fonctionnalités supplémentaires qu'il fournit, comme la transmission d'événements JavaScript entre l'iframe Looker et votre domaine. Le SDK ne peut pas ajouter ce paramètre lui-même, car il fait partie de l'URL signée. Exemple :

<iframe
  id="looker"
  src="https://instance_name.looker.com/embed/dashboards/1?embed_domain=https://myownpersonaldomain.com&sdk=2">
</iframe>

Ajouter le domaine d'intégration à la liste d'autorisation

Enfin, vous devrez ajouter le domaine où l'iFrame est utilisé à la liste d'autorisation sur la page Intégrer du panneau Admin de Looker en suivant ces étapes :

  1. Dans le champ Liste d'autorisation des domaines intégrés, saisissez le domaine dans lequel l'iFrame est utilisé, puis appuyez sur la touche Tabulation pour que le domaine s'affiche dans une zone du champ.

  2. Cliquez sur Mettre à jour.

Vous pouvez utiliser le caractère générique * dans la liste d'autorisation pour créer un modèle de domaine. Par exemple, https://*.myownpersonaldomain.com autoriserait à la fois https://analytics.myownpersonaldomain.com et https://data.myownpersonaldomain.com.

Si vous utilisez l'intégration sans cookie avec Looker 23.8 ou version ultérieure, le domaine d'intégration peut être spécifié lors de l'acquisition de la session sans cookie. Il s'agit d'une alternative à l'ajout du domaine d'intégration à la liste d'autorisation à l'aide du panneau Admin > Intégrer. Si vous décidez d'utiliser cette fonctionnalité, consultez les bonnes pratiques de sécurité.

Récupérer des données à partir de l'iFrame

Une fois les étapes de préparation effectuées, vous pouvez accéder aux événements transmis entre l'iFrame Looker et votre domaine en écoutant les événements postMessage.

L'iFrame intégré peut créer plusieurs types d'événements, comme décrit dans la section Référence des types d'événements de cette page.

Accéder aux événements en JavaScript

Voici un exemple d'écoute de ces événements en JavaScript, puis de consignation des événements dans la console :

window.addEventListener("message", function(event) {
  if (event.source === document.getElementById("looker").contentWindow) {
    if (event.origin === "https://instance_name.looker.com") {
      console.log(JSON.parse(event.data));
    }
  }
});

Voici un exemple d'écoute de ces événements dans jQuery, puis de leur journalisation dans la console :

$(window).on("message", function(event) {
  if (event.originalEvent.source === $("#looker")[0].contentWindow) {
    if (event.origin === "https://instance_name.looker.com") {
      console.log(JSON.parse(event.data));
    }
  }
});

Tableau récapitulatif des types d'événements

Le tableau suivant récapitule les types d'événements. Sélectionnez un type d'événement pour afficher les détails le concernant.

Type d'événement Cause de l'événement
dashboard:loaded Dans les tableaux de bord où les vignettes ne sont pas configurées pour s'exécuter automatiquement, un tableau de bord et ses éléments sont chargés, mais les requêtes ne sont pas encore en cours d'exécution.
dashboard:run:start Un tableau de bord a commencé à se charger, et ses tuiles ont commencé à charger et à interroger les données.
dashboard:run:complete Un tableau de bord a fini de s'exécuter, et toutes les vignettes ont fini de se charger et d'interroger les données.
dashboard:download Le téléchargement d'un PDF d'un tableau de bord a commencé.
dashboard:edit:start Ajouté dans la version 22.20 Un tableau de bord a été mis en mode Édition. L'événement dashboard:save:complete est déclenché lorsque le tableau de bord est enregistré.
dashboard:edit:cancel Ajouté dans la version 22.20 Vous avez quitté le mode Édition d'un tableau de bord sans l'enregistrer.
dashboard:save:complete Un tableau de bord a été modifié et enregistré.
dashboard:delete:complete Un tableau de bord a été supprimé.
dashboard:tile:start Une tuile a commencé à charger des données ou à les interroger.
dashboard:tile:complete Une tuile a terminé d'exécuter la requête.
dashboard:tile:download Le téléchargement des données d'une tuile a commencé.
dashboard:tile:explore Un utilisateur a cliqué sur l'option Explorer à partir d'ici dans une vignette de tableau de bord.
dashboard:tile:view Un utilisateur a cliqué sur l'option Afficher le Look d'origine dans une tuile de tableau de bord.
dashboard:filters:changed Les filtres d'un tableau de bord ont été appliqués ou modifiés.
look:ready Un Look a commencé à charger les données de requête, que la requête s'exécute ou non.
look:run:start Une requête a commencé à s'exécuter et un Look a commencé à charger les données de la requête.
look:run:complete Une requête Look a été exécutée.
look:edit:start Ajouté dans la version 25.10 Un Look est passé en mode Édition. L'événement look:save:complete est déclenché lorsque le look est enregistré.
look:edit:cancel Ajouté dans la version 25.10 Un look en mode édition a été quitté sans être enregistré.
look:save:complete Un Look a été modifié et enregistré.
look:delete:complete Un Look a été déplacé dans le dossier Corbeille.
drillmenu:click Un utilisateur a cliqué sur un menu d'analyse dans un tableau de bord créé avec le paramètre LookML link.
drillmodal:download Un utilisateur a ouvert une boîte de dialogue d'analyse à partir d'une tuile de tableau de bord et a cliqué sur l'option Télécharger.
drillmodal:explore Un utilisateur a cliqué sur l'option Explorer à partir d'ici dans une boîte de dialogue d'analyse.
explore:ready Une exploration a commencé à charger les données de requête, que la requête s'exécute ou non.
explore:run:start Une exploration a commencé à charger les données de la requête et la requête a commencé à s'exécuter.
explore:run:complete Une exploration a terminé d'exécuter la requête.
explore:state:changed L'URL d'une page Explorer a été modifiée à la suite des actions de l'utilisateur.
page:changed Un utilisateur a accédé à une nouvelle page dans l'iframe.
page:properties:changed La hauteur d'un iFrame de tableau de bord a changé.
session:tokens Le client Looker nécessite des jetons pour continuer.
session:expired Added 25.10 La session de l'utilisateur a expiré.
session:status Envoie des informations sur l'état d'une session.
env:client:dialog Une boîte de dialogue s'est ouverte et peut être partiellement hors de vue (par exemple, une boîte de dialogue d'analyse). Cet événement permet à l'application hôte de faire défiler la boîte de dialogue pour l'afficher.

Documentation de référence sur les types d'événements

L'iframe intégré peut créer de nombreux types d'événements :

dashboard:loaded

Dans les tableaux de bord où les tuiles ne sont pas configurées pour s'exécuter automatiquement, cet événement est créé une fois qu'un tableau de bord et ses éléments ont été chargés, mais avant l'exécution des requêtes.


type: "dashboard:loaded",
status: "complete",
dashboard: {
  id: 1,
  title: "Business Pulse",
  canEdit: true,
  dashboard_filters: {
    "date": "Last 6 Years",
    "state": ""
  },
  absoluteUrl: "https://self-signed.looker.com:9999/embed/dashboards/1?embed_domain=https%3A%2F%2Fself-signed.looker.com%3A9999&date=Last+6+Years&state=",
  url: "/embed/dashboards/1?embed_domain=https%3A%2F%2Fself-signed.looker.com%3A9999&date=Last+6+Years&state=",
  options: {
    layouts: [
      {
        id: 1,
        dashboard_id: 1,
        type: "newspaper",
        active: true,
        column_width: null,
        width: null,
        deleted: false,
        dashboard_layout_components: [
          {
            id: 1,
            dashboard_layout_id: 1,
            dashboard_element_id: 1,
            row: 0,
            column: 0,
            width: 8,
            height: 4,
            deleted: false
          },
          {
            id: 2,
            dashboard_layout_id: 1,
            dashboard_element_id: 2,
            row: 0,
            column: 8,
            width: 8,
            height: 4,
            deleted: false
          }
        ]
      }
    ],
    elements: {
      1: {
        title: "Total Orders",
        title_hidden: false,
        vis_config: {
          type: "single_value",
          font_size: "medium",
          title: "Total Orders"
        }
      },
      2: {
        title: "Average Order Profit",
        title_hidden: false,
        vis_config: {
          type: "single_value",
          title: "Average Order Profit"
        }
      }
    }
  }
}
Attribut Format Description
status Chaîne Indique si le tableau de bord et ses éléments ont été chargés correctement.
dashboard.id Nombre/Chaîne ID du tableau de bord.
dashboard.title Chaîne Titre, tel qu'il apparaît en haut du tableau de bord.
dashboard.canEdit Booléen Ajouté dans la version 22.20 Lorsque la valeur est true, l'utilisateur peut modifier le tableau de bord.
dashboard.dashboard_filters Objet Filtres appliqués au tableau de bord. Cet objet a le format suivant : {"Filter name 1": "value 1", "Filter name 2": "value 2", ...}
dashboard.absoluteUrl Chaîne URL complète du tableau de bord.
dashboard.url Chaîne URL relative du tableau de bord (chemin d'accès uniquement).
dashboard.options Objet Propriétés et valeurs de la mise en page du tableau de bord, du composant de mise en page du tableau de bord et de l'élément du tableau de bord. Toutes les propriétés renvoyées dans l'objet options peuvent être mises à jour à l'aide de l'événement dashboard:options:set.

dashboard:run:start

Cet événement est créé lorsqu'un tableau de bord commence à se charger, et que ses tuiles commencent à charger et à interroger les données.

type: "dashboard:run:start",
dashboard: {
  id: 23,
  title: "My Dashboard",
  canEdit: true,
  url: "/embed/dashboards/...",
  absoluteUrl: "https://instance_name.looker.com/embed/dashboards/...",
  dashboard_filters: {
    "Date": "Last 28 days",
    "Total Orders": "Greater than 100"
  }
}
Attribut Format Description
dashboard.id Nombre/Chaîne ID du tableau de bord.
dashboard.title Chaîne Titre, tel qu'il apparaît en haut du tableau de bord.
dashboard.canEdit Booléen Ajouté dans la version 22.20 Lorsque la valeur est true, l'utilisateur peut modifier le tableau de bord.
dashboard.url Chaîne URL relative du tableau de bord (chemin d'accès uniquement).
dashboard.absoluteUrl Chaîne URL complète du tableau de bord.
dashboard.dashboard_filters Objet Filtres appliqués au tableau de bord. Cet objet a le format suivant : {"Filter name 1": "value 1", "Filter name 2": "value 2", ...}

dashboard:run:complete

Cet événement est créé lorsqu'un tableau de bord a fini de s'exécuter et que toutes les tuiles ont fini de se charger et d'interroger les données. Cet événement est créé, que toutes les tuiles se chargent correctement ou non.

type: "dashboard:run:complete",
status: "complete",
dashboard: {
  id: 23,
  title: "My Dashboard",
  canEdit: true,
  url: "/embed/dashboards/...",
  absoluteUrl: "https://my.looker.com/embed/dashboards/...",
  dashboard_filters: {
    "Date": "Last 28 days",
    "Total Orders": "Greater than 100"
  }
  options: {
    layouts: [
      {
        id: 1,
        dashboard_id: 1,
        type: "newspaper",
        active: true,
        column_width: null,
        width: null,
        deleted: false,
        dashboard_layout_components: [
          {
            id: 1,
            dashboard_layout_id: 1,
            dashboard_element_id: 1,
            row: 0,
            column: 0,
            width: 8,
            height: 4,
            deleted: false
          },
          {
            id: 2,
            dashboard_layout_id: 1,
            dashboard_element_id: 2,
            row: 0,
            column: 8,
            width: 8,
            height: 4,
            deleted: false
          }
        ]
      }
    ],
    elements: {
      1: {
        title: "Total Orders",
        title_hidden: false,
        vis_config: {
          type: "single_value",
          font_size: "medium",
          title: "Total Orders"
        }
      },
      2: {
        title: "Average Order Profit",
        title_hidden: false,
        vis_config: {
          type: "single_value",
          title: "Average Order Profit"
        }
      }
    }
  }
}
Attribut Format Description
status Chaîne Indique si le tableau de bord et ses éléments ont été exécutés avec succès. Si le tableau de bord et ses éléments ont été exécutés avec succès, status renvoie "complete". Sinon, status renvoie "error". Si le tableau de bord en cours d'exécution a été arrêté, soit à partir de l'interface utilisateur, soit avec l'action dashboard:stop, status renvoie "stopped".
dashboard.id Nombre/Chaîne ID du tableau de bord.
dashboard.title Chaîne Titre, tel qu'il apparaît en haut du tableau de bord.
dashboard.canEdit Booléen Ajouté dans la version 22.20 Lorsque la valeur est true, l'utilisateur peut modifier le tableau de bord.
dashboard.url Chaîne URL relative du tableau de bord (chemin d'accès uniquement).
dashboard.absoluteUrl Chaîne URL complète du tableau de bord.
dashboard.dashboard_filters Objet Filtres appliqués au tableau de bord. Cet objet a le format suivant : {"Filter name 1": "value 1", "Filter name 2": "value 2", ...}
dashboard.options Objet Propriétés et valeurs de la mise en page du tableau de bord, du composant de mise en page du tableau de bord et de l'élément du tableau de bord. Toutes les propriétés renvoyées dans l'objet options peuvent être mises à jour à l'aide de l'action dashboard:options:set.
dashboard.tileStatuses Tableau d'objets Tableau d'objets fournissant les états des tuiles. Les propriétés de l'objet sont les suivantes :

  • tileId : numéro d'identification de la tuile.
  • status : si la requête de tuile a été exécutée avec succès, status renvoie "complete". Sinon, status renvoie "error".
  • errors : renseigné lorsque la propriété status est définie sur "error". Tableau d'objets fournissant des détails sur l'erreur, y compris le texte du message d'erreur, une description plus détaillée de l'erreur et la requête SQL du bloc qui a généré l'erreur.

dashboard:download

Cet événement est créé lorsqu'un PDF d'un tableau de bord a commencé à être téléchargé.

type: "dashboard:download",
dashboard: {
  id: 23,
  title: "My Dashboard",
  canEdit: true,
  url: "/embed/dashboards/...",
  absoluteUrl: "https://instance_name.looker.com/embed/dashboards/...",
  dashboard_filters: {
    "Date": "Last 28 days",
    "Total Orders": "Greater than 100"
  }
}
fileFormat: "pdf"
Attribut Format Description
dashboard.id Nombre/Chaîne ID du tableau de bord.
dashboard.title Chaîne Titre, tel qu'il apparaît en haut du tableau de bord.
dashboard.canEdit Booléen Ajouté dans la version 22.20 Lorsque la valeur est true, l'utilisateur peut modifier le tableau de bord.
dashboard.url Chaîne URL relative du tableau de bord (chemin d'accès uniquement).
dashboard.absoluteUrl Chaîne URL complète du tableau de bord.
dashboard.dashboard_filters Objet Filtres appliqués au tableau de bord. Cet objet a le format suivant : {"Filter name 1": "value 1", "Filter name 2": "value 2", ...}
fileFormat Chaîne Format du tableau de bord téléchargé (pour le moment, seul "pdf" est disponible).

dashboard:edit:start

Added 22.20 Cet événement est créé lorsqu'un tableau de bord est basculé en mode édition.

type: "dashboard:edit:start",
dashboard: {
  id: 23,
  title: "My Dashboard",
  canEdit: true,
  url: "/embed/dashboards/...",
  absoluteUrl: "https://instance_name.looker.com/embed/dashboards/...",
  dashboard_filters: {
    "Date": "Last 28 days",
    "Total Orders": "Greater than 100"
  }
}
Attribut Format Description
dashboard.id Nombre/Chaîne ID du tableau de bord.
dashboard.title Chaîne Titre, tel qu'il apparaît en haut du tableau de bord.
dashboard.canEdit Booléen Ajouté dans la version 22.20 Lorsque la valeur est true, l'utilisateur peut modifier le tableau de bord.
dashboard.url Chaîne URL relative du tableau de bord (chemin d'accès uniquement).
dashboard.absoluteUrl Chaîne URL complète du tableau de bord.
dashboard.dashboard_filters Objet Filtres appliqués au tableau de bord. Cet objet a le format suivant : {"Filter name 1": "value 1", "Filter name 2": "value 2", ...}

dashboard:edit:cancel

Ajouté dans la version 22.20 Cet événement est créé lorsqu'un tableau de bord en mode Édition est quitté sans être enregistré.

type: "dashboard:edit:cancel",
dashboard: {
  id: 23,
  title: "My Dashboard",
  canEdit: true,
  url: "/embed/dashboards/...",
  absoluteUrl: "https://instance_name.looker.com/embed/dashboards/...",
  dashboard_filters: {
    "Date": "Last 28 days",
    "Total Orders": "Greater than 100"
  }
}
Attribut Format Description
dashboard.id Nombre/Chaîne ID du tableau de bord.
dashboard.title Chaîne Titre, tel qu'il apparaît en haut du tableau de bord.
dashboard.canEdit Booléen Ajouté dans la version 22.20 Lorsque la valeur est true, l'utilisateur peut modifier le tableau de bord.
dashboard.url Chaîne URL relative du tableau de bord (chemin d'accès uniquement).
dashboard.absoluteUrl Chaîne URL complète du tableau de bord.
dashboard.dashboard_filters Objet Filtres appliqués au tableau de bord. Cet objet a le format suivant : {"Filter name 1": "value 1", "Filter name 2": "value 2", ...}

dashboard:save:complete

Cet événement est créé lorsqu'un tableau de bord est modifié, puis enregistré.

type: "dashboard:save:complete",
dashboard: {
  id: 23,
  title: "My Dashboard",
  canEdit: true,
  dashboard_filters: {
    "Date": "Last 28 days",
    "Total Orders": "Greater than 100"
  }
  absoluteUrl: "https://instance_name.looker.com/embed/dashboards/...",
  url: "/embed/dashboards/...",
  options: {
    layouts: [
      {
        id: 1,
        dashboard_id: 1,
        type: "newspaper",
        active: true,
        column_width: null,
        width: null,
        deleted: false,
        dashboard_layout_components: [
          {
            id: 1,
            dashboard_layout_id: 1,
            dashboard_element_id: 1,
            row: 0,
            column: 0,
            width: 8,
            height: 4,
            deleted: false
          },
          {
            id: 2,
            dashboard_layout_id: 1,
            dashboard_element_id: 2,
            row: 0,
            column: 8,
            width: 8,
            height: 4,
            deleted: false
          }
        ]
      }
    ],
    elements: {
      1: {
        title: "Total Orders",
        title_hidden: false,
        vis_config: {
          type: "single_value",
          font_size: "medium",
          title: "Total Orders"
        }
      },
      2: {
        title: "Average Order Profit",
        title_hidden: false,
        vis_config: {
          type: "single_value",
          title: "Average Order Profit"
        }
      }
    }
  }
}
Attribut Format Description
dashboard.id Nombre/Chaîne ID du tableau de bord.
dashboard.title Chaîne Titre, tel qu'il apparaît en haut du tableau de bord.
dashboard.canEdit Booléen Ajouté dans la version 22.20 Lorsque la valeur est true, l'utilisateur peut modifier le tableau de bord.
dashboard.dashboard_filters Objet Filtres appliqués au tableau de bord. Cet objet a le format suivant : {"Filter name 1": "value 1", "Filter name 2": "value 2", ...}
dashboard.absoluteUrl Chaîne URL complète du tableau de bord.
dashboard.url Chaîne URL relative du tableau de bord (chemin d'accès uniquement).
dashboard.options Objet Propriétés et valeurs de la mise en page du tableau de bord, du composant de mise en page du tableau de bord et de l'élément du tableau de bord. Toutes les propriétés renvoyées dans l'objet options peuvent être mises à jour à l'aide de l'événement dashboard:options:set.

dashboard:delete:complete

Cet événement est créé lorsqu'un tableau de bord est supprimé.

type: "dashboard:delete:complete",
dashboard: {
  id: 23,
  title: "My Dashboard",
  canEdit: true,
  dashboard_filters: {
    "Date": "Last 28 days",
    "Total Orders": "Greater than 100"
  }
  absoluteUrl: "https://instance_name.looker.com/embed/dashboards/...",
  url: "/embed/dashboards/...",
  options: {
    layouts: [
      {
        id: 1,
        dashboard_id: 1,
        type: "newspaper",
        active: true,
        column_width: null,
        width: null,
        deleted: false,
        dashboard_layout_components: [
          {
            id: 1,
            dashboard_layout_id: 1,
            dashboard_element_id: 1,
            row: 0,
            column: 0,
            width: 8,
            height: 4,
            deleted: false
          },
          {
            id: 2,
            dashboard_layout_id: 1,
            dashboard_element_id: 2,
            row: 0,
            column: 8,
            width: 8,
            height: 4,
            deleted: false
          }
        ]
      }
    ],
    elements: {
      1: {
        title: "Total Orders",
        title_hidden: false,
        vis_config: {
          type: "single_value",
          font_size: "medium",
          title: "Total Orders"
        }
      },
      2: {
        title: "Average Order Profit",
        title_hidden: false,
        vis_config: {
          type: "single_value",
          title: "Average Order Profit"
        }
      }
    }
  }
}
Attribut Format Description
dashboard.id Nombre/Chaîne ID du tableau de bord.
dashboard.title Chaîne Titre, tel qu'il apparaît en haut du tableau de bord.
dashboard.canEdit Booléen Ajouté dans la version 22.20 Lorsque la valeur est true, l'utilisateur peut modifier le tableau de bord.
dashboard.dashboard_filters Objet Filtres appliqués au tableau de bord. Cet objet a le format suivant : {"Filter name 1": "value 1", "Filter name 2": "value 2", ...}
dashboard.absoluteUrl Chaîne URL complète du tableau de bord.
dashboard.url Chaîne URL relative du tableau de bord (chemin d'accès uniquement).
dashboard.options Objet Propriétés et valeurs de la mise en page du tableau de bord, du composant de mise en page du tableau de bord et de l'élément du tableau de bord. Toutes les propriétés renvoyées dans l'objet options peuvent être mises à jour à l'aide de l'événement dashboard:options:set.

dashboard:tile:start

Cet événement est créé lorsqu'un bloc commence à charger des données ou à les interroger.

type: "dashboard:tile:start",
dashboard: {
  id: 23,
  title: "My Dashboard",
  canEdit: true,
  url: "/embed/dashboards/...",
  absoluteUrl: "https://instance_name.looker.com/embed/dashboards/...",
  dashboard_filters: {
    "Date": "Last 28 days",
    "Total Orders": "Greater than 100"
  }
}
tile: {
  id: 123,
  title: "Quarterly Sales",
  listen: {
    "Date": "order.date",
    "Total Orders": "order.count"
  }
}
Attribut Format Description
dashboard.id Nombre/Chaîne ID du tableau de bord auquel appartient le bloc.
dashboard.title Chaîne Titre du tableau de bord, tel qu'il s'affiche en haut du tableau de bord auquel appartient la vignette.
dashboard.canEdit Booléen Ajouté dans la version 22.20 Lorsque la valeur est true, l'utilisateur peut modifier le tableau de bord.
dashboard.url Chaîne URL relative du tableau de bord (chemin uniquement) auquel appartient le bloc.
dashboard.absoluteUrl Chaîne URL complète du tableau de bord auquel appartient le bloc.
dashboard.dashboard_filters Objet Filtres appliqués au tableau de bord auquel appartient la vignette. Cet objet a le format suivant : {"Filter name 1": "value 1", "Filter name 2": "value 2", ...}
tile.id Integer Numéro d'ID de l'événement, et non de la vignette.
tile.title Chaîne Titre de la vignette, tel qu'il s'affiche en haut de la vignette.
tile.listen Objet Filtres de tableau de bord global auxquels cette vignette est associée. Cet objet a le format suivant : {"Filter Label": "Filter Field", ...}

dashboard:tile:complete

Cet événement est créé lorsqu'un bloc a terminé d'exécuter la requête.

type: "dashboard:tile:complete",
dashboard: {
  id: 23,
  title: "My Dashboard",
  canEdit: true,
  url: "/embed/dashboards/...",
  absoluteUrl: "https://instance_name.looker.com/embed/dashboards/...",
  dashboard_filters: {
    "Date": "Last 28 days",
    "Total Orders": "Greater than 100"
  }
}
status: "complete",
truncated: false,
tile: {
  id: 123,
  title: "Quarterly Sales",
  listen: {
    "Date": "order.date",
    "Total Orders": "order.count"
  }
}
Attribut Format Description
dashboard.id Nombre/Chaîne ID du tableau de bord auquel appartient le bloc.
dashboard.title Chaîne Titre du tableau de bord, tel qu'il s'affiche en haut du tableau de bord auquel appartient la vignette.
dashboard.canEdit Booléen Ajouté dans la version 22.20 Lorsque la valeur est true, l'utilisateur peut modifier le tableau de bord.
dashboard.url Chaîne URL relative du tableau de bord (chemin uniquement) auquel appartient le bloc.
dashboard.absoluteUrl Chaîne URL complète du tableau de bord auquel appartient le bloc.
dashboard.dashboard_filters Objet Filtres appliqués au tableau de bord auquel appartient la vignette. Cet objet a le format suivant : {"Filter name 1": "value 1", "Filter name 2": "value 2", ...}
status Chaîne Indique si la requête de tuile a été exécutée correctement. Les valeurs possibles sont "complete" ou "error".
truncated Booléen Indique si les résultats de la requête de tuile ont été tronqués, car la requête a renvoyé plus de lignes que la limite de lignes autorisée. La limite maximale de lignes peut être spécifiée par l'utilisateur ou correspondre à la limite par défaut de Looker (5 000 lignes).
tile.id Integer Numéro d'ID de l'événement, et non de la vignette.
tile.title Chaîne Titre de la vignette, tel qu'il s'affiche en haut de la vignette.
tile.listen Objet Filtres de tableau de bord global auxquels cette vignette est associée. Cet objet a le format suivant : {"Filter Label": "Filter Field", ...}
tile.errors Tableau d'objets Renseigné lorsque la propriété status est définie sur "error". Tableau d'objets fournissant des détails sur l'erreur, y compris le texte du message d'erreur, une description plus détaillée de l'erreur et la requête SQL du bloc qui a généré l'erreur.

dashboard:tile:download

Cet événement est créé lorsque les données d'une tuile ont commencé à être téléchargées.

type: "dashboard:tile:download",
dashboard: {
  id: 23,
  title: "My Dashboard",
  canEdit: true,
  url: "/embed/dashboards/...",
  absoluteUrl: "https://instance_name.looker.com/embed/dashboards/...",
  dashboard_filters: {
    "Date": "Last 28 days",
    "Total Orders": "Greater than 100"
  }
}
tile: {
  id: 123,
  title: "Quarterly Sales"
  listen: {
    "Date": "order.date",
    "Total Orders": "order.count"
  }
}
fileFormat: "pdf"
Attribut Format Description
dashboard.id Nombre/Chaîne ID du tableau de bord auquel appartient le bloc.
dashboard.title Chaîne Titre du tableau de bord, tel qu'il s'affiche en haut du tableau de bord auquel appartient la vignette.
dashboard.canEdit Booléen Ajouté dans la version 22.20 Lorsque la valeur est true, l'utilisateur peut modifier le tableau de bord.
dashboard.url Chaîne URL relative du tableau de bord (chemin uniquement) auquel appartient le bloc.
dashboard.absoluteUrl Chaîne URL complète du tableau de bord auquel appartient le bloc.
dashboard.dashboard_filters Objet Filtres appliqués au tableau de bord auquel appartient la vignette. Cet objet a le format suivant : {"Filter name 1": "value 1", "Filter name 2": "value 2", ...}
tile.id Integer Numéro d'ID de l'événement, et non de la vignette.
tile.title Chaîne Titre de la vignette, tel qu'il s'affiche en haut de la vignette.
tile.listen Objet Filtres de tableau de bord global auxquels cette vignette est associée. Cet objet a le format suivant : {"Filter Label": "Filter Field", ...}
fileFormat Chaîne Format de la tuile téléchargée (pour le moment, seul "pdf" est disponible).

dashboard:tile:explore

Cet événement est créé lorsqu'un utilisateur clique sur l'option Explorer à partir d'ici dans un bloc de tableau de bord.

type: "dashboard:tile:explore",
label: 'Explore From Here',
url: '/embed/explore/model/view...',
dashboard: {
  id: 23,
  title: "My Dashboard",
  canEdit: true,
  url: "/embed/dashboards/...",
  absoluteUrl: "https://instance_name.looker.com/embed/dashboards/...",
  dashboard_filters: {
    "Date": "Last 28 days",
    "Total Orders": "Greater than 100"
  }
}
tile: {
  id: 123,
  title: "Quarterly Sales",
  listen: {
    "Date": "order.date",
    "Total Orders": "order.count"
  }
}
Attribut Format Description
label Chaîne Libellé du bouton.
url Chaîne URL relative (chemin d'accès uniquement) de l'exploration à afficher.
dashboard.id Nombre/Chaîne ID du tableau de bord auquel appartient le bloc.
dashboard.title Chaîne Titre du tableau de bord, tel qu'il s'affiche en haut du tableau de bord auquel appartient la vignette.
dashboard.canEdit Booléen Ajouté dans la version 22.20 Lorsque la valeur est true, l'utilisateur peut modifier le tableau de bord.
dashboard.url Chaîne URL relative du tableau de bord (chemin uniquement) auquel appartient le bloc.
dashboard.absoluteUrl Chaîne URL complète du tableau de bord auquel appartient le bloc.
dashboard.dashboard_filters Objet Filtres appliqués au tableau de bord auquel appartient la vignette. Cet objet a le format suivant : {"Filter name 1": "value 1", "Filter name 2": "value 2", ...}
tile.id Integer Numéro d'ID de l'événement, et non de la vignette.
tile.title Chaîne Titre de la vignette, tel qu'il s'affiche en haut de la vignette.
tile.listen Objet Filtres de tableau de bord global auxquels cette vignette est associée. Cet objet a le format suivant : {"Filter Label": "Filter Field", ...}

dashboard:tile:view

Cet événement est créé lorsqu'un utilisateur clique sur l'option Afficher l'apparence d'origine dans une tuile de tableau de bord.

type: "dashboard:tile:view",
label: 'View Original Look',
url: '/embed/look/...',
dashboard: {
  id: 23,
  title: "My Dashboard",
  canEdit: true,
  url: "/embed/dashboards/...",
  absoluteUrl: "https://instance_name.looker.com/embed/dashboards/...",
  dashboard_filters: {
    "Date": "Last 28 days",
    "Total Orders": "Greater than 100"
  }
}
tile: {
  id: 123,
  title: "Quarterly Sales",
  listen: {
    "Date": "order.date",
    "Total Orders": "order.count"
  }
}
Attribut Format Description
label Chaîne Libellé du bouton.
url Chaîne URL relative (chemin d'accès uniquement) du Look à afficher.
dashboard.id Nombre/Chaîne ID du tableau de bord auquel appartient le bloc.
dashboard.title Chaîne Titre du tableau de bord, tel qu'il s'affiche en haut du tableau de bord auquel appartient la vignette.
dashboard.canEdit Booléen Ajouté dans la version 22.20 Lorsque la valeur est true, l'utilisateur peut modifier le tableau de bord.
dashboard.url Chaîne URL relative du tableau de bord (chemin uniquement) auquel appartient le bloc.
dashboard.absoluteUrl Chaîne URL complète du tableau de bord auquel appartient le bloc.
dashboard.dashboard_filters Objet Filtres appliqués au tableau de bord auquel appartient la vignette. Cet objet a le format suivant : {"Filter name 1": "value 1", "Filter name 2": "value 2", ...}
tile.id Integer Numéro d'ID de l'événement, et non de la vignette.
tile.title Chaîne Titre de la vignette, tel qu'il s'affiche en haut de la vignette.
tile.listen Objet Filtres de tableau de bord global auxquels cette vignette est associée. Cet objet a le format suivant : {"Filter Label": "Filter Field", ...}

dashboard:filters:changed

Cet événement est créé lorsque les filtres d'un tableau de bord ont été appliqués ou modifiés.

type: "dashboard:filters:changed",
dashboard: {
  id: 23,
  title: "My Dashboard",
  canEdit: true,
  url: "/embed/dashboards/...",
  absoluteUrl: "https://instance_name.looker.com/embed/dashboards/...",
  dashboard_filters: {
    "Date": "Last 28 days",
    "Total Orders": "Greater than 100"
  }
  options: {
    layouts: [
      {
        id: 1,
        dashboard_id: 1,
        type: "newspaper",
        active: true,
        column_width: null,
        width: null,
        deleted: false,
        dashboard_layout_components: [
          {
            id: 1,
            dashboard_layout_id: 1,
            dashboard_element_id: 1,
            row: 0,
            column: 0,
            width: 8,
            height: 4,
            deleted: false
          },
          {
            id: 2,
            dashboard_layout_id: 1,
            dashboard_element_id: 2,
            row: 0,
            column: 8,
            width: 8,
            height: 4,
            deleted: false
          }
        ]
      }
    ],
    elements: {
      1: {
        title: "Total Orders",
        title_hidden: false,
        vis_config: {
          type: "single_value",
          font_size: "medium",
          title: "Total Orders"
        }
      },
      2: {
        title: "Average Order Profit",
        title_hidden: false,
        vis_config: {
          type: "single_value",
          title: "Average Order Profit"
        }
      }
    }
  }
}
Attribut Format Description
dashboard.id Nombre/Chaîne ID du tableau de bord.
dashboard.title Chaîne Titre, tel qu'il apparaît en haut du tableau de bord.
dashboard.canEdit Booléen Ajouté dans la version 22.20 Lorsque la valeur est true, l'utilisateur peut modifier le tableau de bord.
dashboard.url Chaîne URL relative du tableau de bord (chemin d'accès uniquement).
dashboard.absoluteUrl Chaîne URL complète du tableau de bord.
dashboard.dashboard_filters Objet Filtres appliqués au tableau de bord. Cet objet a le format suivant : {"Filter name 1": "value 1", "Filter name 2": "value 2", ...}
dashboard.options Objet Propriétés et valeurs de la mise en page du tableau de bord, du composant de mise en page du tableau de bord et de l'élément du tableau de bord. Toutes les propriétés renvoyées dans l'objet options peuvent être mises à jour à l'aide de l'événement dashboard:options:set.

look:ready

Cet événement est créé lorsqu'un Look commence à charger des données de requête, que la requête s'exécute ou non.

type: "look:ready",
look: {
  url: "/embed/looks/...",
  absoluteUrl: "https://instance_name.looker.com/embed/looks/...",
  }
Attribut Format Description
look.url Chaîne URL relative de la présentation (chemin d'accès uniquement)
look.absoluteUrl Chaîne URL complète du Look

look:run:start

Cet événement est créé lorsqu'un Look commence à charger les données de requête et que la requête commence à s'exécuter.

type: "look:run:start",
look: {
  url: "/embed/looks/...",
  absoluteUrl: "https://instance_name.looker.com/embed/looks/...",
  }
Attribut Format Description
look.url Chaîne URL relative de la présentation (chemin d'accès uniquement)
look.absoluteUrl Chaîne URL complète du Look

look:run:complete

Cet événement est créé lorsqu'un Look a terminé d'exécuter la requête.

type: look:run:complete
look: {
  url: "/embed/looks/...",
  absoluteUrl: "https://instance_name.looker.com/embed/looks/...",
  }
Attribut Format Description
look.url Chaîne URL relative de la présentation (chemin d'accès uniquement)
look.absoluteUrl Chaîne URL complète du Look

look:edit:start

Ajouté le 25/10 Cet événement est déclenché lorsqu'un look est mis en mode édition.

type: "look:edit:start",
look: {
  id: 46,
  title: "My Look",
  url: "/embed/looks/46",
  absoluteUrl: "https://instance_name.looker.com/embed/looks/46",
}
Attribut Format Description
look.id Chaîne ID du Look.
look.title Chaîne Titre de la présentation.
url Chaîne URL relative de la présentation (chemin uniquement).
absoluteUrl Chaîne URL complète du Look.

look:edit:cancel

Ajouté le 25/10 Cet événement est déclenché lorsqu'un Look en mode édition est quitté sans être enregistré.

type: "look:edit:cancel",
look: {
  id: 46,
  title: "My Look",
  url: "/embed/looks/46",
  absoluteUrl: "https://instance_name.looker.com/embed/looks/46",
}
Attribut Format Description
look.id Chaîne ID du Look.
look.title Chaîne Titre de la présentation.
url Chaîne URL relative de la présentation (chemin uniquement).
absoluteUrl Chaîne URL complète du Look.

look:save:complete

Cet événement est créé lorsqu'un Look est modifié et enregistré. Cet événement est créé lorsqu'un utilisateur effectue l'une des tâches suivantes :

Cet événement n'est pas créé si la présentation est enregistrée avec l'option de menu Enregistrer > Dans un tableau de bord existant ou Modifier les paramètres.

type: look:save:complete
look: {
  url: "/embed/looks/...",
  absoluteUrl: "https://instance_name.looker.com/embed/looks/...",
  folderid: 123
  }
Attribut Format Description
look.url Chaîne URL relative de la présentation (chemin d'accès uniquement)
look.absoluteUrl Chaîne URL complète du Look
look.folderid Integer ID du dossier dans lequel la requête Look est stockée

look:delete:complete

Cet événement est créé lorsqu'un Look est déplacé vers le dossier Corbeille.

type: look:delete:complete
look: {
  url: "/embed/looks/...",
  absoluteUrl: "https://instance_name.looker.com/embed/looks/...",
  }
Attribut Format Description
look.url Chaîne URL relative de la présentation (chemin d'accès uniquement)
look.absoluteUrl Chaîne URL complète du Look

drillmenu:click

Cet événement est créé lorsqu'un utilisateur clique sur un menu d'analyse dans un tableau de bord créé avec le paramètre LookML link. Par exemple, le code LookML suivant crée un menu "Afficher le détail" dans lequel un utilisateur peut afficher les données filtrées par la dimension state :


dimension: state {
  type: string
  sql: ${TABLE}.state ;;
  link: {
    label: "Filter by {{ state | encode_uri }}"
    url: "filter::q={{ state | encode_uri }}"
    icon_url: "https://google.com/favicon.ico"
  }
}

Lorsque le filtre state est défini sur Illinois, l'événement drillmenu:click renvoie les informations suivantes à l'hôte de l'iFrame :

type: "drillmenu:click",
label: "Filter by Illinois",
link_type: "url",
modal: false,
target: '_self',
url: "#filter::state=Illinois"
context: ' '
Attribut Format Description
label Chaîne Libellé du lien tel qu'il apparaît dans le menu "Afficher le détail"
link_type Chaîne Type d'objet de la destination du lien
modal Booléen Indique si la boîte de dialogue d'analyse sera utilisée à la place de la navigation dans le navigateur.
target Chaîne _self si la destination du lien remplace l'iframe actuel, _blank si la destination du lien ouvre une nouvelle fenêtre
url Chaîne URL de la destination du lien
context Chaîne Attribut interne utilisé par certains types de visualisations

Si vous placez l'iframe dans un bac à sable, les clics sur le menu "Afficher le détail" ne s'ouvriront pas dans une nouvelle fenêtre. Utilisez ces valeurs de bac à sable dans la balise iframe :

sandbox = "allow-same-origin allow-scripts"

drillmodal:download

Cet événement est créé lorsqu'un utilisateur ouvre une boîte de dialogue d'analyse à partir d'une tuile de tableau de bord et clique sur l'option Télécharger.

{
type: "drillmodal:download",
dashboard: {
  id: 23,
  title: "My Dashboard",
  url: "/embed/dashboards/…",
  absoluteUrl: "https://instance_name.looker.com/embed/dashboards/…",
  dashboard_filters: {
    "Date": "Last 28 days",
    "Total Orders": "Greater than 100"
  }
}
drillExploreUrl: "/embed...",
fileFormat: "pdf"
}
Attribut Format Description
dashboard.id Nombre/Chaîne ID du tableau de bord auquel appartient le bloc.
dashboard.title Chaîne Titre du tableau de bord, tel qu'il s'affiche en haut du tableau de bord auquel appartient la vignette.
dashboard.url Chaîne URL relative du tableau de bord (chemin uniquement) auquel appartient le bloc.
dashboard.absoluteUrl Chaîne URL complète du tableau de bord auquel appartient le bloc.
dashboard.dashboard_filters Objet Filtres appliqués au tableau de bord auquel appartient la vignette. Cet objet a le format suivant : {"Filter name 1": "value 1", "Filter name 2": "value 2", ...}
drillExploreUrl Chaîne URL relative de l'exploration (chemin d'accès uniquement) à télécharger.
fileFormat Chaîne Format du fichier de données téléchargé.

drillmodal:explore

Cet événement est créé lorsqu'un utilisateur clique sur l'option Explorer à partir d'ici dans une boîte de dialogue d'analyse.

type: "drillmodal:explore",
label: "Explore From Here",
url: "/embed/explore/model/view..."
Attribut Format Description
label Chaîne Libellé du bouton tel qu'il s'affiche dans le menu d'analyse
url Chaîne URL relative de l'exploration (chemin d'accès uniquement) à afficher

explore:ready

Cet événement est créé lorsqu'une exploration commence à charger des données de requête, que la requête s'exécute ou non.

type: "explore:ready",
explore: {
  url: "/embed/explore/...",
  absoluteUrl: "https://instance_name.looker.com/embed/explore/...",
  }
Attribut Format Description
explore.url Chaîne URL relative de l'exploration (chemin d'accès uniquement)
explore.absoluteUrl Chaîne URL Explore complète

explore:run:start

Cet événement est créé lorsqu'une exploration commence à charger les données de requête et que la requête commence à s'exécuter.

type: "explore:run:start",
explore: {
  url: "/embed/explore/...",
  absoluteUrl: "https://instance_name.looker.com/embed/explore/...",
  }
Attribut Format Description
explore.url Chaîne URL relative de l'exploration (chemin d'accès uniquement)
explore.absoluteUrl Chaîne URL Explore complète

explore:run:complete

Cet événement est créé lorsqu'une exploration a terminé d'exécuter la requête.

type: "explore:run:complete",
explore: {
  url: "/embed/explore/...",
  absoluteUrl: "https://instance_name.looker.com/embed/explore/...",
  }
}
Attribut Format Description
explore.url Chaîne URL relative de l'exploration (chemin d'accès uniquement)
explore.absoluteUrl Chaîne URL Explore complète

explore:state:changed

Cet événement est créé lorsqu'une URL de page Explorer change à la suite des actions de l'utilisateur.

type: "explore:state:changed",
explore: {
  url: "/embed/explore/...",
  absoluteUrl: "https://instance_name.looker.com/embed/explore/..."
}
Attribut Format Description
explore.url Chaîne URL relative de l'exploration (chemin d'accès uniquement)
explore.absoluteUrl Chaîne URL Explore complète

page:changed

Cet événement est créé lorsqu'un utilisateur accède à une nouvelle page dans l'iframe.

type: "page:changed",
page: {
  type: "dashboard",
  url: "/embed/dashboards/...",
  absoluteUrl: "https://instance_name.looker.com/embed/dashboards/..."
}
Attribut Format Description
page.type Chaîne Type de page vers laquelle l'utilisateur vient d'être redirigé, par exemple "dashboard", "look" ou "explore"
page.url Chaîne URL relative (chemin d'accès uniquement) de la page vers laquelle l'utilisateur vient d'être redirigé
page.absoluteUrl Chaîne URL complète de la page vers laquelle l'utilisateur vient d'être redirigé

page:properties:changed

Cet événement est créé lorsque la hauteur d'un iFrame de tableau de bord change. Elle n'est pas disponible pour les Looks ni les Explorations, car ces éléments ajustent automatiquement leur hauteur à la taille de l'iFrame.

type: "page:properties:changed",
height: 1000
Attribut Format Description
height Integer Hauteur de l'iframe du tableau de bord en pixels

session:tokens

Cet événement indique que le client Looker a besoin de jetons pour continuer. Cet événement est créé immédiatement lors de la création de l'iFrame, puis périodiquement pendant toute la durée de la session.

{
  "type": "session:tokens",
  "api_token": "eyJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczovL3NlbGYtc2lnbmVkLmxvb2tlci5jb206OTk5OSIsImV4cCI6MTY3MDYyNjMzMCwic3ViIjoiYVdrNWFGUzM4RnRwNzFFWXhuS3ZaMXdKRmV3ZjB2VzYtTV9zLWtCcHE1dXIiLCJ0b2tlbl90eXBlIjoiYXBpX3Rva2VuIiwicmFuZG9taXplciI6IkxjYnpOeDNTVjNOb3o3UVlqTVJjNmhlMkdodjh1a2UwWUhiZWNRMHVCYm1KIn0.CBv1__QGc_H7bKNe31SHMMQCsc5ya1xOiEv1UDWAyxM",
  "api_token_ttl": 463,
  "navigation_token": "eyJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczovL3NlbGYtc2lnbmVkLmxvb2tlci5jb206OTk5OSIsImV4cCI6MTY3MDYyNjMzMCwic3ViIjoiYVdrNWFGUzM4RnRwNzFFWXhuS3ZaMXdKRmV3ZjB2VzYtTV9zLWtCcHE1dXIiLCJ0b2tlbl90eXBlIjoibmF2aWdhdGlvbl90b2tlbiIsInJhbmRvbWl6ZXIiOiJHVVNlc00tdTRPRDlNdktodFJDU2pEcVFhUkJNeTh5dm42Q1FDUXhuLTNxMiJ9.sWo7LUEI5LeragVmeDamUR7u2myXpFJ0aqK_IIALUqI",
  "navigation_token_ttl": 463,
  "session_reference_token_ttl": 2924
}
Attribut Format Description
authentication_token Chaîne Jeton d'authentification. Inclus lors de la création de l'iFrame. Non inclus dans une réponse à une demande de génération de jetons ni si la session a expiré.
authentication_token_ttl Nombre Durée de vie du jeton d'authentification en secondes. Inclus lors de la création de l'iFrame. Non inclus dans une réponse à une demande de génération de jetons ni si la session a expiré.
api_token Chaîne Jeton d'API. Non inclus si la session a expiré.
api_token_ttl Nombre Durée de vie du jeton API en secondes. Non inclus si la session a expiré.
navigation_token Chaîne Jeton de navigation. Non inclus si la session a expiré.
navigation_token_ttl Nombre Durée de vie du jeton de navigation en secondes. Non inclus si la session a expiré.
session_references_token_ttl Nombre Durée de vie de la session en secondes. La valeur sera de 0 lorsque la session aura expiré. Pour récupérer l'accès, l'application d'intégration doit acquérir une nouvelle session.

session:expired

Added 25.10 Cet événement est déclenché lorsque la session de l'utilisateur intégré expire.

type: "session:expired",

Cet événement n'a pas de charge utile.

session:status

L'événement est généré lorsque l'application Looker intégrée traite les demandes de jetons de session.

{
  "type": "session:status",
  "session_ttl": 0,
  "expired": true,
  "interrupted": false
}
Attribut Format Description
session_ttl Nombre Durée de vie de la session en secondes.
expired Booléen Lorsque la valeur est true, cela indique que la session a expiré.
interrupted Booléen Lorsque la valeur est true, cela indique qu'aucune réponse n'a été fournie à une demande de jetons de session. Cela peut indiquer qu'un serveur est temporairement indisponible.
recoverable Booléen Renseigné uniquement lorsque la valeur de "interrupted" est true. Indique si la session peut être récupérée ou non. Une valeur de false signifie probablement qu'il y a un problème avec l'application d'intégration.

env:client:dialog

L'événement est généré lorsqu'une boîte de dialogue est ouverte et peut être partiellement hors champ, comme une boîte de dialogue d'analyse. Cet événement permet à l'application hôte de faire défiler la boîte de dialogue pour l'afficher avec l'action env:host:scroll.

{
  type: "env:client:dialog",
  dialogType: 'drilling',
  placement: 'cover',
  open: true
}
Attribut Format Description
type Chaîne env:client:dialog indique qu'une boîte de dialogue a été ouverte ou fermée. Seule la boîte de dialogue d'analyse est acceptée, mais d'autres boîtes de dialogue pourront être ajoutées à l'avenir. Il est possible que le haut de la boîte de dialogue d'analyse ne soit pas visible, car elle recouvre la fenêtre d'affichage de l'iFrame. Cet événement permet à l'application hôte de faire défiler le haut de la boîte de dialogue pour l'afficher.
dialogType Chaîne Type de boîte de dialogue. Seule l'ouverture ou la fermeture de la boîte de dialogue de type "drilling" déclenche cet événement.
placement Chaîne Emplacement de la boîte de dialogue. Les boîtes de dialogue de type "drilling" utilisent toujours un placement de "cover".
open Booléen Indique si la boîte de dialogue est ouverte ou si l'utilisateur a fait défiler la page.

Modifier l'iframe

Une fois que vous avez préparé votre iframe pour la récupération des données, vous pouvez le modifier en procédant comme suit :

  1. Rédigez votre requête au format JSON.
  2. Envoyez la requête à contentWindow de l'iFrame.

Rédiger votre demande au format JSON

Vous pouvez apporter plusieurs modifications à l'iframe, que vous enverrez au format JSON. Les options disponibles sont décrites dans la section Référence des actions de cette page. N'oubliez pas d'utiliser JSON.stringify pour convertir votre action en JSON, comme ceci :

var my_request = JSON.stringify(
  {
    type: "dashboard:run"
  }
);

Publier la requête dans la propriété contentWindow de l'iFrame

Enfin, publiez votre message dans le contentWindow de l'iFrame, comme ceci :

var my_iframe = document.getElementById("my_iframe_id");

my_iframe.contentWindow.postMessage(my_request, 'https://instance_name.looker.com');

Tableau récapitulatif des actions

Le tableau suivant récapitule les actions. Sélectionnez une action pour en afficher les détails.

Action Description de l'action
page:load Charge une nouvelle page dans l'iFrame, en remplaçant la page existante.
dashboard:load Charge un nouveau tableau de bord dans l'iFrame, en remplaçant un tableau de bord existant.
dashboard:run Exécute le tableau de bord dans l'iFrame.
dashboard:edit Ajouté dans la version 22.20 Bascule le tableau de bord en mode Édition.
dashboard:filters:update Met à jour un filtre de tableau de bord existant dans l'iFrame.
dashboard:options:set Écrit de nouvelles valeurs dans la mise en page du tableau de bord et dans les propriétés des éléments du tableau de bord.
dashboard:schedule_modal:open Ouvre le planificateur, qui permet aux utilisateurs de fournir du contenu Looker à différentes destinations.
dashboard:stop Arrête un tableau de bord en cours d'exécution ou de rechargement des données.
look:run Exécute le Look dans l'iFrame.
look:filters:update Met à jour un filtre Look existant dans l'iFrame.
explore:run Exécute l'exploration dans l'iFrame.
explore:filters:update Met à jour ou supprime un filtre Explorer existant dans l'iFrame.
session:tokens:request Envoie des jetons en réponse à un événement session:tokens:request.
env:host:scroll Envoie des informations sur la position de défilement actuelle de l'iFrame hôte à l'application Looker intégrée.

Documentation de référence sur les actions

Voici les actions que vous pouvez publier dans l'iFrame intégré :

page:load

Utilisez cette action pour accéder à de nouveaux contenus dans l'iFrame, en remplaçant le contenu existant. Cette action est semblable à l'action dashboard:load, mais elle est plus flexible, car des paramètres supplémentaires peuvent être spécifiés dans l'URL.

Il existe des différences de comportement à prendre en compte avant d'utiliser page:load. dashboard:load empêchera la navigation si le tableau de bord actuel est en cours de modification. page:load n'empêche pas la navigation. L'application hôte peut déterminer si un tableau de bord ou un Look sont en cours de modification en suivant dashboard:edit:start, look:edit:start et leurs événements de fin de modification correspondants. C'est pourquoi nous vous recommandons d'utiliser le SDK d'intégration. Le SDK d'intégration permet de savoir si un tableau de bord ou un Look sont en cours de modification. La connexion peut donc être interrogée pour savoir si du contenu est en cours de modification avant la navigation.

{
    type: 'page:load',
    url: '/embed/dashboard/32?state=california,
    pushHistory: false
}
Attribut Format Description
type Chaîne L'utilisation du type page:load indique que vous souhaitez charger du nouveau contenu dans l'iFrame.
url Chaîne URL du contenu à charger.
pushHistory Booléen Si la valeur est true, le contenu chargé crée une entrée dans l'historique du navigateur, et l'utilisateur peut utiliser le bouton "Retour" du navigateur pour revenir au contenu précédent. Si la valeur est false, le contenu actuel est remplacé et la navigation dans le navigateur ne peut pas être utilisée pour y revenir.

dashboard:load

Utilisez cette action pour charger un nouveau tableau de bord dans l'iFrame, en remplacement d'un tableau de bord existant. Le nouveau tableau de bord commencera à exécuter les requêtes comme si une nouvelle page de tableau de bord avait été ouverte.

{
  type: "dashboard:load",
  id: "101",
  pushHistory: false
}
Attribut Format Description
type Chaîne L'utilisation du type dashboard:load indique que vous souhaitez charger un nouveau tableau de bord dans l'iFrame.
id Chaîne ID du tableau de bord à charger.
pushHistory Booléen Si la valeur est true, le tableau de bord chargé crée une entrée dans l'historique du navigateur. L'utilisateur peut alors utiliser le bouton "Retour" du navigateur pour revenir au tableau de bord précédent. Si la valeur est false, le tableau de bord actuel est remplacé et la navigation dans le navigateur ne peut pas être utilisée pour y revenir.

dashboard:run

Utilisez cette action pour exécuter le tableau de bord dans l'iFrame. Cette action est identique à celle qui se produit lorsque vous cliquez sur le bouton Exécuter ou Recharger les données sur le tableau de bord.

{
  type: "dashboard:run"
}
Attribut Format Description
type Chaîne L'utilisation du type dashboard:run indique que vous souhaitez exécuter le tableau de bord.

dashboard:edit

Added 22.20 Utilisez cette action pour passer un tableau de bord existant dans l'iFrame en mode Édition. Cette action est identique à celle qui consiste à sélectionner Modifier le tableau de bord dans le menu du tableau de bord.

{
  type: "dashboard:edit"
}
Attribut Format Description
type Chaîne L'utilisation du type dashboard:edit indique que vous souhaitez passer en mode Édition du tableau de bord.

dashboard:filters:update

Utilisez cette action pour mettre à jour un filtre de tableau de bord existant dans l'iFrame. Vous ne pouvez pas ajouter de filtre au tableau de bord à l'aide de cette méthode.

{
  type: "dashboard:filters:update",
  filters: {
    "Sale date": "Last 28 days",
    "Sale amount": "Greater than 100"
  }
}
Attribut Format Description
type Chaîne L'utilisation du type dashboard:filters:update indique que vous souhaitez mettre à jour les filtres utilisés par le tableau de bord.
filters Objet Nouveaux filtres que vous souhaitez appliquer au tableau de bord. Cet objet a le format suivant : {"Filter name 1": "value 1", "Filter name 2": "value 2", ...}

dashboard:options:set

Cette action est disponible après l'événement dashboard:run:complete.

L'intégrateur crée le message et l'envoie à l'iFrame, mais le tableau de bord ne répond qu'après l'événement dashboard:run:complete. L'action dashboard:options:set écrit de nouvelles valeurs dans la mise en page du tableau de bord et dans les propriétés des éléments du tableau de bord. Seules les propriétés renvoyées dans l'attribut options de l'événement dashboard:run:complete peuvent être mises à jour à l'aide de dashboard:options:set. Toutes les propriétés définies qui n'ont pas été renvoyées précédemment par l'attribut options de l'événement dashboard:run:complete sont ignorées.

{
  type: "dashboard:options:set",
  layouts: [
    {
      id: 1,
      dashboard_id: 1,
      type: "newspaper",
      active: true,
      column_width: null,
      width: null,
      deleted: false,
      dashboard_layout_components: [
        {
          id: 1,
          dashboard_layout_id: 1,
          dashboard_element_id: 1,
          row: 0,
          column: 0,
          width: 8,
          height: 4,
          deleted: false
        },
        {
          id: 2,
          dashboard_layout_id: 1,
          dashboard_element_id: 2,
          row: 0,
          column: 8,
          width: 8,
          height: 4,
          deleted: false
        }
      ]
    }
  ],
  elements: {
    1: {
      title: "Total Orders",
      title_hidden: false,
      vis_config: {
        type: "single_value",
        font_size: "medium",
        title: "Total Orders"
      }
    },
    2: {
      title: "Average Order Profit",
      title_hidden: false,
      vis_config: {
        type: "single_value",
        title: "Average Order Profit"
      }
    }
  }
}
Attribut Format Description
type Chaîne L'utilisation du type dashboard:options:set indique que vous souhaitez écrire de nouvelles valeurs dans les propriétés de la mise en page et des éléments du tableau de bord.
layouts Objet Propriétés de la mise en page du tableau de bord renvoyées par l'attribut options dans l'événement dashboard:run:complete. Elles se présenteront sous un format semblable à celui-ci :

  • id: "string",
  • dashboard_id: "string",
  • type: "newspaper",
  • active: boolean,
  • column_width: number,
  • width: number
layouts.dashboard_layout_components Objet Un ou plusieurs objets composant de mise en page du tableau de bord renvoyés par l'attribut options dans l'événement dashboard:run:complete. Elles se présenteront sous un format semblable à celui-ci :

  • id: "string",
  • dashboard_layout_id: "string",
  • dashboard_element_id: "string",
  • row: number,
  • column: number,
  • width: number,
  • height: number,
  • deleted: boolean,
elements Objet Un ou plusieurs objets dashboard element renvoyés par l'attribut options dans l'événement dashboard:run:complete. Elles se présenteront sous un format semblable à celui-ci :

id: {

  title: "string",

  title_hidden: boolean,

  vis_config: {

    type: "string", title: "string"

  }

}

dashboard:schedule_modal:open

Utilisez cette action pour ouvrir le planificateur, qui permet aux utilisateurs de fournir du contenu Looker à différentes destinations.

{
  type: "dashboard:schedule_modal:open"
}
Attribut Format Description
type Chaîne L'utilisation du type dashboard:schedule_modal:open indique que vous souhaitez ouvrir la boîte de dialogue Programmer.

dashboard:stop

Utilisez cette action pour arrêter un tableau de bord en cours d'exécution ou de rechargement des données. Il s'agit de la même action que lorsque vous cliquez sur le bouton Annuler du tableau de bord. Un tableau de bord arrêté à l'aide de dashboard:stop envoie un événement dashboard:run:complete avec status: défini sur "stopped".

{
  type: "dashboard:stop"
}
Attribut Format Description
type Chaîne L'utilisation du type dashboard:stop indique que vous souhaitez arrêter le tableau de bord en cours d'exécution.

look:run

Utilisez cette action pour exécuter la requête sur laquelle le Look est basé dans l'iFrame. Cette action est semblable à celle qui consiste à cliquer sur le bouton Exécuter dans le look, à la différence que look:run interroge toujours la base de données directement et ne récupère pas les données du cache Looker.

{
  type: "look:run"
}
Attribut Format Description
type Chaîne L'utilisation du type look:run indique que vous souhaitez exécuter le Look.

look:filters:update

Utilisez cette action pour mettre à jour un filtre Look existant dans l'iFrame. Vous ne pouvez pas ajouter de filtre au Look à l'aide de cette méthode.

{
  type: "look:filters:update",
  filters: {
    "orders.created_at": "90 days",
    "products.department": "sweaters"
  }
}
Attribut Format Description
type Chaîne L'utilisation du type look:filters:update indique que vous souhaitez mettre à jour les filtres utilisés par le Look.
filters Objet Les nouveaux filtres que vous souhaitez appliquer au Look. Cet objet a le format suivant : {"view_name.field_name_1": "value 1", "view_name.field_name_1": "value 2", ...}

explore:run

Utilisez cette action pour exécuter l'exploration dans l'iFrame. Cette action est semblable à l'action d'appuyer sur le bouton Exécuter dans l'explorateur, à la différence que explore:run interroge toujours directement la base de données et ne récupère pas les données du cache Looker.

{
  type: "explore:run"
}
Attribut Format Description
type Chaîne L'utilisation du type explore:run indique que vous souhaitez exécuter l'exploration.

explore:filters:update

Utilisez cette action pour mettre à jour ou supprimer un filtre Explorer existant dans l'iFrame. Si vous incluez un filtre qui fait référence à un champ valide, il sera ajouté à l'exploration.

{
  type: "explore:filters:update",
  filters: {
    "orders.created_at": "90 days",
    "orders.status": "complete"
  }
  deleteFilters:  ["products.department"]
}
Attribut Format Description
type Chaîne L'utilisation du type explore:filters:update indique que vous souhaitez mettre à jour les filtres utilisés par l'exploration.
filters Objet Les nouveaux filtres que vous souhaitez appliquer à l'exploration. Si filters inclut un filtre qui n'existe pas dans l'exploration, mais qui fait référence à un champ valide, ce filtre sera ajouté à l'exploration. Cet objet est au format {"view_name.field_name_1": "value 1", "view_name.field_name_1": "value 2", ...}.
deleteFilters Tableau Les filtres existants que vous souhaitez supprimer de l'onglet "Explorer". Le tableau a le format suivant : ["view_name.field_name_1", "view_name.field_name_2", ...]

session:tokens:request

Utilisez cette action pour envoyer des jetons en réponse à une requête session:tokens:request.

{
  type: "session:tokens:request",
}
Attribut Format Description
type Chaîne L'utilisation du type session:tokens:request indique que vous souhaitez envoyer des jetons en réponse à un événement session:tokens:request.

env:host:scroll

Utilisez cette action pour envoyer des informations sur la position de défilement actuelle de l'iFrame hôte à l'application Looker intégrée.

{
  type: "env:host:scroll",
  offsetTop: 10,
  offsetLeft: 10,
  scrollX: 5,
  scrollY: 5
}
Attribut Format Description
type Chaîne L'utilisation du type env:host:scroll indique que vous souhaitez envoyer des informations sur la position de défilement actuelle de l'iFrame hôte à l'application Looker intégrée.
offsetTop Nombre Décalage supérieur de l'iFrame.
offsetLeft Nombre Décalage à gauche de l'iFrame.
scrollX Nombre Position scrollX de l'hôte de l'application.
scrollY Nombre Position scrollY de l'hôte de l'application.