CampaignAudienceSelector

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

Ejemplo de uso:

    // Gets the iterator that iterates all campaigns
    // in the account.
    var shoppingCampaign = AdsApp.shoppingCampaigns().withIds(["123456789"]).get();

    // Loops through all campaigns in the account.
    while (iterator.hasNext()) {
        var campaign = iterator.next();

        // Gets the iterator that iterates all campaign audiences
        // in the campaign audience.
        var audienceIterator = campaign.targeting().audiences()
            .withLimit(10)
            .withIds("123456789")
            .get();
    
        // Loops through all campaign audiences in the campaign audience.
        while (audienceIterator.hasNext()) {
            var audience = audienceIterator.next();
        }
    }

Métodos

Nombre del método Tipo de valor devuelto Description
forDateRange(Object dateFrom, Object dateTo) CampaignAudienceSelector Aplica las fechas de inicio y finalización para seleccionar métricas de rendimiento.
forDateRange(string dateRange) CampaignAudienceSelector Aplica el intervalo de fechas predefinido para seleccionar las métricas de rendimiento.
get CampaignAudienceIterator Obtiene un iterador que se usa para iterar a través de la lista de públicos de campaña.
orderBy(string orderBy) CampaignAudienceSelector Aplica el orden especificado a los públicos de la campaña seleccionados.
withCondition(condición de cadena) CampaignAudienceSelector Aplica criterios de filtro a los públicos de la campaña.
withIds(string[] ids) CampaignAudienceSelector Obtiene los públicos de campaña con los identificadores especificados.
withLimit(int limit) CampaignAudienceSelector Obtiene los n públicos principales de la campaña 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. Especifique la fecha mediante una cadena con el formato AAAAMMDD o un objeto con el formato {year: 2020, month: 12, day: 31}.
dateTo Objeto Fecha de finalización del intervalo de fechas que especifica los datos de rendimiento que se incluirán en el selector. Especifique la fecha mediante una cadena en el formato, AAAAMMDD, o un objeto en el formato, {year: 2020, month: 12, day: 1}.

Valores devueltos

Tipo Description
CampaignAudienceSelector Selector con intervalo de fechas aplicado.

forDateRange(String dateRange)

Aplica el intervalo de fechas predefinido para seleccionar las 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.

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

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

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. Los valores que pueden distinguir mayúsculas de minúsculas son: 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.

Valores devueltos

Tipo Description
CampaignAudienceSelector Selector con intervalo de fechas aplicado.

obtener

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

Valores devueltos

Tipo Description
CampaignAudienceIterator Un iterador usado para iterar a través de los públicos de campaña seleccionados.

orderBy(String orderBy)

Aplica el orden especificado a los públicos de la campaña seleccionados.

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 las audiencias de la campaña 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
CampaignAudienceSelector Selector con orden aplicado.

withCondition(condición de cadena)

Aplica criterios de filtro a los públicos de la campaña.

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

Columnas admitidas para el filtrado de audiencia de la campaña. Los nombres 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
AudienceId largo Id. de la audiencia asociada.

withCondition("AudienceId = 123456789")
Nombre de campaña string El nombre de la campaña de la asociación.

withCondition("CampaignName CONTAINS_IGNORE_CASE 'truck'")
CampaignStatus enumeración El estado de la campaña de la asociación. Los valores que pueden distinguir mayúsculas de minúsculas son:
  • HABILITADO
  • EN PAUSA
  • SE QUITÓ
En este ejemplo solo se devuelven los públicos de campaña cuya campaña principal está en pausa.

withCondition("CampaignStatus = PAUSED")
Estado enumeración El estado de la asociación. Los valores que pueden distinguir mayúsculas de minúsculas son:
  • HABILITADO
  • EN PAUSA
  • SE QUITÓ
En este ejemplo se devuelven solo las audiencias de campaña habilitadas.

withCondition("Status = ENABLED")
Nombre de lista de usuarios string El nombre de la audiencia asociada.

withCondition("UserListName = 'foo'")

Argumentos

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

Valores devueltos

Tipo Description
CampaignAudienceSelector Selector con la condición aplicada.

withIds(string[] ids)

Obtiene los públicos de campaña 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 audiencia de la campaña 33333.

var selector = AdsApp.adGroups()
    .withIds(['11111', '22222', '33333'])
    .withIds(['33333', '44444', '55555']);

Argumentos

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

Valores devueltos

Tipo Description
CampaignAudienceSelector con los identificadores aplicados.

withLimit(int limit)

Obtiene los n públicos principales de la campaña que coinciden con los criterios de selección.

Argumentos

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

Valores devueltos

Tipo Description
CampaignAudienceSelector Selector con límite aplicado.
  • Last updated on