Operación del servicio GetBidLandscapeByKeywordIds: Ad Insight
Dada una lista de palabras clave existentes, esta operación devuelve para cada una una lista de pujas sugeridas y estadísticas de rendimiento estimadas de 1 a 7 días. Esta operación no se basa en la posición de destino, sino que devuelve varias opciones de puja que producen diferentes clics, impresiones y costos estimados. Puede usar la vista horizontal de varios puntos de puja con tráfico estimado para la misma palabra clave para ayudar a tomar decisiones sobre cómo ajustar la puja de palabra clave para optimizar los clics, las impresiones y el costo. Por ejemplo, puede usar los datos resultantes para visualizar una curva de clics para coste o una curva de puja a impresiones.
Las estimaciones se basan en los últimos 7 días de datos de rendimiento y no en una predicción o garantía de rendimiento futuro.
Nota:
Esta operación es para campañas de búsqueda que usan la estrategia de puja de CPC mejorada.
Elementos Request
El objeto GetBidLandscapeByKeywordIdsRequest 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
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 GetBidLandscapeByKeywordIdsResponse 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 |
|---|---|---|
| BidLandscape | Matriz de objetos KeywordBidLandscape . La matriz contiene una palabra claveBidLandscape correspondiente a cada palabra clave especificada en la solicitud. Los identificadores de palabra clave duplicados se permiten en la misma llamada y devolverán los mismos resultados. Si el identificador de palabra clave especificado no es válido o no tiene resultados de datos asociados, todos los elementos de KeywordBidLandscape serán nulos excepto keywordId , que refleja el identificador de palabra clave especificado en la solicitud. Si hay datos disponibles para la palabra clave , el objeto KeywordBidLandscape proporcionará una lista de pujas sugeridas y estadísticas de rendimiento estimadas. |
Matriz KeywordBidLandscape |
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">GetBidLandscapeByKeywordIds</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>
<GetBidLandscapeByKeywordIdsRequest xmlns="https://bingads.microsoft.com/AdInsight/v13">
<KeywordIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:long>ValueHere</a1:long>
</KeywordIds>
<IncludeCurrentBid i:nil="false">ValueHere</IncludeCurrentBid>
</GetBidLandscapeByKeywordIdsRequest>
</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>
<GetBidLandscapeByKeywordIdsResponse xmlns="https://bingads.microsoft.com/AdInsight/v13">
<BidLandscape d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<KeywordBidLandscape>
<KeywordId>ValueHere</KeywordId>
<StartDate d4p1:nil="false">
<Day>ValueHere</Day>
<Month>ValueHere</Month>
<Year>ValueHere</Year>
</StartDate>
<EndDate d4p1:nil="false">
<Day>ValueHere</Day>
<Month>ValueHere</Month>
<Year>ValueHere</Year>
</EndDate>
<BidLandscapePoints d4p1:nil="false">
<BidLandscapePoint>
<Bid>ValueHere</Bid>
<Clicks d4p1:nil="false">ValueHere</Clicks>
<Impressions>ValueHere</Impressions>
<TopImpressions d4p1:nil="false">ValueHere</TopImpressions>
<CurrencyCode>ValueHere</CurrencyCode>
<Cost d4p1:nil="false">ValueHere</Cost>
<MarginalCPC d4p1:nil="false">ValueHere</MarginalCPC>
</BidLandscapePoint>
</BidLandscapePoints>
</KeywordBidLandscape>
</BidLandscape>
</GetBidLandscapeByKeywordIdsResponse>
</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<GetBidLandscapeByKeywordIdsResponse> GetBidLandscapeByKeywordIdsAsync(
IList<long> keywordIds,
bool? includeCurrentBid)
{
var request = new GetBidLandscapeByKeywordIdsRequest
{
KeywordIds = keywordIds,
IncludeCurrentBid = includeCurrentBid
};
return (await AdInsightService.CallAsync((s, r) => s.GetBidLandscapeByKeywordIdsAsync(r), request));
}
static GetBidLandscapeByKeywordIdsResponse getBidLandscapeByKeywordIds(
ArrayOflong keywordIds,
boolean includeCurrentBid) throws RemoteException, Exception
{
GetBidLandscapeByKeywordIdsRequest request = new GetBidLandscapeByKeywordIdsRequest();
request.setKeywordIds(keywordIds);
request.setIncludeCurrentBid(includeCurrentBid);
return AdInsightService.getService().getBidLandscapeByKeywordIds(request);
}
static function GetBidLandscapeByKeywordIds(
$keywordIds,
$includeCurrentBid)
{
$GLOBALS['Proxy'] = $GLOBALS['AdInsightProxy'];
$request = new GetBidLandscapeByKeywordIdsRequest();
$request->KeywordIds = $keywordIds;
$request->IncludeCurrentBid = $includeCurrentBid;
return $GLOBALS['AdInsightProxy']->GetService()->GetBidLandscapeByKeywordIds($request);
}
response=adinsight_service.GetBidLandscapeByKeywordIds(
KeywordIds=KeywordIds,
IncludeCurrentBid=IncludeCurrentBid)
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/BidLandscape/QueryByKeywordIds
Elementos Request
El objeto GetBidLandscapeByKeywordIdsRequest 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
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 GetBidLandscapeByKeywordIdsResponse 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 |
|---|---|---|
| BidLandscape | Matriz de objetos KeywordBidLandscape . La matriz contiene una palabra claveBidLandscape correspondiente a cada palabra clave especificada en la solicitud. Los identificadores de palabra clave duplicados se permiten en la misma llamada y devolverán los mismos resultados. Si el identificador de palabra clave especificado no es válido o no tiene resultados de datos asociados, todos los elementos de KeywordBidLandscape serán nulos excepto keywordId , que refleja el identificador de palabra clave especificado en la solicitud. Si hay datos disponibles para la palabra clave , el objeto KeywordBidLandscape proporcionará una lista de pujas sugeridas y estadísticas de rendimiento estimadas. |
Matriz KeywordBidLandscape |
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.
{
"KeywordIds": [
"LongValueHere"
],
"IncludeCurrentBid": "ValueHere"
}
JSON de respuesta
Esta plantilla se generó mediante una herramienta para mostrar los elementos body y header de la respuesta JSON.
{
"BidLandscape": [
{
"BidLandscapePoints": [
{
"Bid": DoubleValueHere,
"Clicks": DoubleValueHere,
"Cost": DoubleValueHere,
"CurrencyCode": "ValueHere",
"Impressions": "LongValueHere",
"MarginalCPC": DoubleValueHere,
"TopImpressions": "LongValueHere"
}
],
"EndDate": {
"Day": IntValueHere,
"Month": IntValueHere,
"Year": IntValueHere
},
"KeywordId": "LongValueHere",
"StartDate": {
"Day": IntValueHere,
"Month": IntValueHere,
"Year": IntValueHere
}
}
]
}
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<GetBidLandscapeByKeywordIdsResponse> GetBidLandscapeByKeywordIdsAsync(
IList<long> keywordIds,
bool? includeCurrentBid)
{
var request = new GetBidLandscapeByKeywordIdsRequest
{
KeywordIds = keywordIds,
IncludeCurrentBid = includeCurrentBid
};
return (await AdInsightService.CallAsync((s, r) => s.GetBidLandscapeByKeywordIdsAsync(r), request));
}
static GetBidLandscapeByKeywordIdsResponse getBidLandscapeByKeywordIds(
ArrayOflong keywordIds,
boolean includeCurrentBid) throws RemoteException, Exception
{
GetBidLandscapeByKeywordIdsRequest request = new GetBidLandscapeByKeywordIdsRequest();
request.setKeywordIds(keywordIds);
request.setIncludeCurrentBid(includeCurrentBid);
return AdInsightService.getService().getBidLandscapeByKeywordIds(request);
}
static function GetBidLandscapeByKeywordIds(
$keywordIds,
$includeCurrentBid)
{
$GLOBALS['Proxy'] = $GLOBALS['AdInsightProxy'];
$request = new GetBidLandscapeByKeywordIdsRequest();
$request->KeywordIds = $keywordIds;
$request->IncludeCurrentBid = $includeCurrentBid;
return $GLOBALS['AdInsightProxy']->GetService()->GetBidLandscapeByKeywordIds($request);
}
response=adinsight_service.GetBidLandscapeByKeywordIds(
KeywordIds=KeywordIds,
IncludeCurrentBid=IncludeCurrentBid)