Esta página foi traduzida pela API Cloud Translation.

Guia de início rápido da API sobre como usar a linha de comando

Nesta página, mostramos como começar a usar a API Data v1 do Google Analytics usando a linha de comando.

Etapa 1. Ativar a API

Clique neste botão para criar um novo projeto do Cloud Platform, ativar automaticamente a API Data v1 do Google Analytics e criar as credenciais do OAuth2 necessárias para este tutorial:

A caixa de diálogo de configuração das credenciais do OAuth2 será aberta automaticamente. Escolha "Computador" para a pergunta "De onde você está ligando?"

Na caixa de diálogo exibida, clique em FAZER O DOWNLOAD DA CONFIGURAÇÃO DO CLIENTE e salve o arquivo credentials.json no diretório de trabalho.

Como alternativa, siga estas etapas para criar manualmente uma credencial OAuth2 em um projeto existente.

Etapa 2. Instale e inicialize o SDK do Cloud

Você precisa da ferramenta de linha de comando gcloud instalada na máquina de desenvolvimento.

Etapa 3: fazer uma chamada de API

Agora você pode usar a API Data do Google Analytics para consultar uma propriedade do Google Analytics 4.

Selecione uma entidade denunciante

Neste tutorial, usaremos a variável de ambiente GA4_PROPERTY_ID para armazenar o ID da propriedade a ser usado nas solicitações de API.

Digite o seguinte na linha de comando para definir a variável GA4_PROPERTY_ID:

export GA4_PROPERTY_ID=[YOUR-GA4-PROPERTY-ID]

Substitua [YOUR-GA4-PROPERTY-ID] pelo seu identificador da propriedade do Google Analytics 4. Exemplo:

export GA4_PROPERTY_ID=1234567890

Criar o JSON da solicitação

O arquivo request.json a seguir demonstra como criar um relatório simples.

Crie o arquivo de solicitação JSON com o seguinte texto e salve-o como um arquivo de texto simples request.json no seu diretório de trabalho:

request.json

{
  "dateRanges": [{ "startDate": "2020-09-01", "endDate": "2020-09-15" }],
  "dimensions": [{ "name": "country" }],
  "metrics": [{ "name": "activeUsers" }]
}

Autenticar

Para receber as credenciais de usuário neste exemplo, execute o comando a seguir e use o caminho para o arquivo JSON de credenciais salvo na Etapa 1:

gcloud auth application-default login \
    --scopes=https://www.googleapis.com/auth/analytics.readonly \
    --client-id-file=[PATH/TO/credentials.json]

Uma caixa de diálogo de consentimento do usuário do OAuth será aberta em uma nova janela do navegador.

Enviar a solicitação

Use curl e o conteúdo do corpo do request.json para enviar a solicitação à API Data do Google Analytics. Digite o seguinte na linha de comando:

  curl -X POST \
  -H "Authorization: Bearer "$(gcloud auth application-default print-access-token) \
  -H "Content-Type: application/json; charset=utf-8" \
  https://analyticsdata.googleapis.com/v1beta/properties/$GA4_PROPERTY_ID:runReport -d @request.json

O comando curl usa o comando gcloud auth application-default print-access-token para receber um token de autenticação.

Para transmitir o nome do arquivo ao curl, use a opção -d (de "dados") e inclua um sinal de @ antes do nome do arquivo. Esse arquivo precisa estar no mesmo diretório em que você executa o comando curl.

Parabéns! Você enviou sua primeira solicitação para a API Data do Google Analytics.