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.
Utilização de exemplo:
var accounts = AccountsApp.accounts()
.withCondition("Name CONTAINS_IGNORE_CASE 'PARTIAL ACCOUNT NAME GOES HERE'")
.get();
while (accounts.hasNext()) {
var account = accounts.next();
}
Métodos
| Nome do Método | Tipo de Devolução | Descrição |
|---|---|---|
| executeInParallel(string functionName, string optionalCallbackFunctionName) | vazio | Executa a função para cada conta que o seletor devolve. |
| executeInParallel(string functionName, string optionalCallbackFunctionName, cadeia optionalInput) | vazio | Executa a função para cada conta que o seletor devolve. |
| forDateRange(Data do objetoA partir de, Data do objetoTo) | BingAdsAccountSelector | Aplica as datas de início e de 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 utilizado 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 de cadeia) | BingAdsAccountSelector | Aplica critérios de filtro às contas. |
| withIds(string[] ids) | BingAdsAccountSelector | Obtém contas com os IDs especificados. |
| withLimit(int limit) | BingAdsAccountSelector | Obtém as principais n contas que correspondem aos critérios de seleção. |
executeInParallel(string functionName, string optionalCallbackFunctionName)
Executa a função para cada conta que o seletor devolve. Depois de a função ser executada para todas as contas selecionadas, os Scripts chamam a função de chamada de retorno opcional.
Nota
O script pode executar um máximo de 50 contas em paralelo sempre que o script for executado. Pode chamar este método uma ou várias vezes, mas o número total de contas que todas as chamadas processam não pode exceder 50. Se uma chamada exceder o máximo de 50 contas do script, nenhuma das contas na chamada é executada. Para limitar o número de contas que o seletor devolve, considere utilizar o withLimit método ou withIds .
A função functionName pode devolver um valor como uma cadeia. Para devolver um objeto complexo, utilize o método JSON.stringify para converter o objeto numa cadeia. Em seguida, pode utilizar o método JSON.parse para converter novamente a cadeia num objeto. Se a função devolver um valor, tem de especificar uma função de chamada de retorno para capturar os valores devolvidos. O seguinte mostra a assinatura da função de chamada de retorno. Os valores devolvidos são transmitidos como uma matriz de objetos ExecutionResult .
function myCallback(ExecutionResult[] results)
O exemplo seguinte mostra como processar os valores devolvidos na função de chamada de retorno.
function myCallback(results) {
for (var result of results) {
var object = JSON.parse(result.getReturnValue());
}
}
Uma vez que este método não devolve um objeto BingAdsAccountSelector , certifique-se de que este método é o último método do seletor na cadeia de chamadas.
Por exemplo, veja Discover disapproved ads (Descobrir anúncios desaprovados).
Argumentos
| Name | Tipo | Descrição |
|---|---|---|
| functionName | cadeia | O nome da função a executar para cada conta que o seletor devolve. O método currentAccount identifica a conta que a função está a processar. |
| optionalCallbackFunctionName | cadeia | Opcional. O nome da função a executar depois de todas as contas terminarem de executar a função functionName . Esta função executa apenas uma vez. |
Devoluções
| Tipo | Descrição |
|---|---|
| vazio | Não devolve nada. |
executeInParallel(string functionName, string optionalCallbackFunctionName, cadeia optionalInput)
Executa a função para cada conta que o seletor devolve. Após a execução da função para todas as contas selecionadas, os Scripts chamam a função de chamada de retorno opcional.
Nota
O script pode executar um máximo de 50 contas em paralelo sempre que o script for executado. Pode chamar este método uma ou várias vezes, mas o número total de contas que todas as chamadas processam não pode exceder 50. Se uma chamada exceder o máximo de 50 contas do script, nenhuma das contas na chamada é executada. Para limitar o número de contas que o seletor devolve, considere utilizar o withLimit método ou withIds .
A função functionName pode devolver um valor como uma cadeia. Para devolver um objeto complexo, utilize o método JSON.stringify para converter o objeto numa cadeia. Em seguida, pode utilizar o método JSON.parse para converter novamente a cadeia num objeto. Se a função devolver um valor, tem de especificar uma função de chamada de retorno para capturar os valores devolvidos. O seguinte mostra a assinatura da função de chamada de retorno. Os valores devolvidos são transmitidos como uma matriz de objetos ExecutionResult .
function myCallback(ExecutionResult[] results)
O exemplo seguinte mostra como processar os valores devolvidos na função de chamada de retorno.
function myCallback(results) {
for (var result of results) {
var object = JSON.parse(result.getReturnValue());
}
}
Se transmitir o parâmetro de entrada opcional, o seguinte mostra a assinatura da função functionName .
function myFunction(string optionalInput)
Uma vez que este método não devolve um objeto BingAdsAccountSelector , certifique-se de que este método é o último método do seletor na cadeia de chamadas.
Por exemplo, veja Discover disapproved ads (Descobrir anúncios desaprovados).
Argumentos
| Name | Tipo | Descrição |
|---|---|---|
| functionName | cadeia | O nome da função a executar para cada conta que o seletor devolve. O método currentAccount identifica a conta que a função está a processar. |
| optionalCallbackFunctionName | cadeia | Opcional. O nome da função a executar depois de todas as contas terminarem de executar a função functionName . Esta função executa apenas uma vez. |
| optionalInput | cadeia | Opcional. Entrada para passar para a função functionName . |
Devoluções
| Tipo | Descrição |
|---|---|
| vazio | Não devolve nada. |
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 |
|---|---|
| BingAdsAccountSelector | 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 |
|---|---|
| BingAdsAccountSelector | Seletor com intervalo de datas aplicado. |
obter
Obtém um iterador utilizado 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" 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 resultados por ordem ascendente por Cliques.
selector = selector.orderBy("Clicks");
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 |
|---|---|
| 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 obter limites, veja Limites de execução de scripts. |
Devoluções
| Tipo | Descrição |
|---|---|
| BingAdsAccountSelector | Seletor com os números de conta aplicados. |
withCondition(Condição de cadeia)
Aplica critérios de filtro às contas.
Especifique o parâmetro condition no formulário "columnName operator value" em que:
- columnName é uma das colunas suportadas. Se columName estiver definido como um nome de coluna de métrica de desempenho, tem de especificar um intervalo de datas com forDateRange(String dateRange) ou forDateRange(Object dateFrom, Object dateTo).
- O operador é 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:
CONTAINS_ALL
CONTAINS_ANY
CONTAINS_NONE
Colunas suportadas para filtragem de conta. 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 | long | withCondition("Clicks >= 33") |
Cliques |
| ConvertClicks | long | withCondition("ConvertedClicks >= 10") |
Conv. |
| Custo | duplo | withCondition("Cost > 3.25")O custo está na moeda da conta. |
Gastar |
| Ctr | duplo | withCondition("Ctr > 0.05")O CTR está no intervalo 0..1, por isso, utilize 0,05 para um CTR de 5%. |
CTR |
| Impressões | long | 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 de moeda 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 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 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 obter limites, veja Limites de execução de scripts. |
Devoluções
| Tipo | Descrição |
|---|---|
| BingAdsAccountSelector | Seletor com os IDs aplicados. |
withLimit(int limit)
Obtém as principais 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. |