KeywordSelector

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

Exemplo de utilização:

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

Metodologia

Nome do método Tipo de Devolução Descrição
forDateRange(Object dateFrom, Object dateTo) KeywordSelector Aplica as datas de início e 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 usado 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 string) KeywordSelector Aplica critérios de filtro às palavras-chave.
withIds(string[] ids) KeywordSelector Obtém palavras-chave com as IDs especificadas.
withLimit(int limit) KeywordSelector Obtém as n principais palavras-chave que correspondem aos critérios de seleção.

forDateRange(Object dateFrom, Object dateTo)

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

Especifique um intervalo de datas apenas se:

  • Você aplica condições ou ordenações que fazem referência a campos de métricas de desempenho.
  • Pretende obter dados de desempenho para os objetos que está a selecionar. Por exemplo, se você planeja chamar o getStats() método.

Você pode especificar os parâmetros de data usando cadeias de caracteres ou objetos. Para utilizar cadeias de caracteres, especifique a data no formato AAAAMMDD. 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 tem uma base, onde 1 é janeiro e 12 é dezembro.

O intervalo de datas é inclusive. Se especificar vários intervalos de data, apenas será utilizado o último intervalo de datas.

Argumentos

Name Tipo Descrição
dateFrom Objecto A data de início do intervalo de datas que especifica os dados de desempenho a incluir no seletor.
dateTo Objecto A data de fim do intervalo de datas que especifica os dados de desempenho a serem incluídos 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 dos intervalos 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:

  • Você aplica condições ou ordenações que fazem referência a campos de métricas de desempenho.
  • Pretende obter dados de desempenho para os objetos que está a selecionar. Por exemplo, se você planeja chamar o getStats() método.

Se especificar vários intervalos de data, apenas será utilizado o último intervalo de datas.

Argumentos

Name Tipo Descrição
IntervaloDeData 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 usado 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" 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 resultados por ordem ascendente por CpcMédia.

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

withCondition(condição String)

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

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 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. Avaliar
MédiaCpc duplo withCondition("AverageCpc < 2.75") CPC médio
MédiaCpm duplo withCondition("AverageCpm > 0.65") CPM médio
ClickConversionRate duplo withCondition("ClickConversionRate > 0.25") Taxa Conv.
Cliques longo withCondition("Clicks >= 33") Cliques
ConvertedClicks longo withCondition("ConvertedClicks >= 10") Conv.
Custo duplo withCondition("Cost > 3.25")

O custo está na moeda da conta.		 Gastos
Ctr duplo withCondition("Ctr > 0.05")

A CTR está no intervalo 0..1, então use 0,05 para uma CTR de 5%.		 CTR
Impressões longo withCondition("Impressions > 10") Impr.
TopImpressionRate duplo withCondition("TopImpressionRate > 0.25") Top Impr. Avaliar

A seguir estão as propriedades da entidade que você 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
EstadoAprovaçãoCombinada cadeia 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 esses valores, consulte Valores de status 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 de correspondência 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:
  • AMPLO
  • EXATO
  • FRASE
withCondition("KeywordMatchType = EXACT")		 Tipo de correspondência
MaxCpc duplo É o valor máximo da licitação CPC da palavra-chave. O CPC está na moeda da conta.

withCondition("MaxCpc > 0.40")		 Licitar
DestinationUrl cadeia withCondition("DestinationUrl STARTS_WITH 'http://www.contoso.com'") URL de Destino
Urls finais cadeia withCondition("FinalUrls CONTAINS 'http://www.contoso.com'")
Índice de Qualidade int withCondition("QualityScore > 5") Qual. pontuação
FirstPageCpc duplo O valor médio cobrado de um anunciante cada vez que seu anúncio é clicado quando ele aparece na barra lateral. Por exemplo, se um anunciante pagou um total de $ 48,35 por 300 cliques, o CPC médio do anunciante é de $ 0,16. Use essas informações para ajudar a decidir se deseja aumentar o lance por palavra-chave para melhorar a chance de seu anúncio aparecer na barra lateral. O CPC está na moeda da conta.

withCondition("FirstPageCpc > 6.00")		 Est. Lance na primeira página
TopOfPageCpc duplo O valor médio cobrado de um anunciante cada vez que seu anúncio é clicado quando ele aparece acima dos resultados de pesquisa orgânica. Por exemplo, se um anunciante pagou um total de $ 48,35 por 300 cliques, o CPC médio do anunciante é de $ 0,16. Use essas informações para ajudar a decidir se deseja aumentar o lance por palavra-chave para melhorar a chance de seu anúncio aparecer acima dos resultados de pesquisa orgânica. O CPC está na moeda da conta corrente.

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 status 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'")
Estado da Campanha 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")
LabelNames 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 com nome.

withCondition("LabelNames CONTAINS_ANY ['bar', 'foo']")
ID Longo O ID da palavra-chave a testar. Por exemplo, pode utilizar esta coluna para procurar 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 as IDs especificadas.

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 palavra-chave. Para limites, consulte 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

  • Last updated on