CampaignExcludedAudienceSelector

Contém os métodos para filtrar e classificar uma lista de públicos excluídos da campanha. Para obter informações sobre seletores, consulte Seletores.

Exemplo de utilização:

    // 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();
        }
    }

Metodologia

Nome do método Tipo de Devolução Descrição
Obter CampaignExcludedAudienceIterator Obtém um iterador usado para iterar através da lista de públicos excluídos da campanha.
orderBy(string orderBy) CampaignExcludedAudienceSelector Aplica a ordenação especificada aos públicos excluídos da campanha selecionada.
withCondition(condição string) CampaignExcludedAudienceSelector Aplica critérios de filtro aos públicos excluídos da campanha.
withIds(string[] ids) CampaignExcludedAudienceSelector Obtém públicos-alvo excluídos da campanha com os IDs especificados.
withLimit(int limit) CampaignExcludedAudienceSelector Obtém os públicos excluídos das X primeiras campanhas que correspondem aos critérios de seleção.

Obter

Obtém um iterador usado para iterar através da lista de públicos excluídos da campanha.

Devoluções

Tipo Descrição
CampaignExcludedAudienceIterator Um iterador utilizado para iterar através dos públicos excluídos da campanha selecionada.

orderBy(String orderBy)

Aplica a ordenação especificada aos públicos excluídos da campanha selecionada.

Especifique o parâmetro orderBy no formulário "columnName orderDirection" onde:

  • columnName é uma das colunas suportadas.
  • orderDirection é a ordem pela qual ordenar os resultados. Defina ASC para ordenar os resultados por ordem ascendente ou DESC para ordenar os resultados por ordem descendente. O padrão é ASC.

Por exemplo, a chamada seguinte devolve campanhas que excluíram audiências por ordem ascendente por AverageCpc.

selector = selector.orderBy("AverageCpc");

Os seletores suportam entidades de ordenação apenas por um campo. Não pode ordenar a lista de entidades pelo campo x, e dentro de x pelo campo y, e assim sucessivamente. Se você especificar mais de uma orderBy() chamada em cadeia ou em chamadas separadas do seletor, os scripts ordenam a lista de entidades usando o campo especificado na última orderBy() chamada. 

Argumentos

Name Tipo Descrição
orderBy cadeia A ordem a aplicar.

Devoluções

Tipo Descrição
CampaignExcludedAudienceSelector Seletor com ordenação aplicada.

withCondition(condição String)

Aplica critérios de filtro aos públicos excluídos da campanha.

Especifique o parâmetro de condição no formulário, "columnName operator value" onde:

Operadores

O operador que utilizar depende do tipo da coluna. Os operadores são sensíveis às maiúsculas e minúsculas. Por exemplo, utilize STARTS_WITH em vez de starts_with.

Operadores para colunas que contêm números inteiros e valores longos:

<
<=
>
>=
=
!=

Operadores para colunas que contêm valores duplos:

<
>

Operadores para colunas que contêm valores de cadeia:

=
!=
STARTS_WITH
STARTS_WITH_IGNORE_CASE
CONTAINS
CONTAINS_IGNORE_CASE
DOES_NOT_CONTAIN
DOES_NOT_CONTAIN_IGNORE_CASE

Operadores para colunas que contêm valores de enumeração:

=
!=
IN []
NOT_IN []

Operadores para colunas que contêm uma matriz de cadeias de caracteres:

CONTAINS_ALL
CONTAINS_ANY
CONTAINS_NONE

Colunas Suportadas

As colunas suportadas para a filtragem de audiências excluídas da campanha. Os nomes são sensíveis às maiúsculas e minúsculas.

A seguir estão as propriedades da entidade que você pode especificar.

Coluna Tipo Exemplos:
AudienceId longo ID da audiência associada.

withCondition("AudienceId = 123456789")
CampaignName cadeia O nome da campanha da associação.

withCondition("CampaignName CONTAINS_IGNORE_CASE 'truck'")
Estado da Campanha Enumeração O estado da campanha da associação. Os possíveis valores sensíveis às maiúsculas e minúsculas são:
  • ATIVADO
  • EM PAUSA
  • REMOVIDO
Este exemplo devolve apenas públicos-alvo excluídos da campanha cuja campanha principal está em pausa.

withCondition("CampaignStatus = PAUSED")
Estado Enumeração O estatuto da associação. Os possíveis valores sensíveis às maiúsculas e minúsculas são:
  • ATIVADO
  • EM PAUSA
  • REMOVIDO
Este exemplo devolve apenas públicos-alvo excluídos da campanha ativada.

withCondition("Status = ENABLED")
NomeDaLista de Utilizadores cadeia O nome da audiência associada.

withCondition("UserListName = 'foo'")

Argumentos

Name Tipo Descrição
Condição cadeia A condição a ser aplicada ao seletor.

Devoluções

Tipo Descrição
CampaignExcludedAudienceSelector Seletor com a condição aplicada.

withIds(string[] ids)

Obtém públicos-alvo excluídos da campanha com os IDs especificados.

Pode aplicar uma ou mais condições a um seletor. Uma cadeia de condições é considerada uma operação E. Por exemplo, a entidade só é selecionada se a condição A for verdadeira E a condição B for verdadeira. Por exemplo, a chamada seguinte seleciona apenas o público excluído da campanha 33333.

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

Argumentos

Name Tipo Descrição
IDs cadeia[] Uma série de IDs de audiência excluídos da campanha. Para limites, consulte Limites de execução de scripts.

Devoluções

Tipo Descrição
CampaignExcludedAudienceSelector Seletor com os IDs aplicados.

withLimit(int limit)

Obtém os públicos excluídos das X primeiras campanhas que correspondem aos critérios de seleção.

Argumentos

Name Tipo Descrição
limite int O número de audiências excluídas da campanha a devolver. O número real pode ser menor.

Devoluções

Tipo Descrição
CampaignExcludedAudienceSelector Seletor com limite aplicado.