CampaignSelector

Contém os métodos para filtrar e classificar uma lista de campanhas. Para obter informações sobre seletores, consulte Seletores.

Exemplo de utilização:

    var iterator = AdsApp.campaigns()
        .withCondition("ClickConversionRate > 0.3")
        .forDateRange("LAST_WEEK")
        .orderBy("Clicks DESC")
        .get();

    while (iterator.hasNext()) {
        var campaign = iterator.next();
        var metrics = campaign.getStats();
    }

Metodologia

Nome do método	Tipo de Devolução	Descrição
forDateRange(Object dateFrom, Object dateTo)	CampaignSelector	Aplica as datas de início e fim para selecionar métricas de desempenho.
forDateRange(string dateRange)	CampaignSelector	Aplica o intervalo de datas predefinido para selecionar métricas de desempenho.
Obter	CampaignIterator	Obtém um iterador usado para iterar através da lista de campanhas.
orderBy(string orderBy)	CampaignSelector	Aplica a ordenação especificada às campanhas selecionadas.
withCondition(condição string)	CampaignSelector	Aplica o filtro à lista de campanhas.
withIds(string[] ids)	CampaignSelector	Obtém campanhas com os IDs especificados.
withLimit(int limit)	CampaignSelector	Obtém as X principais campanhas que correspondem aos critérios de seleção.

forDateRange(Object dateFrom, Object dateTo)

Aplica as datas de início e fim para selecionar métricas de desempenho.

Especifique um intervalo de datas apenas se:

Você aplica condições ou ordenações que fazem referência a campos de métricas de desempenho.
Pretende obter dados de desempenho para os objetos que está a selecionar. Por exemplo, se você planeja chamar o getStats() método.

Você pode especificar os parâmetros de data usando cadeias de caracteres ou objetos. Para utilizar cadeias de caracteres, especifique a data no formato AAAAMMDD. Se utilizar objetos, crie um objeto com os seguintes campos:

ano
mês
Dia

Por exemplo:

var date = {year: 2018, month: 5, day: 13};

O mês tem uma base, onde 1 é janeiro e 12 é dezembro.

O intervalo de datas é inclusive. Se especificar vários intervalos de data, apenas será utilizado o último intervalo de datas.

Argumentos

Name	Tipo	Descrição
dateFrom	Objecto	A data de início do intervalo de datas que especifica os dados de desempenho a incluir no seletor.
dateTo	Objecto	A data de fim do intervalo de datas que especifica os dados de desempenho a serem incluídos no seletor.

Devoluções

Tipo	Descrição
CampaignSelector	Seletor com intervalo de datas aplicado.

forDateRange(string dateRange)

Aplica o intervalo de datas predefinido para selecionar métricas de desempenho.

Valores dos intervalos de datas suportados:

HOJE
ONTEM
LAST_WEEK
LAST_BUSINESS_WEEK
LAST_7_DAYS
THIS_WEEK_SUN_TODAY
LAST_14_DAYS
LAST_30_DAYS
LAST_WEEK_SUN_SAT
THIS_MONTH
LAST_MONTH
ALL_TIME

Especifique um intervalo de datas apenas se:

Você aplica condições ou ordenações que fazem referência a campos de métricas de desempenho.
Pretende obter dados de desempenho para os objetos que está a selecionar. Por exemplo, se você planeja chamar o getStats() método.

Se especificar vários intervalos de data, apenas será utilizado o último intervalo de datas.

Argumentos

Name	Tipo	Descrição
IntervaloDeData	Cadeia	A cadeia de intervalo de datas predefinida que especifica os dados de desempenho a incluir no seletor. A cadeia de intervalo de datas predefinida é sensível às maiúsculas e minúsculas.

Devoluções

Tipo	Descrição
CampaignSelector	Seletor com intervalo de datas aplicado.

Obter

Obtém um iterador usado para iterar através da lista de campanhas.

Devoluções

Tipo	Descrição
CampaignIterator	Um iterador usado para iterar através das campanhas selecionadas.

orderBy(string orderBy)

Aplica a ordenação especificada às campanhas selecionadas.

Especifique o parâmetro orderBy no formulário "columnName orderDirection" onde:

columnName é uma das colunas suportadas
orderDirection é a ordem pela qual ordenar os resultados. Defina ASC para ordenar os resultados por ordem ascendente ou DESC para ordenar os resultados por ordem descendente. O padrão é ASC.

Por exemplo, a chamada seguinte devolve campanhas por ordem ascendente por CpcMédia.

selector = selector.orderBy("AverageCpc");

Os seletores suportam entidades de ordenação apenas por um campo. Não pode ordenar a lista de entidades pelo campo x, e dentro de x pelo campo y, e assim sucessivamente. Se você especificar mais de uma orderBy() chamada em cadeia ou em chamadas separadas do seletor, os scripts ordenam a lista de entidades usando o campo especificado na última orderBy() chamada.

Argumentos

Name	Tipo	Descrição
orderBy	cadeia	A ordem a aplicar.

Devoluções

Tipo	Descrição
CampaignSelector	Seletor com ordenação aplicada.

withCondition(condição string)

Aplica o filtro à lista de campanhas de campanhas.

Especifique o parâmetro de condição no formulário, "columnName operator value" onde:

columnName é uma das colunas suportadas. Se columName estiver definido como um nome de coluna de métrica de desempenho, você deverá especificar um intervalo de datas usando forDateRange(String dateRange) ou forDateRange(Object dateFrom, Object dateTo).
é um dos operadores suportados.

Operadores

O operador que utilizar depende do tipo da coluna. Os operadores são sensíveis às maiúsculas e minúsculas. Por exemplo, utilize STARTS_WITH em vez de starts_with.

Operadores para colunas que contêm números inteiros e valores longos:

<
<=
>
>=
=
!=

Operadores para colunas que contêm valores duplos:

<
>

Operadores para colunas que contêm valores de cadeia:

=
!=
STARTS_WITH
STARTS_WITH_IGNORE_CASE
CONTAINS
CONTAINS_IGNORE_CASE
DOES_NOT_CONTAIN
DOES_NOT_CONTAIN_IGNORE_CASE

Operadores para colunas que contêm valores de enumeração:

=
!=
IN []
NOT_IN []

Operadores para colunas que contêm uma matriz de cadeias de caracteres:

CONTAINS_ALL
CONTAINS_ANY
CONTAINS_NONE

Colunas suportadas para filtragem de campanhas. Os nomes das colunas são sensíveis às maiúsculas e minúsculas.

Seguem-se as colunas de métricas de desempenho que pode especificar.

Coluna	Tipo	Exemplos:
AbsoluteTopImpressionRate	duplo	`withCondition("AbsoluteTopImpressionRate > 0.25")`
MédiaCpc	duplo	`withCondition("AverageCpc < 2.75")`
MédiaCpm	duplo	`withCondition("AverageCpm > 0.65")`
ClickConversionRate	duplo	`withCondition("ClickConversionRate > 0.25")`
Cliques	longo	`withCondition("Clicks >= 33")`
ConvertedClicks	longo	`withCondition("ConvertedClicks >= 10")`
Custo	duplo	`withCondition("Cost > 3.25")` O custo está na moeda da conta.
Ctr	duplo	`withCondition("Ctr > 0.05")` A CTR está no intervalo 0..1, então use 0,05 para uma CTR de 5%.
Impressões	longo	`withCondition("Impressions > 10")`
TopImpressionRate	duplo	`withCondition("TopImpressionRate > 0.25")`

A seguir estão as propriedades da entidade que você pode especificar.

Coluna	Tipo	Exemplos:
Estado	Enumeração	O estado da campanha. Os possíveis valores sensíveis às maiúsculas e minúsculas são: ATIVADO EM PAUSA REMOVIDO BUDGET_PAUSED BUDGET_AND_USER_PAUSED Este exemplo retorna apenas habilitado. `withCondition("Status = ENABLED")`
Name	cadeia	O nome da campanha. `withCondition("Name CONTAINS_IGNORE_CASE 'clearance'")`
Orçamento	duplo	O orçamento da campanha. `withCondition("Budget > 500.0")`
BudgetType	Enumeração	O tipo de orçamento da campanha. Os possíveis valores sensíveis às maiúsculas e minúsculas são: PADRÃO ACELERADO `withCondition("BudgetType = 'STANDARD'")`
EstadoDeEntrega	Enumeração	O estado de entrega da campanha. Os possíveis valores sensíveis às maiúsculas e minúsculas são: ELEGÍVEL LIMITED_BY_BUDGET COLOCAR EM ESPERA CAMPAIGN_OUT_OF_BUDGET CAMPAIGN_SUSPENDED CAMPAIGN_PAUSED `withCondition("DeliveryStatus NOT_IN ['LIMITED_BY_BUDGET', 'HOLD', 'CAMPAIGN_OUT_OF_BUDGET']")`
LabelNames	conjunto de cadeias	Uma lista de um ou mais nomes de etiquetas sensíveis às maiúsculas e minúsculas. Utilize para obter campanhas associadas às etiquetas com nome. `withCondition("LabelNames CONTAINS_ANY ['bar', 'foo']")`
Tipo	Enumeração	O tipo da campanha. Os possíveis valores sensíveis às maiúsculas e minúsculas são: SEARCH_AND_CONTENT COMPRAS DYNAMIC_SEARCH_ADS Este exemplo retorna apenas campanhas cujo tipo é Compras. `withCondition("CampaignType = SHOPPING")`

Argumentos

Name	Tipo	Descrição
Condição	cadeia	A condição a ser aplicada ao seletor.

Devoluções

Tipo	Descrição
CampaignSelector	Seletor com a condição aplicada.

withIds(string[] ids)

Obtém campanhas com os IDs especificados.

Pode aplicar uma ou mais condições a um seletor. Uma cadeia de condições é considerada uma operação E. Por exemplo, a entidade só é selecionada se a condição A for verdadeira E a condição B for verdadeira. Por exemplo, a chamada seguinte seleciona apenas a campanha 33333.

AdsApp.campaigns()
    .withIds(['11111', '22222', '33333'])
    .withIds(['33333', '44444', '55555']);

Argumentos

Name	Tipo	Descrição
IDs	cadeia[]	Uma matriz de IDs de campanha. Para limites, consulte Limites de execução de scripts.

Devoluções

Tipo	Descrição
CampaignSelector	Seletor com os IDs aplicados.

withLimit(int limit)

Obtém as X principais campanhas que correspondem aos critérios de seleção.

Argumentos

Name	Tipo	Descrição
limite	int	O número de campanhas a devolver. O número real pode ser menor.

Devoluções

Tipo	Descrição
CampaignSelector	Seletor com limite aplicado.

Consulte também

Comentários

Esta página foi útil?

Last updated on 2026-09-11

CampaignSelector

Metodologia

forDateRange(Object dateFrom, Object dateTo)

Argumentos

Devoluções

forDateRange(string dateRange)

Argumentos

Devoluções

Obter

Devoluções

orderBy(string orderBy)

Argumentos

Devoluções

withCondition(condição string)

Operadores

Argumentos

Devoluções

withIds(string[] ids)

Argumentos

Devoluções

withLimit(int limit)

Argumentos

Devoluções

Consulte também

Comentários

Recursos adicionais