Experimentos

O conjunto de experiências é um grupo de recursos de experiências, cada um descrevendo uma Experiência de conteúdo disponível para um usuário autenticado.

Para ver uma lista de métodos desse recurso, vá até o final desta página.

Representações do recurso

Modelo JSON para o recurso de experiência do Google Analytics.

{
  "id": string,
  "kind": "analytics#experiment",
  "selfLink": string,
  "accountId": string,
  "webPropertyId": string,
  "internalWebPropertyId": string,
  "profileId": string,
  "name": string,
  "description": string,
  "created": datetime,
  "updated": datetime,
  "objectiveMetric": string,
  "optimizationType": string,
  "status": string,
  "winnerFound": boolean,
  "startTime": datetime,
  "endTime": datetime,
  "reasonExperimentEnded": string,
  "rewriteVariationUrlsAsOriginal": boolean,
  "winnerConfidenceLevel": double,
  "minimumExperimentLengthInDays": integer,
  "trafficCoverage": double,
  "equalWeighting": boolean,
  "snippet": string,
  "variations": [
    {
      "name": string,
      "url": string,
      "status": string,
      "weight": double,
      "won": boolean
    }
  ],
  "servingFramework": string,
  "editableInGaUi": boolean,
  "parentLink": {
    "type": "analytics#profile",
    "href": string
  }
}
Nome da propriedade Valor Descrição Observações
accountId string ID da conta à qual a experiência pertence. Este campo é somente leitura.
created datetime Horário de criação da experiência. Este campo é somente leitura.
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
endTime datetime O horário de término da experiência (horário em que o status mudou de "RUNNING" para "ENDED"). Esse campo aparece apenas se a experiência tiver terminado. Este campo é somente leitura.
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
id string ID da experiência. Obrigatório para patch e atualização. Não permitido para criação.
internalWebPropertyId string ID interno da propriedade da Web à qual essa experiência pertence. Este campo é somente leitura.
kind string Tipo de recurso de uma experiência do Google Analytics. Este campo é somente leitura.
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
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 ao criar uma experiência. gravável
objectiveMetric string A métrica 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
parentLink.href string Link para a vista da propriedade (perfil) à qual essa experiência pertence. Este campo é somente leitura.
parentLink.type string O valor é "analytics#profile". Este campo é somente leitura.
profileId string O ID da vista da propriedade (perfil) à qual a experiência pertence. Este campo é somente leitura.
reasonExperimentEnded string Por que a experiência terminou? Possíveis valores: "STOPPED_BY_USER", "WINNER_FOUND", "EXPERIMENT_EXPIRED", "ENDED_WITH_NO_WINNER", "GOAL_OBJECTIVE_CHANGED". "ENDED_WITH_NO_WINNER" indica que a experiência não expirou, mas não foi possível determinar a variação vencedora. Se o status da experiência for alterado pela API para "ENDED", esse campo é definido como "STOPPED_BY_USER". Esse campo é apenas leitura.
rewriteVariationUrlsAsOriginal boolean Booleano que especifica se os URLs das variações serão regravados 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. Uma das seguintes opções:
  • 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
snippet string Snippet de código a ser incluído nas páginas de controle. Este campo é somente leitura.
startTime datetime Horário de início da experiência (o horário em que o status foi alterado de "READY_TO_RUN" para "RUNNING". Esse campo aparecerá apenas se a experiência tiver iniciado. Este campo é somente leitura.
status string Status da experiência. 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
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
updated datetime Horário em que a experiência foi modificada pela última vez. Este campo é somente leitura.
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[].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
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
variations[].weight double Peso que essa variação deve receber. Presente apenas se a experiência estiver em andamento. Este campo é somente leitura.
variations[].won boolean Verdadeiro se a experiência tiver terminado e essa variação apresentar (estatisticamente) um desempenho melhor do que a original. Este campo é somente leitura.
webPropertyId string ID da propriedade da Web ID à qual essa experiência pertence. O ID da propriedade da Web fica no formato UA-XXXXX-YY. Esse campo é somente leitura.
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
winnerFound boolean Booleano que especifica se uma variação vencedora foi encontrada para a experiência. Este campo é somente leitura.

Métodos

delete
Exclui uma experiência.
get
Retorna uma experiência à qual o usuário tem acesso.
insert
Cria uma nova experiência.
list
Lista as experiências às quais o usuário tem acesso.
patch
Atualiza um experimento existente. Esse método é compatível com a semântica de patch.
update
Atualiza um experimento existente.