CampaignAudienceSelector

Artigo
11/13/2024

Contém os métodos para filtrar e ordenar uma lista de audiências de 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 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

Nome do Método	Tipo de Devolução	Descrição
forDateRange(Data do objetoA partir de, Data do objetoTo)	CampaignAudienceSelector	Aplica as datas de início e de fim para selecionar métricas de desempenho.
forDateRange(string dateRange)	CampaignAudienceSelector	Aplica o intervalo de datas predefinido para selecionar métricas de desempenho.
obter	CampaignAudienceIterator	Obtém um iterador utilizado para iterar através da lista de audiências de campanha.
orderBy(string orderBy)	CampaignAudienceSelector	Aplica a ordenação especificada às audiências de campanha selecionadas.
withCondition(condição de cadeia)	CampaignAudienceSelector	Aplica critérios de filtro às audiências da campanha.
withIds(string[] ids)	CampaignAudienceSelector	Obtém audiências de campanha com os IDs especificados.
withLimit(int limit)	CampaignAudienceSelector	Obtém as principais audiências de campanha n que correspondem aos critérios de seleção.

forDateRange(Data do objetoA partir de, Data do objetoTo)

Aplica as datas de início e de fim para selecionar métricas de desempenho.

Especifique um intervalo de datas apenas se:

Aplica condições ou ordenação que referenciam campos de métricas de desempenho.
Quer obter dados de desempenho para os objetos que está a selecionar. Por exemplo, se planear chamar o getStats() método .

Pode especificar os parâmetros de data com cadeias ou objetos. Para utilizar cadeias, especifique a data no formulário YYYYMMDD. Se utilizar objetos, crie um objeto com os seguintes campos:

ano
mês
dia

Por exemplo:

var date = {year: 2018, month: 5, day: 13};

O mês é baseado num, em que 1 é janeiro e 12 é dezembro.

O intervalo de datas é inclusivo. Se especificar vários intervalos de datas, só é utilizado o último intervalo de datas.

Argumentos

Name	Tipo	Descrição
dateFrom	Objeto	A data de início do intervalo de datas que especifica os dados de desempenho a incluir no seletor. Especifique a data com uma cadeia no formulário, AAAAMMDD ou um objeto no formulário{ year: 2020, month: 12, day: 31}.
dateTo	Objeto	A data de fim do intervalo de datas que especifica os dados de desempenho a incluir no seletor. Especifique a data com uma cadeia no formulário, AAAAMMDD ou um objeto no formulário{ year: 2020, month: 12, day: 1}.

Devoluções

Tipo	Descrição
CampaignAudienceSelector	Seletor com intervalo de datas aplicado.

forDateRange(String dateRange)

Aplica o intervalo de datas predefinido para selecionar métricas de desempenho.

Especifique um intervalo de datas apenas se:

Aplica condições ou ordenação que referenciam campos de métricas de desempenho.
Quer obter dados de desempenho para os objetos que está a selecionar. Por exemplo, se planear chamar o getStats() método .

Se especificar vários intervalos de datas, só é utilizado o último intervalo de datas.

Valores de intervalo de datas suportados:

HOJE
ONTEM
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

Name	Tipo	Descrição
dateRange	Cadeia	A cadeia de intervalo de datas predefinida que especifica os dados de desempenho a incluir no seletor. A cadeia de intervalo de datas predefinida é sensível às maiúsculas e minúsculas. Os possíveis valores sensíveis às maiúsculas e minúsculas são: HOJE, ONTEM, 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.

Devoluções

Tipo	Descrição
CampaignAudienceSelector	Seletor com intervalo de datas aplicado.

obter

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

Devoluções

Tipo	Descrição
CampaignAudienceIterator	Um iterador utilizado para iterar através das audiências de campanha selecionadas.

orderBy(String orderBy)

Aplica a ordenação especificada às audiências de campanha selecionadas.

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 de 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
CampaignAudienceSelector	Seletor com ordenação aplicada.

withCondition(Condição de cadeia)

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

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

columnName é uma das Colunas suportadas. Se columName estiver definido como um nome de coluna de métrica de desempenho, tem de especificar um intervalo de datas com forDateRange(String dateRange) ou forDateRange(Object dateFrom, Object dateTo).
O operador é um dos operadores suportados.

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 filtragem de audiências de campanha. Os nomes são sensíveis às maiúsculas e minúsculas.

Seguem-se as colunas de métricas de desempenho que pode especificar.

Coluna	Tipo	Exemplos:
AbsoluteTopImpressionRate	duplo	`withCondition("AbsoluteTopImpressionRate > 0.25")`
AverageCpc	duplo	`withCondition("AverageCpc < 2.75")`
AverageCpm	duplo	`withCondition("AverageCpm > 0.65")`
ClickConversionRate	duplo	`withCondition("ClickConversionRate > 0.25")`
Cliques	long	`withCondition("Clicks >= 33")`
ConvertClicks	long	`withCondition("ConvertedClicks >= 10")`
Custo	duplo	`withCondition("Cost > 3.25")` O custo está na moeda da conta.
Ctr	duplo	`withCondition("Ctr > 0.05")` O CTR está no intervalo 0..1, por isso, utilize 0,05 para um CTR de 5%.
Impressões	long	`withCondition("Impressions > 10")`
TopImpressionRate	duplo	`withCondition("TopImpressionRate > 0.25")`

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 de 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 de campanha ativadas. `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
CampaignAudienceSelector	Seletor com a condição aplicada.

withIds(string[] ids)

Obtém audiências de 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 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 de campanha. Para obter limites, veja Limites de execução de scripts.

Devoluções

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

withLimit(int limit)

Obtém as principais audiências de campanha n que correspondem aos critérios de seleção.

Argumentos

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

Devoluções

Tipo	Descrição
CampaignAudienceSelector	Seletor com limite aplicado.

Partilhar via

CampaignAudienceSelector

Métodos

forDateRange(Data do objetoA partir de, Data do objetoTo)

Argumentos

Devoluções

forDateRange(String dateRange)

Argumentos

Devoluções

obter

Devoluções

orderBy(String orderBy)

Argumentos

Devoluções

withCondition(Condição de cadeia)

Operadores

Colunas Suportadas

Argumentos

Devoluções

withIds(string[] ids)

Argumentos

Devoluções

withLimit(int limit)

Argumentos

Devoluções

Comentários

Recursos adicionais