GetAuctionInsightData Service-Vorgang – Ad Insight

Ruft Auktionserkenntnisse für ein Konto, Kampagnen, Anzeigengruppen oder Schlüsselwörter ab.

Indem Sie Zeigen, wo Sie erfolgreich sind und wo Sie möglicherweise Möglichkeiten für eine verbesserte Leistung verpassen, können die Erkenntnisse zu Auktionen Ihnen helfen, strategische Optimierungsentscheidungen zu treffen.

Wenn es sich um eine neue Kampagne handelt oder Sie über zu wenige Impressionen verfügen, werden die Auktionserkenntnisse nicht generiert.

Die Datenaufbewahrungsdauer beträgt 180 Tage.

Anfordern von Elementen

Das GetAuctionInsightDataRequest-Objekt definiert die Body- und 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
EntityIds	Die Microsoft Advertising-Bezeichner für bis zu 200 Kampagnen, Anzeigengruppen oder Schlüsselwörter. Dieses Element ist für die Entitätstypen Kampagne, Anzeigengruppe und Schlüsselwort (keyword) erforderlich. Wenn EntityType account ist, ist dieses Element optional und überschreibt den im CustomerAccountId-Header festgelegten Wert. Unabhängig vom Entitätstyp müssen Sie die Headerelemente CustomerId und CustomerAccountId festlegen.	langes Array
EntityType	Die Entitätsebene, auf der Sie Auktionserkenntnisse anfordern möchten. Die unterstützten Werte sind Account, Campaign, AdGroup und Keyword. Dieses Element ist erforderlich.	EntityType
ReturnAdditionalFields	Die Liste der zusätzlichen Eigenschaften, die in jedem zurückgegebenen KPI für Auktionserkenntnisse enthalten sein sollen. Mit den zusätzlichen Feldwerten können Sie die neuesten Features mithilfe der aktuellen Version der Ad Insight-API abrufen, und in der nächsten Version sind die entsprechenden Elemente standardmäßig enthalten. Dieses Anforderungselement ist optional.	AuctionInsightKpiAdditionalField
SearchParameters	Die Suchparameter definieren Ihre Kriterien und Filter für die Auktionserkenntnisse. Sie müssen genau einen DateRangeSearchParameter einschließen. Darüber hinaus können Sie optional bis zu drei verschiedene AuctionSegmentSearchParameter-Objekte einschließen, z. B. für Day, DayOfWeek und Device. Andere Objekte, die von SearchParameter abgeleitet werden, sind für diesen Vorgang ungültig.	SearchParameter-Array

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 GetAuctionInsightDataResponse-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
Ergebnis	Enthält die Auktionserkenntnisse für die angeforderte Entität, den Datumsbereich und die Segmentsuchparameter.	AuctionInsightResult

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">GetAuctionInsightData</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>
    <GetAuctionInsightDataRequest xmlns="https://bingads.microsoft.com/AdInsight/v13">
      <EntityType>ValueHere</EntityType>
      <EntityIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <a1:long>ValueHere</a1:long>
      </EntityIds>
      <SearchParameters i:nil="false">
        <SearchParameter i:type="-- derived type specified here with the appropriate prefix --">
          <!--These fields are applicable if the derived type attribute is set to DateRangeSearchParameter-->
          <EndDate i:nil="false">
            <Day>ValueHere</Day>
            <Month>ValueHere</Month>
            <Year>ValueHere</Year>
          </EndDate>
          <StartDate i:nil="false">
            <Day>ValueHere</Day>
            <Month>ValueHere</Month>
            <Year>ValueHere</Year>
          </StartDate>
          <!--This field is applicable if the derived type attribute is set to AuctionSegmentSearchParameter-->
          <Segment>ValueHere</Segment>
        </SearchParameter>
      </SearchParameters>
      <ReturnAdditionalFields i:nil="false">ValueHere</ReturnAdditionalFields>
    </GetAuctionInsightDataRequest>
  </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>
    <GetAuctionInsightDataResponse xmlns="https://bingads.microsoft.com/AdInsight/v13">
      <Result d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <Segments d4p1:nil="false">
          <AuctionSegment>ValueHere</AuctionSegment>
        </Segments>
        <Entries d4p1:nil="false">
          <AuctionInsightEntry>
            <DisplayDomain d4p1:nil="false">ValueHere</DisplayDomain>
            <AggregatedKpi d4p1:nil="false">
              <Segments d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                <a1:string>ValueHere</a1:string>
              </Segments>
              <ImpressionShare>ValueHere</ImpressionShare>
              <OverlapRate>ValueHere</OverlapRate>
              <AveragePosition>ValueHere</AveragePosition>
              <AboveRate>ValueHere</AboveRate>
              <TopOfPageRate>ValueHere</TopOfPageRate>
              <OutrankingShare>ValueHere</OutrankingShare>
              <AbsoluteTopOfPageRate>ValueHere</AbsoluteTopOfPageRate>
            </AggregatedKpi>
            <SegmentedKpis d4p1:nil="false">
              <AuctionInsightKpi>
                <Segments d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                  <a1:string>ValueHere</a1:string>
                </Segments>
                <ImpressionShare>ValueHere</ImpressionShare>
                <OverlapRate>ValueHere</OverlapRate>
                <AveragePosition>ValueHere</AveragePosition>
                <AboveRate>ValueHere</AboveRate>
                <TopOfPageRate>ValueHere</TopOfPageRate>
                <OutrankingShare>ValueHere</OutrankingShare>
                <AbsoluteTopOfPageRate>ValueHere</AbsoluteTopOfPageRate>
              </AuctionInsightKpi>
            </SegmentedKpis>
          </AuctionInsightEntry>
        </Entries>
        <UsedImpressions>ValueHere</UsedImpressions>
        <UsedKeywords>ValueHere</UsedKeywords>
      </Result>
    </GetAuctionInsightDataResponse>
  </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<GetAuctionInsightDataResponse> GetAuctionInsightDataAsync(
	EntityType entityType,
	IList<long> entityIds,
	IList<SearchParameter> searchParameters,
	AuctionInsightKpiAdditionalField? returnAdditionalFields)
{
	var request = new GetAuctionInsightDataRequest
	{
		EntityType = entityType,
		EntityIds = entityIds,
		SearchParameters = searchParameters,
		ReturnAdditionalFields = returnAdditionalFields
	};

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

static GetAuctionInsightDataResponse getAuctionInsightData(
	EntityType entityType,
	ArrayOflong entityIds,
	ArrayOfSearchParameter searchParameters,
	ArrayList<AuctionInsightKpiAdditionalField> returnAdditionalFields) throws RemoteException, Exception
{
	GetAuctionInsightDataRequest request = new GetAuctionInsightDataRequest();

	request.setEntityType(entityType);
	request.setEntityIds(entityIds);
	request.setSearchParameters(searchParameters);
	request.setReturnAdditionalFields(returnAdditionalFields);

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

static function GetAuctionInsightData(
	$entityType,
	$entityIds,
	$searchParameters,
	$returnAdditionalFields)
{

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

	$request = new GetAuctionInsightDataRequest();

	$request->EntityType = $entityType;
	$request->EntityIds = $entityIds;
	$request->SearchParameters = $searchParameters;
	$request->ReturnAdditionalFields = $returnAdditionalFields;

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

response=adinsight_service.GetAuctionInsightData(
	EntityType=EntityType,
	EntityIds=EntityIds,
	SearchParameters=SearchParameters,
	ReturnAdditionalFields=ReturnAdditionalFields)

Anforderungen

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

Anforderungs-URL

Produktions-URL

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

Sandbox-URL

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

Anfordern von Elementen

Das GetAuctionInsightDataRequest-Objekt definiert die Body- und Headerelemente der Dienstvorgangsanforderung.

Hinweis

Sofern unten nicht anders angegeben, sind alle Anforderungselemente erforderlich.

Anforderungstextelemente

Element	Beschreibung	Datentyp
EntityIds	Die Microsoft Advertising-Bezeichner für bis zu 200 Kampagnen, Anzeigengruppen oder Schlüsselwörter. Dieses Element ist für die Entitätstypen Kampagne, Anzeigengruppe und Schlüsselwort (keyword) erforderlich. Wenn EntityType account ist, ist dieses Element optional und überschreibt den im CustomerAccountId-Header festgelegten Wert. Unabhängig vom Entitätstyp müssen Sie die Headerelemente CustomerId und CustomerAccountId festlegen.	langes Array
EntityType	Die Entitätsebene, auf der Sie Auktionserkenntnisse anfordern möchten. Die unterstützten Werte sind Account, Campaign, AdGroup und Keyword. Dieses Element ist erforderlich.	EntityType
ReturnAdditionalFields	Die Liste der zusätzlichen Eigenschaften, die in jedem zurückgegebenen KPI für Auktionserkenntnisse enthalten sein sollen. Mit den zusätzlichen Feldwerten können Sie die neuesten Features mithilfe der aktuellen Version der Ad Insight-API abrufen, und in der nächsten Version sind die entsprechenden Elemente standardmäßig enthalten. Dieses Anforderungselement ist optional.	AuctionInsightKpiAdditionalField
SearchParameters	Die Suchparameter definieren Ihre Kriterien und Filter für die Auktionserkenntnisse. Sie müssen genau einen DateRangeSearchParameter einschließen. Darüber hinaus können Sie optional bis zu drei verschiedene AuctionSegmentSearchParameter-Objekte einschließen, z. B. für Day, DayOfWeek und Device. Andere Objekte, die von SearchParameter abgeleitet werden, sind für diesen Vorgang ungültig.	SearchParameter-Array

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 GetAuctionInsightDataResponse-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
Ergebnis	Enthält die Auktionserkenntnisse für die angeforderte Entität, den Datumsbereich und die Segmentsuchparameter.	AuctionInsightResult

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 .

{
  "EntityType": "ValueHere",
  "EntityIds": [
    "LongValueHere"
  ],
  "SearchParameters": [
    {
      "EndDate": {
        "Day": "ValueHere",
        "Month": "ValueHere",
        "Year": "ValueHere"
      },
      "StartDate": {
        "Day": "ValueHere",
        "Month": "ValueHere",
        "Year": "ValueHere"
      },
      "Segment": "ValueHere"
    }
  ],
  "ReturnAdditionalFields": "ValueHere"
}

Antwort-JSON

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

{
  "Result": {
    "Entries": [
      {
        "AggregatedKpi": {
          "AboveRate": DoubleValueHere,
          "AbsoluteTopOfPageRate": DoubleValueHere,
          "AveragePosition": DoubleValueHere,
          "ImpressionShare": DoubleValueHere,
          "OutrankingShare": DoubleValueHere,
          "OverlapRate": DoubleValueHere,
          "Segments": [
            "ValueHere"
          ],
          "TopOfPageRate": DoubleValueHere
        },
        "DisplayDomain": "ValueHere",
        "SegmentedKpis": [
          {
            "AboveRate": DoubleValueHere,
            "AbsoluteTopOfPageRate": DoubleValueHere,
            "AveragePosition": DoubleValueHere,
            "ImpressionShare": DoubleValueHere,
            "OutrankingShare": DoubleValueHere,
            "OverlapRate": DoubleValueHere,
            "Segments": [
              "ValueHere"
            ],
            "TopOfPageRate": DoubleValueHere
          }
        ]
      }
    ],
    "Segments": [
      "ValueHere"
    ],
    "UsedImpressions": DoubleValueHere,
    "UsedKeywords": 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<GetAuctionInsightDataResponse> GetAuctionInsightDataAsync(
	EntityType entityType,
	IList<long> entityIds,
	IList<SearchParameter> searchParameters,
	AuctionInsightKpiAdditionalField? returnAdditionalFields)
{
	var request = new GetAuctionInsightDataRequest
	{
		EntityType = entityType,
		EntityIds = entityIds,
		SearchParameters = searchParameters,
		ReturnAdditionalFields = returnAdditionalFields
	};

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

static GetAuctionInsightDataResponse getAuctionInsightData(
	EntityType entityType,
	ArrayOflong entityIds,
	ArrayOfSearchParameter searchParameters,
	ArrayList<AuctionInsightKpiAdditionalField> returnAdditionalFields) throws RemoteException, Exception
{
	GetAuctionInsightDataRequest request = new GetAuctionInsightDataRequest();

	request.setEntityType(entityType);
	request.setEntityIds(entityIds);
	request.setSearchParameters(searchParameters);
	request.setReturnAdditionalFields(returnAdditionalFields);

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

static function GetAuctionInsightData(
	$entityType,
	$entityIds,
	$searchParameters,
	$returnAdditionalFields)
{

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

	$request = new GetAuctionInsightDataRequest();

	$request->EntityType = $entityType;
	$request->EntityIds = $entityIds;
	$request->SearchParameters = $searchParameters;
	$request->ReturnAdditionalFields = $returnAdditionalFields;

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

response=adinsight_service.GetAuctionInsightData(
	EntityType=EntityType,
	EntityIds=EntityIds,
	SearchParameters=SearchParameters,
	ReturnAdditionalFields=ReturnAdditionalFields)