Exportar dados do Analytics

Esta página aplica-se ao Apigee e ao Apigee Hybrid.

Veja a documentação do Apigee Edge.

O Apigee Analytics recolhe e analisa um vasto espetro de dados que fluem nas suas APIs e fornece ferramentas de visualização, incluindo painéis de controlo interativos, relatórios personalizados e outras ferramentas que identificam tendências no desempenho do proxy de API.

Agora, pode desbloquear este conteúdo avançado exportando dados de estatísticas do Apigee Analytics para o seu próprio repositório de dados, como o Google Cloud Storage ou o Google BigQuery. Em seguida, pode tirar partido das poderosas capacidades de consulta e aprendizagem automática oferecidas pelo Google BigQuery e TensorFlow para realizar a sua própria análise de dados. Também pode combinar os dados de estatísticas exportados com outros dados, como registos Web, para obter novas estatísticas sobre os seus utilizadores, APIs e aplicações.

Que formatos de dados de exportação são suportados?

Exporte dados de estatísticas para um dos seguintes formatos:

  • Valores separados por vírgulas (.csv)

    O delimitador predefinido é o caráter de vírgula (,). Os carateres delimitadores suportados incluem a vírgula (,), a barra vertical (|) e a tabulação (\t). Configure o valor através da propriedade csvDelimiter, conforme descrito na referência da propriedade de pedido de exportação .

  • JSON (delimitado por newline)

    Permite que o caráter de nova linha seja usado como delimitador.

Os dados exportados incluem todas as métricas e dimensões de estatísticas incorporadas no Apigee, e todos os dados de estatísticas personalizados que adicionar. Para ver uma descrição dos dados exportados, consulte a referência de métricas, dimensões e filtros do Analytics.

Pode exportar dados de estatísticas para os seguintes repositórios de dados:

Passos para exportar os dados do Analytics

Os passos seguintes resumem o processo usado para exportar os dados de estatísticas:

  1. Configure o seu repositório de dados (Cloud Storage ou BigQuery) para a exportação de dados. Tem de garantir que o seu repositório de dados foi configurado corretamente e que a conta de serviço do agente de serviço do Apigee usada para escrever dados no repositório de dados tem as autorizações corretas.
  2. Crie um arquivo de dados que defina as propriedades do repositório de dados (Cloud Storage ou BigQuery) para onde exporta os seus dados.
  3. Exporte os seus dados de estatísticas. A exportação de dados é executada de forma assíncrona em segundo plano.
  4. Veja o estado do pedido de exportação para determinar quando a exportação é concluída.
  5. Quando a exportação estiver concluída, aceda aos dados exportados no seu repositório de dados.

As secções seguintes descrevem estes passos mais detalhadamente.

Configurar o repositório de dados

Configure o Cloud Storage ou o BigQuery para permitir o acesso através da exportação de dados do Analytics.

Configurar o Google Cloud Storage

Antes de poder exportar dados para o Google Cloud Storage, tem de fazer o seguinte:

  • Crie um contentor do Google Cloud Storage.

  • Certifique-se de que a API BigQuery está ativada no seu projeto da Google Cloud Platform. O Apigee usa a API BigQuery para tirar partido das funcionalidades do BigQuery Export quando exporta para o Cloud Storage.

    Consulte o artigo Ativar APIs para ver instruções.

  • Certifique-se de que a conta de serviço do agente de serviço do Apigee com o endereço de email service-project-number@gcp-sa-apigee.iam.gserviceaccount.com está atribuída às seguintes funções:

    • Utilizador de tarefas do BigQuery
    • Administrador de armazenamento

    O project-number é apresentado na página inicial do projeto, conforme mostrado abaixo.

    Consulte o artigo Conceder, alterar e revogar o acesso a recursos.

    Em alternativa, se quiser modificar uma função existente ou criar uma função personalizada, adicione as seguintes autorizações à função:

    • bigquery.jobs.create
    • storage.objects.create
    • storage.objects.delete
    • storage.objects.list

Configurar o Google BigQuery

Antes de poder exportar dados para o Google BigQuery:

  • Certifique-se de que ativou o BigQuery no seu projeto da Google Cloud Platform.
  • Certifique-se de que a API BigQuery está ativada no seu projeto da Google Cloud Platform. Consulte o artigo Ativar APIs para ver instruções.
  • Certifique-se de que a conta de serviço do agente de serviço do Apigee com o endereço de email service-project-number@gcp-sa-apigee.iam.gserviceaccount.com está atribuída às seguintes funções:

    • Utilizador de tarefas do BigQuery
    • Editor de dados do BigQuery

    O project-number é apresentado na página inicial do projeto, conforme mostrado abaixo.

    Consulte o artigo Conceder, alterar e revogar o acesso a recursos.

    Se quiser modificar uma função existente ou criar uma função personalizada, adicione as seguintes autorizações à função:

    • bigquery.datasets.create
    • bigquery.datasets.get
    • bigquery.jobs.create
    • bigquery.tables.create
    • bigquery.tables.get
    • bigquery.tables.updateData
  • Crie um conjunto de dados do BigQuery.

Exportar dados para o BigQuery para uma região individual nos EUA ou na UE

Uma vez que os dados de estatísticas para os EUA ou a UE são armazenados na multirregião dos EUA ou da UE, não pode exportar os dados diretamente para uma região individual dos EUA ou da UE no BigQuery. Como solução alternativa, pode primeiro exportar os dados para o Google Cloud Storage e, em seguida, transferi-los para o BigQuery da seguinte forma:

  1. Crie um contentor do Cloud Storage e defina a Localização para a região individual nos EUA ou na UE que quer associar aos seus dados no BigQuery.
  2. Crie um arquivo de dados do Cloud Storage, usando o contentor de armazenamento criado no passo anterior.
  3. Exporte os dados para o Cloud Storage. Consulte o Exemplo 1: exportar dados para o Cloud Storage abaixo para ver um exemplo.
  4. Carregue os dados para o BigQuery, conforme descrito nas secções seguintes:

Gerir bases de dados

O datastore define a ligação ao seu repositório de dados de exportação (Cloud Storage, BigQuery).

As secções seguintes descrevem como criar e gerir os seus repositórios de dados. Antes de criar um arquivo de dados, recomendamos que teste a configuração do repositório de dados.

Testar a configuração do repositório de dados

Quando cria o repositório de dados, o Apigee não testa nem valida se a configuração é válida. Isto significa que pode criar o arquivo de dados (no passo seguinte) e não detetar erros até executar a primeira exportação de dados.

Uma vez que um processo de exportação de dados pode demorar muito tempo a ser executado, pode detetar erros mais cedo testando a configuração do repositório de dados para garantir que é válida e corrigindo quaisquer erros antes de criar o arquivo de dados.

Para testar a configuração do repositório de dados, emita um pedido POST para a API /organizations/{org}/analytics/datastores:test. Transmita as seguintes informações no corpo do pedido:

Por exemplo, o seguinte testa uma configuração de repositório de dados do Cloud Storage:

curl "https://apigee.googleapis.com/v1/organizations/myorg/analytics/datastores:test" \
  -X POST \
  -H "Content-type:application/json" \
  -H "Authorization: Bearer $TOKEN" \
  -d \
  '{
    "displayName": "My Cloud Storage datastore",
    "targetType": "gcs",
    "datastoreConfig": {
      "projectId": "my-project",
      "bucketName": "my-bucket",
      "path": "my/analytics/path"
    }
  }'

Segue-se um exemplo da resposta se o teste for bem-sucedido:

{
  "state": "completed",
}

Segue-se um exemplo da resposta se o teste falhar:

{
  "state": "failed",
  "error": "<error message>"
}

Neste caso, resolva os problemas apresentados na mensagem de erro e volte a testar a configuração do repositório de dados. Após um teste bem-sucedido, crie o arquivo de dados, conforme descrito na secção seguinte.

Criar um arquivo de dados

Para criar um arquivo de dados, emita um pedido POST para a API /organizations/{org}/analytics/datastores. Transmita as seguintes informações no corpo do pedido:

Abaixo, são apresentados exemplos para cada tipo de arquivo de dados.

Segue-se um exemplo da resposta para um repositório de dados do Cloud Storage:

{
    "self": "/organizations/myorg/analytics/datastores/c7d3b5aq-1c64-3389-9c43-b211b60de35b",
    "displayName": "My Cloud Storage datastore",
    "org": "myorg",
    "targetType": "gcs",
    "createTime": "1535411583949",
    "lastUpdateTime": "1535411634291",
    "datastoreConfig": {
          "projectId": "my-project",
          "bucketName": "my-bucket",
          "path": "my/analytics/path"
    }
}

Use o URL devolvido na propriedade self para ver os detalhes do arquivo de dados, conforme descrito em Ver os detalhes de um arquivo de dados.

Para mais informações, consulte a API Create data store.

Exemplo 1: crie um arquivo de dados do Cloud Storage

O pedido seguinte cria um arquivo de dados do Cloud Storage:

curl "https://apigee.googleapis.com/v1/organizations/myorg/analytics/datastores" \
  -X POST \
  -H "Content-type:application/json" \
  -H "Authorization: Bearer $TOKEN" \
  -d \
  '{
    "displayName": "My Cloud Storage datastore",
    "targetType": "gcs",
    "datastoreConfig": {
      "projectId": "my-project",
      "bucketName": "my-bucket",
      "path": "my/analytics/path"
    }
  }'

Onde $TOKEN está definido como a sua chave de acesso OAuth 2.0, conforme descrito em Obter uma chave de acesso OAuth 2.0. Para informações sobre as opções de curl usadas neste exemplo, consulte a secção Usar o curl. Para uma descrição das variáveis de ambiente que pode usar, consulte o artigo Definir variáveis de ambiente para pedidos de API Apigee.

Exemplo 2: crie um repositório de dados do BigQuery

O pedido seguinte cria um repositório de dados do BigQuery:

curl "https://apigee.googleapis.com/v1/organizations/myorg/analytics/datastores" \
  -X POST \
  -H "Content-type:application/json" \
  -H "Authorization: Bearer $TOKEN" \
  -d \
  '{
    "displayName": "My BigQuery datastore",
    "targetType": "bigquery",
    "datastoreConfig": {
      "projectId": "my-project",
      "datasetName": "mybigquery",
      "tablePrefix": "bqprefix"
    }
  }'

Onde $TOKEN está definido como a sua chave de acesso OAuth 2.0, conforme descrito em Obter uma chave de acesso OAuth 2.0. Para informações sobre as opções de curl usadas neste exemplo, consulte a secção Usar o curl. Para uma descrição das variáveis de ambiente que pode usar, consulte o artigo Definir variáveis de ambiente para pedidos de API Apigee.

Visualizar todos os arquivos de dados

Para ver todos os arquivos de dados da sua organização, envie um pedido GET para a API /organizations/{org}/analytics/datastores.

Por exemplo:

curl "https://apigee.googleapis.com/v1/organizations/myorg/analytics/datastores" \
  -X GET \
  -H "Authorization: Bearer $TOKEN"

Onde $TOKEN está definido como a sua chave de acesso OAuth 2.0, conforme descrito em Obter uma chave de acesso OAuth 2.0. Para informações sobre as opções de curl usadas neste exemplo, consulte a secção Usar o curl. Para uma descrição das variáveis de ambiente que pode usar, consulte o artigo Definir variáveis de ambiente para pedidos de API Apigee.

Segue-se um exemplo da resposta:

{
  "datastores": [
  {
    "self": "/organizations/myorg/analytics/datastores/c7d3b5aq-1c64-3389-9c43-b211b60de35b",
    "displayName": "My Cloud Storage datastore",
    "org": "myorg",
    "targetType": "gcs",
    "createTime": "1535411583949",
    "lastUpdateTime": "1535411634291",
    "datastoreConfig": {
          "projectId": "my-project",
          "bucketName": "my-bucket",
          "path": "my/analytics/path"
    }
  },
  {
    "self": "/organizations/myorg/analytics/datastores/g8c3f0mk-1f78-8837-9c67-k222b60ce30b",
    "displayName": "My BigQuery datastore",
    "org": "myorg",
    "targetType": "bigquery",
    "createTime": "1535411583949",
    "lastUpdateTime": "1535411634291",
    "datastoreConfig": {
      "projectId": "my-project",
      "datasetName": "mybigquery",
      "tablePrefix": "bqprefix"
    }
  }
  ]
}

Para mais informações, consulte a API List data stores.

Ver os detalhes de um arquivo de dados

Para ver os detalhes de um arquivo de dados, envie um pedido GET para a API /organizations/{org}/analytics/datastores/{datastore}.

Por exemplo:

curl "https://apigee.googleapis.com/v1/organizations/myorg/analytics/datastores/c7d3b5aq-1c64-3389-9c43-b211b60de35b" \
  -X GET \
  -H "Authorization: Bearer $TOKEN"

Onde $TOKEN está definido como a sua chave de acesso OAuth 2.0, conforme descrito em Obter uma chave de acesso OAuth 2.0. Para informações sobre as opções de curl usadas neste exemplo, consulte a secção Usar o curl. Para uma descrição das variáveis de ambiente que pode usar, consulte o artigo Definir variáveis de ambiente para pedidos de API Apigee.

Segue-se um exemplo da resposta para um arquivo de dados do Cloud Storage:

{
    "self": "/organizations/myorg/analytics/datastores/c7d3b5aq-1c64-3389-9c43-b211b60de35b",
    "displayName": "My Cloud Storage datastore",
    "org": "myorg",
    "targetType": "gcs",
    "createTime": "1535411583949",
    "lastUpdateTime": "1535411634291",
    "datastoreConfig": {
          "projectId": "my-project",
          "bucketName": "my-bucket",
          "path": "my/analytics/path"
    }
}

Para mais informações, consulte o artigo Obtenha a API Data Store.

Modificar um arquivo de dados

Para modificar um arquivo de dados, emita um pedido PUT para a API /organizations/{org}/analytics/datastores/{datastore}. Transmita todas ou um subconjunto das seguintes informações no corpo do pedido:

Por exemplo, para atualizar um arquivo de dados do Cloud Storage:

curl "https://apigee.googleapis.com/v1/organizations/myorg/analytics/datastores/c7d3b5aq-1c64-3389-9c43-b211b60de35b" \
  -X PUT \
  -H "Content-type:application/json" \
  -H "Authorization: Bearer $TOKEN" \
  -d \
  '{
    "displayName": "My Cloud Storage datastore",
    "datastoreConfig": {
      "projectId": "my-project",
      "bucketName": "my-bucket",
      "path": "my/analytics/path"
    }
  }'

Onde $TOKEN está definido como a sua chave de acesso OAuth 2.0, conforme descrito em Obter uma chave de acesso OAuth 2.0. Para informações sobre as opções de curl usadas neste exemplo, consulte a secção Usar o curl. Para uma descrição das variáveis de ambiente que pode usar, consulte o artigo Definir variáveis de ambiente para pedidos de API Apigee.

Segue-se um exemplo da resposta para um arquivo de dados do Cloud Storage:

{
    "self": "/organizations/myorg/analytics/datastores/c7d3b5aq-1c64-3389-9c43-b211b60de35b",
    "displayName": "My Cloud Storage datastore",
    "org": "myorg",
    "targetType": "gcs",
    "createTime": "1535411583949",
    "lastUpdateTime": "1535411634291",
    "datastoreConfig": {
          "projectId": "my-project",
          "bucketName": "my-bucket",
          "path": "my/analytics/path"
    }
}

Para mais informações, consulte a API de armazenamento de dados de atualização.

Eliminar um arquivo de dados

Para eliminar um arquivo de dados, envie um pedido DELETE para a API /organizations/{org}/analytics/datastores/{datastore}.

Por exemplo:

curl "https://apigee.googleapis.com/v1/organizations/myorg/analytics/datastores/c7d3b5aq-1c64-3389-9c43-b211b60de35b" \
  -X DELETE \
  -H "Authorization: Bearer $TOKEN"

Onde $TOKEN está definido como a sua chave de acesso OAuth 2.0, conforme descrito em Obter uma chave de acesso OAuth 2.0. Para informações sobre as opções de curl usadas neste exemplo, consulte a secção Usar o curl. Para uma descrição das variáveis de ambiente que pode usar, consulte o artigo Definir variáveis de ambiente para pedidos de API Apigee.

Segue-se um exemplo da resposta:

{}

Para mais informações, consulte a API Delete data store.

Exportar dados de estatísticas

Para exportar dados de estatísticas, envie um pedido POST para a /organizations/{org}/environments/{env}/analytics/exports API. Transmita as seguintes informações no corpo do pedido:

  • Nome e descrição do pedido de exportação
  • Intervalo de datas dos dados exportados (o valor só pode abranger um dia)
  • Formato dos dados exportados
  • Nome do armazenamento de dados

Abaixo, são apresentados exemplos de pedidos de exportação. Para uma descrição completa das propriedades do corpo do pedido, consulte a referência das propriedades do pedido de exportação.

A resposta do POST está no formato:

{
    "self": "/organizations/myorg/environments/test/analytics/exports/a7c2f0dd-1b53-4917-9c42-a211b60ce35b",
    "created": "2017-09-28T12:39:35Z",
    "state": "enqueued"
}

Tenha em atenção que a propriedade state na resposta está definida como enqueued. O pedido POST funciona de forma assíncrona. Isto significa que continua a ser executado em segundo plano depois de o pedido devolver uma resposta. Os valores possíveis para state incluem: enqueued, running, completed e failed.

Use o URL devolvido na propriedade self para ver o estado do pedido de exportação de dados, conforme descrito no artigo Ver o estado de um pedido de exportação do Analytics. Quando o pedido é concluído, o valor da propriedade state na resposta é definido como completed. Em seguida, pode aceder aos dados de estatísticas na sua base de dados.

Para mais informações, consulte a API Create data export.

Exemplo 1: exporte dados para o Cloud Storage

O exemplo seguinte exporta um conjunto completo de dados não processados das últimas 24 horas do ambiente de teste na organização myorg. O conteúdo é exportado para o Cloud Storage em JSON:

curl "https://apigee.googleapis.com/v1/organizations/myorg/environments/test/analytics/exports" \
  -X POST \
  -H "Content-type:application/json" \
  -H "Authorization: Bearer $TOKEN" \
  -d \
  '{
    "name": "Export raw results to Cloud Storage",
    "description": "Export raw results to Cloud Storage for last 24 hours",
    "dateRange": {
      "start": "2020-06-08",
      "end": "2020-06-09"
    },
    "outputFormat": "json",
    "datastoreName": "My Cloud Storage data repository"
  }'

Onde $TOKEN está definido como a sua chave de acesso OAuth 2.0, conforme descrito em Obter uma chave de acesso OAuth 2.0. Para informações sobre as opções de curl usadas neste exemplo, consulte a secção Usar o curl. Para uma descrição das variáveis de ambiente que pode usar, consulte o artigo Definir variáveis de ambiente para pedidos de API Apigee.

Use o URI especificado pela propriedade self para monitorizar o estado da tarefa, conforme descrito em Ver o estado de um pedido de exportação do Analytics.

Exemplo 2: exporte dados para o BigQuery

O exemplo seguinte exporta um ficheiro CSV delimitado por vírgulas para o BigQuery:

curl "https://apigee.googleapis.com/v1/organizations/myorg/environments/test/analytics/exports" \
  -X POST \
  -H "Content-type:application/json" \
  -H "Authorization: Bearer $TOKEN" \
  -d \
  '{
    "name": "Export query results to BigQuery",
    "description": "One-time export to BigQuery",
    "dateRange": {
      "start": "2018-06-08", 
      "end": "2018-06-09"
    },
    "outputFormat": "csv",
    "csvDelimiter": ",", 
    "datastoreName": "My BigQuery data repository"
  }'

Onde $TOKEN está definido como a sua chave de acesso OAuth 2.0, conforme descrito em Obter uma chave de acesso OAuth 2.0. Para informações sobre as opções de curl usadas neste exemplo, consulte a secção Usar o curl. Para uma descrição das variáveis de ambiente que pode usar, consulte o artigo Definir variáveis de ambiente para pedidos de API Apigee.

Nota: o ficheiro CSV exportado cria uma tabela do BigQuery com o seguinte prefixo:

<PREFIX>_<EXPORT_DATE>_api_<UUID>_from_<FROM_DATE>_to_<TO_DATE>

Use o URI especificado pela propriedade self para monitorizar o estado da tarefa, conforme descrito em Ver o estado de um pedido de exportação do Analytics.

Acerca das quotas da API de exportação

Para evitar a utilização excessiva de chamadas API de exportação de dados dispendiosas, o Apigee aplica uma quota de 15 chamadas por dia por organização nas chamadas para a API organizations/{org}/environments/{env}/analytics/exports.

Se exceder a quota de chamadas, a API devolve uma resposta HTTP 429.

Ver o estado de todos os pedidos de exportação do Analytics

Para ver o estado de todos os pedidos de exportação de estatísticas, emita um pedido GET para /organizations/{org}/environments/{env}/analytics/exports.

Por exemplo, o seguinte pedido devolve o estado de todos os pedidos de exportação do Analytics para o ambiente test na organização myorg:

curl "https://apigee.googleapis.com/v1/organizations/myorg/environments/test/analytics/exports" \
  -X GET \
  -H "Authorization: Bearer $TOKEN" 

Onde $TOKEN está definido como a sua chave de acesso OAuth 2.0, conforme descrito em Obter uma chave de acesso OAuth 2.0. Para informações sobre as opções de curl usadas neste exemplo, consulte a secção Usar o curl. Para uma descrição das variáveis de ambiente que pode usar, consulte o artigo Definir variáveis de ambiente para pedidos de API Apigee.

Segue-se um exemplo da resposta que apresenta dois pedidos de exportação, um em fila de espera (criado e na fila) e outro concluído:

[
  {
    "self":
"/v1/organizations/myorg/environments/test/analytics/exports/e8b8db22-fe03-4364-aaf2-6d4f110444ba",
    "name": "Export results To Cloud Storage",
    "description": "One-time export to Cloud Storage",
    "userId": "my@email.com",
    "datastoreName": "My datastore",
    "executionTime": "36 seconds",
    "created": "2018-09-28T12:39:35Z",
    "updated": "2018-09-28T12:39:42Z",
    "state": "enqueued"
  },
  {
    "self":
"/v1/organizations/myorg/environments/test/analytics/exports/9870987089fe03-4364-aaf2-6d4f110444ba"
    "name": "Export raw results to BigQuery",
    "description": "One-time export to BigQuery",
    ... 
  }
]

Para mais informações, consulte o artigo API List data exports.

Ver o estado de um pedido de exportação do Analytics

Para ver o estado de um pedido de exportação de estatísticas específico, emita um pedido GET para /organizations/{org}/environments/{env}/analytics/exports/{exportId}, em que {exportId} é o ID associado ao pedido de exportação de estatísticas.

Por exemplo, o pedido seguinte devolve o estado do pedido de exportação do Analytics com o ID 4d6d94ad-a33b-4572-8dba-8677c9c4bd98.

curl "https://apigee.googleapis.com/v1/organizations/myorg/environments/test/analytics/exports/4d6d94ad-a33b-4572-8dba-8677c9c4bd98" \
  -X GET \
  -H "Authorization: Bearer $TOKEN"

Segue-se um exemplo da resposta:

{
  "self":
"/v1/organizations/myorg/environments/test/analytics/exports/4d6d94ad-a33b-4572-8dba-8677c9c4bd98",
  "name": "Export results to Cloud Storage",
  "description": "One-time export to Cloud Storage",
  "userId": "my@email.com",
  "datastoreName": "My datastore",
  "executionTime": "36 seconds",
  "created": "2018-09-28T12:39:35Z",
  "updated": "2018-09-28T12:39:42Z",
  "state": "enqueued"
}

Para mais informações, consulte o artigo Obtenha a API de exportação de dados.

Se a exportação de estatísticas não devolver dados de estatísticas, executionTime é definido como "0 segundos".

Referência da propriedade de pedido do Datastore

A tabela seguinte descreve as propriedades que pode transmitir no corpo do pedido no formato JSON quando cria um arquivo de dados com base no tipo de arquivo de dados.

Para o Google Cloud Storage:

Propriedade Descrição Obrigatório?
ID do projeto ID do projeto da Google Cloud Platform.

Para criar um projeto da Google Cloud Platform, consulte o artigo Criar e gerir projetos na documentação da Google Cloud Platform.

Sim
Nome do grupo Nome do contentor no Cloud Storage para o qual quer exportar dados de estatísticas.

Nota: o contentor tem de existir antes de efetuar uma exportação de dados.

Para criar um contentor do Cloud Storage, consulte o artigo Crie contentores na documentação da Google Cloud Platform.

Sim
Caminho Diretório no qual armazenar os dados de estatísticas no contentor do Cloud Storage. Sim

Para o BigQuery:

Propriedade Descrição Obrigatório?
ID do projeto ID do projeto da Google Cloud Platform.

Para criar um projeto da Google Cloud Platform, consulte o artigo Criar e gerir projetos na documentação da Google Cloud Platform.

Sim
Nome do conjunto de dados Nome do conjunto de dados do BigQuery para o qual quer exportar dados do Analytics. Certifique-se de que o conjunto de dados é criado antes de pedir a exportação de dados.

Para criar um conjunto de dados do BigQuery, consulte o artigo Criar e usar conjuntos de dados na documentação da Google Cloud Platform.

Sim
Prefixo da tabela O prefixo dos nomes das tabelas criadas para os dados de estatísticas no conjunto de dados do BigQuery. Sim

Referência da propriedade do pedido de exportação

A tabela seguinte descreve as propriedades que pode transmitir no corpo do pedido no formato JSON quando exporta dados de estatísticas.

Propriedade Descrição Obrigatório?
description Descrição do pedido de exportação. Não
name Nome do pedido de exportação. Sim
dateRange

Especifique a data start e end dos dados a exportar no formato yyyy-mm-dd. Por exemplo:

"dateRange": {
    "start": "2018-07-29",
    "end": "2018-07-30"
}

O valor dateRange só pode abranger um dia. O intervalo de datas começa às 00:00:00 UTC na data start e termina às 00:00:00 UTC na data end.

Nota: para garantir que todos os dados são capturados do dia anterior, pode ter de atrasar a hora de início do pedido de exportação (por exemplo, 00:05:00 UTC).

Sim
outputFormat Especifique como json ou csv. Sim
csvDelimiter

Delimitador usado no ficheiro de saída CSV, se outputFormat estiver definido como csv. A predefinição é o caráter , (vírgula). Os carateres delimitadores suportados incluem a vírgula (,), a barra vertical (|) e a tabulação (\t).

Não
datastoreName O nome do arquivo de dados que contém a definição do seu arquivo de dados. Sim

Por exemplo:

{
  "name": "Export raw results to Cloud Storage",
  "description": "Export raw results to Cloud Storage for last 24 hours",
  "datastoreName": "My Cloud Storage datastore"
}