Freigeben über

GetKeywordLocations Service Operation – Ad Insight

  • Artikel

Ruft die geografischen Standorte von Benutzern ab, die nach den angegebenen Schlüsselwörtern gesucht haben.

Hinweis

Der GetKeywordLocations-Dienstvorgang ist ab dem 21. August 2023 veraltet. Weitere Informationen.

Anfordern von Elementen

Das GetKeywordLocationsRequest-Objekt definiert den Text und die Headerelemente der Dienstvorgangsanforderung. Die Elemente müssen in der gleichen Reihenfolge wie im Anforderungs-SOAP dargestellt sein.

Hinweis

Sofern unten nicht anders angegeben, sind alle Anforderungselemente erforderlich.

Anforderungstextelemente

Element Beschreibung Datentyp
Gerät Ein Array von Geräten, für die Informationen zum geografischen Standort abgerufen werden sollen.

Zu den unterstützten Gerätetypen gehören: Computer, Nichtsmartphones, Smartphones, Tablets. Der Standardwert ist Computer.

Die Antwort enthält Schlüsselwort (keyword) Standortdaten nur für die von Ihnen angegebenen Gerätetypen, sofern verfügbar.		 Zeichenfolgenarray
Schlüsselwörter Ein Array von Schlüsselwörtern, für die Informationen zum geografischen Standort abgerufen werden sollen.

Die Daten werden auch nach Gerätetyp aufgeschlüsselt. Das Array kann maximal 1.000 Schlüsselwörter enthalten, und jedes Schlüsselwort (keyword) darf maximal 100 Zeichen enthalten.		 Zeichenfolgenarray
Sprache Die Sprache, in der die Schlüsselwörter geschrieben werden.

Mögliche Werte finden Sie unter Anzeigensprachen.		 Zeichenfolge
Ebene Die Ebene, auf der die Daten des geografischen Standorts aggregiert werden sollen. Im Folgenden sind die möglichen Werte aufgeführt:

0 - Land

1 - Bundesland/Provinz

2 - Metropolregion

3 - Stadt

Der Standardwert ist 1 (Bundesland/Provinz).		 int
MaxLocations Die maximale Anzahl von Speicherorten, die zurückgegeben werden sollen. Sie können maximal 10 Standorte anfordern.

Der Standardwert ist 10.		 int
ParentCountry Das Land/die Region, aus dem/der die Suche stammt.

Mögliche Werte finden Sie unter Codes für geografische Standorte.

Der Standardwert ist "USA".		 Zeichenfolge
PublisherCountry Der Ländercode des Landes/der Region, das als Quelle der Standortdaten verwendet werden soll.

Das angegebene Land/die Region muss die im Language-Element angegebene Sprache unterstützen.

Mögliche Werte finden Sie unter Anzeigensprachen.		 Zeichenfolge

Anforderungsheaderelemente

Element Beschreibung Datentyp
AuthenticationToken Das OAuth-Zugriffstoken, das die Anmeldeinformationen eines Benutzers darstellt, der über Berechtigungen für Microsoft Advertising-Konten verfügt.

Weitere Informationen finden Sie unter Authentifizierung mit OAuth.		 Zeichenfolge
CustomerAccountId Der Bezeichner des Anzeigenkontos, das die Entitäten in der Anforderung besitzt oder zugeordnet ist. Dieses Headerelement muss denselben Wert wie das AccountId-Body-Element aufweisen, wenn beides erforderlich ist. Dieses Element ist für die meisten Dienstvorgänge erforderlich, und als bewährte Methode sollten Sie es immer festlegen.

Weitere Informationen finden Sie unter Abrufen Von Konto- und Kunden-IDs.		 Zeichenfolge
CustomerId Der Bezeichner des Vorgesetztenkontos (Kunde), auf das der Benutzer zugreift oder von dort aus arbeitet. Ein Benutzer kann Zugriff auf mehrere Managerkonten haben. Dieses Element ist für die meisten Dienstvorgänge erforderlich, und als bewährte Methode sollten Sie es immer festlegen.

Weitere Informationen finden Sie unter Abrufen Von Konto- und Kunden-IDs.		 Zeichenfolge
DeveloperToken Das Entwicklertoken, das für den Zugriff auf die Bing Ads-API verwendet wird.

Weitere Informationen finden Sie unter Abrufen eines Entwicklertokens.		 Zeichenfolge
Kennwort Dieses Element ist für die interne Verwendung reserviert und wird aus einer zukünftigen Version der API entfernt. Sie müssen das AuthenticationToken-Element verwenden, um Benutzeranmeldeinformationen festzulegen. Zeichenfolge
UserName Dieses Element ist für die interne Verwendung reserviert und wird aus einer zukünftigen Version der API entfernt. Sie müssen das AuthenticationToken-Element verwenden, um Benutzeranmeldeinformationen festzulegen. Zeichenfolge

Antwortelemente

Das GetKeywordLocationsResponse-Objekt definiert den Text und die Headerelemente der Dienstvorgangsantwort. Die Elemente werden in der gleichen Reihenfolge zurückgegeben, in der die Antwort-SOAP gezeigt wird.

Antworttextelemente

Element Beschreibung Datentyp
KeywordLocationResult Ein Array von KeywordLocationResult-Datenobjekten . Die Reihenfolge der Elemente entspricht direkt den in der Anforderung angegebenen Schlüsselwörtern. Wenn für eine Schlüsselwort (keyword) keine Standortdaten verfügbar sind, wird die Schlüsselwort (keyword) in die Liste aufgenommen, aber das KeywordLocations-Element des entsprechenden KeywordLocationResult-Objekts ist NULL.

Jedes KeywordLocationResult-Datenobjekt enthält ein Array von KeywordLocation. Das Array enthält ein Element für jedes in der Anforderung angegebene Gerät. Jede KeywordLocation enthält den geografischen Standort und den Prozentsatz der Zeit, die Benutzer am geografischen Standort nach dem angegebenen Schlüsselwort (keyword) gesucht haben.		 KeywordLocationResult-Array

Antwortheaderelemente

Element Beschreibung Datentyp
TrackingId Der Bezeichner des Protokolleintrags, der die Details des API-Aufrufs enthält. Zeichenfolge

SOAP anfordern

Diese Vorlage wurde von einem Tool generiert, um die Reihenfolge der Text- und Headerelemente für die SOAP-Anforderung anzuzeigen. Informationen zu unterstützten Typen, die Sie mit diesem Dienstvorgang verwenden können, finden Sie oben in der Referenz zu Anforderungstextelementen .

<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>

Antwort-SOAP

Diese Vorlage wurde von einem Tool generiert, um die Reihenfolge der Text- und Headerelemente für die SOAP-Antwort anzuzeigen.

<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>

Codesyntax

Die Beispielsyntax kann mit Bing Ads SDKs verwendet werden. Weitere Beispiele finden Sie unter Codebeispiele für die Bing Ads-API .

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)

Anforderungen

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

Anforderungs-URL

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

Anfordern von Elementen

Das GetKeywordLocationsRequest-Objekt definiert den Text und die Headerelemente der Dienstvorgangsanforderung.

Hinweis

Sofern unten nicht anders angegeben, sind alle Anforderungselemente erforderlich.

Anforderungstextelemente

Element Beschreibung Datentyp
Gerät Ein Array von Geräten, für die Informationen zum geografischen Standort abgerufen werden sollen.

Zu den unterstützten Gerätetypen gehören: Computer, Nichtsmartphones, Smartphones, Tablets. Der Standardwert ist Computer.

Die Antwort enthält Schlüsselwort (keyword) Standortdaten nur für die von Ihnen angegebenen Gerätetypen, sofern verfügbar.		 Zeichenfolgenarray
Schlüsselwörter Ein Array von Schlüsselwörtern, für die Informationen zum geografischen Standort abgerufen werden sollen.

Die Daten werden auch nach Gerätetyp aufgeschlüsselt. Das Array kann maximal 1.000 Schlüsselwörter enthalten, und jedes Schlüsselwort (keyword) darf maximal 100 Zeichen enthalten.		 Zeichenfolgenarray
Sprache Die Sprache, in der die Schlüsselwörter geschrieben werden.

Mögliche Werte finden Sie unter Anzeigensprachen.		 Zeichenfolge
Ebene Die Ebene, auf der die Daten des geografischen Standorts aggregiert werden sollen. Im Folgenden sind die möglichen Werte aufgeführt:

0 - Land

1 - Bundesland/Provinz

2 - Metropolregion

3 - Stadt

Der Standardwert ist 1 (Bundesland/Provinz).		 int
MaxLocations Die maximale Anzahl von Speicherorten, die zurückgegeben werden sollen. Sie können maximal 10 Standorte anfordern.

Der Standardwert ist 10.		 int
ParentCountry Das Land/die Region, aus dem/der die Suche stammt.

Mögliche Werte finden Sie unter Codes für geografische Standorte.

Der Standardwert ist "USA".		 Zeichenfolge
PublisherCountry Der Ländercode des Landes/der Region, das als Quelle der Standortdaten verwendet werden soll.

Das angegebene Land/die Region muss die im Language-Element angegebene Sprache unterstützen.

Mögliche Werte finden Sie unter Anzeigensprachen.		 Zeichenfolge

Anforderungsheaderelemente

Element Beschreibung Datentyp
Authorization Das OAuth-Zugriffstoken, das die Anmeldeinformationen eines Benutzers darstellt, der über Berechtigungen für Microsoft Advertising-Konten verfügt. Stellen Sie sicher, dass dem Token das Präfix "Bearer" vorangestellt ist. Dies ist für die ordnungsgemäße Authentifizierung erforderlich.

Weitere Informationen finden Sie unter Authentifizierung mit OAuth.		 Zeichenfolge
CustomerAccountId Der Bezeichner des Anzeigenkontos, das die Entitäten in der Anforderung besitzt oder zugeordnet ist. Dieses Headerelement muss denselben Wert wie das AccountId-Body-Element aufweisen, wenn beides erforderlich ist. Dieses Element ist für die meisten Dienstvorgänge erforderlich, und als bewährte Methode sollten Sie es immer festlegen.

Weitere Informationen finden Sie unter Abrufen Von Konto- und Kunden-IDs.		 Zeichenfolge
CustomerId Der Bezeichner des Vorgesetztenkontos (Kunde), auf das der Benutzer zugreift oder von dort aus arbeitet. Ein Benutzer kann Zugriff auf mehrere Managerkonten haben. Dieses Element ist für die meisten Dienstvorgänge erforderlich, und als bewährte Methode sollten Sie es immer festlegen.

Weitere Informationen finden Sie unter Abrufen Von Konto- und Kunden-IDs.		 Zeichenfolge
DeveloperToken Das Entwicklertoken, das für den Zugriff auf die Bing Ads-API verwendet wird.

Weitere Informationen finden Sie unter Abrufen eines Entwicklertokens.		 Zeichenfolge
Kennwort Dieses Element ist für die interne Verwendung reserviert und wird aus einer zukünftigen Version der API entfernt. Sie müssen das AuthenticationToken-Element verwenden, um Benutzeranmeldeinformationen festzulegen. Zeichenfolge
UserName Dieses Element ist für die interne Verwendung reserviert und wird aus einer zukünftigen Version der API entfernt. Sie müssen das AuthenticationToken-Element verwenden, um Benutzeranmeldeinformationen festzulegen. Zeichenfolge

Antwortelemente

Das GetKeywordLocationsResponse-Objekt definiert den Text und die Headerelemente der Dienstvorgangsantwort. Die Elemente werden in der gleichen Reihenfolge zurückgegeben wie im Antwort-JSON-Code gezeigt.

Antworttextelemente

Element Beschreibung Datentyp
KeywordLocationResult Ein Array von KeywordLocationResult-Datenobjekten . Die Reihenfolge der Elemente entspricht direkt den in der Anforderung angegebenen Schlüsselwörtern. Wenn für eine Schlüsselwort (keyword) keine Standortdaten verfügbar sind, wird die Schlüsselwort (keyword) in die Liste aufgenommen, aber das KeywordLocations-Element des entsprechenden KeywordLocationResult-Objekts ist NULL.

Jedes KeywordLocationResult-Datenobjekt enthält ein Array von KeywordLocation. Das Array enthält ein Element für jedes in der Anforderung angegebene Gerät. Jede KeywordLocation enthält den geografischen Standort und den Prozentsatz der Zeit, die Benutzer am geografischen Standort nach dem angegebenen Schlüsselwort (keyword) gesucht haben.		 KeywordLocationResult-Array

Antwortheaderelemente

Element Beschreibung Datentyp
TrackingId Der Bezeichner des Protokolleintrags, der die Details des API-Aufrufs enthält. Zeichenfolge

JSON anfordern

Diese Vorlage wurde von einem Tool generiert, um die Text- und Headerelemente für die JSON-Anforderung anzuzeigen. Informationen zu unterstützten Typen, die Sie mit diesem Dienstvorgang verwenden können, finden Sie oben in der Referenz zu Anforderungstextelementen .

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

Antwort-JSON

Diese Vorlage wurde von einem Tool generiert, um die Text- und Headerelemente für die JSON-Antwort anzuzeigen.

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

Codesyntax

Um die REST-API über SDKs aufzurufen, müssen Sie das SDK auf eine bestimmte Version aktualisieren und die Systemparameter konfigurieren. Die Beispielsyntax kann mit Bing Ads SDKs verwendet werden. Weitere Beispiele finden Sie unter Codebeispiele für die Bing Ads-API .

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)