BudgetSelector

Contém os métodos para filtrar e ordenar a lista de orçamentos partilhados. Para obter informações sobre seletores, consulte Seletores.

Exemplo de utilização:

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

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

Metodologia

Nome do método Tipo de Devolução Descrição
forDateRange(Object dateFrom, Object dateTo) BudgetSelector Aplica as datas de início e fim para selecionar métricas de desempenho.
forDateRange(string dateRange) BudgetSelector Aplica o intervalo de datas predefinido para selecionar métricas de desempenho.
Obter AdGroupIterator Obtém um iterador usado para iterar através da lista de orçamentos compartilhados.
orderBy(string orderBy) BudgetSelector Aplica a ordenação especificada aos orçamentos partilhados selecionados.
withCondition(condição string) BudgetSelector Aplica critérios de filtro aos orçamentos partilhados.
withIds(string[] ids) BudgetSelector Obtém orçamentos compartilhados com as IDs especificadas.
withLimit(int limit) BudgetSelector Obtém os n primeiros orçamentos compartilhados 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
BudgetSelector Seletor com intervalo de datas aplicado.

forDateRange(String dateRange)

Aplica o intervalo de datas predefinido 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.

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

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

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
BudgetSelector Seletor com intervalo de datas aplicado.

Obter

Obtém um iterador usado para iterar através da lista de orçamentos compartilhados.

Devoluções

Tipo Descrição
AdGroupIterator Um iterador utilizado para iterar através dos orçamentos partilhados selecionados.

orderBy(String orderBy)

Aplica a ordenação especificada aos orçamentos partilhados selecionados.

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 orçamentos partilhados 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
BudgetSelector Seletor com ordenação aplicada.

withCondition(condição String)

Aplica critérios de filtro aos orçamentos partilhados.

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

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

Colunas suportadas para filtragem de orçamento partilhado. Os nomes 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:
Montante duplo O montante do orçamento partilhado.

withCondition("Amount >= 130")
BudgetName cadeia O nome do orçamento partilhado.

withCondition("BudgetName CONTAINS_IGNORE_CASE 'sport'")
BudgetReferenceCount Número inteiro O número de campanhas associadas ao orçamento partilhado.

withCondition("BudgetReferenceCount > 5")

Argumentos

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

Devoluções

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

withIds(string[] ids)

Obtém orçamentos compartilhados com as IDs especificadas.

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 o orçamento partilhado 33333.

var selector = AdsApp.budgets()
    .withIds(['11111', '22222', '33333'])
    .withIds(['33333', '44444', '55555']);

Argumentos

Name Tipo Descrição
IDs cadeia[] Um conjunto de IDs de orçamento partilhados. Para limites, consulte Limites de execução de scripts.

Devoluções

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

withLimit(int limit)

Obtém os n primeiros orçamentos compartilhados que correspondem aos critérios de seleção.

Argumentos

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

Devoluções

Tipo Descrição
BudgetSelector Seletor com limite aplicado.

Consulte também

AdsApp.budgets()

  • Last updated on