Experiments: insert

Requer autorização

Cria uma nova experiência. Veja um exemplo.

Além dos parâmetros padrão, esse método é compatível com os parâmetros listados na tabela correspondente.

Solicitação

Solicitação HTTP

POST https://www.googleapis.com/analytics/v3/management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/experiments

Parâmetros

Nome do parâmetro	Valor	Descrição
Parâmetros de caminho
`accountId`	`string`	ID da conta para a qual criar a experiência.
`profileId`	`string`	ID da vista da propriedade (perfil) para a qual criar a experiência.
`webPropertyId`	`string`	ID da propriedade da Web para a qual criar a experiência.

Autorização

Esta solicitação requer autorização com pelo menos um dos seguintes escopos (leia mais sobre autenticação e autorização).

Escopo
`https://www.googleapis.com/auth/analytics`
`https://www.googleapis.com/auth/analytics.edit`

Corpo da solicitação

No corpo da solicitação, forneça um recurso "management.experiment" com estas propriedades:

Nome da propriedade	Valor	Descrição	Observações
Propriedades obrigatórias
`name`	`string`	Nome da experiência. Esse campo não pode ser alterado para uma experiência cujo status seja "ENDED". Esse campo é obrigatório na criação de uma experiência.	gravável
`status`	`string`	Status do experimento. Valores possíveis: "DRAFT", "READY_TO_RUN", "RUNNING", "ENDED". As experiências podem ser criadas no estado "DRAFT", "READY_TO_RUN" ou "RUNNING". Esse campo é obrigatório na criação de uma experiência.	gravável
`variations[].name`	`string`	Nome da variação. Esse campo é obrigatório na criação de uma experiência. Esse campo não pode ser alterado para uma experiência cujo status seja "ENDED".	gravável
Propriedades opcionais
`description`	`string`	Observações sobre essa experiência.	gravável
`editableInGaUi`	`boolean`	Se o valor for "true", o usuário final poderá editar a experiência pela interface do usuário do Google Analytics.	gravável
`equalWeighting`	`boolean`	Booleano que especifica se o tráfego deve ser distribuído uniformemente em todas as variações. Se o valor for "False", as Experiências de conteúdo seguem o comportamento padrão de ajuste dinâmico de tráfego com base no desempenho da variação. Opcional: o padrão é "False". Esse campo não pode ser alterado para uma experiência cujo status seja "ENDED".	gravável
`minimumExperimentLengthInDays`	`integer`	Um número inteiro em [3, 90]. Especifica a duração mínima da experiência. Pode ser alterado para uma experiência em andamento. Esse campo não pode ser alterado para uma experiência cujo status seja "ENDED".	gravável
`objectiveMetric`	`string`	A métrica sendo otimizada pela experiência. Valores válidos: "ga:goal(n)Completions", "ga:adsenseAdsClicks", "ga:adsenseAdsViewed", "ga:adsenseRevenue", "ga:bounces", "ga:pageviews", "ga:sessionDuration", "ga:transactions", "ga:transactionRevenue". Esse campo será obrigatório se o status for "RUNNING" e se servingFramework for "REDIRECT" ou "API".	gravável
`optimizationType`	`string`	Se objectiveMetric deve ser minimizado ou maximizado. Valores possíveis: "MAXIMUM", "MINIMUM". Opcional: o padrão é "MAXIMUM". Não pode ser especificado sem "objectiveMetric". Não pode ser modificado quando o status é "RUNNING" ou "ENDED".	gravável
`rewriteVariationUrlsAsOriginal`	`boolean`	Booleano que especifica se os URLs das variações serão reescritos de modo a corresponder aos da variação original. Esse campo não pode ser alterado para uma experiência cujo status seja "ENDED".	gravável
`servingFramework`	`string`	A estrutura usada para veicular as variações do experimento e avaliar os resultados. Um de: REDIRECT: O Google Analytics redireciona o tráfego para diferentes páginas de variação, informa a variação escolhida e avalia os resultados. API: O Google Analytics escolhe e informa a variação a ser veiculada e avalia os resultados. O autor da chamada é responsável por veicular a variação selecionada. EXTERNAL: as variações serão veiculadas externamente, e a variação escolhida será informada ao Google Analytics. O autor da chamada é responsável por veicular a variação selecionada e avaliar os resultados.	gravável
`trafficCoverage`	`double`	Número do ponto de variação entre 0 e 1. Especifica a fração do tráfego que participa da experiência. Pode ser alterado para uma experiência em andamento. Esse campo não pode ser alterado para uma experiência cujo status seja "ENDED".	gravável
`variations[]`	`list`	Matriz de variações. A primeira variação na matriz é a original. O número de variações não pode ser alterado quando uma experiência está no estado "RUNNING". São necessárias pelo menos duas variações para que o status seja alterado para "RUNNING".	gravável
`variations[].status`	`string`	Status da variação. Valores possíveis: "ACTIVE", "INACTIVE". Variações "INACTIVE" não são veiculadas. Esse campo não pode ser alterado para uma experiência cujo status seja "ENDED".	gravável
`variations[].url`	`string`	URL da variação. Esse campo não pode ser alterado para uma experiência cujo status seja "RUNNING" ou "ENDED".	gravável
`winnerConfidenceLevel`	`double`	Número do ponto de variação entre 0 e 1. Especifica o nível de confiança necessário para escolher uma variação vencedora. Esse campo não pode ser alterado para uma experiência cujo status seja "ENDED".	gravável

Resposta

Se for bem-sucedido, esse método retornará um recurso "management.experiment" no corpo da resposta.

Exemplos

Observação: os exemplos de código disponíveis para esse método não representam todas as linguagens de programação compatíveis. Consulte a página de bibliotecas cliente para ver uma lista de linguagens compatíveis.

Java

Usa a biblioteca cliente de Java.

/*
 * Note: This code assumes you have an authorized Analytics service object.
 * See the Experiments Developer Guide for details.
 */

/*
 *  This request creates a new Experiment.
 */

// Construct the body of the request.
Experiment body = new Experiment();
body.setName("Landing Page Experiment");
body.setStatus("DRAFT");

// Construct the first variation.
Variations variationA = new Variations();
variationA.setName("Variation A");
variationA.setUrl("index.html");

// Construct the second variation.
Variations variationB = new Variations();
variationB.setName("Variation B");
variationB.setUrl("indexB.html");

// Set the variations.
body.setVariations(Arrays.asList(variationA, variationB));

try {
  analytics.management().experiments().insert("123456", "UA-123456-1",
      "7654321", body).execute();
} catch (GoogleJsonResponseException e) {
  System.err.println("There was a service error: "
      + e.getDetails().getCode() + " : "
      + e.getDetails().getMessage());
}

PHP

Usa a biblioteca cliente de PHP.

/**
 * Note: This code assumes you have an authorized Analytics service object.
 * See the Experiments Developer Guide for details.
 */

/**
 * This request creates a new experiment.
 */

// Construct the body of the request.
$experiment = new Google_Service_Analytics_Experiment();
$experiment->setName('Landing Page Experiment');
$experiment->setStatus('DRAFT');

// Construct the first variation.
$variationA = new Google_Service_Analytics_ExperimentVariations();
$variationA->setName('VariationA');
$variationA->setUrl('index.html');

// Construct the second variation.
$variationB = new Google_Service_Analytics_ExperimentVariations();
$variationB->setName('VariationB');
$variationB->setUrl('indexB.html');

// Set the variations.
$experiment->setVariations(array($variationA, $variationB));

try {
  $analytics->management_experiments->insert('123456', 'UA-123456-1',
      '7654321', $experiment);
} catch (apiServiceException $e) {
  print 'There was an Analytics API service error '
      . $e->getCode() . ':' . $e->getMessage();

} catch (apiException $e) {
  print 'There was a general API error '
      . $e->getCode() . ':' . $e->getMessage();
}

Python

Usa a biblioteca cliente de Python.

# Note: This code assumes you have an authorized Analytics service object.
# See the Experiments Developer Guide for details.

# Example #1:
# Creates a new DRAFT experiment with two variations.
try:
  experiments = analytics.management().experiments().insert(
      accountId='123456',
      webPropertyId='UA-123456-1',
      profileId='98765432',
      body={
          'name': 'Landing Page Test',
          'status': 'DRAFT',
          'variations': [
              {
                  'name': 'Variation A',
                  'url': 'index.html'
              },
              {
                  'name': 'Variation B',
                  'url': 'indexB.html'
              }
          ]
      }
  ).execute()

except TypeError, error:
  # Handle errors in constructing a query.
  print 'There was an error in constructing your query : %s' % error

except HttpError, error:
  # Handle API errors.
  print ('There was an API error : %s : %s' %
         (error.resp.status, error.resp.reason))

JavaScript

Usa a biblioteca cliente de JavaScript.

/*
 * Note: This code assumes you have an authorized Analytics client object.
 * See the Experiments Developer Guide for details.
 */

/*
 * This request creates a new Experiment.
 */
function insertExperiment() {
  var request = gapi.client.analytics.management.experiments.insert(
    {
      'accountId': '123456',
      'webPropertyId': 'UA-123456-1',
      'profileId': '7654321',
      'resource': {
        'name': 'Landing Page Test',
        'status': 'DRAFT',
        'variations': [
          {
            'name': 'VariationA',
            'url': 'index.html'
          },
          {
            'name': 'VariationB',
            'url': 'indexB.html'
          }
        ]
      }
    });
  request.execute(function (response) { // Handle the response. });
}