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 alterações em várias campanhas, comparar a performance e aplicar as mudanças eficazes.

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 }

{
  "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
}

Campos
`resourceName`	`string` Imutável. O nome do recurso do experimento. Os nomes dos recursos do experimento têm o seguinte formato: `customers/{customerId}/experiments/{experimentId}`
`name`	`string` Obrigatório. O nome do experimento. Ele precisa ter um tamanho mínimo de 1 e máximo de 1.024. Ele precisa ser exclusivo de um cliente.
`description`	`string` A descrição do experimento. Ele precisa ter um tamanho 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 etapa de configuração, antes de passar para o estado iniciado. O sufixo será anexado aos nomes das campanhas experimentais e integradas para que o nome seja 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, a que ocorrer depois. Se esse campo estiver 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 vai 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 usada para pesquisar a conclusão da programação do experimento ou promover. A operação de longa duração mais recente é retornada.

ExperimentType

O tipo do experimento.

Enums
`UNSPECIFIED`	Não especificado.
`UNKNOWN`	O valor é desconhecido nesta versão.
`DISPLAY_AND_VIDEO_360`	Este é um experimento do DISPLAY_AND_VIDEO_360.
`AD_VARIATION`	Este é um experimento 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 vai ser promovido fora do status experimental.
`SETUP`	Status inicial do experimento.
`INITIATED`	A materialização das campanhas do experimento está pendente. Este status pode ser definido a partir do status de 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, sem 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, sem 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 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 da conversão por custo.
`AVERAGE_CPC`	A meta da experiência é o CPC médio.
`CTR`	A meta do experimento é a CTR.
`INCREMENTAL_CONVERSIONS`	A meta do experimento são conversões incrementais.
`COMPLETED_VIDEO_VIEWS`	A meta do experimento são as visualizações completas de vídeos.
`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 da 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.