Compartilhar via

CampaignSelector

  • Artigo

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

Utilização de exemplo:

    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();
    }

Métodos

Nome do Método Tipo de Devolução Descrição
forDateRange(Data do objetoA partir de, Data do objetoTo) CampaignSelector Aplica as datas de início e de 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 utilizado para iterar através da lista de campanhas.
orderBy(string orderBy) CampaignSelector Aplica a ordenação especificada às campanhas selecionadas.
withCondition(condição de cadeia) 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 principais n campanhas que correspondem aos critérios de seleção.

forDateRange(Data do objetoA partir de, Data do objetoTo)

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

Especifique um intervalo de datas apenas se:

  • Aplica condições ou ordenação que referenciam campos de métricas de desempenho.
  • Quer obter dados de desempenho para os objetos que está a selecionar. Por exemplo, se planear chamar o getStats() método .

Pode especificar os parâmetros de data com cadeias ou objetos. Para utilizar cadeias, especifique a data no formulário YYYYMMDD. 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 é baseado num, em que 1 é janeiro e 12 é dezembro.

O intervalo de datas é inclusivo. Se especificar vários intervalos de datas, só é utilizado o último intervalo de datas.

Argumentos

Name Tipo Descrição
dateFrom Objeto A data de início do intervalo de datas que especifica os dados de desempenho a incluir no seletor.
dateTo Objeto A data de fim do intervalo de datas que especifica os dados de desempenho a incluir 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 de intervalo 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:

  • Aplica condições ou ordenação que referenciam campos de métricas de desempenho.
  • Quer obter dados de desempenho para os objetos que está a selecionar. Por exemplo, se planear chamar o getStats() método .

Se especificar vários intervalos de datas, só é utilizado o último intervalo de datas.

Argumentos

Name Tipo Descrição
dateRange 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 utilizado para iterar através da lista de campanhas.

Devoluções

Tipo Descrição
CampaignIterator Um iterador utilizado 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" em que:

  • columnName é uma das colunas suportadas
  • orderDirection é a ordem para ordenar os resultados. Defina como ASC para ordenar os resultados por ordem ascendente ou DESC para ordenar os resultados por ordem descendente. A predefinição é ASC.

Por exemplo, a chamada seguinte devolve campanhas por ordem ascendente por AverageCpc.

selector = selector.orderBy("AverageCpc");

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

Argumentos

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

Devoluções

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

withCondition(condição de cadeia)

Aplica o filtro à lista de campanhas.

Especifique o parâmetro condition no formulário "columnName operator value" em que:

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:

CONTAINS_ALL
CONTAINS_ANY
CONTAINS_NONE

Colunas suportadas para filtragem de campanha. 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")
AverageCpc duplo withCondition("AverageCpc < 2.75")
AverageCpm duplo withCondition("AverageCpm > 0.65")
ClickConversionRate duplo withCondition("ClickConversionRate > 0.25")
Cliques long withCondition("Clicks >= 33")
ConvertClicks long withCondition("ConvertedClicks >= 10")
Custo duplo withCondition("Cost > 3.25")

O custo está na moeda da conta.
Ctr duplo withCondition("Ctr > 0.05")

O CTR está no intervalo 0..1, por isso, utilize 0,05 para um CTR de 5%.
Impressões long withCondition("Impressions > 10")
TopImpressionRate duplo withCondition("TopImpressionRate > 0.25")

Seguem-se as propriedades da entidade que 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 devolve apenas ativado.

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'")
DeliveryStatus 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
  • SUSPENSÃO
  • CAMPAIGN_OUT_OF_BUDGET
  • CAMPAIGN_SUSPENDED
  • CAMPAIGN_PAUSED
withCondition("DeliveryStatus NOT_IN ['LIMITED_BY_BUDGET', 'HOLD', 'CAMPAIGN_OUT_OF_BUDGET']")
Nomes de Etiqueta 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 nomeadas.

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 devolve apenas campanhas cujo tipo é Compras.

withCondition("CampaignType = SHOPPING")

Argumentos

Name Tipo Descrição
condição cadeia A condição a aplicar 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 obter limites, veja Limites de execução de scripts.

Devoluções

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

withLimit(int limit)

Obtém as principais n 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