BingAdsAccountSelector
Contiene los métodos para filtrar y ordenar la lista de cuentas a las que el usuario tiene acceso. Para obtener información sobre los selectores, vea Selectores.
Ejemplo de uso:
var accounts = AccountsApp.accounts()
.withCondition("Name CONTAINS_IGNORE_CASE 'PARTIAL ACCOUNT NAME GOES HERE'")
.get();
while (accounts.hasNext()) {
var account = accounts.next();
}
Métodos
Nombre del método | Tipo de valor devuelto | Descripción |
---|---|---|
executeInParallel(string functionName, string optionalCallbackFunctionName) | void | Ejecuta la función para cada cuenta que devuelve el selector. |
executeInParallel(string functionName, string optionalCallbackFunctionName, string optionalInput) | void | Ejecuta la función para cada cuenta que devuelve el selector. |
forDateRange(Object dateFrom, Object dateTo) | BingAdsAccountSelector | Aplica las fechas de inicio y finalización para seleccionar métricas de rendimiento. |
forDateRange(string dateRange) | BingAdsAccountSelector | Aplica el intervalo de fechas predefinido para seleccionar métricas de rendimiento. |
get | BingAdsAccountIterator | Obtiene un iterador usado para recorrer en iteración la lista de cuentas. |
orderBy(string orderBy) | BingAdsAccountSelector | Aplica el orden especificado a las cuentas seleccionadas. |
withAccountNumbers(string[] accountNumbers) | BingAdsAccountSelector | Obtiene cuentas con los números de cuenta especificados. |
withCondition(string condition) | BingAdsAccountSelector | Aplica criterios de filtro a las cuentas. |
withIds(string[] ids) | BingAdsAccountSelector | Obtiene cuentas con los identificadores especificados. |
withLimit(int limit) | BingAdsAccountSelector | Obtiene las n cuentas principales que coinciden con los criterios de selección. |
executeInParallel(string functionName, string optionalCallbackFunctionName)
Ejecuta la función para cada cuenta que devuelve el selector. Una vez ejecutada la función para todas las cuentas seleccionadas, Scripts llama a la función de devolución de llamada opcional.
Nota:
El script puede ejecutar un máximo de 50 cuentas en paralelo cada vez que se ejecuta el script. Puede llamar a este método una o varias veces, pero el número total de cuentas que todos los procesos de llamadas no deben superar 50. Si una llamada supera el máximo de 50 cuentas para el script, no se ejecuta ninguna de las cuentas de la llamada. Para limitar el número de cuentas que devuelve el selector, considere la posibilidad de usar el withLimit
método o withIds
.
La función functionName puede devolver un valor como una cadena. Para devolver un objeto complejo, use el método JSON.stringify para convertir el objeto en una cadena. Después, puede usar el método JSON.parse para volver a convertir la cadena en un objeto . Si la función devuelve un valor, debe especificar una función de devolución de llamada para capturar los valores devueltos. A continuación se muestra la firma de la función de devolución de llamada. Los valores devueltos se pasan como una matriz de objetos ExecutionResult .
function myCallback(ExecutionResult[] results)
En el ejemplo siguiente se muestra cómo procesar los valores devueltos en la función de devolución de llamada.
function myCallback(results) {
for (var result of results) {
var object = JSON.parse(result.getReturnValue());
}
}
Dado que este método no devuelve un objeto BingAdsAccountSelector , asegúrese de que este método es el último método selector de la cadena de llamadas.
Para obtener un ejemplo, consulte Detección de anuncios no aprobados.
Argumentos
Nombre | Tipo | Descripción |
---|---|---|
Nombrefunción | string | Nombre de la función que se va a ejecutar para cada cuenta que devuelve el selector. El método currentAccount identifica la cuenta que está procesando la función. |
optionalCallbackFunctionName | string | Opcional. Nombre de la función que se va a ejecutar después de que todas las cuentas terminen de ejecutar la función functionName . Esta función solo se ejecuta una vez. |
Valores devueltos
Tipo | Descripción |
---|---|
void | Devuelve el valor nothing. |
executeInParallel(string functionName, string optionalCallbackFunctionName, string optionalInput)
Ejecuta la función para cada cuenta que devuelve el selector. Una vez que la función se ejecuta para todas las cuentas seleccionadas, Scripts llama a la función de devolución de llamada opcional.
Nota:
El script puede ejecutar un máximo de 50 cuentas en paralelo cada vez que se ejecuta el script. Puede llamar a este método una o varias veces, pero el número total de cuentas que todos los procesos de llamadas no deben superar 50. Si una llamada supera el máximo de 50 cuentas para el script, no se ejecuta ninguna de las cuentas de la llamada. Para limitar el número de cuentas que devuelve el selector, considere la posibilidad de usar el withLimit
método o withIds
.
La función functionName puede devolver un valor como una cadena. Para devolver un objeto complejo, use el método JSON.stringify para convertir el objeto en una cadena. Después, puede usar el método JSON.parse para volver a convertir la cadena en un objeto . Si la función devuelve un valor, debe especificar una función de devolución de llamada para capturar los valores devueltos. A continuación se muestra la firma de la función de devolución de llamada. Los valores devueltos se pasan como una matriz de objetos ExecutionResult .
function myCallback(ExecutionResult[] results)
En el ejemplo siguiente se muestra cómo procesar los valores devueltos en la función de devolución de llamada.
function myCallback(results) {
for (var result of results) {
var object = JSON.parse(result.getReturnValue());
}
}
Si pasa el parámetro de entrada opcional, a continuación se muestra la firma de la función functionName .
function myFunction(string optionalInput)
Dado que este método no devuelve un objeto BingAdsAccountSelector , asegúrese de que este método es el último método selector de la cadena de llamadas.
Para obtener un ejemplo, consulte Detección de anuncios no aprobados.
Argumentos
Nombre | Tipo | Descripción |
---|---|---|
Nombrefunción | string | Nombre de la función que se va a ejecutar para cada cuenta que devuelve el selector. El método currentAccount identifica la cuenta que está procesando la función. |
optionalCallbackFunctionName | string | Opcional. Nombre de la función que se va a ejecutar después de que todas las cuentas terminen de ejecutar la función functionName . Esta función solo se ejecuta una vez. |
optionalInput | string | Opcional. Entrada para pasar a la función functionName . |
Valores devueltos
Tipo | Descripción |
---|---|
void | Devuelve el valor nothing. |
forDateRange(Object dateFrom, Object dateTo)
Aplica las fechas de inicio y finalización para seleccionar métricas de rendimiento.
Especifique un intervalo de fechas solo si:
- Puede aplicar condiciones o ordenar que hagan referencia a campos de métricas de rendimiento.
- Quiere obtener datos de rendimiento de los objetos que está seleccionando. Por ejemplo, si tiene previsto llamar al
getStats()
método .
Puede especificar los parámetros de fecha mediante cadenas u objetos. Para usar cadenas, especifique la fecha en el formulario AAAAMMDD. Si usa objetos, cree un objeto con los campos siguientes:
- year
- month
- Día
Por ejemplo:
var date = {year: 2018, month: 5, day: 13};
El mes se basa en uno, donde el 1 es enero y el 12 es diciembre.
El intervalo de fechas es inclusivo. Si especifica varios intervalos de fechas, solo se usa el último intervalo de fechas.
Argumentos
Nombre | Tipo | Descripción |
---|---|---|
dateFrom | Objeto | Fecha de inicio del intervalo de fechas que especifica los datos de rendimiento que se van a incluir en el selector. |
dateTo | Objeto | Fecha de finalización del intervalo de fechas que especifica los datos de rendimiento que se van a incluir en el selector. |
Valores devueltos
Tipo | Descripción |
---|---|
BingAdsAccountSelector | Selector con intervalo de fechas aplicado. |
forDateRange(String dateRange)
Aplica el intervalo de fechas predefinido para seleccionar métricas de rendimiento.
Valores de intervalo de fecha admitidos:
- HOY
- AYER
- 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 un intervalo de fechas solo si:
- Puede aplicar condiciones o ordenar que hagan referencia a campos de métricas de rendimiento.
- Quiere obtener datos de rendimiento de los objetos que está seleccionando. Por ejemplo, si tiene previsto llamar al
getStats()
método .
Si especifica varios intervalos de fechas, solo se usa el último intervalo de fechas.
Argumentos
Nombre | Tipo | Descripción |
---|---|---|
dateRange | Cadena | Cadena de intervalo de fechas predefinida que especifica los datos de rendimiento que se van a incluir en el selector. La cadena de intervalo de fechas predefinida distingue mayúsculas de minúsculas. |
Valores devueltos
Tipo | Descripción |
---|---|
BingAdsAccountSelector | Selector con intervalo de fechas aplicado. |
Obtener
Obtiene un iterador usado para recorrer en iteración la lista de cuentas.
Valores devueltos
Tipo | Descripción |
---|---|
BingAdsAccount | Iterador usado para recorrer en iteración las cuentas seleccionadas. |
orderBy(string orderBy)
Aplica el orden especificado a las cuentas seleccionadas.
Especifique el parámetro orderBy en el formulario "columnName orderDirection" donde:
- columnName es una de las columnas admitidas.
- orderDirection es el orden en el que se ordenan los resultados. Establezca en ASC para ordenar los resultados en orden ascendente o DESC para ordenar los resultados en orden descendente. El valor predeterminado es ASC.
Por ejemplo, la siguiente llamada devuelve resultados en orden ascendente por clics.
selector = selector.orderBy("Clicks");
Los selectores admiten la ordenación de entidades solo por un campo. No puede ordenar la lista de entidades por campo x, y dentro de x por campo y, etc. Si especifica más de una orderBy()
llamada en una cadena o en llamadas de selector independientes, Scripts ordena la lista de entidades mediante el campo especificado en la última orderBy()
llamada.
Argumentos
Nombre | Tipo | Descripción |
---|---|---|
Orderby | string | Orden que se va a aplicar. |
Valores devueltos
Tipo | Descripción |
---|---|
BingAdsAccountSelector | Selector con orden aplicado. |
withAccountNumbers(string[] accountNumbers)
Obtiene cuentas con los números de cuenta especificados.
Argumentos
Nombre | Tipo | Descripción |
---|---|---|
accountNumbers | string[] | Matriz de números de cuenta. Para conocer los límites, consulte Límites de ejecución de scripts. |
Valores devueltos
Tipo | Descripción |
---|---|
BingAdsAccountSelector | Selector con los números de cuenta aplicados. |
withCondition(String condition)
Aplica criterios de filtro a las cuentas.
Especifique el parámetro de condición en el formulario "columnName operator value" donde:
- columnName es una de las columnas admitidas. Si columName se establece en un nombre de columna de métrica de rendimiento, debe especificar un intervalo de fechas mediante forDateRange(String dateRange) o forDateRange(Object dateFrom, Object dateTo).
- operator es uno de los operadores admitidos.
Operadores
El operador que use depende del tipo de columna. Los operadores distinguen mayúsculas de minúsculas. Por ejemplo, use STARTS_WITH en lugar de starts_with.
Operadores para columnas que contienen enteros y valores largos:
<
<=
>
>=
=
!=
Operadores para columnas que contienen valores dobles:
<
>
Operadores para columnas que contienen valores de cadena:
=
!=
STARTS_WITH
STARTS_WITH_IGNORE_CASE
CONTAINS
CONTAINS_IGNORE_CASE
DOES_NOT_CONTAIN
DOES_NOT_CONTAIN_IGNORE_CASE
Operadores para columnas que contienen valores de enumeración:
=
!=
IN []
NOT_IN []
Operadores para columnas que contienen una matriz de cadenas:
CONTAINS_ALL
CONTAINS_ANY
CONTAINS_NONE
Columnas admitidas para el filtrado de cuentas. Los nombres de columna distinguen mayúsculas de minúsculas.
A continuación se muestran las columnas de métricas de rendimiento que puede especificar.
Column | Tipo | Ejemplo | Filtro de interfaz de usuario web de Microsoft Advertising |
---|---|---|---|
ClickConversionRate | double | withCondition("ClickConversionRate > 0.25") |
Conv. Rate |
Clics | largo | withCondition("Clicks >= 33") |
Clics |
ConvertedClicks | largo | withCondition("ConvertedClicks >= 10") |
Conv. |
Costo | double | withCondition("Cost > 3.25") El costo está en la moneda de la cuenta. |
Gastar |
Ctr | double | withCondition("Ctr > 0.05") El CTR está en el intervalo 0..1, por lo que use 0.05 para una CTR del 5 %. |
CTR |
Impresiones | largo | withCondition("Impressions > 10") |
Impr. |
Las siguientes son las propiedades de la cuenta que puede especificar.
Column | Tipo | Ejemplo | Filtro de interfaz de usuario web de Microsoft Advertising |
---|---|---|---|
CurrencyCode | string | Código de moneda de la moneda utilizada por la cuenta. Por ejemplo, USD por Estados Unidos dólar.withCondition("CurrencyCode = USD") |
|
ManagerCustomerId | string | Identificador de cliente del usuario que administra las cuentas.withCondition("ManagerCustomerId = '123456789'") |
|
Nombre | string | Nombre de una cuenta administrada.withCondition("Name CONTAINS_IGNORE_CASE 'foo'") |
Argumentos
Nombre | Tipo | Descripción |
---|---|---|
Condición | string | Condición que se va a agregar al selector. |
Valores devueltos
Tipo | Descripción |
---|---|
BingAdsAccountSelector | Selector con la condición aplicada. |
withIds(string[] ids)
Obtiene cuentas con los identificadores especificados.
Puede aplicar una o varias condiciones a un selector. Una cadena de condiciones se considera una operación AND. Por ejemplo, la entidad solo se selecciona si la condición A es true Y la condición B es true. Por ejemplo, la llamada siguiente selecciona solo la cuenta 33333.
AccountsApp.accounts()
.withIds(['11111', '22222', '33333'])
.withIds(['33333', '44444', '55555']);
.get();
Argumentos
Nombre | Tipo | Descripción |
---|---|---|
ids | string[] | Matriz de identificadores de cuenta. Para conocer los límites, consulte Límites de ejecución de scripts. |
Valores devueltos
Tipo | Descripción |
---|---|
BingAdsAccountSelector | Selector con los identificadores aplicados. |
withLimit(int limit)
Obtiene las n cuentas principales que coinciden con los criterios de selección.
Argumentos
Nombre | Tipo | Descripción |
---|---|---|
límite | Entero | Número de cuentas que se van a devolver. El número real puede ser menor. |
Valores devueltos
Tipo | Descripción |
---|---|
BingAdsAccountSelector | Selector con límite aplicado. |