Freigeben über


SuggestKeywordsForUrl-Dienstvorgang – Ad Insight

Schlägt die möglichen Schlüsselwörter für den Inhalt unter der angegebenen URL vor.

Anfordern von Elementen

Das SuggestKeywordsForUrlRequest-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
ExcludeBrand Ein -Wert, der bestimmt, ob die Ergebnisse Markenschlüsselwörter ausschließen. Um Markenschlüsselwörter im Ergebnis auszuschließen, legen Sie auf true fest. Der Standardwert ist „false“. boolean
Sprache Die sprache, die von der Website verwendet wird.

Mögliche Werte finden Sie unter Anzeigensprachen.

Der Standardwert ist Englisch.
Zeichenfolge
MaxKeywords Ein positiver ganzzahliger Wert, der die maximale Anzahl von Schlüsselwörtern angibt, die zurückgegeben werden sollen. Der Maximalwert, den Sie angeben können, ist 800.

Der Standardwert ist 10.
int
MinConfidenceScore Ein Filterwert, der die Schlüsselwörter, die der Dienst zurückgibt, auf diejenigen beschränkt, die eine Zuverlässigkeitsbewertung aufweisen, die größer oder gleich der angegebenen Bewertung ist. Sie können beispielsweise angeben, dass der Vorgang nur Schlüsselwörter zurückgibt, die eine Zuverlässigkeitsbewertung von mindestens 80 Prozent (0,8) aufweisen.

Wenn null, wird die Zuverlässigkeitsbewertung nicht verwendet, um die Ergebnisse einzuschränken.
doppelt
URL Die URL der Webseite, die nach möglichen Schlüsselwörtern gesucht werden soll. Die URL darf maximal 2.000 Zeichen enthalten. 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 SuggestKeywordsForUrlResponse-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
Schlüsselwörter Ein Array von KeywordAndConfidence-Objekten , das die möglichen Schlüsselwörter enthält, die im Inhalt der angegebenen URL gefunden werden. Darüber hinaus enthält das -Objekt eine Bewertung, die die Wahrscheinlichkeit angibt, dass die Verwendung des Schlüsselwort (keyword) dazu führen würde, dass die URL in die Ergebnisse einer Suchabfrage einbezogen wird.

Die Ergebnisse werden in der Reihenfolge sortiert, von Schlüsselwörtern mit der höchsten Konfidenzbewertung bis hin zu Schlüsselwörtern mit der niedrigsten Zuverlässigkeitsbewertung.
KeywordAndConfidence-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">SuggestKeywordsForUrl</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>
    <SuggestKeywordsForUrlRequest xmlns="https://bingads.microsoft.com/AdInsight/v13">
      <Url i:nil="false">ValueHere</Url>
      <Language i:nil="false">ValueHere</Language>
      <MaxKeywords i:nil="false">ValueHere</MaxKeywords>
      <MinConfidenceScore i:nil="false">ValueHere</MinConfidenceScore>
      <ExcludeBrand i:nil="false">ValueHere</ExcludeBrand>
    </SuggestKeywordsForUrlRequest>
  </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>
    <SuggestKeywordsForUrlResponse xmlns="https://bingads.microsoft.com/AdInsight/v13">
      <Keywords d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <KeywordAndConfidence>
          <SuggestedKeyword d4p1:nil="false">ValueHere</SuggestedKeyword>
          <ConfidenceScore>ValueHere</ConfidenceScore>
        </KeywordAndConfidence>
      </Keywords>
    </SuggestKeywordsForUrlResponse>
  </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<SuggestKeywordsForUrlResponse> SuggestKeywordsForUrlAsync(
	string url,
	string language,
	int? maxKeywords,
	double? minConfidenceScore,
	bool? excludeBrand)
{
	var request = new SuggestKeywordsForUrlRequest
	{
		Url = url,
		Language = language,
		MaxKeywords = maxKeywords,
		MinConfidenceScore = minConfidenceScore,
		ExcludeBrand = excludeBrand
	};

	return (await AdInsightService.CallAsync((s, r) => s.SuggestKeywordsForUrlAsync(r), request));
}
static SuggestKeywordsForUrlResponse suggestKeywordsForUrl(
	java.lang.String url,
	java.lang.String language,
	int maxKeywords,
	double minConfidenceScore,
	boolean excludeBrand) throws RemoteException, Exception
{
	SuggestKeywordsForUrlRequest request = new SuggestKeywordsForUrlRequest();

	request.setUrl(url);
	request.setLanguage(language);
	request.setMaxKeywords(maxKeywords);
	request.setMinConfidenceScore(minConfidenceScore);
	request.setExcludeBrand(excludeBrand);

	return AdInsightService.getService().suggestKeywordsForUrl(request);
}
static function SuggestKeywordsForUrl(
	$url,
	$language,
	$maxKeywords,
	$minConfidenceScore,
	$excludeBrand)
{

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

	$request = new SuggestKeywordsForUrlRequest();

	$request->Url = $url;
	$request->Language = $language;
	$request->MaxKeywords = $maxKeywords;
	$request->MinConfidenceScore = $minConfidenceScore;
	$request->ExcludeBrand = $excludeBrand;

	return $GLOBALS['AdInsightProxy']->GetService()->SuggestKeywordsForUrl($request);
}
response=adinsight_service.SuggestKeywordsForUrl(
	Url=Url,
	Language=Language,
	MaxKeywords=MaxKeywords,
	MinConfidenceScore=MinConfidenceScore,
	ExcludeBrand=ExcludeBrand)

Anforderungen

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

Anforderungs-URL

https://adinsight.api.bingads.microsoft.com/AdInsight/v13/KeywordSuggestions/QueryByUrl

Anfordern von Elementen

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

Hinweis

Sofern unten nicht anders angegeben, sind alle Anforderungselemente erforderlich.

Anforderungstextelemente

Element Beschreibung Datentyp
ExcludeBrand Ein -Wert, der bestimmt, ob die Ergebnisse Markenschlüsselwörter ausschließen. Um Markenschlüsselwörter im Ergebnis auszuschließen, legen Sie auf true fest. Der Standardwert ist „false“. boolean
Sprache Die sprache, die von der Website verwendet wird.

Mögliche Werte finden Sie unter Anzeigensprachen.

Der Standardwert ist Englisch.
Zeichenfolge
MaxKeywords Ein positiver ganzzahliger Wert, der die maximale Anzahl von Schlüsselwörtern angibt, die zurückgegeben werden sollen. Der Maximalwert, den Sie angeben können, ist 800.

Der Standardwert ist 10.
int
MinConfidenceScore Ein Filterwert, der die Schlüsselwörter, die der Dienst zurückgibt, auf diejenigen beschränkt, die eine Zuverlässigkeitsbewertung aufweisen, die größer oder gleich der angegebenen Bewertung ist. Sie können beispielsweise angeben, dass der Vorgang nur Schlüsselwörter zurückgibt, die eine Zuverlässigkeitsbewertung von mindestens 80 Prozent (0,8) aufweisen.

Wenn null, wird die Zuverlässigkeitsbewertung nicht verwendet, um die Ergebnisse einzuschränken.
doppelt
URL Die URL der Webseite, die nach möglichen Schlüsselwörtern gesucht werden soll. Die URL darf maximal 2.000 Zeichen enthalten. 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 SuggestKeywordsForUrlResponse-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
Schlüsselwörter Ein Array von KeywordAndConfidence-Objekten , das die möglichen Schlüsselwörter enthält, die im Inhalt der angegebenen URL gefunden werden. Darüber hinaus enthält das -Objekt eine Bewertung, die die Wahrscheinlichkeit angibt, dass die Verwendung des Schlüsselwort (keyword) dazu führen würde, dass die URL in die Ergebnisse einer Suchabfrage einbezogen wird.

Die Ergebnisse werden in der Reihenfolge sortiert, von Schlüsselwörtern mit der höchsten Konfidenzbewertung bis hin zu Schlüsselwörtern mit der niedrigsten Zuverlässigkeitsbewertung.
KeywordAndConfidence-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 .

{
  "Url": "ValueHere",
  "Language": "ValueHere",
  "MaxKeywords": IntValueHere,
  "MinConfidenceScore": DoubleValueHere,
  "ExcludeBrand": "ValueHere"
}

Antwort-JSON

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

{
  "Keywords": [
    {
      "ConfidenceScore": DoubleValueHere,
      "SuggestedKeyword": "ValueHere"
    }
  ]
}

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<SuggestKeywordsForUrlResponse> SuggestKeywordsForUrlAsync(
	string url,
	string language,
	int? maxKeywords,
	double? minConfidenceScore,
	bool? excludeBrand)
{
	var request = new SuggestKeywordsForUrlRequest
	{
		Url = url,
		Language = language,
		MaxKeywords = maxKeywords,
		MinConfidenceScore = minConfidenceScore,
		ExcludeBrand = excludeBrand
	};

	return (await AdInsightService.CallAsync((s, r) => s.SuggestKeywordsForUrlAsync(r), request));
}
static SuggestKeywordsForUrlResponse suggestKeywordsForUrl(
	java.lang.String url,
	java.lang.String language,
	int maxKeywords,
	double minConfidenceScore,
	boolean excludeBrand) throws RemoteException, Exception
{
	SuggestKeywordsForUrlRequest request = new SuggestKeywordsForUrlRequest();

	request.setUrl(url);
	request.setLanguage(language);
	request.setMaxKeywords(maxKeywords);
	request.setMinConfidenceScore(minConfidenceScore);
	request.setExcludeBrand(excludeBrand);

	return AdInsightService.getService().suggestKeywordsForUrl(request);
}
static function SuggestKeywordsForUrl(
	$url,
	$language,
	$maxKeywords,
	$minConfidenceScore,
	$excludeBrand)
{

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

	$request = new SuggestKeywordsForUrlRequest();

	$request->Url = $url;
	$request->Language = $language;
	$request->MaxKeywords = $maxKeywords;
	$request->MinConfidenceScore = $minConfidenceScore;
	$request->ExcludeBrand = $excludeBrand;

	return $GLOBALS['AdInsightProxy']->GetService()->SuggestKeywordsForUrl($request);
}
response=adinsight_service.SuggestKeywordsForUrl(
	Url=Url,
	Language=Language,
	MaxKeywords=MaxKeywords,
	MinConfidenceScore=MinConfidenceScore,
	ExcludeBrand=ExcludeBrand)