Compartir a través de

CampaignSelector

  • Artículo

Contiene los métodos para filtrar y ordenar una lista de campañas. Para obtener información sobre los selectores, vea 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 Descripción
forDateRange(Object dateFrom, Object dateTo) CampaignSelector Aplica las fechas de inicio y finalización para seleccionar métricas de rendimiento.
forDateRange(string dateRange) CampaignSelector Aplica el intervalo de fechas predefinido para seleccionar métricas de rendimiento.
get CampaignIterator Obtiene un iterador usado para recorrer en iteración la lista de campañas.
orderBy(string orderBy) CampaignSelector Aplica el orden especificado a las campañas seleccionadas.
withCondition(string condition) CampaignSelector Aplica el filtro a la lista de campañas.
withIds(string[] ids) CampaignSelector Obtiene campañas con los identificadores especificados.
withLimit(int limit) CampaignSelector 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 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
CampaignSelector 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
CampaignSelector Selector con intervalo de fechas aplicado.

Obtener

Obtiene un iterador usado para recorrer en iteración la lista de campañas.

Valores devueltos

Tipo Descripción
CampaignIterator Iterador usado para recorrer en iteración 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 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 campañas en orden ascendente por AverageCpc.

selector = selector.orderBy("AverageCpc");

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
CampaignSelector Selector con orden aplicado.

withCondition(string condition)

Aplica el filtro a la lista de campañas.

Especifique el parámetro de condición en el formulario "columnName operator value" 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 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 campañas. 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
AbsoluteTopImpressionRate double withCondition("AbsoluteTopImpressionRate > 0.25")
AverageCpc double withCondition("AverageCpc < 2.75")
AverageCpm double withCondition("AverageCpm > 0.65")
ClickConversionRate double withCondition("ClickConversionRate > 0.25")
Clics largo withCondition("Clicks >= 33")
ConvertedClicks largo withCondition("ConvertedClicks >= 10")
Costo double withCondition("Cost > 3.25")

El costo está en la moneda de la cuenta.
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 %.
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 Estado de la campaña. Los posibles valores que distinguen mayúsculas de minúsculas son:
  • HABILITADO
  • PAUSA
  • QUITADO
  • BUDGET_PAUSED
  • BUDGET_AND_USER_PAUSED
En este ejemplo solo se devuelve 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")
BudgetType Enumeración Tipo de presupuesto de la campaña. Los posibles valores que distinguen mayúsculas de minúsculas son:
  • ESTÁNDAR
  • ACELERADO
withCondition("BudgetType = 'STANDARD'")
DeliveryStatus Enumeración Estado de entrega de la campaña. Los posibles valores que distinguen mayúsculas de minúsculas son:
  • ELEGIBLE
  • LIMITED_BY_BUDGET
  • MANTENER
  • CAMPAIGN_OUT_OF_BUDGET
  • CAMPAIGN_SUSPENDED
  • CAMPAIGN_PAUSED
withCondition("DeliveryStatus NOT_IN ['LIMITED_BY_BUDGET', 'HOLD', 'CAMPAIGN_OUT_OF_BUDGET']")
LabelNames conjunto de cadenas Lista de uno o varios nombres de etiqueta que distinguen mayúsculas de minúsculas. Use para obtener campañas asociadas a las etiquetas con nombre.

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

withCondition("CampaignType = SHOPPING")

Argumentos

Nombre Tipo Descripción
Condición string Condición que se va a aplicar al selector.

Valores devueltos

Tipo Descripción
CampaignSelector Selector con la condición aplicada.

withIds(string[] ids)

Obtiene campañas 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 siguiente llamada selecciona solo la campaña 33333.

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

Argumentos

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

Valores devueltos

Tipo Descripción
CampaignSelector Selector con los identificadores aplicados.

withLimit(int limit)

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

Argumentos

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

Valores devueltos

Tipo Descripción
CampaignSelector Selector con límite aplicado.

Consulte también