Condividi tramite


Operazione del servizio GetEstimatedPositionByKeywordIds - Ad Insight

Ottiene la posizione stimata nei risultati della ricerca se il valore di offerta specificato è stato usato per le parole chiave negli ultimi 7 giorni. Inoltre, l'operazione fornisce stime dei clic, del costo medio per clic (CPC) e delle impressioni che le parole chiave avrebbero potuto generare con l'offerta stimata.

Le stime si basano sugli ultimi 7 giorni di dati sulle prestazioni e non su una stima o una garanzia di prestazioni future.

Nota

Questa operazione è destinata alle campagne di ricerca che usano la strategia di offerta CPC avanzata.

Elementi della richiesta

L'oggetto GetEstimatedPositionByKeywordIdsRequest definisce il corpo e gli elementi di intestazione della richiesta di operazione del servizio. Gli elementi devono essere nello stesso ordine indicato nella richiesta SOAP.

Nota

Se non diversamente indicato di seguito, sono necessari tutti gli elementi della richiesta.

Elementi del corpo della richiesta

Elemento Descrizione Tipo di dati
KeywordIds Matrice di identificatori delle parole chiave per cui si vuole ottenere la posizione stimata nei risultati della ricerca, in base al valore di offerta specificato. È possibile specificare un massimo di 1.000 identificatori di parole chiave. matrice long
MaxBid Valore massimo dell'offerta da utilizzare per determinare la posizione stimata nei risultati della ricerca.

È necessario specificare il valore dell'offerta nella valuta del conto.
doppio

Elementi dell'intestazione della richiesta

Elemento Descrizione Tipo di dati
AuthenticationToken Token di accesso OAuth che rappresenta le credenziali di un utente che dispone delle autorizzazioni per gli account Microsoft Advertising.

Per altre informazioni, vedere Autenticazione con OAuth.
corda
CustomerAccountId Identificatore dell'account pubblicitario proprietario o associato alle entità nella richiesta. Questo elemento di intestazione deve avere lo stesso valore dell'elemento del corpo AccountId quando sono necessari entrambi. Questo elemento è necessario per la maggior parte delle operazioni del servizio e, come procedura consigliata, è consigliabile impostarlo sempre.

Per altre informazioni, vedere Ottenere l'account e gli ID cliente.
corda
CustomerId Identificatore dell'account manager (cliente) da cui l'utente accede o opera. Un utente può avere accesso a più account manager. Questo elemento è necessario per la maggior parte delle operazioni del servizio e, come procedura consigliata, è consigliabile impostarlo sempre.

Per altre informazioni, vedere Ottenere l'account e gli ID cliente.
corda
DeveloperToken Token di sviluppo usato per accedere all'API Bing Ads.

Per altre informazioni, vedere Ottenere un token per sviluppatori.
corda
Password Questo elemento è riservato per l'uso interno e verrà rimosso da una versione futura dell'API. È necessario usare l'elemento AuthenticationToken per impostare le credenziali utente. corda
UserName Questo elemento è riservato per l'uso interno e verrà rimosso da una versione futura dell'API. È necessario usare l'elemento AuthenticationToken per impostare le credenziali utente. corda

Elementi di risposta

L'oggetto GetEstimatedPositionByKeywordIdsResponse definisce il corpo e gli elementi di intestazione della risposta dell'operazione del servizio. Gli elementi vengono restituiti nello stesso ordine illustrato nella soap di risposta.

Elementi del corpo della risposta

Elemento Descrizione Tipo di dati
KeywordEstimatedPositions Elenco di oggetti dati KeywordIdEstimatedPosition . La matrice contiene un elemento per ogni parola chiave specificata nella richiesta. Se l'ID parola chiave non è valido, l'elemento corrispondente nella matrice sarà Null.

Ogni KeywordIdEstimatedPosition contiene un identificatore di parola chiave e un oggetto KeywordEstimatedPosition. Se i dati sono disponibili per la parola chiave , EstimatedPositionAndTraffic fornirà la posizione stimata nei risultati della ricerca, in base al valore di offerta specificato. In caso contrario, l'elemento EstimatedPositions verrà impostato su Null.
Matrice KeywordIdEstimatedPosition

Elementi dell'intestazione della risposta

Elemento Descrizione Tipo di dati
TrackingId Identificatore della voce di log che contiene i dettagli della chiamata API. corda

Richiedi SOAP

Questo modello è stato generato da uno strumento per visualizzare l'ordine degli elementi corpo e intestazione per la richiesta SOAP. Per i tipi supportati che è possibile usare con questa operazione del servizio, vedere il riferimento Request Body Elements sopra riportato.

<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">GetEstimatedPositionByKeywordIds</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>
    <GetEstimatedPositionByKeywordIdsRequest 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>
      <MaxBid>ValueHere</MaxBid>
    </GetEstimatedPositionByKeywordIdsRequest>
  </s:Body>
</s:Envelope>

SOAP della risposta

Questo modello è stato generato da uno strumento per visualizzare l'ordine degli elementi del corpo e dell'intestazione per la risposta 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>
    <GetEstimatedPositionByKeywordIdsResponse xmlns="https://bingads.microsoft.com/AdInsight/v13">
      <KeywordEstimatedPositions d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <KeywordIdEstimatedPosition>
          <KeywordId>ValueHere</KeywordId>
          <KeywordEstimatedPosition d4p1:nil="false">
            <Keyword d4p1:nil="false">ValueHere</Keyword>
            <EstimatedPositions d4p1:nil="false">
              <EstimatedPositionAndTraffic>
                <MatchType>ValueHere</MatchType>
                <MinClicksPerWeek>ValueHere</MinClicksPerWeek>
                <MaxClicksPerWeek>ValueHere</MaxClicksPerWeek>
                <AverageCPC>ValueHere</AverageCPC>
                <MinImpressionsPerWeek>ValueHere</MinImpressionsPerWeek>
                <MaxImpressionsPerWeek>ValueHere</MaxImpressionsPerWeek>
                <CTR>ValueHere</CTR>
                <MinTotalCostPerWeek>ValueHere</MinTotalCostPerWeek>
                <MaxTotalCostPerWeek>ValueHere</MaxTotalCostPerWeek>
                <CurrencyCode>ValueHere</CurrencyCode>
                <EstimatedAdPosition>ValueHere</EstimatedAdPosition>
              </EstimatedPositionAndTraffic>
            </EstimatedPositions>
          </KeywordEstimatedPosition>
        </KeywordIdEstimatedPosition>
      </KeywordEstimatedPositions>
    </GetEstimatedPositionByKeywordIdsResponse>
  </s:Body>
</s:Envelope>

Sintassi del codice

La sintassi di esempio può essere usata con gli SDK di Bing Ads. Per altri esempi, vedere Esempi di codice DELL'API Bing Ads .

public async Task<GetEstimatedPositionByKeywordIdsResponse> GetEstimatedPositionByKeywordIdsAsync(
	IList<long> keywordIds,
	double maxBid)
{
	var request = new GetEstimatedPositionByKeywordIdsRequest
	{
		KeywordIds = keywordIds,
		MaxBid = maxBid
	};

	return (await AdInsightService.CallAsync((s, r) => s.GetEstimatedPositionByKeywordIdsAsync(r), request));
}
static GetEstimatedPositionByKeywordIdsResponse getEstimatedPositionByKeywordIds(
	ArrayOflong keywordIds,
	double maxBid) throws RemoteException, Exception
{
	GetEstimatedPositionByKeywordIdsRequest request = new GetEstimatedPositionByKeywordIdsRequest();

	request.setKeywordIds(keywordIds);
	request.setMaxBid(maxBid);

	return AdInsightService.getService().getEstimatedPositionByKeywordIds(request);
}
static function GetEstimatedPositionByKeywordIds(
	$keywordIds,
	$maxBid)
{

	$GLOBALS['Proxy'] = $GLOBALS['AdInsightProxy'];

	$request = new GetEstimatedPositionByKeywordIdsRequest();

	$request->KeywordIds = $keywordIds;
	$request->MaxBid = $maxBid;

	return $GLOBALS['AdInsightProxy']->GetService()->GetEstimatedPositionByKeywordIds($request);
}
response=adinsight_service.GetEstimatedPositionByKeywordIds(
	KeywordIds=KeywordIds,
	MaxBid=MaxBid)

Requisiti

Servizio: AdInsightService.svc v13
Namespace: https://bingads.microsoft.com/AdInsight/v13

URL richiesta

https://adinsight.api.bingads.microsoft.com/AdInsight/v13/EstimatedPosition/QueryByKeywordIds

Elementi della richiesta

L'oggetto GetEstimatedPositionByKeywordIdsRequest definisce il corpo e gli elementi di intestazione della richiesta di operazione del servizio.

Nota

Se non diversamente indicato di seguito, sono necessari tutti gli elementi della richiesta.

Elementi del corpo della richiesta

Elemento Descrizione Tipo di dati
KeywordIds Matrice di identificatori delle parole chiave per cui si vuole ottenere la posizione stimata nei risultati della ricerca, in base al valore di offerta specificato. È possibile specificare un massimo di 1.000 identificatori di parole chiave. matrice long
MaxBid Valore massimo dell'offerta da utilizzare per determinare la posizione stimata nei risultati della ricerca.

È necessario specificare il valore dell'offerta nella valuta del conto.
doppio

Elementi dell'intestazione della richiesta

Elemento Descrizione Tipo di dati
Autorizzazione Token di accesso OAuth che rappresenta le credenziali di un utente che dispone delle autorizzazioni per gli account Microsoft Advertising. Assicurarsi che il token sia preceduto da "Bearer", necessario per l'autenticazione corretta.

Per altre informazioni, vedere Autenticazione con OAuth.
corda
CustomerAccountId Identificatore dell'account pubblicitario proprietario o associato alle entità nella richiesta. Questo elemento di intestazione deve avere lo stesso valore dell'elemento del corpo AccountId quando sono necessari entrambi. Questo elemento è necessario per la maggior parte delle operazioni del servizio e, come procedura consigliata, è consigliabile impostarlo sempre.

Per altre informazioni, vedere Ottenere l'account e gli ID cliente.
corda
CustomerId Identificatore dell'account manager (cliente) da cui l'utente accede o opera. Un utente può avere accesso a più account manager. Questo elemento è necessario per la maggior parte delle operazioni del servizio e, come procedura consigliata, è consigliabile impostarlo sempre.

Per altre informazioni, vedere Ottenere l'account e gli ID cliente.
corda
DeveloperToken Token di sviluppo usato per accedere all'API Bing Ads.

Per altre informazioni, vedere Ottenere un token per sviluppatori.
corda
Password Questo elemento è riservato per l'uso interno e verrà rimosso da una versione futura dell'API. È necessario usare l'elemento AuthenticationToken per impostare le credenziali utente. corda
UserName Questo elemento è riservato per l'uso interno e verrà rimosso da una versione futura dell'API. È necessario usare l'elemento AuthenticationToken per impostare le credenziali utente. corda

Elementi di risposta

L'oggetto GetEstimatedPositionByKeywordIdsResponse definisce il corpo e gli elementi di intestazione della risposta dell'operazione del servizio. Gli elementi vengono restituiti nello stesso ordine illustrato nel codice JSON della risposta.

Elementi del corpo della risposta

Elemento Descrizione Tipo di dati
KeywordEstimatedPositions Elenco di oggetti dati KeywordIdEstimatedPosition . La matrice contiene un elemento per ogni parola chiave specificata nella richiesta. Se l'ID parola chiave non è valido, l'elemento corrispondente nella matrice sarà Null.

Ogni KeywordIdEstimatedPosition contiene un identificatore di parola chiave e un oggetto KeywordEstimatedPosition. Se i dati sono disponibili per la parola chiave , EstimatedPositionAndTraffic fornirà la posizione stimata nei risultati della ricerca, in base al valore di offerta specificato. In caso contrario, l'elemento EstimatedPositions verrà impostato su Null.
Matrice KeywordIdEstimatedPosition

Elementi dell'intestazione della risposta

Elemento Descrizione Tipo di dati
TrackingId Identificatore della voce di log che contiene i dettagli della chiamata API. corda

Richiedere JSON

Questo modello è stato generato da uno strumento per visualizzare il corpo e gli elementi di intestazione per la richiesta JSON. Per i tipi supportati che è possibile usare con questa operazione del servizio, vedere il riferimento Request Body Elements sopra riportato.

{
  "KeywordIds": [
    "LongValueHere"
  ],
  "MaxBid": DoubleValueHere
}

Risposta JSON

Questo modello è stato generato da uno strumento per mostrare il corpo e gli elementi dell'intestazione per la risposta JSON.

{
  "KeywordEstimatedPositions": [
    {
      "KeywordEstimatedPosition": {
        "EstimatedPositions": [
          {
            "AverageCPC": DoubleValueHere,
            "CTR": DoubleValueHere,
            "CurrencyCode": "ValueHere",
            "EstimatedAdPosition": DoubleValueHere,
            "MatchType": "ValueHere",
            "MaxClicksPerWeek": DoubleValueHere,
            "MaxImpressionsPerWeek": "LongValueHere",
            "MaxTotalCostPerWeek": DoubleValueHere,
            "MinClicksPerWeek": DoubleValueHere,
            "MinImpressionsPerWeek": "LongValueHere",
            "MinTotalCostPerWeek": DoubleValueHere
          }
        ],
        "Keyword": "ValueHere"
      },
      "KeywordId": "LongValueHere"
    }
  ]
}

Sintassi del codice

Per chiamare l'API REST tramite SDK, è necessario aggiornare l'SDK a una determinata versione e configurare i parametri di sistema. La sintassi di esempio può essere usata con gli SDK di Bing Ads. Per altri esempi, vedere Esempi di codice DELL'API Bing Ads .

public async Task<GetEstimatedPositionByKeywordIdsResponse> GetEstimatedPositionByKeywordIdsAsync(
	IList<long> keywordIds,
	double maxBid)
{
	var request = new GetEstimatedPositionByKeywordIdsRequest
	{
		KeywordIds = keywordIds,
		MaxBid = maxBid
	};

	return (await AdInsightService.CallAsync((s, r) => s.GetEstimatedPositionByKeywordIdsAsync(r), request));
}
static GetEstimatedPositionByKeywordIdsResponse getEstimatedPositionByKeywordIds(
	ArrayOflong keywordIds,
	double maxBid) throws RemoteException, Exception
{
	GetEstimatedPositionByKeywordIdsRequest request = new GetEstimatedPositionByKeywordIdsRequest();

	request.setKeywordIds(keywordIds);
	request.setMaxBid(maxBid);

	return AdInsightService.getService().getEstimatedPositionByKeywordIds(request);
}
static function GetEstimatedPositionByKeywordIds(
	$keywordIds,
	$maxBid)
{

	$GLOBALS['Proxy'] = $GLOBALS['AdInsightProxy'];

	$request = new GetEstimatedPositionByKeywordIdsRequest();

	$request->KeywordIds = $keywordIds;
	$request->MaxBid = $maxBid;

	return $GLOBALS['AdInsightProxy']->GetService()->GetEstimatedPositionByKeywordIds($request);
}
response=adinsight_service.GetEstimatedPositionByKeywordIds(
	KeywordIds=KeywordIds,
	MaxBid=MaxBid)