GetEstimatedPositionByKeywords-Dienstvorgang – Ad Insight
Ruft die geschätzte Position in den Suchergebnissen ab, wenn der angegebene Gebotswert für die angegebenen Schlüsselwörter verwendet würde. Darüber hinaus bietet der Vorgang Schätzungen von Klicks, durchschnittlichen Kosten pro Klick (CPC) und Impressionen, die die Schlüsselwörter mit dem geschätzten Gebot generieren könnten.
Die Schätzungen stellen keine Vorhersage oder Garantie für die zukünftige Leistung dar.
Hinweis
Dieser Vorgang ist für Suchkampagnen mit der erweiterten CPC-Gebotsstrategie vorgesehen.
Anfordern von Elementen
Das GetEstimatedPositionByKeywordsRequest-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 |
|---|---|---|
| AdGroupId | Der Bezeichner der Anzeigengruppe, deren Leistungsdaten verwendet werden, um die Leistung der Schlüsselwort (keyword) im Kontext der Anzeigengruppe zu bestimmen. Das Angeben einer Anzeigengruppe trägt dazu bei, die Genauigkeit der vorgeschlagenen Position zu verbessern. Wenn Sie eine Anzeigengruppe angeben, müssen Sie die Kampagne angeben, zu der sie gehört. |
Lange |
| CampaignId | Der Bezeichner der Kampagne, die besitzer der in AdGroupId angegebenen Anzeigengruppe ist. Wenn Sie keine Anzeigengruppe angeben, werden anhand der Leistungsdaten der Kampagne ermittelt, wie gut die Schlüsselwort (keyword) im Kontext der Kampagne funktionieren könnten. Das Angeben einer Kampagne und einer Anzeigengruppe trägt dazu bei, die Genauigkeit der vorgeschlagenen Position zu verbessern. Wenn weder AdGroupId noch CampaignId angegeben sind, verwendet der Vorgang das angegebene CustomerAccountId-Headerelement, um die Leistung der Schlüsselwort (keyword) im Kontext des Kontos zu bestimmen. |
Lange |
| CurrencyCode | Der ISO-Code für die Währungseinheit, die zum Berechnen der Kostenschätzungen und des vorgeschlagenen Gebotswerts verwendet werden soll. Falls nicht festgelegt, bestimmt der Dienst die Währung aus dem Konto, das im Headerelement CustomerAccountId angegeben ist. Wenn weder Currency noch CustomerAccountId festgelegt ist, verwendet der Dienst USD. |
CurrencyCode |
| Schlüsselwörter | Ein Array von Schlüsselwörtern, für die Sie die geschätzte Position in den Suchergebnissen basierend auf dem angegebenen Gebotswert abrufen möchten. Sie können maximal 1.000 Schlüsselwörter angeben, und jedes Schlüsselwort (keyword) darf maximal 100 Zeichen enthalten. | Zeichenfolgenarray |
| Sprache | Die Sprache, die parallel zu Standortbezeichnern zum Schätzen der Position verwendet wird. Die Sprache muss an jedem der Speicherorte unterstützt werden, die Sie in LocationIds angeben. Mögliche Sprachwerte finden Sie unter Anzeigensprachen. Wenn Sie die Sprache nicht angeben, verwendet der Dienstvorgang die Sprache der angegebenen AdGroupId oder CampaignId. Wenn keine dieser Eigenschaften festgelegt ist, wird standardmäßig EN (Englisch) verwendet. |
Zeichenfolge |
| LocationIds | Der Bezeichner oder die Bezeichner der geografischen Standorte, die zum Schätzen der Position verwendet werden sollen. Alle Speicherorte müssen die im Language-Element angegebene Sprache unterstützen. Obwohl Sie mehrere Standortbezeichner angeben können, sollten Sie als bewährte Methode für die genauesten Positionsschätzungen pro Standort nur einen Standort pro Dienstaufruf angeben. Informationen zu möglichen Standortbezeichnern finden Sie unter Geografische Standortcodes. Wenn Sie keine Standorte angeben, verwendet der Dienstvorgang die Standortkriterien der angegebenen AdGroupId oder CampaignId. Wenn keine dieser Eigenschaften festgelegt ist, wird standardmäßig 190 (USA) verwendet. |
langes Array |
| MatchTypes | Ein Array eindeutiger Übereinstimmungstypen, für die Sie Schätzungen abrufen möchten. Sie dürfen den Inhalts-Übereinstimmungstyp nicht angeben. |
MatchType-Array |
| MaxBid | Der maximale Gebotswert, der verwendet werden soll, um die geschätzte Position in den Suchergebnissen zu bestimmen. | Doppel |
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 GetEstimatedPositionByKeywordsResponse-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 |
|---|---|---|
| KeywordEstimatedPositions | Ein Array von KeywordEstimatedPosition-Datenobjekten . Das Array enthält ein Element für jede in der Anforderung angegebene Schlüsselwort (keyword). Wenn die Schlüsselwort (keyword) ungültig ist, ist das entsprechende Element im Array NULL. Wenn Daten für die Schlüsselwort (keyword) verfügbar sind, gibt EstimatedPositionAndTraffic die geschätzte Position in den Suchergebnissen an, an der Ihre Anzeigen angezeigt werden könnten, basierend auf dem angegebenen Gebotswert. Andernfalls wird das EstimatedPositions-Element auf NULL festgelegt. |
KeywordEstimatedPosition-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">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>
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>
<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>
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<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)
Anforderungen
Dienst: AdInsightService.svc v13
Namespace: https://bingads.microsoft.com/AdInsight/v13