Guia do desenvolvedor de relatórios sem dados de amostra

Com a API de gerenciamento do Google Analytics, você pode criar programaticamente Relatórios sem dados de amostra.

Introdução

Relatórios sem dados de amostra são relatórios do Google Analytics que foram gerados com dados sem amostra. No momento, os Relatórios sem dados de amostra estão disponíveis somente para usuários do Google Analytics Premium.

Com essa API, você pode:

  • Recuperar informações de configuração sobre todos os seus Relatórios sem dados de amostra existentes. Criar Relatórios sem dados de amostra uma única vez.
  • Verificar o status de processamento de Relatórios sem dados de amostra.
  • Receber um link para o arquivo de dados de um relatório sem dados de amostra após a conclusão do processamento.
  • Excluir Relatórios sem dados de amostra.

Recuperação de dados para relatórios sem dados de amostra

Quando você cria um relatório sem dados de amostra, pode levar algum tempo para que ele fique disponível para download. O campo status de um relatório sem dados de amostra indica se o processamento dele foi concluído. Depois que o status é marcado como COMPLETED, é possível usar o downloadType os campos de detalhes de download correspondentes para recuperar o arquivo que contém os dados do relatório. Por exemplo:

Não use pesquisas contínuas e frequentes para verificar o status desses relatórios, pois provavelmente esgotará sua cota diária muito rápido. É necessário haver um atraso entre as solicitações ao verificar o status de relatórios sem dados de amostra.

Uso do Google Drive / Google Cloud Storage API

Dependendo do local para o qual seus arquivos estão sendo enviados (Google Drive ou Google Cloud Storage), você receberá um link correspondente para o arquivo. Você pode usar a Drive API ou a Cloud Storage API para fazer o download do arquivo usando esse link. Para mais detalhes sobre como recuperar o arquivo, consulte a documentação da Google Drive API ou da Google Cloud Storage API.

Por exemplo, se seu relatório sem dados de amostra é armazenado no Google Drive, você pode fazer uma solicitação HTTP GET autorizada ao URL do recurso do arquivo e incluir o parâmetro de consulta alt=media.

GET /drive/v2/files/XXXXXX?alt=media
Host: www.googleapis.com
Content-length: 0
Authorization: Bearer ya29.AHESVbXTUv5mHMo3RYfmS1YJonjzzdTOFZwvyOAUVhrs

em que XXXXXX é o relatório sem dados de amostra driveDownloadDetails.documentId

Autenticação

Se você planeja usar o Relatório sem dados de amostra junto com as APIs do Google Drive ou do Google Cloud Storage para o download de arquivos, é necessário incluir o escopo de autorização correspondente para a API (além do escopo de autorização da Google Analytics API) ao solicitar um token OAuth 2.0. Assim, você poderá usar o mesmo token de autorização para as duas APIs.

Exclusão de relatórios sem dados de amostra

Você pode excluir relatórios sem dados de amostra agendados ou concluídos. No entanto, chamar delete durante o breve período em que o relatório é gerado resulta em um erro. A exclusão de relatórios sem dados de amostra só remove o recurso da sua vista da propriedade (perfil) do Google Analytics, e os dados exportados no Google Drive ou no Google Cloud Storage permanecem.

Restrições

As restrições a seguir se aplicam à criação de relatórios sem dados de amostra.

  • Você só pode especificar até quatro dimensões.
  • Alguns tipos de dados de relatórios não são suportados, por exemplo, dados do Google AdWords.
  • Consultas consideradas muito caras não são suportadas.

Se sua solicitação for considerada muito cara, a operação "criar" retornará um erro com uma mensagem adequada. Se isso acontecer, você pode:

  • Solicitar menos dimensões.
  • Dividir a consulta em várias consultas com períodos melhores e agrupar os relatórios resultantes.

Casos de uso

Relatórios sem dados de amostra e a API de relatórios principais

Se você usar a API de relatórios principais para recuperar dados e ela contiver dados com amostra, poderá criar um Relatório sem dados de amostra para a mesma consulta.

  1. Faça uma solicitação da API de relatórios principais.
  2. Na resposta, consulte a propriedade "containsSampledData" para ver se os dados têm amostra.
  3. Se a propriedade estiver definida como "true",você poderá usar os campos "query" e "profileInfo fields" da mesma resposta para criar uma solicitação de Relatório sem dados de amostra.

Exemplo de campo "query" da resposta da API de relatórios principais:

"query": {
  "start-date": "2011-01-01",
  "end-date": "2011-01-31",
  "ids": "ga:1234",
  "dimensions": "ga:browser",
  "metrics": [
  "ga:visits"
  ],
  "filters": "ga:country==US",
  "start-index": 1,
  "max-results": 1000
}

Exemplo de campo profileInfo da resposta da API de relatórios principais:

"profileInfo": {
  "profileId": "1234",
  "accountId": "12345",
  "webPropertyId": "UA-12345-1",
  "internalWebPropertyId": "11254",
  "profileName": "Name of the profile",
  "tableId": "ga:1234"
}

Veja um exemplo de como criar um relatório sem dados de amostra da resposta da API de relatórios principais:

Java

// Make a Core Reporting API call.
GaData reportingApiData = v3.data().ga().get(...).execute();

// Check if the response is sampled.
if (reportingApiData.getContainsSampledData()) {

  // Use the “query” object to construct an unsampled report object.
  Query query = reportingApiData.getQuery();
  UnsampledReport report = new UnsampledReport()
      .setDimensions(query.getDimensions())
      .setMetrics(Joiner.on(',').join(query.getMetrics()))
      .setStartDate(startDate)
      .setEndDate(endDate)
      .setSegment(query.getSegment())
      .setFilters(query.getFilters())
      .setTitle(“My unsampled report”);

  // Use “profileInfo” to create an InsertRequest for creating an
  // unsampled report.
  ProfileInfo profileInfo = reportingApiData.getProfileInfo();
  Insert insertRequest = analytics.management().unsampledReports()
  .insert(profileInfo.getAccountId(),
          profileInfo.getWebPropertyId(),
          profileInfo.getProfileId(),
          report);
  UnsampledReport createdReport = insertRequest.execute();
}

Agrupamento de dados sem amostra de vários dias

Você pode combinar ou agrupar relatórios de vários dias para acessar dados sem amostra de um período específico. Isso é útil quando uma solicitação de Relatório sem dados de amostra é muito grande. Nesses casos, você pode dividir a solicitação em várias solicitações com um período menor e combinar os resultados.

Política de cotas

Veja os Limites e cotas das APIs de configuração e relatórios para a lista completa de limites e cotas que se aplicam ao criar Relatórios sem dados de amostra.