KeywordSelector

Contiene los métodos para filtrar y ordenar una lista de palabras clave. Para obtener información sobre los selectores, consulte Selectores.

Ejemplo de uso:

    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

Nombre del método Tipo de valor devuelto Description
forDateRange(Object dateFrom, Object dateTo) KeywordSelector Aplica las fechas de inicio y finalización para seleccionar métricas de rendimiento.
forDateRange(string dateRange) KeywordSelector Aplica el intervalo de fechas predefinido para seleccionar las métricas de rendimiento.
get KeywordIterator Obtiene un iterador que se usa para iterar a través de la lista de palabras clave.
orderBy(string orderBy) KeywordSelector Aplica el orden especificado a las palabras clave seleccionadas.
withCondition(condición de cadena) KeywordSelector Aplica criterios de filtro a las palabras clave.
withIds(string[] ids) KeywordSelector Obtiene palabras clave con los identificadores especificados.
withLimit(int limit) KeywordSelector Obtiene las n palabras clave principales que coinciden con los criterios de selección.

forDateRange(Object dateFrom, Object dateTo)

Aplica las fechas de inicio y finalización para seleccionar métricas de rendimiento.

Especifique un intervalo de fechas únicamente si:

  • Se aplican condiciones u órdenes que hacen referencia a campos de métricas de rendimiento.
  • Desea obtener datos de rendimiento para los objetos que está seleccionando. Por ejemplo, si tiene previsto getStats() llamar al método.

Puede especificar los parámetros de fecha mediante cadenas u objetos. Para usar cadenas, especifique la fecha con el formato AAAAMMDD. Si utiliza objetos, cree un objeto con los siguientes campos:

  • year
  • month
  • día

Por ejemplo:

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

El mes es de una sola base, donde 1 es enero y 12 es diciembre.

El intervalo de fechas es inclusivo. Si especifica varios intervalos de fechas, solo se usará el último intervalo de fechas.

Argumentos

Nombre Tipo Description
dateFrom Objeto Fecha de inicio del intervalo de fechas que especifica los datos de rendimiento que se incluirán en el selector.
dateTo Objeto Fecha de finalización del intervalo de fechas que especifica los datos de rendimiento que se incluirán en el selector.

Valores devueltos

Tipo Description
KeywordSelector Selector con intervalo de fechas aplicado.

forDateRange(String dateRange)

Aplica el intervalo de fechas predefinido para seleccionar las métricas de rendimiento.

Valores de intervalo de fechas admitidos:

  • HOY
  • AYER
  • 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 un intervalo de fechas únicamente si:

  • Se aplican condiciones u órdenes que hacen referencia a campos de métricas de rendimiento.
  • Desea obtener datos de rendimiento para los objetos que está seleccionando. Por ejemplo, si tiene previsto getStats() llamar al método.

Si especifica varios intervalos de fechas, solo se usará el último intervalo de fechas.

Argumentos

Nombre Tipo Description
Intervalo de fechas Cadena La cadena de intervalo de fechas predefinida que especifica los datos de rendimiento que se incluirán en el selector. La cadena de intervalo de fechas predefinida distingue mayúsculas de minúsculas.

Valores devueltos

Tipo Description
KeywordSelector Selector con intervalo de fechas aplicado.

obtener

Obtiene un iterador que se usa para iterar a través de la lista de palabras clave.

Valores devueltos

Tipo Description
KeywordIterator Iterador usado para iterar a través de las palabras clave seleccionadas.

orderBy(string orderBy)

Aplica el orden especificado a las palabras clave seleccionadas.

Especifique el parámetro orderBy en el formulario "columnName orderDirection" donde:

  • columnName es una de las columnas admitidas.
  • orderDirection es el orden en el que se ordenarán los resultados. Establezca ASC para ordenar los resultados en orden ascendente o DESC para ordenar los resultados en orden descendente. El valor predeterminado es ASC.

Por ejemplo, la siguiente llamada devuelve los resultados en orden ascendente por AverageCpc.

selector = selector.orderBy("AverageCpc");

Los selectores admiten entidades de orden por un solo campo. No puede ordenar la lista de entidades por el campo x, y dentro de x por el campo y, etc. Si especifica más de una orderBy() llamada en una cadena o en selectores independientes, los scripts ordenan la lista de entidades mediante el campo especificado en la última orderBy() llamada. 

Argumentos

Nombre Tipo Description
orderBy string La orden de aplicar.

Valores devueltos

Tipo Description
KeywordSelector Selector con orden aplicado.

withCondition(condición de cadena)

Aplica criterios de filtro a las palabras clave.

Especifique el parámetro de condición en el formulario "valor del operador columnName" donde:

Operadores

El operador que use depende del tipo de columna. Los operadores distinguen mayúsculas de minúsculas. Por ejemplo, use STARTS_WITH en lugar de starts_with.

Operadores para columnas que contienen enteros y valores largos:

<
<=
>
>=
=
!=

Operadores para columnas que contienen valores dobles:

<
>

Operadores de columnas que contienen valores de cadena:

=
!=
STARTS_WITH
STARTS_WITH_IGNORE_CASE
CONTAINS
CONTAINS_IGNORE_CASE
DOES_NOT_CONTAIN
DOES_NOT_CONTAIN_IGNORE_CASE

Operadores para columnas que contienen valores de enumeración:

=
!=
IN []
NOT_IN []

Operadores de columnas que contienen una matriz de cadenas:

CONTAINS_ALL
CONTAINS_ANY
CONTAINS_NONE

Columnas admitidas para el filtrado de palabras clave. Los nombres de columna distinguen mayúsculas de minúsculas.

Las siguientes son las columnas de métricas de rendimiento que puede especificar.

Column Tipo Ejemplo Filtro de interfaz de usuario web de Microsoft Advertising
AbsoluteTopImpressionRate double withCondition("AbsoluteTopImpressionRate > 0.25") Abs. Top Impr. Tasa
AverageCpc double withCondition("AverageCpc < 2.75") CPC medio
PromedioCpm double withCondition("AverageCpm > 0.65") CPM medio
ClickConversionRate double withCondition("ClickConversionRate > 0.25") Tasa de conversión
Clics largo withCondition("Clicks >= 33") Clics
ConversionedClicks largo withCondition("ConvertedClicks >= 10") Conv.
Costo double withCondition("Cost > 3.25")

El coste está en la moneda de la cuenta.
Gasto
CTR double withCondition("Ctr > 0.05")

El CTR está en el rango 0..1, así que use 0.05 para un CTR del 5%.
CTR
Impresiones largo withCondition("Impressions > 10") Impr.
TopImpressionRate double withCondition("TopImpressionRate > 0.25") Top Impr. Tasa

Las siguientes son las propiedades de entidad que puede especificar.

Column Tipo Ejemplo Filtro de interfaz de usuario web de Microsoft Advertising
Estado enumeración El estado de la palabra clave. Los valores que pueden distinguir mayúsculas de minúsculas son:
  • HABILITADO
  • EN PAUSA
  • SE QUITÓ
withCondition("Status = ENABLED")
Estado
CombinedApprovalStatus string El estado de aprobación de la palabra clave. Los valores que pueden distinguir mayúsculas de minúsculas son:
  • APROBADO
  • APPROVED_LIMITED
  • UNDER_REVIEW
  • NO APROBADO
Para obtener información sobre estos valores, consulta Valores de estado de aprobación editorial.

En este ejemplo se muestran las palabras clave que requieren atención.

withCondition("CombinedApprovalStatus IN ['APPROVED_LIMITED', 'DISAPPROVED']")
Texto string El texto de la palabra clave. Incluye solo el texto de la palabra clave. No incluyas el tipo de coincidencia de la palabra clave en el texto. Por ejemplo, si la palabra clave es una palabra clave de coincidencia exacta, como [libros], usa libros, no [libros].

withCondition("Text STARTS_WITH 'flowers'")
Texto de la palabra clave
KeywordMatchType enumeración El tipo de coincidencia de la palabra clave. Los valores que pueden distinguir mayúsculas de minúsculas son:
  • AMPLIA
  • EXACTA
  • PHRASE
withCondition("KeywordMatchType = EXACT")
Tipo de coincidencia
MaxCpc double Importe máximo de la puja de CPC de la palabra clave. El CPC está en la moneda de la cuenta.

withCondition("MaxCpc > 0.40")
Puja
Url de destino string withCondition("DestinationUrl STARTS_WITH 'http://www.contoso.com'") Dirección URL de destino
Direcciones URL finales string withCondition("FinalUrls CONTAINS 'http://www.contoso.com'")
Puntuación de calidad Entero withCondition("QualityScore > 5") Calidad. puntuación
FirstPageCpc double El importe medio que se cobra a un anunciante cada vez que se hace clic en su anuncio cuando aparece en la barra lateral. Por ejemplo, si un anunciante pagó un total de 48,35 USD por 300 clics, el CPC medio del anunciante es de 0,16 USD. Usa esta información para ayudarte a decidir si aumentar la puja de palabra clave para aumentar las probabilidades de que el anuncio aparezca en la barra lateral. El CPC está en la moneda de la cuenta.

withCondition("FirstPageCpc > 6.00")
Costo mensual Puja de primera página
TopOfPageCpc double El importe medio que se cobra a un anunciante cada vez que se hace clic en su anuncio cuando se muestra por encima de los resultados de búsqueda orgánicos. Por ejemplo, si un anunciante pagó un total de 48,35 USD por 300 clics, el CPC medio del anunciante es de 0,16 USD. Usa esta información para ayudarte a decidir si aumentar la puja de palabras clave para aumentar las posibilidades de que el anuncio aparezca por encima de los resultados de búsqueda orgánicos. El CPC está en la moneda de la cuenta corriente.

withCondition("TopOfPageCpc > 8.00")
Mejor posición
AdGroupName string Nombre del grupo de anuncios que contiene las palabras clave.

withCondition("AdGroupName = 'foo'")
AdGroupStatus enumeración El estado del grupo de anuncios. Los valores que pueden distinguir mayúsculas de minúsculas son:
  • HABILITADO
  • EN PAUSA
  • SE QUITÓ
withCondition("AdGroupStatus = ENABLED")
Nombre de campaña string El nombre de la campaña que contiene las palabras clave.

withCondition("CampaignName = 'bar'")
CampaignStatus enumeración El estado de la campaña. Los valores que pueden distinguir mayúsculas de minúsculas son:
  • HABILITADO
  • EN PAUSA
  • SE QUITÓ
withCondition("CampaignStatus = ENABLED")
LabelNames juego de cadenas Una lista de uno o varios nombres de etiqueta que distinguen mayúsculas de minúsculas. Se usa para obtener palabras clave asociadas a las etiquetas con nombre.

withCondition("LabelNames CONTAINS_ANY ['bar', 'foo']")
Id Long El identificador de la palabra clave que se va a probar. Por ejemplo, puede usar esta columna para comprobar palabras clave cuyo id. sea mayor que el especificado.

withCondition('Id > 1234')

Argumentos

Nombre Tipo Description
condición string Condición que se va a agregar al selector.

Valores devueltos

Tipo Description
KeywordSelector Selector con la condición aplicada.

withIds(string[] ids)

Obtiene palabras clave con los identificadores especificados.

Puede aplicar una o más condiciones a un selector. Una cadena de condiciones se considera una operación AND. Por ejemplo, la entidad solo se selecciona si la condición A es verdadera Y la condición B es verdadera. Por ejemplo, la siguiente llamada selecciona solo la palabra clave 33333.

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

Argumentos

Nombre Tipo Descripción
ids string[] Una matriz de identificadores de palabras clave. Para conocer los límites, consulte Límites de ejecución de scripts.

Valores devueltos

Tipo Description
KeywordSelector con los identificadores aplicados.

withLimit(int limit)

Obtiene las n palabras clave principales que coinciden con los criterios de selección.

Argumentos

Nombre Tipo Description
límite Entero El número de palabras clave que se van a devolver. El número real puede ser menor.

Valores devueltos

Tipo Description
KeywordSelector Selector con límite aplicado.

Vea también