Condividi tramite

Operazione del servizio GetKeywordLocations - Ad Insight

  • Articolo

Ottiene le posizioni geografiche degli utenti che hanno cercato le parole chiave specificate.

Nota

L'operazione del servizio GetKeywordLocations è deprecata a partire dal 21 agosto 2023. Altre informazioni.

Elementi della richiesta

L'oggetto GetKeywordLocationsRequest definisce il corpo e gli elementi dell'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
Dispositivo Matrice di dispositivi per cui si desidera ottenere informazioni sulla posizione geografica.

I tipi di dispositivo supportati includono: Computer, NonSmartphones, Smartphone, Tablet. Il valore predefinito è Computer.

La risposta include i dati delle posizioni delle parole chiave solo per i tipi di dispositivo specificati, se disponibili.		 matrice di stringhe
Parole chiave Matrice di parole chiave per cui si desidera ottenere informazioni sulla posizione geografica.

I dati vengono suddivisi anche per tipo di dispositivo . La matrice può contenere un massimo di 1.000 parole chiave e ogni parola chiave può contenere un massimo di 100 caratteri.		 matrice di stringhe
Lingua Linguaggio in cui vengono scritte le parole chiave.

Per i valori possibili, vedi Lingue degli annunci.		 corda
Livello Livello al quale aggregare i dati della posizione geografica. Di seguito sono riportati i valori possibili:

0 - Paese

1 - Stato/Provincia

2 - Area metropolitana

3 - Città

Il valore predefinito è 1 (Stato/Provincia).		 int
MaxLocations Numero massimo di posizioni da restituire. È possibile richiedere un massimo di 10 posizioni.

Il valore predefinito è 10.		 int
Paese padre Paese/area geografica da cui ha avuto origine la ricerca.

Per i valori possibili, vedere Codici di posizione geografica.

Il valore predefinito è US.		 corda
PublisherCountry Codice paese del paese o dell'area geografica da usare come origine dei dati di posizione.

Il paese specificato deve supportare la lingua specificata nell'elemento Language .

Per i valori possibili, vedi Lingue degli annunci.		 corda

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 GetKeywordLocationsResponse definisce il corpo e gli elementi dell'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
KeywordLocationResult Matrice di oggetti dati KeywordLocationResult . L'ordine degli elementi corrisponde direttamente alle parole chiave specificate nella richiesta. Se non sono disponibili dati sulla posizione per una parola chiave, la parola chiave verrà inclusa nell'elenco, ma l'elemento KeywordLocations dell'oggetto KeywordLocationResult corrispondente sarà Null.

Ogni oggetto dati KeywordLocationResult contiene una matrice di KeywordLocation. La matrice contiene un elemento per ogni dispositivo specificato nella richiesta. Ogni KeywordLocation contiene la posizione geografica e la percentuale di tempo in cui gli utenti nella posizione geografica hanno cercato la parola chiave specificata.		 Matrice KeywordLocationResult

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">GetKeywordLocations</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>
    <GetKeywordLocationsRequest 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>
      <PublisherCountry i:nil="false">ValueHere</PublisherCountry>
      <Device i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <a1:string>ValueHere</a1:string>
      </Device>
      <Level i:nil="false">ValueHere</Level>
      <ParentCountry i:nil="false">ValueHere</ParentCountry>
      <MaxLocations i:nil="false">ValueHere</MaxLocations>
    </GetKeywordLocationsRequest>
  </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>
    <GetKeywordLocationsResponse xmlns="https://bingads.microsoft.com/AdInsight/v13">
      <KeywordLocationResult d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <KeywordLocationResult>
          <Keyword d4p1:nil="false">ValueHere</Keyword>
          <KeywordLocations d4p1:nil="false">
            <KeywordLocation>
              <Device d4p1:nil="false">ValueHere</Device>
              <Location d4p1:nil="false">ValueHere</Location>
              <Percentage>ValueHere</Percentage>
            </KeywordLocation>
          </KeywordLocations>
        </KeywordLocationResult>
      </KeywordLocationResult>
    </GetKeywordLocationsResponse>
  </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<GetKeywordLocationsResponse> GetKeywordLocationsAsync(
	IList<string> keywords,
	string language,
	string publisherCountry,
	IList<string> device,
	int? level,
	string parentCountry,
	int? maxLocations)
{
	var request = new GetKeywordLocationsRequest
	{
		Keywords = keywords,
		Language = language,
		PublisherCountry = publisherCountry,
		Device = device,
		Level = level,
		ParentCountry = parentCountry,
		MaxLocations = maxLocations
	};

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

static GetKeywordLocationsResponse getKeywordLocations(
	ArrayOfstring keywords,
	java.lang.String language,
	java.lang.String publisherCountry,
	ArrayOfstring device,
	int level,
	java.lang.String parentCountry,
	int maxLocations) throws RemoteException, Exception
{
	GetKeywordLocationsRequest request = new GetKeywordLocationsRequest();

	request.setKeywords(keywords);
	request.setLanguage(language);
	request.setPublisherCountry(publisherCountry);
	request.setDevice(device);
	request.setLevel(level);
	request.setParentCountry(parentCountry);
	request.setMaxLocations(maxLocations);

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

static function GetKeywordLocations(
	$keywords,
	$language,
	$publisherCountry,
	$device,
	$level,
	$parentCountry,
	$maxLocations)
{

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

	$request = new GetKeywordLocationsRequest();

	$request->Keywords = $keywords;
	$request->Language = $language;
	$request->PublisherCountry = $publisherCountry;
	$request->Device = $device;
	$request->Level = $level;
	$request->ParentCountry = $parentCountry;
	$request->MaxLocations = $maxLocations;

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

response=adinsight_service.GetKeywordLocations(
	Keywords=Keywords,
	Language=Language,
	PublisherCountry=PublisherCountry,
	Device=Device,
	Level=Level,
	ParentCountry=ParentCountry,
	MaxLocations=MaxLocations)

Requisiti

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

URL richiesta

https://adinsight.api.bingads.microsoft.com/AdInsight/v13/KeywordLocations/Query

Elementi della richiesta

L'oggetto GetKeywordLocationsRequest definisce il corpo e gli elementi dell'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
Dispositivo Matrice di dispositivi per cui si desidera ottenere informazioni sulla posizione geografica.

I tipi di dispositivo supportati includono: Computer, NonSmartphones, Smartphone, Tablet. Il valore predefinito è Computer.

La risposta include i dati delle posizioni delle parole chiave solo per i tipi di dispositivo specificati, se disponibili.		 matrice di stringhe
Parole chiave Matrice di parole chiave per cui si desidera ottenere informazioni sulla posizione geografica.

I dati vengono suddivisi anche per tipo di dispositivo . La matrice può contenere un massimo di 1.000 parole chiave e ogni parola chiave può contenere un massimo di 100 caratteri.		 matrice di stringhe
Lingua Linguaggio in cui vengono scritte le parole chiave.

Per i valori possibili, vedi Lingue degli annunci.		 corda
Livello Livello al quale aggregare i dati della posizione geografica. Di seguito sono riportati i valori possibili:

0 - Paese

1 - Stato/Provincia

2 - Area metropolitana

3 - Città

Il valore predefinito è 1 (Stato/Provincia).		 int
MaxLocations Numero massimo di posizioni da restituire. È possibile richiedere un massimo di 10 posizioni.

Il valore predefinito è 10.		 int
Paese padre Paese/area geografica da cui ha avuto origine la ricerca.

Per i valori possibili, vedere Codici di posizione geografica.

Il valore predefinito è US.		 corda
PublisherCountry Codice paese del paese o dell'area geografica da usare come origine dei dati di posizione.

Il paese specificato deve supportare la lingua specificata nell'elemento Language .

Per i valori possibili, vedi Lingue degli annunci.		 corda

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 GetKeywordLocationsResponse definisce il corpo e gli elementi dell'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
KeywordLocationResult Matrice di oggetti dati KeywordLocationResult . L'ordine degli elementi corrisponde direttamente alle parole chiave specificate nella richiesta. Se non sono disponibili dati sulla posizione per una parola chiave, la parola chiave verrà inclusa nell'elenco, ma l'elemento KeywordLocations dell'oggetto KeywordLocationResult corrispondente sarà Null.

Ogni oggetto dati KeywordLocationResult contiene una matrice di KeywordLocation. La matrice contiene un elemento per ogni dispositivo specificato nella richiesta. Ogni KeywordLocation contiene la posizione geografica e la percentuale di tempo in cui gli utenti nella posizione geografica hanno cercato la parola chiave specificata.		 Matrice KeywordLocationResult

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.

{
  "Keywords": [
    "ValueHere"
  ],
  "Language": "ValueHere",
  "PublisherCountry": "ValueHere",
  "Device": [
    "ValueHere"
  ],
  "Level": IntValueHere,
  "ParentCountry": "ValueHere",
  "MaxLocations": IntValueHere
}

Risposta JSON

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

{
  "KeywordLocationResult": [
    {
      "Keyword": "ValueHere",
      "KeywordLocations": [
        {
          "Device": "ValueHere",
          "Location": "ValueHere",
          "Percentage": DoubleValueHere
        }
      ]
    }
  ]
}

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<GetKeywordLocationsResponse> GetKeywordLocationsAsync(
	IList<string> keywords,
	string language,
	string publisherCountry,
	IList<string> device,
	int? level,
	string parentCountry,
	int? maxLocations)
{
	var request = new GetKeywordLocationsRequest
	{
		Keywords = keywords,
		Language = language,
		PublisherCountry = publisherCountry,
		Device = device,
		Level = level,
		ParentCountry = parentCountry,
		MaxLocations = maxLocations
	};

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

static GetKeywordLocationsResponse getKeywordLocations(
	ArrayOfstring keywords,
	java.lang.String language,
	java.lang.String publisherCountry,
	ArrayOfstring device,
	int level,
	java.lang.String parentCountry,
	int maxLocations) throws RemoteException, Exception
{
	GetKeywordLocationsRequest request = new GetKeywordLocationsRequest();

	request.setKeywords(keywords);
	request.setLanguage(language);
	request.setPublisherCountry(publisherCountry);
	request.setDevice(device);
	request.setLevel(level);
	request.setParentCountry(parentCountry);
	request.setMaxLocations(maxLocations);

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

static function GetKeywordLocations(
	$keywords,
	$language,
	$publisherCountry,
	$device,
	$level,
	$parentCountry,
	$maxLocations)
{

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

	$request = new GetKeywordLocationsRequest();

	$request->Keywords = $keywords;
	$request->Language = $language;
	$request->PublisherCountry = $publisherCountry;
	$request->Device = $device;
	$request->Level = $level;
	$request->ParentCountry = $parentCountry;
	$request->MaxLocations = $maxLocations;

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

response=adinsight_service.GetKeywordLocations(
	Keywords=Keywords,
	Language=Language,
	PublisherCountry=PublisherCountry,
	Device=Device,
	Level=Level,
	ParentCountry=ParentCountry,
	MaxLocations=MaxLocations)