Selector de campaña

Contiene los métodos para filtrar y ordenar una lista de campañas. Para obtener información sobre los selectores, consulte Selectores.

Ejemplo de uso:

    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

Nombre del método Tipo de valor devuelto Description
forDateRange(Object dateFrom, Object dateTo) Selector de campaña Aplica las fechas de inicio y finalización para seleccionar métricas de rendimiento.
forDateRange(string dateRange) Selector de campaña Aplica el intervalo de fechas predefinido para seleccionar las métricas de rendimiento.
get CampaignIterator Obtiene un iterador que se usa para iterar a través de la lista de campañas.
orderBy(string orderBy) Selector de campaña Aplica el orden especificado a las campañas seleccionadas.
withCondition(condición de cadena) Selector de campaña Aplica el filtro a la lista de campañas.
withIds(string[] ids) Selector de campaña Obtiene las campañas con los identificadores especificados.
withLimit(int limit) Selector de campaña Obtiene las n campañas principales que coinciden con los criterios de selección.

forDateRange(Object dateFrom, Object dateTo)

Aplica las fechas de inicio y finalización para seleccionar métricas de rendimiento.

Especifique un intervalo de fechas únicamente si:

  • Se aplican condiciones u órdenes que hacen referencia a campos de métricas de rendimiento.
  • Desea obtener datos de rendimiento para los objetos que está seleccionando. Por ejemplo, si tiene previsto getStats() llamar al método.

Puede especificar los parámetros de fecha mediante cadenas u objetos. Para usar cadenas, especifique la fecha con el formato AAAAMMDD. Si utiliza objetos, cree un objeto con los siguientes campos:

  • year
  • month
  • día

Por ejemplo:

var date = {year: 2018, month: 5, day: 13};

El mes es de una sola base, donde 1 es enero y 12 es diciembre.

El intervalo de fechas es inclusivo. Si especifica varios intervalos de fechas, solo se usará el último intervalo de fechas.

Argumentos

Nombre Tipo Description
dateFrom Objeto Fecha de inicio del intervalo de fechas que especifica los datos de rendimiento que se incluirán en el selector.
dateTo Objeto Fecha de finalización del intervalo de fechas que especifica los datos de rendimiento que se incluirán en el selector.

Valores devueltos

Tipo Description
Selector de campaña Selector con intervalo de fechas aplicado.

forDateRange(string dateRange)

Aplica el intervalo de fechas predefinido para seleccionar las métricas de rendimiento.

Valores de intervalo de fechas 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 únicamente si:

  • Se aplican condiciones u órdenes que hacen referencia a campos de métricas de rendimiento.
  • Desea obtener datos de rendimiento para los objetos que está seleccionando. Por ejemplo, si tiene previsto getStats() llamar al método.

Si especifica varios intervalos de fechas, solo se usará el último intervalo de fechas.

Argumentos

Nombre Tipo Description
Intervalo de fechas Cadena La cadena de intervalo de fechas predefinida que especifica los datos de rendimiento que se incluirán en el selector. La cadena de intervalo de fechas predefinida distingue mayúsculas de minúsculas.

Valores devueltos

Tipo Description
Selector de campaña Selector con intervalo de fechas aplicado.

obtener

Obtiene un iterador que se usa para iterar a través de la lista de campañas.

Valores devueltos

Tipo Description
CampaignIterator Iterador usado para iterar a través de las campañas seleccionadas.

orderBy(string orderBy)

Aplica el orden especificado a las campañas 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 ordenarán los resultados. Establezca 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 campañas en orden ascendente por AverageCpc.

selector = selector.orderBy("AverageCpc");

Los selectores admiten entidades de orden por un solo campo. No puede ordenar la lista de entidades por el campo x, y dentro de x por el campo y, etc. Si especifica más de una orderBy() llamada en una cadena o en selectores independientes, los scripts ordenan la lista de entidades mediante el campo especificado en la última orderBy() llamada. 

Argumentos

Nombre Tipo Description
orderBy string La orden de aplicar.

Valores devueltos

Tipo Description
Selector de campaña Selector con orden aplicado.

withCondition(condición de cadena)

Aplica el filtro a la lista de campañas de campañas.

Especifique el parámetro de condición en el formulario "valor del operador columnName" donde:

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 de 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 de columnas que contienen una matriz de cadenas:

CONTAINS_ALL
CONTAINS_ANY
CONTAINS_NONE

Columnas admitidas para el filtrado de campañas. Los nombres de columna distinguen mayúsculas de minúsculas.

Las siguientes son las columnas de métricas de rendimiento que puede especificar.

Column Tipo Ejemplo
AbsoluteTopImpressionRate double withCondition("AbsoluteTopImpressionRate > 0.25")
AverageCpc double withCondition("AverageCpc < 2.75")
PromedioCpm double withCondition("AverageCpm > 0.65")
ClickConversionRate double withCondition("ClickConversionRate > 0.25")
Clics largo withCondition("Clicks >= 33")
ConversionedClicks largo withCondition("ConvertedClicks >= 10")
Costo double withCondition("Cost > 3.25")

El coste está en la moneda de la cuenta.
CTR double withCondition("Ctr > 0.05")

El CTR está en el rango 0..1, así que use 0.05 para un CTR del 5%.
Impresiones largo withCondition("Impressions > 10")
TopImpressionRate double withCondition("TopImpressionRate > 0.25")

Las siguientes son las propiedades de entidad que puede especificar.

Column Tipo Ejemplo
Estado enumeración El estado de la campaña. Los valores que pueden distinguir mayúsculas de minúsculas son:
  • HABILITADO
  • EN PAUSA
  • SE QUITÓ
  • BUDGET_PAUSED
  • BUDGET_AND_USER_PAUSED
En este ejemplo solo se devuelve habilitado habilitado.

withCondition("Status = ENABLED")
Nombre string El nombre de la campaña.

withCondition("Name CONTAINS_IGNORE_CASE 'clearance'")
Presupuesto double El presupuesto de la campaña.

withCondition("Budget > 500.0")
Tipo de presupuesto enumeración El tipo de presupuesto de la campaña. Los valores que pueden distinguir mayúsculas de minúsculas son:
  • ESTÁNDAR
  • ACELERACIÓN
withCondition("BudgetType = 'STANDARD'")
DeliveryStatus enumeración El estado de publicación de la campaña. Los valores que pueden distinguir mayúsculas de minúsculas son:
  • APTO
  • LIMITED_BY_BUDGET
  • EN ESPERA
  • CAMPAIGN_OUT_OF_BUDGET
  • CAMPAIGN_SUSPENDED
  • CAMPAIGN_PAUSED
withCondition("DeliveryStatus NOT_IN ['LIMITED_BY_BUDGET', 'HOLD', 'CAMPAIGN_OUT_OF_BUDGET']")
LabelNames juego de cadenas Una lista de uno o varios nombres de etiqueta que distinguen mayúsculas de minúsculas. Se usa para obtener campañas asociadas a las etiquetas con nombre.

withCondition("LabelNames CONTAINS_ANY ['bar', 'foo']")
Tipo enumeración El tipo de campaña. Los valores que pueden distinguir mayúsculas de minúsculas son:
  • SEARCH_AND_CONTENT
  • COMPRAS
  • DYNAMIC_SEARCH_ADS
En este ejemplo se devuelven solo las campañas cuyo tipo es Compras.

withCondition("CampaignType = SHOPPING")

Argumentos

Nombre Tipo Description
condición string La condición que se aplicará al selector.

Valores devueltos

Tipo Description
Selector de campaña Selector con la condición aplicada.

withIds(string[] ids)

Obtiene las campañas con los identificadores especificados.

Puede aplicar una o más 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 verdadera Y la condición B es verdadera. Por ejemplo, la siguiente llamada selecciona solo la campaña 333333.

AdsApp.campaigns()
    .withIds(['11111', '22222', '33333'])
    .withIds(['33333', '44444', '55555']);

Argumentos

Nombre Tipo Descripción
ids string[] Una matriz de identificadores de campaña. Para conocer los límites, consulte Límites de ejecución de scripts.

Valores devueltos

Tipo Description
Selector de campaña con los identificadores aplicados.

withLimit(int limit)

Obtiene las n campañas principales que coinciden con los criterios de selección.

Argumentos

Nombre Tipo Description
límite Entero El número de campañas que se van a devolver. El número real puede ser menor.

Valores devueltos

Tipo Description
Selector de campaña Selector con límite aplicado.

Vea también

  • Last updated on