Operazione del servizio GetEstimatedPositionByKeywords - Ad Insight

Articolo
12/21/2023

Ottiene la posizione stimata nei risultati della ricerca se il valore di offerta specificato viene utilizzato per le parole chiave specificate. Inoltre, l'operazione fornisce stime dei clic, il costo medio per clic (CPC) e le impressioni che le parole chiave potrebbero essere generate con l'offerta stimata.

Le stime non sono 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 GetEstimatedPositionByKeywordsRequest definisce gli elementi corpo e 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
AdGroupId	Identificatore del gruppo di annunci i cui dati sulle prestazioni vengono usati per determinare le prestazioni della parola chiave nel contesto del gruppo di annunci. La specifica di un gruppo di annunci consente di migliorare l'accuratezza della posizione suggerita. Se specifichi un gruppo di annunci, devi specificare la campagna a cui appartiene.	long
CampaignId	Identificatore della campagna proprietaria del gruppo di annunci specificato in AdGroupId. Se non specifichi un gruppo di annunci, i dati sulle prestazioni della campagna vengono usati per determinare il livello di prestazioni della parola chiave nel contesto della campagna. La specifica di una campagna e di un gruppo di annunci consente di migliorare l'accuratezza della posizione suggerita. Se non vengono specificati né AdGroupId né CampaignId , l'operazione usa l'elemento di intestazione CustomerAccountId specificato per determinare le prestazioni della parola chiave nel contesto dell'account.	long
CurrencyCode	Codice ISO per l'unità monetaria da utilizzare per calcolare le stime dei costi e il valore di offerta suggerito. Se non impostato, il servizio determina la valuta dall'account specificato nell'elemento di intestazione CustomerAccountId . Se non è impostato né Currency né CustomerAccountId , il servizio usa USD.	CurrencyCode
Parole chiave	Matrice di 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 parole chiave e ogni parola chiave può contenere un massimo di 100 caratteri.	matrice di stringhe
Lingua	Lingua usata in parallelo con gli identificatori di posizione per stimare la posizione. La lingua deve essere supportata in ognuna delle posizioni specificate in LocationIds. Per i possibili valori linguistici, vedere Lingue degli annunci. Se non si specifica la lingua, l'operazione del servizio usa la lingua dell'AdGroupId o del CampaignId specificato. Se nessuna di queste proprietà è impostata, per impostazione predefinita viene usato EN (inglese).	Stringa
LocationIds	Identificatore o identificatori delle posizioni geografiche da utilizzare per stimare la posizione. Tutte le posizioni devono supportare la lingua specificata nell'elemento Language . Sebbene sia possibile specificare più identificatori di posizione, come procedura consigliata per le stime della posizione più accurate per località, è consigliabile specificare una sola posizione per ogni chiamata al servizio. Per i possibili identificatori di posizione, vedere Codici di posizione geografica. Se non si specificano posizioni, l'operazione del servizio usa i criteri di posizione dell'AdGroupId o del CampaignId specificati. Se nessuna di queste proprietà è impostata, per impostazione predefinita viene usato 190 (Stati Uniti).	matrice long
MatchTypes	Matrice di tipi di corrispondenza univoci per i quali si desidera ottenere stime. Non è possibile specificare il tipo di corrispondenza Contenuto.	Matrice MatchType
MaxBid	Valore massimo dell'offerta da utilizzare per determinare la posizione stimata nei risultati della ricerca.	Doppia

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.	Stringa
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.	Stringa
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.	Stringa
DeveloperToken	Token di sviluppo usato per accedere all'API Bing Ads. Per altre informazioni, vedere Ottenere un token per sviluppatori.	Stringa
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.	Stringa
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.	Stringa

Elementi di risposta

L'oggetto GetEstimatedPositionByKeywordsResponse definisce gli elementi corpo e 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	Matrice di oggetti dati KeywordEstimatedPosition . La matrice contiene un elemento per ogni parola chiave specificata nella richiesta. Se la parola chiave non è valida, l'elemento corrispondente nella matrice sarà Null. Se i dati sono disponibili per la parola chiave, EstimatedPositionAndTraffic fornirà la posizione stimata nei risultati della ricerca in cui potrebbero essere visualizzati gli annunci, in base al valore di offerta specificato. In caso contrario, l'elemento EstimatedPositions verrà impostato su Null.	Matrice KeywordEstimatedPosition

Elementi dell'intestazione della risposta

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

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">GetEstimatedPositionByKeywords</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>
    <GetEstimatedPositionByKeywordsRequest 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>
      <MaxBid>ValueHere</MaxBid>
      <Language i:nil="false">ValueHere</Language>
      <LocationIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <a1:long>ValueHere</a1:long>
      </LocationIds>
      <CurrencyCode i:nil="false">ValueHere</CurrencyCode>
      <MatchTypes i:nil="false">
        <MatchType>ValueHere</MatchType>
      </MatchTypes>
      <CampaignId i:nil="false">ValueHere</CampaignId>
      <AdGroupId i:nil="false">ValueHere</AdGroupId>
    </GetEstimatedPositionByKeywordsRequest>
  </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>
    <GetEstimatedPositionByKeywordsResponse xmlns="https://bingads.microsoft.com/AdInsight/v13">
      <KeywordEstimatedPositions d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <KeywordEstimatedPosition>
          <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>
      </KeywordEstimatedPositions>
    </GetEstimatedPositionByKeywordsResponse>
  </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<GetEstimatedPositionByKeywordsResponse> GetEstimatedPositionByKeywordsAsync(
	IList<string> keywords,
	double maxBid,
	string language,
	IList<long> locationIds,
	CurrencyCode? currencyCode,
	IList<MatchType> matchTypes,
	long? campaignId,
	long? adGroupId)
{
	var request = new GetEstimatedPositionByKeywordsRequest
	{
		Keywords = keywords,
		MaxBid = maxBid,
		Language = language,
		LocationIds = locationIds,
		CurrencyCode = currencyCode,
		MatchTypes = matchTypes,
		CampaignId = campaignId,
		AdGroupId = adGroupId
	};

	return (await AdInsightService.CallAsync((s, r) => s.GetEstimatedPositionByKeywordsAsync(r), request));
}

static GetEstimatedPositionByKeywordsResponse getEstimatedPositionByKeywords(
	ArrayOfstring keywords,
	double maxBid,
	java.lang.String language,
	ArrayOflong locationIds,
	CurrencyCode currencyCode,
	ArrayOfMatchType matchTypes,
	java.lang.Long campaignId,
	java.lang.Long adGroupId) throws RemoteException, Exception
{
	GetEstimatedPositionByKeywordsRequest request = new GetEstimatedPositionByKeywordsRequest();

	request.setKeywords(keywords);
	request.setMaxBid(maxBid);
	request.setLanguage(language);
	request.setLocationIds(locationIds);
	request.setCurrencyCode(currencyCode);
	request.setMatchTypes(matchTypes);
	request.setCampaignId(campaignId);
	request.setAdGroupId(adGroupId);

	return AdInsightService.getService().getEstimatedPositionByKeywords(request);
}

static function GetEstimatedPositionByKeywords(
	$keywords,
	$maxBid,
	$language,
	$locationIds,
	$currencyCode,
	$matchTypes,
	$campaignId,
	$adGroupId)
{

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

	$request = new GetEstimatedPositionByKeywordsRequest();

	$request->Keywords = $keywords;
	$request->MaxBid = $maxBid;
	$request->Language = $language;
	$request->LocationIds = $locationIds;
	$request->CurrencyCode = $currencyCode;
	$request->MatchTypes = $matchTypes;
	$request->CampaignId = $campaignId;
	$request->AdGroupId = $adGroupId;

	return $GLOBALS['AdInsightProxy']->GetService()->GetEstimatedPositionByKeywords($request);
}

response=adinsight_service.GetEstimatedPositionByKeywords(
	Keywords=Keywords,
	MaxBid=MaxBid,
	Language=Language,
	LocationIds=LocationIds,
	CurrencyCode=CurrencyCode,
	MatchTypes=MatchTypes,
	CampaignId=CampaignId,
	AdGroupId=AdGroupId)

Requisiti

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

Condividi tramite