Compartilhar via

KeywordSelector

  • Artigo

Contém os métodos para filtrar e ordenar uma lista de palavras-chave. Para obter informações sobre seletores, consulte Seletores.

Utilização de exemplo:

    var iterator = AdsApp.keywords()
        .withCondition("AdGroupName = 'AD GROUP NAME GOES HERE'")
        .withCondition("CampaignName = 'CAMPAIGN NAME GOES HERE'")
        .get();

    while (iterator.hasNext()) {
        var keyword = iterator.next();
    }

Métodos

Nome do Método Tipo de Devolução Descrição
forDateRange(Data do objetoA partir de, Data do objetoTo) KeywordSelector Aplica as datas de início e de fim para selecionar métricas de desempenho.
forDateRange(string dateRange) KeywordSelector Aplica o intervalo de datas predefinido para selecionar métricas de desempenho.
obter KeywordIterator Obtém um iterador utilizado para iterar através da lista de palavras-chave.
orderBy(string orderBy) KeywordSelector Aplica a ordenação especificada às palavras-chave selecionadas.
withCondition(condição de cadeia) KeywordSelector Aplica critérios de filtro às palavras-chave.
withIds(string[] ids) KeywordSelector Obtém palavras-chave com os IDs especificados.
withLimit(int limit) KeywordSelector Obtém as n principais palavras-chave 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
KeywordSelector 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
KeywordSelector Seletor com intervalo de datas aplicado.

obter

Obtém um iterador utilizado para iterar através da lista de palavras-chave.

Devoluções

Tipo Descrição
KeywordIterator Um iterador utilizado para iterar através das palavras-chave selecionadas.

orderBy(string orderBy)

Aplica a ordenação especificada às palavras-chave 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
KeywordSelector Seletor com ordenação aplicada.

withCondition(Condição de cadeia)

Aplica critérios de filtro às palavras-chave.

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 para filtragem de palavras-chave. 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

Seguem-se as propriedades da entidade que pode especificar.

Coluna Tipo Exemplos: Filtro de IU da Web do Microsoft Advertising
Estado enumeração O estado da palavra-chave. Os possíveis valores sensíveis às maiúsculas e minúsculas são:
  • ATIVADO
  • EM PAUSA
  • REMOVIDO
withCondition("Status = ENABLED")		 Estado
CombinedApprovalStatus cadeia O estado de aprovação da palavra-chave. Os possíveis valores sensíveis às maiúsculas e minúsculas são:
  • APROVADO
  • APPROVED_LIMITED
  • UNDER_REVIEW
  • REPROVADO
Para obter informações sobre estes valores, veja Valores de estado de aprovação editorial.

Este exemplo devolve palavras-chave que precisam de atenção.

withCondition("CombinedApprovalStatus IN ['APPROVED_LIMITED', 'DISAPPROVED']")
Text cadeia O texto da palavra-chave. Inclua apenas o texto da palavra-chave. Não inclua o tipo de correspondência da palavra-chave no texto. Por exemplo, se a palavra-chave for uma palavra-chave exata como [livros], utilize livros e não [livros].

withCondition("Text STARTS_WITH 'flowers'")		 Texto da Palavra-chave
KeywordMatchType enumeração O tipo de correspondência da palavra-chave. Os possíveis valores sensíveis às maiúsculas e minúsculas são:
  • BROAD
  • EXATO
  • EXPRESSÃO
withCondition("KeywordMatchType = EXACT")		 Tipo de correspondência
MaxCpc duplo O valor máximo da oferta CPC da palavra-chave. O CPC está na moeda da conta.

withCondition("MaxCpc > 0.40")		 Licitação
DestinationUrl cadeia withCondition("DestinationUrl STARTS_WITH 'http://www.contoso.com'") URL de destino
FinalUrls cadeia withCondition("FinalUrls CONTAINS 'http://www.contoso.com'")
QualityScore int withCondition("QualityScore > 5") Qual. pontuação
FirstPageCpc duplo O montante médio cobrado por um anunciante sempre que o respetivo anúncio é clicado quando aparece na barra lateral. Por exemplo, se um anunciante pagou um total de $48,35 por 300 cliques, a média do CPC do anunciante é de $0,16. Utilize estas informações para ajudar a decidir se pretende aumentar a oferta de palavras-chave para melhorar a probabilidade de o seu anúncio aparecer na barra lateral. O CPC está na moeda da conta.

withCondition("FirstPageCpc > 6.00")		 Est. oferta de primeira página
TopOfPageCpc duplo O montante médio cobrado por um anunciante sempre que o seu anúncio é clicado quando aparece acima dos resultados da pesquisa orgânica. Por exemplo, se um anunciante pagou um total de $48,35 por 300 cliques, a média do CPC do anunciante é de $0,16. Utilize estas informações para ajudar a decidir se pretende aumentar a oferta de palavras-chave para melhorar a probabilidade de o seu anúncio aparecer acima dos resultados da pesquisa orgânica. O CPC está na moeda da conta atual.

withCondition("TopOfPageCpc > 8.00")		 Melhor posição
AdGroupName cadeia O nome do grupo de anúncios que contém as palavras-chave.

withCondition("AdGroupName = 'foo'")
AdGroupStatus enumeração O estado do grupo de anúncios. Os possíveis valores sensíveis às maiúsculas e minúsculas são:
  • ATIVADO
  • EM PAUSA
  • REMOVIDO
withCondition("AdGroupStatus = ENABLED")
CampaignName cadeia O nome da campanha que contém as palavras-chave.

withCondition("CampaignName = 'bar'")
CampaignStatus enumeração O estado da campanha. Os possíveis valores sensíveis às maiúsculas e minúsculas são:
  • ATIVADO
  • EM PAUSA
  • REMOVIDO
withCondition("CampaignStatus = ENABLED")
Nomes de Etiqueta conjunto de cadeias Uma lista de um ou mais nomes de etiquetas sensíveis às maiúsculas e minúsculas. Utilize para obter palavras-chave associadas às etiquetas nomeadas.

withCondition("LabelNames CONTAINS_ANY ['bar', 'foo']")
ID Longo O ID da palavra-chave a testar. Por exemplo, pode utilizar esta coluna para verificar se existem palavras-chave com IDs superiores ao ID especificado.

withCondition('Id > 1234')

Argumentos

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

Devoluções

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

withIds(string[] ids)

Obtém palavras-chave 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 palavra-chave 33333.

AdsApp.keywords()
    .withIds(['11111', '22222', '33333'])
    .withIds(['33333', '44444', '55555']);

Argumentos

Name Tipo Descrição
IDs cadeia[] Uma matriz de IDs de palavras-chave. Para obter limites, veja Limites de execução de scripts.

Devoluções

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

withLimit(int limit)

Obtém as n principais palavras-chave que correspondem aos critérios de seleção.

Argumentos

Name Tipo Descrição
limite int O número de palavras-chave a devolver. O número real pode ser menor.

Devoluções

Tipo Descrição
KeywordSelector Seletor com limite aplicado.

Consulte também