Operación del servicio GetKeywordIdeas: Ad Insight
Obtiene la lista de ideas de palabras clave.
Sugiere nuevos grupos de anuncios y palabras clave en función de las palabras clave, el sitio web y la categoría de producto existentes. También puede solicitar estadísticas históricas de palabras clave, por ejemplo, búsquedas mensuales, competencia, CPC medio y recurso compartido de impresiones de anuncios. Puede usar las pujas de palabras clave sugeridas devueltas como entrada para la operación GetKeywordTrafficEstimates .
Sugerencia
Para obtener información general, consulte la guía técnica Ideas de palabras clave y estimaciones de tráfico .
Elementos Request
El objeto GetKeywordIdeasRequest define los elementos body y header de la solicitud de operación de servicio. Los elementos deben estar en el mismo orden que se muestra en la solicitud SOAP.
Nota:
A menos que se indique lo contrario a continuación, se requieren todos los elementos de solicitud.
Elementos del cuerpo de la solicitud
| Elemento | Descripción | Tipo de datos |
|---|---|---|
| ExpandIdeas | Determina si desea nuevas ideas de palabras clave o si solo quiere atributos de palabra clave para el conjunto de palabras clave que especificó en la lista SearchParameters . Si establece este elemento false, el objeto QuerySearchParameter debe incluirse en la lista SearchParameters . | boolean |
| IdeaAttributes | Los atributos de idea de palabra clave que desea incluir en la respuesta, por ejemplo, Keyword, Competition, MonthlySearchCounts y SuggestedBid. Se requiere el atributo Competition . El atributo Keyword siempre se devolverá para cada keywordIdea devuelto independientemente de si se incluye o no el valor de Keyword en la lista solicitada de atributos de idea. |
Matriz KeywordIdeaAttribute |
| SearchParameters | Los parámetros de búsqueda definen los criterios y filtros para las ideas de palabras clave solicitadas. No intente crear una instancia de SearchParameter. Puede incluir uno o varios de los siguientes objetos que se derivan de él: CategorySearchParameter, CompetitionSearchParameter, DateRangeSearchParameter, DeviceSearchParameter, ExcludeAccountKeywordsSearchParameter, IdeaTextSearchParameter, ImpressionShareSearchParameter, LanguageSearchParameter, LocationSearchParameter, NetworkSearchParameter, QuerySearchParameter, SearchVolumeSearchParameter, SuggestedBidSearchParameter y UrlSearchParameter. Otros objetos que derivan de SearchParameter no son válidos para esta operación. No se pueden incluir duplicados de ningún tipo de parámetro de búsqueda. La lista debe incluir todos estos parámetros de búsqueda: LanguageSearchParameter, LocationSearchParameter y NetworkSearchParameter. La lista debe incluir uno o varios de estos parámetros de búsqueda: CategorySearchParameter, QuerySearchParameter o UrlSearchParameter. Si el elemento ExpandIdeas es false, se requiere QuerySearchParameter independientemente de si ha incluido o no parámetros de búsqueda adicionales. Los datos del mes natural anterior pueden tardar hasta 72 horas en estar disponibles. Por ejemplo, si solicita ideas de palabras clave el 1, 2 o 3 de agosto y los datos de julio no están listos, la respuesta se basará en los datos de junio. Si no incluye DateRangeSearchParameter en la solicitud GetKeywordIdeas , no podrá confirmar si el primer elemento de lista son datos del mes anterior o del mes anterior. Si se especifica el intervalo de fechas y los datos del mes más reciente aún no están disponibles, GetKeywordIdeas devolverá un error. |
Matriz SearchParameter |
Elementos de encabezado de solicitud
| Elemento | Descripción | Tipo de datos |
|---|---|---|
| AuthenticationToken | Token de acceso de OAuth que representa las credenciales de un usuario que tiene permisos para cuentas de Microsoft Advertising. Para obtener más información, consulte Autenticación con OAuth. |
string |
| CustomerAccountId | Identificador de la cuenta de anuncio que posee o está asociada a las entidades de la solicitud. Este elemento de encabezado debe tener el mismo valor que el elemento de cuerpo AccountId cuando ambos son necesarios. Este elemento es necesario para la mayoría de las operaciones de servicio y, como procedimiento recomendado, siempre debe establecerlo. Para obtener más información, consulte Obtención de su cuenta e identificadores de cliente. |
string |
| CustomerId | Identificador de la cuenta de administrador (cliente) desde la que el usuario accede o funciona. Un usuario puede tener acceso a varias cuentas de administrador. Este elemento es necesario para la mayoría de las operaciones de servicio y, como procedimiento recomendado, siempre debe establecerlo. Para obtener más información, consulte Obtención de su cuenta e identificadores de cliente. |
string |
| DeveloperToken | Token de desarrollador que se usa para acceder a Bing Ads API. Para obtener más información, consulte Obtención de un token de desarrollador. |
string |
| Password | Este elemento está reservado para uso interno y se quitará de una versión futura de la API. Debe usar el elemento AuthenticationToken para establecer las credenciales de usuario. | string |
| UserName | Este elemento está reservado para uso interno y se quitará de una versión futura de la API. Debe usar el elemento AuthenticationToken para establecer las credenciales de usuario. | string |
Elementos de respuesta
El objeto GetKeywordIdeasResponse define los elementos body y header de la respuesta de la operación de servicio. Los elementos se devuelven en el mismo orden que se muestra en soap de respuesta.
Elementos del cuerpo de la respuesta
| Elemento | Descripción | Tipo de datos |
|---|---|---|
| KeywordIdeas | Lista de ideas de palabras clave. Actualmente se pueden devolver hasta 3000 elementos de lista, aunque el límite está sujeto a cambios. |
Matriz KeywordIdea |
Elementos de encabezado de respuesta
| Elemento | Descripción | Tipo de datos |
|---|---|---|
| Seguimiento del Id. | Identificador de la entrada de registro que contiene los detalles de la llamada API. | string |
Solicitud de SOAP
Esta plantilla se generó mediante una herramienta para mostrar el orden del cuerpo y los elementos de encabezado de la solicitud SOAP. Para ver los tipos admitidos que puede usar con esta operación de servicio, consulte la referencia de elementos de cuerpo de solicitud anterior.
<s:Envelope xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Header xmlns="https://bingads.microsoft.com/AdInsight/v13">
<Action mustUnderstand="1">GetKeywordIdeas</Action>
<AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
<CustomerAccountId i:nil="false">ValueHere</CustomerAccountId>
<CustomerId i:nil="false">ValueHere</CustomerId>
<DeveloperToken i:nil="false">ValueHere</DeveloperToken>
</s:Header>
<s:Body>
<GetKeywordIdeasRequest xmlns="https://bingads.microsoft.com/AdInsight/v13">
<ExpandIdeas i:nil="false">ValueHere</ExpandIdeas>
<IdeaAttributes i:nil="false">
<KeywordIdeaAttribute>ValueHere</KeywordIdeaAttribute>
</IdeaAttributes>
<SearchParameters i:nil="false">
<SearchParameter i:type="-- derived type specified here with the appropriate prefix --">
<!--This field is applicable if the derived type attribute is set to QuerySearchParameter-->
<Queries i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:string>ValueHere</a1:string>
</Queries>
<!--This field is applicable if the derived type attribute is set to UrlSearchParameter-->
<Url i:nil="false">ValueHere</Url>
<!--This field is applicable if the derived type attribute is set to CategorySearchParameter-->
<CategoryId>ValueHere</CategoryId>
<!--These fields are applicable if the derived type attribute is set to SearchVolumeSearchParameter-->
<Maximum i:nil="false">ValueHere</Maximum>
<Minimum i:nil="false">ValueHere</Minimum>
<!--These fields are applicable if the derived type attribute is set to SuggestedBidSearchParameter-->
<Maximum i:nil="false">ValueHere</Maximum>
<Minimum i:nil="false">ValueHere</Minimum>
<!--These fields are applicable if the derived type attribute is set to IdeaTextSearchParameter-->
<Excluded i:nil="false">
<Keyword>
<Id i:nil="false">ValueHere</Id>
<MatchType>ValueHere</MatchType>
<Text i:nil="false">ValueHere</Text>
</Keyword>
</Excluded>
<Included i:nil="false">
<Keyword>
<Id i:nil="false">ValueHere</Id>
<MatchType>ValueHere</MatchType>
<Text i:nil="false">ValueHere</Text>
</Keyword>
</Included>
<!--This field is applicable if the derived type attribute is set to ExcludeAccountKeywordsSearchParameter-->
<ExcludeAccountKeywords>ValueHere</ExcludeAccountKeywords>
<!--These fields are applicable if the derived type attribute is set to ImpressionShareSearchParameter-->
<Maximum i:nil="false">ValueHere</Maximum>
<Minimum i:nil="false">ValueHere</Minimum>
<!--This field is applicable if the derived type attribute is set to LocationSearchParameter-->
<Locations i:nil="false">
<LocationCriterion>
<LocationId>ValueHere</LocationId>
</LocationCriterion>
</Locations>
<!--This field is applicable if the derived type attribute is set to NetworkSearchParameter-->
<Network i:nil="false">
<Network>ValueHere</Network>
</Network>
<!--This field is applicable if the derived type attribute is set to DeviceSearchParameter-->
<Device i:nil="false">
<DeviceName i:nil="false">ValueHere</DeviceName>
</Device>
<!--This field is applicable if the derived type attribute is set to LanguageSearchParameter-->
<Languages i:nil="false">
<LanguageCriterion>
<Language i:nil="false">ValueHere</Language>
</LanguageCriterion>
</Languages>
<!--This field is applicable if the derived type attribute is set to CompetitionSearchParameter-->
<CompetitionLevels i:nil="false">
<CompetitionLevel>ValueHere</CompetitionLevel>
</CompetitionLevels>
<!--These fields are applicable if the derived type attribute is set to DateRangeSearchParameter-->
<EndDate i:nil="false">
<Day>ValueHere</Day>
<Month>ValueHere</Month>
<Year>ValueHere</Year>
</EndDate>
<StartDate i:nil="false">
<Day>ValueHere</Day>
<Month>ValueHere</Month>
<Year>ValueHere</Year>
</StartDate>
</SearchParameter>
</SearchParameters>
</GetKeywordIdeasRequest>
</s:Body>
</s:Envelope>
SOAP de respuesta
Esta plantilla se generó mediante una herramienta para mostrar el orden de los elementos body y header para la respuesta SOAP.
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Header xmlns="https://bingads.microsoft.com/AdInsight/v13">
<TrackingId d3p1:nil="false" xmlns:d3p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</TrackingId>
</s:Header>
<s:Body>
<GetKeywordIdeasResponse xmlns="https://bingads.microsoft.com/AdInsight/v13">
<KeywordIdeas d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<KeywordIdea>
<AdGroupId d4p1:nil="false">ValueHere</AdGroupId>
<AdGroupName d4p1:nil="false">ValueHere</AdGroupName>
<AdImpressionShare d4p1:nil="false">ValueHere</AdImpressionShare>
<Competition d4p1:nil="false">ValueHere</Competition>
<Keyword d4p1:nil="false">ValueHere</Keyword>
<MonthlySearchCounts d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:long>ValueHere</a1:long>
</MonthlySearchCounts>
<Relevance d4p1:nil="false">ValueHere</Relevance>
<Source d4p1:nil="false">ValueHere</Source>
<SuggestedBid d4p1:nil="false">ValueHere</SuggestedBid>
</KeywordIdea>
</KeywordIdeas>
</GetKeywordIdeasResponse>
</s:Body>
</s:Envelope>
Sintaxis de código
La sintaxis de ejemplo se puede usar con los SDK de Bing Ads. Consulte Ejemplos de código de API de Bing Ads para obtener más ejemplos.
public async Task<GetKeywordIdeasResponse> GetKeywordIdeasAsync(
bool? expandIdeas,
IList<KeywordIdeaAttribute> ideaAttributes,
IList<SearchParameter> searchParameters)
{
var request = new GetKeywordIdeasRequest
{
ExpandIdeas = expandIdeas,
IdeaAttributes = ideaAttributes,
SearchParameters = searchParameters
};
return (await AdInsightService.CallAsync((s, r) => s.GetKeywordIdeasAsync(r), request));
}
static GetKeywordIdeasResponse getKeywordIdeas(
boolean expandIdeas,
ArrayOfKeywordIdeaAttribute ideaAttributes,
ArrayOfSearchParameter searchParameters) throws RemoteException, Exception
{
GetKeywordIdeasRequest request = new GetKeywordIdeasRequest();
request.setExpandIdeas(expandIdeas);
request.setIdeaAttributes(ideaAttributes);
request.setSearchParameters(searchParameters);
return AdInsightService.getService().getKeywordIdeas(request);
}
static function GetKeywordIdeas(
$expandIdeas,
$ideaAttributes,
$searchParameters)
{
$GLOBALS['Proxy'] = $GLOBALS['AdInsightProxy'];
$request = new GetKeywordIdeasRequest();
$request->ExpandIdeas = $expandIdeas;
$request->IdeaAttributes = $ideaAttributes;
$request->SearchParameters = $searchParameters;
return $GLOBALS['AdInsightProxy']->GetService()->GetKeywordIdeas($request);
}
response=adinsight_service.GetKeywordIdeas(
ExpandIdeas=ExpandIdeas,
IdeaAttributes=IdeaAttributes,
SearchParameters=SearchParameters)
Requisitos
Servicio: AdInsightService.svc v13
Namespace: https://bingads.microsoft.com/AdInsight/v13
Dirección URL de solicitud
https://adinsight.api.bingads.microsoft.com/AdInsight/v13/KeywordIdeas/Query
Elementos Request
El objeto GetKeywordIdeasRequest define los elementos body y header de la solicitud de operación de servicio.
Nota:
A menos que se indique lo contrario a continuación, se requieren todos los elementos de solicitud.
Elementos del cuerpo de la solicitud
| Elemento | Descripción | Tipo de datos |
|---|---|---|
| ExpandIdeas | Determina si desea nuevas ideas de palabras clave o si solo quiere atributos de palabra clave para el conjunto de palabras clave que especificó en la lista SearchParameters . Si establece este elemento false, el objeto QuerySearchParameter debe incluirse en la lista SearchParameters . | boolean |
| IdeaAttributes | Los atributos de idea de palabra clave que desea incluir en la respuesta, por ejemplo, Keyword, Competition, MonthlySearchCounts y SuggestedBid. Se requiere el atributo Competition . El atributo Keyword siempre se devolverá para cada keywordIdea devuelto independientemente de si se incluye o no el valor de Keyword en la lista solicitada de atributos de idea. |
Matriz KeywordIdeaAttribute |
| SearchParameters | Los parámetros de búsqueda definen los criterios y filtros para las ideas de palabras clave solicitadas. No intente crear una instancia de SearchParameter. Puede incluir uno o varios de los siguientes objetos que se derivan de él: CategorySearchParameter, CompetitionSearchParameter, DateRangeSearchParameter, DeviceSearchParameter, ExcludeAccountKeywordsSearchParameter, IdeaTextSearchParameter, ImpressionShareSearchParameter, LanguageSearchParameter, LocationSearchParameter, NetworkSearchParameter, QuerySearchParameter, SearchVolumeSearchParameter, SuggestedBidSearchParameter y UrlSearchParameter. Otros objetos que derivan de SearchParameter no son válidos para esta operación. No se pueden incluir duplicados de ningún tipo de parámetro de búsqueda. La lista debe incluir todos estos parámetros de búsqueda: LanguageSearchParameter, LocationSearchParameter y NetworkSearchParameter. La lista debe incluir uno o varios de estos parámetros de búsqueda: CategorySearchParameter, QuerySearchParameter o UrlSearchParameter. Si el elemento ExpandIdeas es false, se requiere QuerySearchParameter independientemente de si ha incluido o no parámetros de búsqueda adicionales. Los datos del mes natural anterior pueden tardar hasta 72 horas en estar disponibles. Por ejemplo, si solicita ideas de palabras clave el 1, 2 o 3 de agosto y los datos de julio no están listos, la respuesta se basará en los datos de junio. Si no incluye DateRangeSearchParameter en la solicitud GetKeywordIdeas , no podrá confirmar si el primer elemento de lista son datos del mes anterior o del mes anterior. Si se especifica el intervalo de fechas y los datos del mes más reciente aún no están disponibles, GetKeywordIdeas devolverá un error. |
Matriz SearchParameter |
Elementos de encabezado de solicitud
| Elemento | Descripción | Tipo de datos |
|---|---|---|
| Autorización | Token de acceso de OAuth que representa las credenciales de un usuario que tiene permisos para cuentas de Microsoft Advertising. Asegúrese de que el token tiene el prefijo "Portador", esto es necesario para la autenticación adecuada. Para obtener más información, consulte Autenticación con OAuth. |
string |
| CustomerAccountId | Identificador de la cuenta de anuncio que posee o está asociada a las entidades de la solicitud. Este elemento de encabezado debe tener el mismo valor que el elemento de cuerpo AccountId cuando ambos son necesarios. Este elemento es necesario para la mayoría de las operaciones de servicio y, como procedimiento recomendado, siempre debe establecerlo. Para obtener más información, consulte Obtención de su cuenta e identificadores de cliente. |
string |
| CustomerId | Identificador de la cuenta de administrador (cliente) desde la que el usuario accede o funciona. Un usuario puede tener acceso a varias cuentas de administrador. Este elemento es necesario para la mayoría de las operaciones de servicio y, como procedimiento recomendado, siempre debe establecerlo. Para obtener más información, consulte Obtención de su cuenta e identificadores de cliente. |
string |
| DeveloperToken | Token de desarrollador que se usa para acceder a Bing Ads API. Para obtener más información, consulte Obtención de un token de desarrollador. |
string |
| Password | Este elemento está reservado para uso interno y se quitará de una versión futura de la API. Debe usar el elemento AuthenticationToken para establecer las credenciales de usuario. | string |
| UserName | Este elemento está reservado para uso interno y se quitará de una versión futura de la API. Debe usar el elemento AuthenticationToken para establecer las credenciales de usuario. | string |
Elementos de respuesta
El objeto GetKeywordIdeasResponse define los elementos body y header de la respuesta de la operación de servicio. Los elementos se devuelven en el mismo orden que se muestra en el JSON de respuesta.
Elementos del cuerpo de la respuesta
| Elemento | Descripción | Tipo de datos |
|---|---|---|
| KeywordIdeas | Lista de ideas de palabras clave. Actualmente se pueden devolver hasta 3000 elementos de lista, aunque el límite está sujeto a cambios. |
Matriz KeywordIdea |
Elementos de encabezado de respuesta
| Elemento | Descripción | Tipo de datos |
|---|---|---|
| Seguimiento del Id. | Identificador de la entrada de registro que contiene los detalles de la llamada API. | string |
Solicitud de JSON
Esta plantilla se generó mediante una herramienta para mostrar los elementos body y header de la solicitud JSON. Para ver los tipos admitidos que puede usar con esta operación de servicio, consulte la referencia de elementos de cuerpo de solicitud anterior.
{
"ExpandIdeas": "ValueHere",
"IdeaAttributes": [
"ValueHere"
],
"SearchParameters": [
{
"Queries": {
"string": "ValueHere"
},
"Url": "ValueHere",
"CategoryId": "ValueHere",
"Maximum": [
"ValueHere",
"ValueHere",
"ValueHere"
],
"Minimum": [
"ValueHere",
"ValueHere",
"ValueHere"
],
"Excluded": {
"Keyword": {
"Id": "ValueHere",
"MatchType": "ValueHere",
"Text": "ValueHere"
}
},
"Included": {
"Keyword": {
"Id": "ValueHere",
"MatchType": "ValueHere",
"Text": "ValueHere"
}
},
"ExcludeAccountKeywords": "ValueHere",
"Locations": {
"LocationCriterion": {
"LocationId": "ValueHere"
}
},
"Network": {
"Network": "ValueHere"
},
"Device": {
"DeviceName": "ValueHere"
},
"Languages": {
"LanguageCriterion": {
"Language": "ValueHere"
}
},
"CompetitionLevels": {
"CompetitionLevel": "ValueHere"
},
"EndDate": {
"Day": "ValueHere",
"Month": "ValueHere",
"Year": "ValueHere"
},
"StartDate": {
"Day": "ValueHere",
"Month": "ValueHere",
"Year": "ValueHere"
}
}
]
}
JSON de respuesta
Esta plantilla se generó mediante una herramienta para mostrar los elementos body y header de la respuesta JSON.
{
"KeywordIdeas": [
{
"AdGroupId": "LongValueHere",
"AdGroupName": "ValueHere",
"AdImpressionShare": DoubleValueHere,
"Competition": "ValueHere",
"Keyword": "ValueHere",
"MonthlySearchCounts": [
"LongValueHere"
],
"Relevance": DoubleValueHere,
"Source": "ValueHere",
"SuggestedBid": DoubleValueHere
}
]
}
Sintaxis de código
Para llamar a la API REST a través de SDK, debe actualizar el SDK a una versión determinada y configurar los parámetros del sistema. La sintaxis de ejemplo se puede usar con los SDK de Bing Ads. Consulte Ejemplos de código de API de Bing Ads para obtener más ejemplos.
public async Task<GetKeywordIdeasResponse> GetKeywordIdeasAsync(
bool? expandIdeas,
IList<KeywordIdeaAttribute> ideaAttributes,
IList<SearchParameter> searchParameters)
{
var request = new GetKeywordIdeasRequest
{
ExpandIdeas = expandIdeas,
IdeaAttributes = ideaAttributes,
SearchParameters = searchParameters
};
return (await AdInsightService.CallAsync((s, r) => s.GetKeywordIdeasAsync(r), request));
}
static GetKeywordIdeasResponse getKeywordIdeas(
boolean expandIdeas,
ArrayOfKeywordIdeaAttribute ideaAttributes,
ArrayOfSearchParameter searchParameters) throws RemoteException, Exception
{
GetKeywordIdeasRequest request = new GetKeywordIdeasRequest();
request.setExpandIdeas(expandIdeas);
request.setIdeaAttributes(ideaAttributes);
request.setSearchParameters(searchParameters);
return AdInsightService.getService().getKeywordIdeas(request);
}
static function GetKeywordIdeas(
$expandIdeas,
$ideaAttributes,
$searchParameters)
{
$GLOBALS['Proxy'] = $GLOBALS['AdInsightProxy'];
$request = new GetKeywordIdeasRequest();
$request->ExpandIdeas = $expandIdeas;
$request->IdeaAttributes = $ideaAttributes;
$request->SearchParameters = $searchParameters;
return $GLOBALS['AdInsightProxy']->GetService()->GetKeywordIdeas($request);
}
response=adinsight_service.GetKeywordIdeas(
ExpandIdeas=ExpandIdeas,
IdeaAttributes=IdeaAttributes,
SearchParameters=SearchParameters)