Operación de servicio SuggestKeywordsFromExistingKeywords: Ad Insight
Sugiere palabras clave que podrían funcionar mejor que las palabras clave especificadas.
Elementos Request
El objeto SuggestKeywordsFromExistingKeywordsRequest 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 |
---|---|---|
AdGroupId | Identificador del grupo de anuncios para las palabras clave sugeridas. Este elemento aún no se admite y se puede usar para influir en las sugerencias de palabras clave en una versión futura. |
largo |
CampaignId | Identificador de la campaña para las palabras clave sugeridas. Este elemento aún no se admite y se puede usar para influir en las sugerencias de palabras clave en una versión futura. |
largo |
ExcludeBrand | Valor que determina si los resultados excluyen palabras clave de marca. Para excluir palabras clave de marca en el resultado, establezca en true. El valor predeterminado es falso. | boolean |
Palabras clave | Matriz de palabras clave para las que desea obtener palabras clave sugeridas que podrían funcionar mejor. La matriz puede contener un máximo de 1000 palabras clave y cada palabra clave puede contener un máximo de 100 caracteres. | matriz de cadenas |
Idioma | Idioma en el que se escribe la palabra clave . Los posibles valores que distinguen mayúsculas de minúsculas son inglés, francés y alemán. Consulte la sección Comentarios a continuación para obtener una lista de los proveedores que se admiten para cada idioma. El valor predeterminado es Inglés. |
string |
MaxSuggestionsPerKeyword | Número máximo de sugerencias de palabras clave que se devolverán por palabra clave especificada. Si SuggestionType está establecido en 4, puede solicitar un máximo de 200 sugerencias por palabra clave; de lo contrario, las sugerencias máximas que puede solicitar son 100. El valor predeterminado es 50. |
int |
PublisherCountries | Códigos de país de los países o regiones que se usarán como origen de datos para determinar las palabras clave sugeridas. Puede especificar uno o varios códigos de país. Cada país o región que especifique debe admitir el idioma especificado en el elemento Language . Para ver los valores admitidos , consulte la sección Comentarios a continuación. El valor predeterminado es todos los países o regiones que admiten el idioma especificado. |
matriz de cadenas |
RemoveDuplicates | Valor booleano que determina si se deben quitar palabras clave duplicadas de la lista de palabras clave sugeridas. Para quitar duplicados, establezca en true. El valor predeterminado es falso. | boolean |
SuggestionType | Proveedor que se va a usar para generar las sugerencias de palabra clave. Para obtener una lista de posibles proveedores, las restricciones de idioma y país o región de cada proveedor y el proveedor predeterminado por país o región, consulte la sección Comentarios a continuación. | int |
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 SuggestKeywordsFromExistingKeywordsResponse 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 |
---|---|---|
KeywordSuggestions | Matriz de objetos de datos KeywordSuggestion . La matriz contiene un elemento para cada palabra clave especificada en la solicitud. El objeto contiene una lista de palabras clave sugeridas que pueden funcionar mejor que la palabra clave especificada. Para cada palabra clave sugerida, el objeto incluye una puntuación que indica la probabilidad de que al usar la palabra clave se incluya un anuncio en los resultados de una consulta de búsqueda. Si no hay sugerencias para una palabra clave, el elemento SuggestionsAndConfidence será null. |
Matriz KeywordSuggestion |
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">SuggestKeywordsFromExistingKeywords</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>
<SuggestKeywordsFromExistingKeywordsRequest xmlns="https://bingads.microsoft.com/AdInsight/v13">
<Keywords i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:string>ValueHere</a1:string>
</Keywords>
<Language i:nil="false">ValueHere</Language>
<PublisherCountries i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:string>ValueHere</a1:string>
</PublisherCountries>
<MaxSuggestionsPerKeyword i:nil="false">ValueHere</MaxSuggestionsPerKeyword>
<SuggestionType i:nil="false">ValueHere</SuggestionType>
<RemoveDuplicates i:nil="false">ValueHere</RemoveDuplicates>
<ExcludeBrand i:nil="false">ValueHere</ExcludeBrand>
<AdGroupId i:nil="false">ValueHere</AdGroupId>
<CampaignId i:nil="false">ValueHere</CampaignId>
</SuggestKeywordsFromExistingKeywordsRequest>
</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>
<SuggestKeywordsFromExistingKeywordsResponse xmlns="https://bingads.microsoft.com/AdInsight/v13">
<KeywordSuggestions d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<KeywordSuggestion>
<Keyword d4p1:nil="false">ValueHere</Keyword>
<SuggestionsAndConfidence d4p1:nil="false">
<KeywordAndConfidence>
<SuggestedKeyword d4p1:nil="false">ValueHere</SuggestedKeyword>
<ConfidenceScore>ValueHere</ConfidenceScore>
</KeywordAndConfidence>
</SuggestionsAndConfidence>
</KeywordSuggestion>
</KeywordSuggestions>
</SuggestKeywordsFromExistingKeywordsResponse>
</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<SuggestKeywordsFromExistingKeywordsResponse> SuggestKeywordsFromExistingKeywordsAsync(
IList<string> keywords,
string language,
IList<string> publisherCountries,
int? maxSuggestionsPerKeyword,
int? suggestionType,
bool? removeDuplicates,
bool? excludeBrand,
long? adGroupId,
long? campaignId)
{
var request = new SuggestKeywordsFromExistingKeywordsRequest
{
Keywords = keywords,
Language = language,
PublisherCountries = publisherCountries,
MaxSuggestionsPerKeyword = maxSuggestionsPerKeyword,
SuggestionType = suggestionType,
RemoveDuplicates = removeDuplicates,
ExcludeBrand = excludeBrand,
AdGroupId = adGroupId,
CampaignId = campaignId
};
return (await AdInsightService.CallAsync((s, r) => s.SuggestKeywordsFromExistingKeywordsAsync(r), request));
}
static SuggestKeywordsFromExistingKeywordsResponse suggestKeywordsFromExistingKeywords(
ArrayOfstring keywords,
java.lang.String language,
ArrayOfstring publisherCountries,
int maxSuggestionsPerKeyword,
int suggestionType,
boolean removeDuplicates,
boolean excludeBrand,
java.lang.Long adGroupId,
java.lang.Long campaignId) throws RemoteException, Exception
{
SuggestKeywordsFromExistingKeywordsRequest request = new SuggestKeywordsFromExistingKeywordsRequest();
request.setKeywords(keywords);
request.setLanguage(language);
request.setPublisherCountries(publisherCountries);
request.setMaxSuggestionsPerKeyword(maxSuggestionsPerKeyword);
request.setSuggestionType(suggestionType);
request.setRemoveDuplicates(removeDuplicates);
request.setExcludeBrand(excludeBrand);
request.setAdGroupId(adGroupId);
request.setCampaignId(campaignId);
return AdInsightService.getService().suggestKeywordsFromExistingKeywords(request);
}
static function SuggestKeywordsFromExistingKeywords(
$keywords,
$language,
$publisherCountries,
$maxSuggestionsPerKeyword,
$suggestionType,
$removeDuplicates,
$excludeBrand,
$adGroupId,
$campaignId)
{
$GLOBALS['Proxy'] = $GLOBALS['AdInsightProxy'];
$request = new SuggestKeywordsFromExistingKeywordsRequest();
$request->Keywords = $keywords;
$request->Language = $language;
$request->PublisherCountries = $publisherCountries;
$request->MaxSuggestionsPerKeyword = $maxSuggestionsPerKeyword;
$request->SuggestionType = $suggestionType;
$request->RemoveDuplicates = $removeDuplicates;
$request->ExcludeBrand = $excludeBrand;
$request->AdGroupId = $adGroupId;
$request->CampaignId = $campaignId;
return $GLOBALS['AdInsightProxy']->GetService()->SuggestKeywordsFromExistingKeywords($request);
}
response=adinsight_service.SuggestKeywordsFromExistingKeywords(
Keywords=Keywords,
Language=Language,
PublisherCountries=PublisherCountries,
MaxSuggestionsPerKeyword=MaxSuggestionsPerKeyword,
SuggestionType=SuggestionType,
RemoveDuplicates=RemoveDuplicates,
ExcludeBrand=ExcludeBrand,
AdGroupId=AdGroupId,
CampaignId=CampaignId)
Comentarios
A continuación se muestran los posibles proveedores de sugerencias que puede especificar.
Tipo de sugerencia | Descripción |
---|---|
1 | Devuelve consultas de búsqueda que incluyen la palabra clave . |
2 | Devuelve palabras clave de otros grupos de anuncios que incluyen la palabra clave especificada. |
3 | Devuelve consultas de búsqueda relacionadas con la palabra clave especificada. |
4 | Devuelve las mejores sugerencias de los otros proveedores. |
A continuación se muestran los proveedores que admite cada país o región.
País o región | Idioma | Tipos de proveedor admitidos | Tipo de proveedor predeterminado |
---|---|---|---|
Australia (AU) | Inglés | 2,3,4 | 4 |
Canadá (CA) | Inglés | 2,3,4 | 4 |
Francia (FR) | Francés | 2,3,4 | 4 |
Alemania (DE) | Alemán | 1,2,3,4 | 4 |
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/KeywordSuggestions/QueryByKeywords
Elementos Request
El objeto SuggestKeywordsFromExistingKeywordsRequest 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 |
---|---|---|
AdGroupId | Identificador del grupo de anuncios para las palabras clave sugeridas. Este elemento aún no se admite y se puede usar para influir en las sugerencias de palabras clave en una versión futura. |
largo |
CampaignId | Identificador de la campaña para las palabras clave sugeridas. Este elemento aún no se admite y se puede usar para influir en las sugerencias de palabras clave en una versión futura. |
largo |
ExcludeBrand | Valor que determina si los resultados excluyen palabras clave de marca. Para excluir palabras clave de marca en el resultado, establezca en true. El valor predeterminado es falso. | boolean |
Palabras clave | Matriz de palabras clave para las que desea obtener palabras clave sugeridas que podrían funcionar mejor. La matriz puede contener un máximo de 1000 palabras clave y cada palabra clave puede contener un máximo de 100 caracteres. | matriz de cadenas |
Idioma | Idioma en el que se escribe la palabra clave . Los posibles valores que distinguen mayúsculas de minúsculas son inglés, francés y alemán. Consulte la sección Comentarios a continuación para obtener una lista de los proveedores que se admiten para cada idioma. El valor predeterminado es Inglés. |
string |
MaxSuggestionsPerKeyword | Número máximo de sugerencias de palabras clave que se devolverán por palabra clave especificada. Si SuggestionType está establecido en 4, puede solicitar un máximo de 200 sugerencias por palabra clave; de lo contrario, las sugerencias máximas que puede solicitar son 100. El valor predeterminado es 50. |
int |
PublisherCountries | Códigos de país de los países o regiones que se usarán como origen de datos para determinar las palabras clave sugeridas. Puede especificar uno o varios códigos de país. Cada país o región que especifique debe admitir el idioma especificado en el elemento Language . Para ver los valores admitidos , consulte la sección Comentarios a continuación. El valor predeterminado es todos los países o regiones que admiten el idioma especificado. |
matriz de cadenas |
RemoveDuplicates | Valor booleano que determina si se deben quitar palabras clave duplicadas de la lista de palabras clave sugeridas. Para quitar duplicados, establezca en true. El valor predeterminado es falso. | boolean |
SuggestionType | Proveedor que se va a usar para generar las sugerencias de palabra clave. Para obtener una lista de posibles proveedores, las restricciones de idioma y país o región de cada proveedor y el proveedor predeterminado por país o región, consulte la sección Comentarios a continuación. | int |
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 SuggestKeywordsFromExistingKeywordsResponse 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 |
---|---|---|
KeywordSuggestions | Matriz de objetos de datos KeywordSuggestion . La matriz contiene un elemento para cada palabra clave especificada en la solicitud. El objeto contiene una lista de palabras clave sugeridas que pueden funcionar mejor que la palabra clave especificada. Para cada palabra clave sugerida, el objeto incluye una puntuación que indica la probabilidad de que al usar la palabra clave se incluya un anuncio en los resultados de una consulta de búsqueda. Si no hay sugerencias para una palabra clave, el elemento SuggestionsAndConfidence será null. |
Matriz KeywordSuggestion |
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.
{
"Keywords": [
"ValueHere"
],
"Language": "ValueHere",
"PublisherCountries": [
"ValueHere"
],
"MaxSuggestionsPerKeyword": IntValueHere,
"SuggestionType": IntValueHere,
"RemoveDuplicates": "ValueHere",
"ExcludeBrand": "ValueHere",
"AdGroupId": "LongValueHere",
"CampaignId": "LongValueHere"
}
JSON de respuesta
Esta plantilla se generó mediante una herramienta para mostrar los elementos body y header de la respuesta JSON.
{
"KeywordSuggestions": [
{
"Keyword": "ValueHere",
"SuggestionsAndConfidence": [
{
"ConfidenceScore": DoubleValueHere,
"SuggestedKeyword": "ValueHere"
}
]
}
]
}
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<SuggestKeywordsFromExistingKeywordsResponse> SuggestKeywordsFromExistingKeywordsAsync(
IList<string> keywords,
string language,
IList<string> publisherCountries,
int? maxSuggestionsPerKeyword,
int? suggestionType,
bool? removeDuplicates,
bool? excludeBrand,
long? adGroupId,
long? campaignId)
{
var request = new SuggestKeywordsFromExistingKeywordsRequest
{
Keywords = keywords,
Language = language,
PublisherCountries = publisherCountries,
MaxSuggestionsPerKeyword = maxSuggestionsPerKeyword,
SuggestionType = suggestionType,
RemoveDuplicates = removeDuplicates,
ExcludeBrand = excludeBrand,
AdGroupId = adGroupId,
CampaignId = campaignId
};
return (await AdInsightService.CallAsync((s, r) => s.SuggestKeywordsFromExistingKeywordsAsync(r), request));
}
static SuggestKeywordsFromExistingKeywordsResponse suggestKeywordsFromExistingKeywords(
ArrayOfstring keywords,
java.lang.String language,
ArrayOfstring publisherCountries,
int maxSuggestionsPerKeyword,
int suggestionType,
boolean removeDuplicates,
boolean excludeBrand,
java.lang.Long adGroupId,
java.lang.Long campaignId) throws RemoteException, Exception
{
SuggestKeywordsFromExistingKeywordsRequest request = new SuggestKeywordsFromExistingKeywordsRequest();
request.setKeywords(keywords);
request.setLanguage(language);
request.setPublisherCountries(publisherCountries);
request.setMaxSuggestionsPerKeyword(maxSuggestionsPerKeyword);
request.setSuggestionType(suggestionType);
request.setRemoveDuplicates(removeDuplicates);
request.setExcludeBrand(excludeBrand);
request.setAdGroupId(adGroupId);
request.setCampaignId(campaignId);
return AdInsightService.getService().suggestKeywordsFromExistingKeywords(request);
}
static function SuggestKeywordsFromExistingKeywords(
$keywords,
$language,
$publisherCountries,
$maxSuggestionsPerKeyword,
$suggestionType,
$removeDuplicates,
$excludeBrand,
$adGroupId,
$campaignId)
{
$GLOBALS['Proxy'] = $GLOBALS['AdInsightProxy'];
$request = new SuggestKeywordsFromExistingKeywordsRequest();
$request->Keywords = $keywords;
$request->Language = $language;
$request->PublisherCountries = $publisherCountries;
$request->MaxSuggestionsPerKeyword = $maxSuggestionsPerKeyword;
$request->SuggestionType = $suggestionType;
$request->RemoveDuplicates = $removeDuplicates;
$request->ExcludeBrand = $excludeBrand;
$request->AdGroupId = $adGroupId;
$request->CampaignId = $campaignId;
return $GLOBALS['AdInsightProxy']->GetService()->SuggestKeywordsFromExistingKeywords($request);
}
response=adinsight_service.SuggestKeywordsFromExistingKeywords(
Keywords=Keywords,
Language=Language,
PublisherCountries=PublisherCountries,
MaxSuggestionsPerKeyword=MaxSuggestionsPerKeyword,
SuggestionType=SuggestionType,
RemoveDuplicates=RemoveDuplicates,
ExcludeBrand=ExcludeBrand,
AdGroupId=AdGroupId,
CampaignId=CampaignId)
Comentarios
A continuación se muestran los posibles proveedores de sugerencias que puede especificar.
Tipo de sugerencia | Descripción |
---|---|
1 | Devuelve consultas de búsqueda que incluyen la palabra clave . |
2 | Devuelve palabras clave de otros grupos de anuncios que incluyen la palabra clave especificada. |
3 | Devuelve consultas de búsqueda relacionadas con la palabra clave especificada. |
4 | Devuelve las mejores sugerencias de los otros proveedores. |
A continuación se muestran los proveedores que admite cada país o región.
País o región | Idioma | Tipos de proveedor admitidos | Tipo de proveedor predeterminado |
---|---|---|---|
Australia (AU) | Inglés | 2,3,4 | 4 |
Canadá (CA) | Inglés | 2,3,4 | 4 |
Francia (FR) | Francés | 2,3,4 | 4 |
Alemania (DE) | Alemán | 1,2,3,4 | 4 |