GetHistoricalKeywordPerformance Service-Vorgang – Ad Insight

Ruft die historische Leistung des normalisierten Suchbegriffs ab. Die Ergebnisse werden nach Gerätetyp aggregiert.

Anfordern von Elementen

Das GetHistoricalKeywordPerformanceRequest-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äte	Eine Liste mit einem oder mehreren der folgenden Gerätetypen: Computer, Nichtsmartphones, Smartphones, Tablets. Der Standardwert ist Computer. Die Antwort enthält Schlüsselwort (keyword) Leistungsdaten für die Gerätetypen, die Sie nur angeben, sofern verfügbar. Wird verwendet, um die Leistung eines Schlüsselwort (keyword) für die angegebenen Gerätetypen zu bestimmen.	Zeichenfolgenarray
Schlüsselwörter	Ein Array von Schlüsselwörtern, für die Sie verlaufsbezogene Leistungsstatistiken abrufen möchten. 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. Die Länder/Regionen, die Sie im PublisherCountries-Element angeben, müssen die angegebene Sprache unterstützen. Mögliche Werte sind Dänisch, Niederländisch, Englisch, Finnisch, Französisch, Deutsch, Italienisch, Norwegisch, Portugiesisch, Spanisch, Schwedisch und TraditionellChinesisch.	Zeichenfolge
MatchTypes	Die Übereinstimmungstypen, für die Sie Verlaufsdaten abrufen möchten. Sie dürfen den Inhalts-Übereinstimmungstyp nicht angeben.	MatchType-Array
PublisherCountries	Die Ländercodes der Länder/Regionen, die als Quelle der Verlaufsdaten verwendet werden sollen. Sie können einen oder mehrere Ländercodes angeben. Jedes Land/jede Region, die Sie angeben, muss die im Language-Element angegebene Sprache unterstützen. Die folgenden Kombinationen aus Sprache und Land/Region werden unterstützt: Dänisch: DK Niederländisch: NL Englisch: AU, CA, GB, ID, IN, MY, PH, SG, TH, US, VN Finnisch: FI Französisch: CA, FR Deutsch: AT, CH, DE Italienisch: IT Norwegisch: NB Portugiesisch: BR Spanisch: AR, CL, CO, ES, MX, PE, VE Schwedisch: SE TraditionalChinesisch: HK, TW Wenn dieses Element NULL ist, umfasst der Dienst standardmäßig alle Länder/Regionen, die die angegebene Sprache unterstützen.	Zeichenfolgenarray
TargetAdPosition	Die Position der Suchergebnisse, für die Sie Leistungsdaten abrufen möchten. Wenn Sie z. B. Leistungsdaten abrufen möchten, wenn Anzeigen an der ersten Position der Hauptlinie mit dem Schlüsselwort (keyword) und dem Übereinstimmungstyp angezeigt werden, legen Sie dieses Element auf MainLine1 fest. Legen Sie dieses Element auf Alle fest, um Leistungsdaten zu erhalten, wenn Anzeigen an einer beliebigen Position der Suchergebnisse angezeigt werden, indem Sie die Schlüsselwort (keyword) und den Übereinstimmungstyp verwenden. SixMonths Wenn Sie für dieses Element Alle angeben, gibt der Dienst für jede unterstützte Anzeigenposition mehrere Ergebnisse pro Schlüsselwort (keyword) zurück. Wenn Sie Aggregat angeben, gibt der Dienst ein aggregiertes Ergebnis zurück. Seitenleistenanzeigen werden nicht mehr auf Bing-eigenen und betriebenen Websites im USA. Wenn Sie nur Daten der ersten Seite anfordern, z. B. FirstPage1 für die USA (USA), ist das KeywordKPIs-Element im Ergebnis null/leer. Wenn Sie in derselben Anforderung zusätzliche Länder/Regionen wie z. B. USA und Zertifizierungsstelle einschließen, werden alle Ergebnisse der ersten Seite nur Ländern/Regionen außerhalb des USA zugeordnet.	AdPosition
TimeInterval	Der Zeitraum, in dem die Daten identifiziert werden, die verwendet werden sollen, um den Schlüsselleistungsindex der angegebenen Schlüsselwörter zu bestimmen. Verwenden Sie beispielsweise Daten der letzten sieben Tage oder der letzten 30 Tage, um die Schlüsselwort (keyword) Leistung zu bestimmen. Der Standardwert ist LastDay.	TimeInterval

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 GetHistoricalKeywordPerformanceResponse-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
KeywordHistoricalPerformances	Ein Array von KeywordHistoricalPerformance-Datenobjekten . Das Array enthält ein Element für jedes in der Anforderung angegebene Schlüsselwort (keyword), Gerät, Übereinstimmungstyp und Anzeigenposition. Wenn die Schlüsselwort (keyword) ungültig ist oder keine Daten verfügbar sind, ist das entsprechende Element im Array NULL.	KeywordHistoricalPerformance-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">GetHistoricalKeywordPerformance</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>
    <GetHistoricalKeywordPerformanceRequest 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>
      <TimeInterval i:nil="false">ValueHere</TimeInterval>
      <TargetAdPosition i:nil="false">ValueHere</TargetAdPosition>
      <MatchTypes i:nil="false">
        <MatchType>ValueHere</MatchType>
      </MatchTypes>
      <Language i:nil="false">ValueHere</Language>
      <PublisherCountries i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <a1:string>ValueHere</a1:string>
      </PublisherCountries>
      <Devices i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <a1:string>ValueHere</a1:string>
      </Devices>
    </GetHistoricalKeywordPerformanceRequest>
  </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>
    <GetHistoricalKeywordPerformanceResponse xmlns="https://bingads.microsoft.com/AdInsight/v13">
      <KeywordHistoricalPerformances d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <KeywordHistoricalPerformance>
          <Keyword d4p1:nil="false">ValueHere</Keyword>
          <KeywordKPIs d4p1:nil="false">
            <KeywordKPI>
              <Device d4p1:nil="false">ValueHere</Device>
              <MatchType>ValueHere</MatchType>
              <AdPosition>ValueHere</AdPosition>
              <Clicks>ValueHere</Clicks>
              <Impressions>ValueHere</Impressions>
              <AverageCPC>ValueHere</AverageCPC>
              <CTR>ValueHere</CTR>
              <TotalCost>ValueHere</TotalCost>
              <AverageBid>ValueHere</AverageBid>
            </KeywordKPI>
          </KeywordKPIs>
        </KeywordHistoricalPerformance>
      </KeywordHistoricalPerformances>
    </GetHistoricalKeywordPerformanceResponse>
  </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<GetHistoricalKeywordPerformanceResponse> GetHistoricalKeywordPerformanceAsync(
	IList<string> keywords,
	TimeInterval? timeInterval,
	AdPosition? targetAdPosition,
	IList<MatchType> matchTypes,
	string language,
	IList<string> publisherCountries,
	IList<string> devices)
{
	var request = new GetHistoricalKeywordPerformanceRequest
	{
		Keywords = keywords,
		TimeInterval = timeInterval,
		TargetAdPosition = targetAdPosition,
		MatchTypes = matchTypes,
		Language = language,
		PublisherCountries = publisherCountries,
		Devices = devices
	};

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

static GetHistoricalKeywordPerformanceResponse getHistoricalKeywordPerformance(
	ArrayOfstring keywords,
	TimeInterval timeInterval,
	AdPosition targetAdPosition,
	ArrayOfMatchType matchTypes,
	java.lang.String language,
	ArrayOfstring publisherCountries,
	ArrayOfstring devices) throws RemoteException, Exception
{
	GetHistoricalKeywordPerformanceRequest request = new GetHistoricalKeywordPerformanceRequest();

	request.setKeywords(keywords);
	request.setTimeInterval(timeInterval);
	request.setTargetAdPosition(targetAdPosition);
	request.setMatchTypes(matchTypes);
	request.setLanguage(language);
	request.setPublisherCountries(publisherCountries);
	request.setDevices(devices);

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

static function GetHistoricalKeywordPerformance(
	$keywords,
	$timeInterval,
	$targetAdPosition,
	$matchTypes,
	$language,
	$publisherCountries,
	$devices)
{

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

	$request = new GetHistoricalKeywordPerformanceRequest();

	$request->Keywords = $keywords;
	$request->TimeInterval = $timeInterval;
	$request->TargetAdPosition = $targetAdPosition;
	$request->MatchTypes = $matchTypes;
	$request->Language = $language;
	$request->PublisherCountries = $publisherCountries;
	$request->Devices = $devices;

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

response=adinsight_service.GetHistoricalKeywordPerformance(
	Keywords=Keywords,
	TimeInterval=TimeInterval,
	TargetAdPosition=TargetAdPosition,
	MatchTypes=MatchTypes,
	Language=Language,
	PublisherCountries=PublisherCountries,
	Devices=Devices)

Anforderungen

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