Partilhar via

CampaignExcludedAudienceSelector

  • Artigo

Contém os métodos para filtrar e ordenar uma lista de audiências excluídas da campanha. Para obter informações sobre seletores, consulte Seletores.

Utilização de exemplo:

    // 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

Nome do Método Tipo de Devolução Descrição
obter CampaignExcludedAudienceIterator Obtém um iterador utilizado para iterar através da lista de audiências excluídas da campanha.
orderBy(string orderBy) CampaignExcludedAudienceSelector Aplica a ordenação especificada às audiências excluídas da campanha selecionada.
withCondition(condição de cadeia) CampaignExcludedAudienceSelector Aplica critérios de filtro às audiências excluídas da campanha.
withIds(string[] ids) CampaignExcludedAudienceSelector Obtém audiências excluídas da campanha com os IDs especificados.
withLimit(int limit) CampaignExcludedAudienceSelector Obtém as principais n audiências excluídas da campanha que correspondem aos critérios de seleção.

obter

Obtém um iterador utilizado para iterar através da lista de audiências excluídas da campanha.

Devoluções

Tipo Descrição
CampaignExcludedAudienceIterator Um iterador utilizado para iterar através da campanha selecionada excluiu audiências.

orderBy(String orderBy)

Aplica a ordenação especificada às audiências excluídas da campanha selecionada.

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

  • columnName é uma das colunas suportadas.
  • orderDirection é a ordem para ordenar os resultados. Defina como ASC para ordenar os resultados por ordem ascendente ou DESC para ordenar os resultados por ordem descendente. A predefinição é ASC.

Por exemplo, a chamada seguinte devolve audiências excluídas da campanha por ordem ascendente por AverageCpc.

selector = selector.orderBy("AverageCpc");

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

Argumentos

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

Devoluções

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

withCondition(Condição de cadeia)

Aplica critérios de filtro às audiências excluídas da campanha.

Especifique o parâmetro condition no formulário "columnName operator value" em que:

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:

CONTAINS_ALL
CONTAINS_ANY
CONTAINS_NONE

Colunas Suportadas

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

Seguem-se as propriedades da entidade que pode especificar.

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

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

withCondition("CampaignName CONTAINS_IGNORE_CASE 'truck'")
CampaignStatus 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 audiências excluídas da campanha cuja campanha principal está em pausa.

withCondition("CampaignStatus = PAUSED")
Estado enumeração O estado 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 audiências excluídas da campanha ativada.

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

withCondition("UserListName = 'foo'")

Argumentos

Name Tipo Descrição
condição cadeia A condição a aplicar ao seletor.

Devoluções

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

withIds(string[] ids)

Obtém audiências excluídas 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 a audiência 33333 excluída da campanha.

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

Argumentos

Name Tipo Descrição
IDs cadeia[] Uma matriz de IDs de audiência excluídos da campanha. Para obter limites, veja Limites de execução de scripts.

Devoluções

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

withLimit(int limit)

Obtém as principais n audiências excluídas da campanha 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 regressar. O número real pode ser menor.

Devoluções

Tipo Descrição
CampaignExcludedAudienceSelector Seletor com limite aplicado.