Cuidado: você está vendo a documentação da interface REST da API. A maioria das nossas bibliotecas de cliente oficiais usa o gRPC. Consulte Introdução ao REST para ver mais detalhes.

Esta página foi traduzida pela API Cloud Translation.

Experiment

Representação JSON
ExperimentType
ExperimentStatus
MetricGoal
- Representação JSON
ExperimentMetric
ExperimentMetricDirection
AsyncActionStatus

Um experimento do Google Ads em que os usuários podem testar mudanças em várias campanhas, comparar a performance e aplicar as mudanças efetivas.

Representação JSON

Representação JSON
{ "resourceName": string, "name": string, "description": string, "suffix": string, "type": enum (`ExperimentType`), "status": enum (`ExperimentStatus`), "goals": [ { object (`MetricGoal`) } ], "promoteStatus": enum (`AsyncActionStatus`), "experimentId": string, "startDate": string, "endDate": string, "longRunningOperation": string, "syncEnabled": boolean }

{
  "resourceName": string,
  "name": string,
  "description": string,
  "suffix": string,
  "type": enum (ExperimentType),
  "status": enum (ExperimentStatus),
  "goals": [
    {
      object (MetricGoal)
    }
  ],
  "promoteStatus": enum (AsyncActionStatus),
  "experimentId": string,
  "startDate": string,
  "endDate": string,
  "longRunningOperation": string,
  "syncEnabled": boolean
}

Campos
`resourceName`	`string` Imutável. O nome do recurso do experimento. Os nomes dos recursos do experimento têm a seguinte forma: `customers/{customerId}/experiments/{experimentId}`
`name`	`string` Obrigatório. O nome do experimento. Ele precisa ter comprimento mínimo de 1 e máximo de 1024. Ele precisa ser exclusivo para um cliente.
`description`	`string` A descrição do experimento. Ele precisa ter comprimento mínimo de 1 e máximo de 2.048 caracteres.
`suffix`	`string` Para experimentos gerenciados pelo sistema, o anunciante precisa fornecer um sufixo durante a criação, na fase de configuração, antes de passar para o início. O sufixo será anexado aos nomes das campanhas com design e experimental para que sejam o nome da campanha base + o sufixo.
`type`	`enum (ExperimentType)` Obrigatório. O produto/recurso que usa o experimento.
`status`	`enum (ExperimentStatus)` O status escolhido pelo anunciante para este experimento.
`goals[]`	`object (MetricGoal)` As metas deste experimento.
`promoteStatus`	`enum (AsyncActionStatus)` Apenas saída. Status do processo de promoção do experimento.
`experimentId`	`string (int64 format)` Apenas saída. O ID do experimento. Somente leitura.
`startDate`	`string` Data de início do experimento. Por padrão, o experimento começa agora ou na data de início da campanha, o que ocorrer depois. Se esse campo for definido, o experimento vai começar no início da data especificada no fuso horário do cliente. Formato: AAAA-MM-DD Exemplo: 2019-03-14
`endDate`	`string` Data de término do experimento. Por padrão, o experimento termina na data de término da campanha. Se esse campo for definido, o experimento terminará no final da data especificada no fuso horário do cliente. Formato: AAAA-MM-DD Exemplo: 2019-04-18
`longRunningOperation`	`string` Apenas saída. O nome do recurso da operação de longa duração que pode ser usado para pesquisar a conclusão da programação do experimento ou promover. A operação de longa duração mais recente é retornada.
`syncEnabled`	`boolean` Imutável. Defina como verdadeiro se as mudanças nas campanhas de base precisarem ser sincronizadas com as campanhas de teste. Todas as alterações feitas diretamente nas campanhas de teste serão preservadas. Esse campo só pode ser definido quando o experimento está sendo criado.

ExperimentType

O tipo do experimento.

Enums
`UNSPECIFIED`	Não especificado.
`UNKNOWN`	O valor é desconhecido nesta versão.
`DISPLAY_AND_VIDEO_360`	Este é um experimento DISPLAY_AND_VIDEO_360.
`AD_VARIATION`	Esta é uma experiência de variação do anúncio.
`YOUTUBE_CUSTOM`	Um experimento personalizado que consiste em campanhas de vídeo.
`DISPLAY_CUSTOM`	Um experimento personalizado que consiste em campanhas de display.
`SEARCH_CUSTOM`	Um experimento personalizado que consiste em campanhas de pesquisa.
`DISPLAY_AUTOMATED_BIDDING_STRATEGY`	Um experimento que compara estratégias de lances para campanhas de display.
`SEARCH_AUTOMATED_BIDDING_STRATEGY`	Um experimento que compara estratégias de lances para campanhas de pesquisa."
`SHOPPING_AUTOMATED_BIDDING_STRATEGY`	Um experimento que compara estratégias de lances para Campanhas do Shopping.
`SMART_MATCHING`	OBSOLETO. Um experimento de correspondência inteligente com campanhas de pesquisa
`HOTEL_CUSTOM`	Um experimento personalizado que consiste em campanhas de hotel.

ExperimentStatus

É o status do experimento.

Enums
`UNSPECIFIED`	Não especificado.
`UNKNOWN`	O valor é desconhecido nesta versão.
`ENABLED`	O experimento está ativado.
`REMOVED`	O experimento foi removido.
`HALTED`	O experimento foi interrompido. Esse status pode ser definido a partir do status ATIVADO por meio da API.
`PROMOTED`	O experimento sairá do status experimental.
`SETUP`	Status inicial do experimento.
`INITIATED`	A materialização das campanhas do experimento está pendente. Esse status pode ser definido a partir do status da CONFIGURAÇÃO por meio da API.
`GRADUATED`	O experimento foi otimizado.

MetricGoal

Uma meta de métrica para um experimento.

Representação JSON
{ "metric": enum (`ExperimentMetric`), "direction": enum (`ExperimentMetricDirection`) }

Campos

Campos
`metric`	`enum (ExperimentMetric)` A métrica da meta. Por exemplo, cliques, impressões, custo, conversões etc.
`direction`	`enum (ExperimentMetricDirection)` A direção da métrica da meta. Por exemplo, aumentar, diminuir, nenhuma mudança.

metric

enum (ExperimentMetric)

A métrica da meta. Por exemplo, cliques, impressões, custo, conversões etc.

direction

enum (ExperimentMetricDirection)

A direção da métrica da meta. Por exemplo, aumentar, diminuir, nenhuma mudança.

ExperimentMetric

O tipo de métrica do experimento.

Enums
`UNSPECIFIED`	Não especificado.
`UNKNOWN`	O valor é desconhecido nesta versão.
`CLICKS`	A meta do experimento são cliques.
`IMPRESSIONS`	A meta do experimento são as impressões.
`COST`	A meta do experimento é o custo.
`CONVERSIONS_PER_INTERACTION_RATE`	A meta do experimento é a taxa de conversão.
`COST_PER_CONVERSION`	A meta do experimento é o custo por conversão.
`CONVERSIONS_VALUE_PER_COST`	A meta do experimento é o valor de conversão por custo.
`AVERAGE_CPC`	A meta da experiência é o CPC médio.
`CTR`	A meta do experimento é ctr.
`INCREMENTAL_CONVERSIONS`	A meta do experimento são conversões incrementais.
`COMPLETED_VIDEO_VIEWS`	A meta do experimento são exibições de vídeos concluídas.
`CUSTOM_ALGORITHMS`	O objetivo do experimento são algoritmos personalizados.
`CONVERSIONS`	A meta do experimento são conversões.
`CONVERSION_VALUE`	A meta do experimento é o valor da conversão.

ExperimentMetricDirection

O tipo de direção da métrica do experimento.

Enums
`UNSPECIFIED`	Não especificado.
`UNKNOWN`	O valor é desconhecido nesta versão.
`NO_CHANGE`	O objetivo do experimento é não mudar a métrica.
`INCREASE`	O objetivo do experimento é criar a métrica.
`DECREASE`	A meta do experimento é diminuir a métrica.
`NO_CHANGE_OR_INCREASE`	A meta do experimento é não mudar nem aumentar a métrica.
`NO_CHANGE_OR_DECREASE`	A meta do experimento é não mudar nem diminuir a métrica.

AsyncActionStatus

O status de ação assíncrona do experimento.

Enums
`UNSPECIFIED`	Não especificado.
`UNKNOWN`	O valor é desconhecido nesta versão.
`NOT_STARTED`	A ação não foi iniciada.
`IN_PROGRESS`	A ação está em andamento.
`COMPLETED`	A ação foi concluída.
`FAILED`	Falha na ação.
`COMPLETED_WITH_WARNING`	A ação foi concluída com avisos.