Freigeben über


GetDomainCategories-Dienstvorgang – Ad Insight

Ruft die Liste der kategorien ab, die für die Websitedomäne und -sprache verfügbar sind.

Anfordern von Elementen

Das GetDomainCategoriesRequest-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
CategoryName Der Filter "Kategoriename".

Wenn Sie bereits eine oder mehrere der Kategorien kennen, können Sie die Ergebnisliste optional nach Unterkategorie filtern. Es können bis zu drei Kategorieebenen angegeben werden, die durch einen Schrägstrich ("/") getrennt werden müssen. Beispielsweise können Sie den Filter als CategoryL1 / CategoryL2 / CategoryL3 formatieren.

Wenn Sie keinen Kategorienamen angeben, werden alle Kategorien für die Domäne und Sprache zurückgegeben.
Zeichenfolge
DomainName Der Websitename, der den Seiten entspricht, auf die Ihre Anzeigen ausgerichtet sein sollen.

Die maximale Länge der Domäne beträgt 2.048 Zeichen. Sie müssen das Präfix http, https oder www nicht einschließen.
Zeichenfolge
Sprache Die Sprache der Websitedomäne.

Derzeit wird nur Englisch unterstützt, sodass Sie dieses Element auf EN festlegen müssen.
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 GetDomainCategoriesResponse-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
Kategorien Die Liste der Domänenkategorien. DomainCategory-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">GetDomainCategories</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>
    <GetDomainCategoriesRequest xmlns="https://bingads.microsoft.com/AdInsight/v13">
      <CategoryName i:nil="false">ValueHere</CategoryName>
      <DomainName i:nil="false">ValueHere</DomainName>
      <Language i:nil="false">ValueHere</Language>
    </GetDomainCategoriesRequest>
  </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>
    <GetDomainCategoriesResponse xmlns="https://bingads.microsoft.com/AdInsight/v13">
      <Categories d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <DomainCategory>
          <Bid>ValueHere</Bid>
          <CategoryName d4p1:nil="false">ValueHere</CategoryName>
          <Coverage>ValueHere</Coverage>
        </DomainCategory>
      </Categories>
    </GetDomainCategoriesResponse>
  </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<GetDomainCategoriesResponse> GetDomainCategoriesAsync(
	string categoryName,
	string domainName,
	string language)
{
	var request = new GetDomainCategoriesRequest
	{
		CategoryName = categoryName,
		DomainName = domainName,
		Language = language
	};

	return (await AdInsightService.CallAsync((s, r) => s.GetDomainCategoriesAsync(r), request));
}
static GetDomainCategoriesResponse getDomainCategories(
	java.lang.String categoryName,
	java.lang.String domainName,
	java.lang.String language) throws RemoteException, Exception
{
	GetDomainCategoriesRequest request = new GetDomainCategoriesRequest();

	request.setCategoryName(categoryName);
	request.setDomainName(domainName);
	request.setLanguage(language);

	return AdInsightService.getService().getDomainCategories(request);
}
static function GetDomainCategories(
	$categoryName,
	$domainName,
	$language)
{

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

	$request = new GetDomainCategoriesRequest();

	$request->CategoryName = $categoryName;
	$request->DomainName = $domainName;
	$request->Language = $language;

	return $GLOBALS['AdInsightProxy']->GetService()->GetDomainCategories($request);
}
response=adinsight_service.GetDomainCategories(
	CategoryName=CategoryName,
	DomainName=DomainName,
	Language=Language)

Anforderungen

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

Anforderungs-URL

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

Anfordern von Elementen

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

Hinweis

Sofern unten nicht anders angegeben, sind alle Anforderungselemente erforderlich.

Anforderungstextelemente

Element Beschreibung Datentyp
CategoryName Der Filter "Kategoriename".

Wenn Sie bereits eine oder mehrere der Kategorien kennen, können Sie die Ergebnisliste optional nach Unterkategorie filtern. Es können bis zu drei Kategorieebenen angegeben werden, die durch einen Schrägstrich ("/") getrennt werden müssen. Beispielsweise können Sie den Filter als CategoryL1 / CategoryL2 / CategoryL3 formatieren.

Wenn Sie keinen Kategorienamen angeben, werden alle Kategorien für die Domäne und Sprache zurückgegeben.
Zeichenfolge
DomainName Der Websitename, der den Seiten entspricht, auf die Ihre Anzeigen ausgerichtet sein sollen.

Die maximale Länge der Domäne beträgt 2.048 Zeichen. Sie müssen das Präfix http, https oder www nicht einschließen.
Zeichenfolge
Sprache Die Sprache der Websitedomäne.

Derzeit wird nur Englisch unterstützt, sodass Sie dieses Element auf EN festlegen müssen.
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 GetDomainCategoriesResponse-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
Kategorien Die Liste der Domänenkategorien. DomainCategory-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 .

{
  "CategoryName": "ValueHere",
  "DomainName": "ValueHere",
  "Language": "ValueHere"
}

Antwort-JSON

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

{
  "Categories": [
    {
      "Bid": DoubleValueHere,
      "CategoryName": "ValueHere",
      "Coverage": 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<GetDomainCategoriesResponse> GetDomainCategoriesAsync(
	string categoryName,
	string domainName,
	string language)
{
	var request = new GetDomainCategoriesRequest
	{
		CategoryName = categoryName,
		DomainName = domainName,
		Language = language
	};

	return (await AdInsightService.CallAsync((s, r) => s.GetDomainCategoriesAsync(r), request));
}
static GetDomainCategoriesResponse getDomainCategories(
	java.lang.String categoryName,
	java.lang.String domainName,
	java.lang.String language) throws RemoteException, Exception
{
	GetDomainCategoriesRequest request = new GetDomainCategoriesRequest();

	request.setCategoryName(categoryName);
	request.setDomainName(domainName);
	request.setLanguage(language);

	return AdInsightService.getService().getDomainCategories(request);
}
static function GetDomainCategories(
	$categoryName,
	$domainName,
	$language)
{

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

	$request = new GetDomainCategoriesRequest();

	$request->CategoryName = $categoryName;
	$request->DomainName = $domainName;
	$request->Language = $language;

	return $GLOBALS['AdInsightProxy']->GetService()->GetDomainCategories($request);
}
response=adinsight_service.GetDomainCategories(
	CategoryName=CategoryName,
	DomainName=DomainName,
	Language=Language)