Compartir a través de

CampaignExcludedAudienceSelector

  • Artículo

Contiene los métodos para filtrar y ordenar una lista de audiencias excluidas 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 excluded audiences
        // in the campaign excluded audience.
        var audienceIterator = campaign.targeting().excludedAudiences()
            .withLimit(10)
            .withIds("123456789")
            .get();
    
        // Loops through all campaign excluded audiences in the campaign excluded audience.
        while (audienceIterator.hasNext()) {
            var audience = audienceIterator.next();
        }
    }

Métodos

Nombre del método Tipo de valor devuelto Descripción
get CampaignExcludedAudienceIterator Obtiene un iterador usado para recorrer en iteración la lista de audiencias excluidas de campaña.
orderBy(string orderBy) CampaignExcludedAudienceSelector Aplica el orden especificado a las audiencias excluidas de la campaña seleccionada.
withCondition(string condition) CampaignExcludedAudienceSelector Aplica criterios de filtro a las audiencias excluidas de la campaña.
withIds(string[] ids) CampaignExcludedAudienceSelector Obtiene audiencias excluidas de campaña con los identificadores especificados.
withLimit(int limit) CampaignExcludedAudienceSelector Obtiene las principales n audiencias excluidas de campaña que coinciden con los criterios de selección.

Obtener

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

Valores devueltos

Tipo Descripción
CampaignExcludedAudienceIterator Iterador usado para recorrer en iteración las audiencias excluidas de la campaña seleccionada.

orderBy(String orderBy)

Aplica el orden especificado a las audiencias excluidas de la campaña seleccionada.

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

withCondition(String condition)

Aplica criterios de filtro a las audiencias excluidas 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 excluido de campaña. Los nombres distinguen mayúsculas de minúsculas.

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 excluidas de campaña cuya campaña principal 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 excluidas 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
CampaignExcludedAudienceSelector Selector con la condición aplicada.

withIds(string[] ids)

Obtiene audiencias excluidas 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 excluido 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 excluidos de campaña. Para conocer los límites, consulte Límites de ejecución de scripts.

Valores devueltos

Tipo Descripción
CampaignExcludedAudienceSelector Selector con los identificadores aplicados.

withLimit(int limit)

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

Argumentos

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

Valores devueltos

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