BingAdsAccountSelector

Contém os métodos para filtrar e ordenar a lista de contas às quais o utilizador tem acesso. Para obter informações sobre seletores, consulte Seletores.

Exemplo de utilização:

    var accounts = AccountsApp.accounts()
        .withCondition("Name CONTAINS_IGNORE_CASE 'PARTIAL ACCOUNT NAME GOES HERE'")
        .get();

    while (accounts.hasNext()) {
        var account = accounts.next();
    }

Metodologia

Nome do método	Tipo de Devolução	Descrição
executeInParallel(string functionName, string optionalCallbackFunctionName)	Void	Executa a função para cada conta devolvida pelo seletor.
executeInParallel(string functionName, string optionalCallbackFunctionName, string optionalInput)	Void	Executa a função para cada conta devolvida pelo seletor.
forDateRange(Object dateFrom, Object dateTo)	BingAdsAccountSelector	Aplica as datas de início e fim para selecionar métricas de desempenho.
forDateRange(string dateRange)	BingAdsAccountSelector	Aplica o intervalo de datas predefinido para selecionar métricas de desempenho.
Obter	BingAdsAccountIterator	Obtém um iterador usado para iterar através da lista de contas.
orderBy(string orderBy)	BingAdsAccountSelector	Aplica a ordenação especificada às contas selecionadas.
withAccountNumbers(string[], accountNumbers)	BingAdsAccountSelector	Obtém contas com os números de conta especificados.
withCondition(condição string)	BingAdsAccountSelector	Aplica critérios de filtragem às contas.
withIds(string[] ids)	BingAdsAccountSelector	Obtém contas com as IDs especificadas.
withLimit(int limit)	BingAdsAccountSelector	Obtém as primeiras n contas que correspondem aos critérios de seleção.

executeInParallel(string functionName, string optionalCallbackFunctionName)

Executa a função para cada conta devolvida pelo seletor. Depois que a função é executada para todas as contas selecionadas, o Scripts chama a função de retorno de chamada opcional.

Nota

O script pode executar um máximo de 50 contas em paralelo cada vez que é executado. Pode chamar este método uma ou várias vezes, mas o número total de contas processadas por todas as chamadas não pode exceder as 50. Se uma chamada exceder o máximo de 50 contas para o script, nenhuma das contas na chamada será executada. Para limitar o número de contas devolvidas pelo seletor, considere utilizar o withLimit método ou withIds .

A função functionName pode retornar um valor como uma cadeia de caracteres. Para retornar um objeto complexo, use o método JSON.stringify para converter o objeto em uma cadeia de caracteres. Em seguida, você pode usar o método JSON.parse para converter a cadeia de caracteres novamente em um objeto. Se sua função retornar um valor, você deve especificar uma função de retorno de chamada para capturar os valores de retorno. A seguir mostra a assinatura da função de retorno de chamada. Os valores retornados são passados como uma matriz de objetos ExecutionResult .

function myCallback(ExecutionResult[] results)

O exemplo a seguir mostra como processar os valores retornados na função de retorno de chamada.

function myCallback(results) {
    for (var result of results) {
        var object = JSON.parse(result.getReturnValue());
    }
}

Como esse método não retorna um objeto BingAdsAccountSelector , verifique se esse método é o último método seletor na cadeia de chamadas.

Por exemplo, consulte Descobrindo anúncios reprovados.

Argumentos

Name	Tipo	Descrição
nomeDafunção	cadeia	O nome da função a ser executada para cada conta que o seletor devolve. O método currentAccount identifica a conta que a função está processando.
optionalCallbackFunctionName	cadeia	Opcional. O nome da função a ser executada depois que todas as contas terminarem de executar a função functionName . Esta função é executada apenas uma vez.

Devoluções

Tipo	Descrição
Void	Não devolve nada.

executeInParallel(string functionName, string optionalCallbackFunctionName, string optionalInput)

Executa a função para cada conta devolvida pelo seletor. Depois que a função é executada para todas as contas selecionadas, o Scripts chama a função de retorno de chamada opcional.

Nota

O script pode executar um máximo de 50 contas em paralelo cada vez que é executado. Pode chamar este método uma ou várias vezes, mas o número total de contas processadas por todas as chamadas não pode exceder as 50. Se uma chamada exceder o máximo de 50 contas para o script, nenhuma das contas na chamada será executada. Para limitar o número de contas devolvidas pelo seletor, considere utilizar o withLimit método ou withIds .

A função functionName pode retornar um valor como uma cadeia de caracteres. Para retornar um objeto complexo, use o método JSON.stringify para converter o objeto em uma cadeia de caracteres. Em seguida, você pode usar o método JSON.parse para converter a cadeia de caracteres novamente em um objeto. Se sua função retornar um valor, você deve especificar uma função de retorno de chamada para capturar os valores de retorno. A seguir mostra a assinatura da função de retorno de chamada. Os valores retornados são passados como uma matriz de objetos ExecutionResult .

function myCallback(ExecutionResult[] results)

O exemplo a seguir mostra como processar os valores retornados na função de retorno de chamada.

function myCallback(results) {
    for (var result of results) {
        var object = JSON.parse(result.getReturnValue());
    }
}

Se você passar o parâmetro de entrada opcional, a seguir mostra a assinatura da função functionName .

function myFunction(string optionalInput)

Como esse método não retorna um objeto BingAdsAccountSelector , verifique se esse método é o último método seletor na cadeia de chamadas.

Por exemplo, consulte Descobrindo anúncios reprovados.

Argumentos

Name	Tipo	Descrição
nomeDafunção	cadeia	O nome da função a ser executada para cada conta que o seletor devolve. O método currentAccount identifica a conta que a função está processando.
optionalCallbackFunctionName	cadeia	Opcional. O nome da função a ser executada depois que todas as contas terminarem de executar a função functionName . Esta função é executada apenas uma vez.
entrada opcional	cadeia	Opcional. Entrada para passar para a função functionName .

Devoluções

Tipo	Descrição
Void	Não devolve nada.

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

Obter

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

Devoluções

Tipo	Descrição
BingAdsAccount	Um iterador utilizado para iterar através das contas selecionadas.

orderBy(string orderBy)

Aplica a ordenação especificada às contas 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 os resultados por ordem ascendente por Cliques.

selector = selector.orderBy("Clicks");

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
BingAdsAccountSelector	Seletor com ordenação aplicada.

withAccountNumbers(string[], accountNumbers)

Obtém contas com os números de conta especificados.

Argumentos

Name	Tipo	Descrição
accountNumbers	cadeia[]	Uma matriz de números de conta. Para limites, consulte Limites de execução de scripts.

Devoluções

Tipo	Descrição
BingAdsAccountSelector	Seletor com os números de conta aplicados.

withCondition(condição String)

Aplica critérios de filtragem às contas.

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 contas. 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:	Filtro de IU da Web do Microsoft Advertising
ClickConversionRate	duplo	withCondition("ClickConversionRate > 0.25")	Taxa Conv.
Cliques	longo	withCondition("Clicks >= 33")	Cliques
ConvertedClicks	longo	withCondition("ConvertedClicks >= 10")	Conv.
Custo	duplo	withCondition("Cost > 3.25") O custo está na moeda da conta.	Gastos
Ctr	duplo	withCondition("Ctr > 0.05") A CTR está no intervalo 0..1, então use 0,05 para uma CTR de 5%.	CTR
Impressões	longo	withCondition("Impressions > 10")	Impr.

Seguem-se as propriedades da conta que pode especificar.

Coluna	Tipo	Exemplos:	Filtro de IU da Web do Microsoft Advertising
CurrencyCode	cadeia	O código da moeda utilizada pela conta. Por exemplo, USD para Estados Unidos Dólar. withCondition("CurrencyCode = USD")
ManagerCustomerId	cadeia	O ID de cliente do utilizador que gere as contas. withCondition("ManagerCustomerId = '123456789'")
Name	cadeia	O nome de uma conta gerida. withCondition("Name CONTAINS_IGNORE_CASE 'foo'")

Argumentos

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

Devoluções

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

withIds(string[] ids)

Obtém contas 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 a conta 33333.

AccountsApp.accounts()
    .withIds(['11111', '22222', '33333'])
    .withIds(['33333', '44444', '55555']);
    .get();

Argumentos

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

Devoluções

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

withLimit(int limit)

Obtém as primeiras n contas que correspondem aos critérios de seleção.

Argumentos

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

Devoluções

Tipo	Descrição
BingAdsAccountSelector	Seletor com limite aplicado.

Consulte também

• AccountsApp.accounts()
• BingAdsAccountIterator
• Acesso multicontas