KeywordSelector
Contiene los métodos para filtrar y ordenar una lista de palabras clave. Para obtener información sobre los selectores, vea 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 | Descripción |
|---|---|---|
| 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 métricas de rendimiento. |
| get | KeywordIterator | Obtiene un iterador usado para recorrer en iteración la lista de palabras clave. |
| orderBy(string orderBy) | KeywordSelector | Aplica el orden especificado a las palabras clave seleccionadas. |
| withCondition(string condition) | 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 principales n palabras clave 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 solo si:
- Puede aplicar condiciones o ordenar que hagan referencia a campos de métricas de rendimiento.
- Quiere obtener datos de rendimiento de los objetos que está seleccionando. Por ejemplo, si tiene previsto llamar al
getStats()método .
Puede especificar los parámetros de fecha mediante cadenas u objetos. Para usar cadenas, especifique la fecha en el formulario AAAAMMDD. Si usa objetos, cree un objeto con los campos siguientes:
- year
- month
- Día
Por ejemplo:
var date = {year: 2018, month: 5, day: 13};
El mes se basa en uno, donde el 1 es enero y el 12 es diciembre.
El intervalo de fechas es inclusivo. Si especifica varios intervalos de fechas, solo se usa el último intervalo de fechas.
Argumentos
| Nombre | Tipo | Descripción |
|---|---|---|
| dateFrom | Objeto | Fecha de inicio del intervalo de fechas que especifica los datos de rendimiento que se van a incluir en el selector. |
| dateTo | Objeto | Fecha de finalización del intervalo de fechas que especifica los datos de rendimiento que se van a incluir en el selector. |
Valores devueltos
| Tipo | Descripción |
|---|---|
| KeywordSelector | Selector con intervalo de fechas aplicado. |
forDateRange(String dateRange)
Aplica el intervalo de fechas predefinido para seleccionar métricas de rendimiento.
Valores de intervalo de fecha 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 solo si:
- Puede aplicar condiciones o ordenar que hagan referencia a campos de métricas de rendimiento.
- Quiere obtener datos de rendimiento de los objetos que está seleccionando. Por ejemplo, si tiene previsto llamar al
getStats()método .
Si especifica varios intervalos de fechas, solo se usa el último intervalo de fechas.
Argumentos
| Nombre | Tipo | Descripción |
|---|---|---|
| dateRange | Cadena | Cadena de intervalo de fechas predefinida que especifica los datos de rendimiento que se van a incluir en el selector. La cadena de intervalo de fechas predefinida distingue mayúsculas de minúsculas. |
Valores devueltos
| Tipo | Descripción |
|---|---|
| KeywordSelector | Selector con intervalo de fechas aplicado. |
Obtener
Obtiene un iterador usado para recorrer en iteración la lista de palabras clave.
Valores devueltos
| Tipo | Descripción |
|---|---|
| KeywordIterator | Iterador usado para recorrer en iteración 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 ordenan los resultados. Establezca en 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 resultados en orden ascendente por AverageCpc.
selector = selector.orderBy("AverageCpc");
Los selectores admiten la ordenación de entidades solo por un campo. No puede ordenar la lista de entidades por campo x, y dentro de x por campo y, etc. Si especifica más de una orderBy() llamada en una cadena o en llamadas de selector independientes, Scripts ordena la lista de entidades mediante el campo especificado en la última orderBy() llamada.
Argumentos
| Nombre | Tipo | Descripción |
|---|---|---|
| Orderby | string | Orden que se va a aplicar. |
Valores devueltos
| Tipo | Descripción |
|---|---|
| KeywordSelector | Selector con orden aplicado. |
withCondition(String condition)
Aplica criterios de filtro a las palabras clave.
Especifique el parámetro de condición en el formulario "columnName operator value" donde:
- columnName es una de las columnas admitidas. Si columName se establece en un nombre de columna de métrica de rendimiento, debe especificar un intervalo de fechas mediante forDateRange(String dateRange) o forDateRange(Object dateFrom, Object dateTo).
- operator es uno de los operadores admitidos.
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 para 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 para 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.
A continuación se muestran 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 promedio |
| AverageCpm | double | withCondition("AverageCpm > 0.65") |
Promedio de CPM |
| ClickConversionRate | double | withCondition("ClickConversionRate > 0.25") |
Conv. Rate |
| Clics | largo | withCondition("Clicks >= 33") |
Clics |
| ConvertedClicks | largo | withCondition("ConvertedClicks >= 10") |
Conv. |
| Costo | double | withCondition("Cost > 3.25")El costo está en la moneda de la cuenta. |
Gastar |
| Ctr | double | withCondition("Ctr > 0.05")El CTR está en el intervalo 0..1, por lo que use 0.05 para una CTR del 5 %. |
CTR |
| Impresiones | largo | withCondition("Impressions > 10") |
Impr. |
| TopImpressionRate | double | withCondition("TopImpressionRate > 0.25") |
Impr superior. 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 | Estado de la palabra clave. Los posibles valores que distinguen mayúsculas de minúsculas son:
withCondition("Status = ENABLED") |
Estado |
| CombinedApprovalStatus | string | Estado de aprobación de la palabra clave. Los posibles valores que distinguen mayúsculas de minúsculas son:
En este ejemplo se devuelven palabras clave que necesitan atención. withCondition("CombinedApprovalStatus IN ['APPROVED_LIMITED', 'DISAPPROVED']") |
|
| Texto | string | Texto de la palabra clave. Incluya solo el texto de la palabra clave. No incluya 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 [books], use libros que no sean [libros].withCondition("Text STARTS_WITH 'flowers'") |
Texto de palabra clave |
| KeywordMatchType | Enumeración | Tipo de coincidencia de la palabra clave. Los posibles valores que distinguen mayúsculas de minúsculas son:
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") |
Oferta |
| DestinationUrl | string | withCondition("DestinationUrl STARTS_WITH 'http://www.contoso.com'") |
Dirección URL de destino |
| FinalUrls | string | withCondition("FinalUrls CONTAINS 'http://www.contoso.com'") |
|
| QualityScore | Entero | withCondition("QualityScore > 5") |
Qual. Puntuación |
| FirstPageCpc | double | La cantidad media 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 decidir si quieres aumentar la puja de palabras clave para mejorar la posibilidad de que el anuncio aparezca en la barra lateral. El CPC está en la moneda de la cuenta.withCondition("FirstPageCpc > 6.00") |
Est. oferta 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 aparece 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 decidir si quieres aumentar la puja de palabras clave para mejorar la posibilidad de que el anuncio aparezca por encima de los resultados de búsqueda orgánicos. El CPC está en la moneda de la cuenta actual.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 | Estado del grupo de anuncios. Los posibles valores que distinguen mayúsculas de minúsculas son:
withCondition("AdGroupStatus = ENABLED") |
|
| CampaignName | string | Nombre de la campaña que contiene las palabras clave.withCondition("CampaignName = 'bar'") |
|
| CampaignStatus | Enumeración | Estado de la campaña. Los posibles valores que distinguen mayúsculas de minúsculas son:
withCondition("CampaignStatus = ENABLED") |
|
| LabelNames | conjunto de cadenas | Lista de uno o varios nombres de etiqueta que distinguen mayúsculas de minúsculas. Use para obtener palabras clave asociadas a las etiquetas con nombre.withCondition("LabelNames CONTAINS_ANY ['bar', 'foo']") |
|
| Id | Long | Identificador de la palabra clave que se va a probar. Por ejemplo, puede usar esta columna para comprobar si hay palabras clave con identificadores mayores que el identificador especificado.withCondition('Id > 1234') |
Argumentos
| Nombre | Tipo | Descripción |
|---|---|---|
| Condición | string | Condición que se va a agregar al selector. |
Valores devueltos
| Tipo | Descripción |
|---|---|
| KeywordSelector | Selector con la condición aplicada. |
withIds(string[] ids)
Obtiene palabras clave con los identificadores especificados.
Puede aplicar una o varias 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 true Y la condición B es true. Por ejemplo, la llamada siguiente selecciona solo la palabra clave 33333.
AdsApp.keywords()
.withIds(['11111', '22222', '33333'])
.withIds(['33333', '44444', '55555']);
Argumentos
| Nombre | Tipo | Descripción |
|---|---|---|
| ids | string[] | Matriz de identificadores de palabra clave. Para conocer los límites, consulte Límites de ejecución de scripts. |
Valores devueltos
| Tipo | Descripción |
|---|---|
| KeywordSelector | Selector con los identificadores aplicados. |
withLimit(int limit)
Obtiene las principales n palabras clave que coinciden con los criterios de selección.
Argumentos
| Nombre | Tipo | Descripción |
|---|---|---|
| límite | Entero | Número de palabras clave que se van a devolver. El número real puede ser menor. |
Valores devueltos
| Tipo | Descripción |
|---|---|
| KeywordSelector | Selector con límite aplicado. |