TargetedLocationSelector
Contém os métodos para filtrar e ordenar uma lista de localizações direcionadas. Para obter informações sobre seletores, consulte Seletores.
Utilização de exemplo:
var shoppingCampaign = AdsApp.shoppingCampaigns().withIds(["123456789"]).get().next();
var iterator = shoppingCampaign.targeting().targetedLocations()
.withLimit(10)
.withIds("123456789")
.get();
while (iterator.hasNext()) {
var targetedLocation = iterator.next();
}
Métodos
Nome do Método | Tipo de Devolução | Descrição |
---|---|---|
forDateRange(Data do objetoA partir de, Data do objetoTo) | TargetedLocationSelector | Aplica as datas de início e de fim para selecionar métricas de desempenho. |
forDateRange(string dateRange) | TargetedLocationSelector | Aplica o intervalo de datas predefinido para selecionar métricas de desempenho. |
obter | TargetedLocationIterator | Obtém um iterador utilizado para iterar através da lista de localizações de destino. |
orderBy(string orderBy) | TargetedLocationSelector | Aplica a ordenação especificada às localizações de destino selecionadas. |
withCondition(condição de cadeia) | TargetedLocationSelector | Aplica critérios de filtro às localizações de destino. |
withIds(string[] ids) | TargetedLocationSelector | Obtém localizações direcionadas com os IDs especificados. |
withLimit(int limit) | TargetedLocationSelector | Obtém as n localizações principais direcionadas 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. |
dateTo | Objeto | A data de fim do intervalo de datas que especifica os dados de desempenho a incluir no seletor. |
Devoluções
Tipo | Descrição |
---|---|
TargetedLocationSelector | Seletor com intervalo de datas aplicado. |
forDateRange(String dateRange)
Aplica o intervalo de datas predefinido para selecionar métricas de desempenho.
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
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.
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. |
Devoluções
Tipo | Descrição |
---|---|
TargetedLocationSelector | Seletor com intervalo de datas aplicado. |
obter
Obtém um iterador utilizado para iterar através da lista de localizações de destino.
Devoluções
Tipo | Descrição |
---|---|
TargetedLocationIterator | Um iterador utilizado para iterar através das localizações de destino selecionadas. |
orderBy(string orderBy)
Aplica a ordenação especificada às localizações de destino 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 resultados 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 |
---|---|
TargetedLocationSelector | Seletor com ordenação aplicada. |
withCondition(Condição de cadeia)
Aplica critérios de filtro às localizações de destino.
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 para filtragem de localização direcionada. Os nomes das colunas 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: | Filtro de IU da Web do Microsoft Advertising |
---|---|---|---|
AbsoluteTopImpressionRate | duplo | withCondition("AbsoluteTopImpressionRate > 0.25") |
Abs. Top Impr. Taxa |
AverageCpc | duplo | withCondition("AverageCpc < 2.75") |
Avg. CPC |
AverageCpm | duplo | withCondition("AverageCpm > 0.65") |
CPM Médio |
ClickConversionRate | duplo | withCondition("ClickConversionRate > 0.25") |
Taxa conv. |
Cliques | long | withCondition("Clicks >= 33") |
Cliques |
ConvertClicks | long | withCondition("ConvertedClicks >= 10") |
Conv. |
Custo | duplo | withCondition("Cost > 3.25") O custo está na moeda da conta. |
Gastar |
Ctr | duplo | withCondition("Ctr > 0.05") O CTR está no intervalo 0..1, por isso, utilize 0,05 para um CTR de 5%. |
CTR |
Impressões | long | withCondition("Impressions > 10") |
Impr. |
TopImpressionRate | duplo | withCondition("TopImpressionRate > 0.25") |
Impr superior. Taxa |
Argumentos
Name | Tipo | Descrição |
---|---|---|
condição | cadeia | A condição a adicionar ao seletor. |
Devoluções
Tipo | Descrição |
---|---|
TargetedLocationSelector | Seletor com a condição aplicada. |
withIds(string[] ids)
Obtém localizações direcionadas 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 localização de destino 72.
var shoppingCampaign = AdsApp.shoppingCampaigns().withIds(["123456789"]).get().next();
var iterator = shoppingCampaign.targeting().targetedLocations()
.withIds(["32", "72"])
.withIds(["72", "190"]);
Argumentos
Name | Tipo | Descrição |
---|---|---|
IDs | cadeia[] | Uma matriz de IDs de localização de destino. Para obter limites, veja Limites de execução de scripts. |
Devoluções
Tipo | Descrição |
---|---|
TargetedLocationSelector | Seletor com os IDs aplicados. |
withLimit(int limit)
Obtém as n localizações principais direcionadas que correspondem aos critérios de seleção.
Argumentos
Name | Tipo | Descrição |
---|---|---|
limite | int | O número de localizações direcionadas a devolver. O número real pode ser menor. |
Devoluções
Tipo | Descrição |
---|---|
TargetedLocationSelector | Seletor com limite aplicado. |