Compartir a través de

CampaignAudienceSelector

  • Artículo

Contiene los métodos para filtrar y ordenar una lista de audiencias de campaña. Para obtener información sobre los selectores, vea 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 Descripción
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 métricas de rendimiento.
get CampaignAudienceIterator Obtiene un iterador usado para recorrer en iteración la lista de audiencias de campaña.
orderBy(string orderBy) CampaignAudienceSelector Aplica el orden especificado a las audiencias de campaña seleccionadas.
withCondition(string condition) CampaignAudienceSelector Aplica criterios de filtro a las audiencias de la campaña.
withIds(string[] ids) CampaignAudienceSelector Obtiene audiencias de campaña con los identificadores especificados.
withLimit(int limit) CampaignAudienceSelector Obtiene las principales n audiencias de 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 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. Especifique la fecha mediante una cadena en el formulario, AAAAMMDD o un objeto en el formulario, {año: 2020, mes: 12, día: 31}.
dateTo Objeto Fecha de finalización del intervalo de fechas que especifica los datos de rendimiento que se van a incluir en el selector. Especifique la fecha mediante una cadena en el formulario, AAAAMMDD, o un objeto en el formulario, {año: 2020, mes: 12, día: 1}.

Valores devueltos

Tipo Descripción
CampaignAudienceSelector Selector con intervalo de fechas aplicado.

forDateRange(String dateRange)

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

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

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

Argumentos

Nombre Tipo Descripción
dateRange String 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. Los valores posibles que distinguen mayúsculas de minúsculas son: TODAY, YESTERDAY, 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 Descripción
CampaignAudienceSelector Selector con intervalo de fechas aplicado.

Obtener

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

Valores devueltos

Tipo Descripción
CampaignAudienceIterator Iterador usado para recorrer en iteración las audiencias de campaña seleccionadas.

orderBy(String orderBy)

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

withCondition(String condition)

Aplica criterios de filtro a las audiencias de la campaña.

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

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

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

withCondition("CampaignName CONTAINS_IGNORE_CASE 'truck'")
CampaignStatus Enumeración Estado de la campaña de la asociación. Los posibles valores que distinguen mayúsculas de minúsculas son:
  • HABILITADO
  • PAUSA
  • QUITADO
En este ejemplo solo se devuelven audiencias de campaña cuya campaña primaria está en pausa.

withCondition("CampaignStatus = PAUSED")
Estado Enumeración Estado de la asociación. Los posibles valores que distinguen mayúsculas de minúsculas son:
  • HABILITADO
  • PAUSA
  • QUITADO
En este ejemplo solo se devuelven audiencias de campaña habilitadas.

withCondition("Status = ENABLED")
UserListName string Nombre de la audiencia asociada.

withCondition("UserListName = 'foo'")

Argumentos

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

Valores devueltos

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

withIds(string[] ids)

Obtiene audiencias de campaña 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 el público de 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 Descripción
CampaignAudienceSelector Selector con los identificadores aplicados.

withLimit(int limit)

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

Argumentos

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

Valores devueltos

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