Inserir um relatório

  • Artigo

Dica

Tente inserir um relatório ou experimentar nossas APIs cliente na seção Explorar nossas APIs do playground do Power BI Embedded Analytics.

Este artigo aborda as etapas para inserir um relatório do Power BI em seu aplicativo. Saiba mais sobre relatórios em relatórios no Power BI.

Como inserir um relatório

Ao inserir o conteúdo do Power BI em um aplicativo, você usa um objeto de configuração para definir o conteúdo que está inserindo e especificar as configurações do conteúdo. Em seguida, você passa esse objeto para a API. Consulte Definir configurações de relatório para obter mais informações.

Inserir um relatório existente

Quando você inserir um relatório que já existe, use um objeto de configuração do tipo IReportLoadConfiguration.

interface IReportLoadConfiguration {
    accessToken: string;
    bookmark?: models.IApplyBookmarkRequest;
    contrastMode?: models.ContrastMode;
    datasetBinding?: models.IDatasetBinding;
    embedUrl?: string;
    filters?: models.ReportLevelFilters[];
    id: string;
    pageName?: string;
    permissions?: models.Permissions;
    settings?: models.IEmbedSettings;
    slicers?: models.ISlicer[];
    theme?: models.IReportTheme;
    tokenType?: models.TokenType;
    type: string;
    viewMode?: models.ViewMode;
}

Essa interface inclui estas propriedades:

  • accessToken - O token que fornece acesso aos dados do Power BI que você está inserindo. Confira Noções básicas sobre as diferentes soluções de inserção para saber mais sobre tokens de acesso.

  • datasetBinding - O conjunto de dados que define o esquema de dados que o relatório inserido usa. Consulte Associar conjuntos de dados dinamicamente a um relatório para obter mais informações sobre conjuntos de dados.

  • embedUrl - A URL do relatório que você está inserindo. Essa URL se torna a origem do elemento HTML iframe que contém o relatório inserido. Especificamente, a API atribui a URL ao src atributo do iframe. Você pode usar uma API de Relatório para obter essa URL. Dois exemplos são:

  • id - A ID do relatório do Power BI que você está inserindo.

  • permissions - Operações que você concede aos usuários para o relatório inserido. Esses valores estão disponíveis:

    • Read - Os usuários podem exibir o relatório.
    • ReadWrite - Os usuários podem exibir, editar e salvar o relatório.
    • Copy - Os usuários podem salvar uma cópia do relatório usando Salvar como.
    • Create - Os usuários podem criar um novo relatório.
    • All - Os usuários podem criar, exibir, editar, salvar e salvar uma cópia do relatório.

  • tokenType - O tipo de token que lhe dá acesso aos dados do Power BI que você está inserindo.

    • Use models.TokenType.Aad se você estiver inserindo para sua organização (o usuário é o proprietário dos dados).
    • Use models.TokenType.Embed se você estiver inserindo para seus clientes (o aplicativo é o proprietário dos dados).

    Consulte Entender as diferentes soluções de inserção para obter mais informações.

  • type - O tipo de conteúdo que você está inserindo. Use 'report' para um relatório do Power BI.

A IReportLoadConfiguration interface também contém outras propriedades. Consulte Definir configurações de relatório para obter informações sobre essas propriedades:

  • bookmark
  • contrastMode
  • filters
  • pageName
  • settings
  • slicers
  • theme
  • viewMode

Inserir um novo relatório

Ao inserir um novo relatório criado com base em um conjunto de dados, use um objeto de configuração do tipo IReportCreateConfiguration.

interface IReportCreateConfiguration {
    accessToken: string;
    datasetId: string;
    embedUrl?: string;
    settings?: models.IEmbedSettings;
    theme?: IReportTheme;
    tokenType?: models.TokenType;
    type: string;
}

As propriedades nessa interface são semelhantes às propriedades na IReportLoadConfiguration interface, com as seguintes exceções:

Consulte Criar, editar e salvar um relatório inserido para obter informações sobre como editar e criar relatórios.

Exemplo

O exemplo a seguir mostra como inserir um relatório:

// Set up the configuration object that determines what to embed and how to embed it.
let embedConfiguration = {
    accessToken: anAccessToken,
    embedUrl: anEmbedUrl,
    id: aReportId,
    permissions: somePermissions,
    tokenType: aTokenType,
    type: 'report'
};
 
// Get a reference to the HTML element that contains the embedded report.
let embedContainer = $('#embedContainer')[0];
 
// Embed the report.
let report = powerbi.embed(embedContainer, embedConfiguration);

Próximas etapas

Inserir um visual de relatório

Inserir um relatório paginado

Definir configurações de relatório

Criar, editar e salvar um relatório

Usar bootstrap para melhorar o desempenho