Operazione del servizio GetAuctionInsightData - Ad Insight

Articolo
12/21/2023

Ottiene i dati analitici dell'asta per un account, campagne, gruppi di annunci o parole chiave.

Mostrandoti dove stai avendo successo e dove potresti perdere opportunità per migliorare le prestazioni, i dati analitici dell'asta possono aiutarti a prendere decisioni di ottimizzazione strategica.

Se si tratta di una nuova campagna o se si hanno poche impressioni, i dati analitici dell'asta non verranno generati.

Il periodo di conservazione dei dati è di 180 giorni.

Elementi della richiesta

L'oggetto GetAuctionInsightDataRequest definisce il corpo e gli elementi dell'intestazione della richiesta di operazione del servizio. Gli elementi devono essere nello stesso ordine indicato nella richiesta SOAP.

Nota

Se non diversamente indicato di seguito, sono necessari tutti gli elementi della richiesta.

Elementi del corpo della richiesta

Elemento	Descrizione	Tipo di dati
EntityIds	Identificatori di Microsoft Advertising per un massimo di 200 campagne, gruppi di annunci o parole chiave. Questo elemento è necessario per i tipi di entità campagna, gruppo di annunci e parole chiave. Se EntityType è Account, questo elemento è facoltativo e eseguirà l'override del valore impostato nell'intestazione CustomerAccountId. Indipendentemente dal tipo di entità, è necessario impostare gli elementi di intestazione CustomerId e CustomerAccountId.	matrice long
Entitytype	Livello di entità che si desidera richiedere dati analitici dell'asta. I valori supportati sono Account, Campaign, AdGroup e Keyword. Questo elemento è obbligatorio.	Entitytype
ReturnAdditionalFields	Elenco di proprietà aggiuntive che si desidera includere all'interno di ogni indicatore KPI di informazioni dettagliate dell'asta restituito. I valori di campo aggiuntivi consentono di ottenere le funzionalità più recenti usando la versione corrente dell'API Ad Insight e nella versione successiva gli elementi corrispondenti verranno inclusi per impostazione predefinita. Questo elemento della richiesta è facoltativo.	AuctionInsightKpiAdditionalField
SearchParameters	I parametri di ricerca definiscono i criteri e i filtri per i dati analitici dell'asta. È necessario includere esattamente un dateRangeSearchParameter. È anche possibile includere facoltativamente fino a tre diversi oggetti AuctionSegmentSearchParameter , ad esempio per Day, DayOfWeek e Device. Altri oggetti che derivano da SearchParameter non sono validi per questa operazione.	Matrice SearchParameter

Elementi dell'intestazione della richiesta

Elemento	Descrizione	Tipo di dati
AuthenticationToken	Token di accesso OAuth che rappresenta le credenziali di un utente che dispone delle autorizzazioni per gli account Microsoft Advertising. Per altre informazioni, vedere Autenticazione con OAuth.	Stringa
CustomerAccountId	Identificatore dell'account pubblicitario proprietario o associato alle entità nella richiesta. Questo elemento di intestazione deve avere lo stesso valore dell'elemento del corpo AccountId quando sono necessari entrambi. Questo elemento è necessario per la maggior parte delle operazioni del servizio e, come procedura consigliata, è consigliabile impostarlo sempre. Per altre informazioni, vedere Ottenere l'account e gli ID cliente.	Stringa
Customerid	Identificatore dell'account manager (cliente) da cui l'utente accede o opera. Un utente può avere accesso a più account manager. Questo elemento è necessario per la maggior parte delle operazioni del servizio e, come procedura consigliata, è consigliabile impostarlo sempre. Per altre informazioni, vedere Ottenere l'account e gli ID cliente.	Stringa
DeveloperToken	Token di sviluppo usato per accedere all'API Bing Ads. Per altre informazioni, vedere Ottenere un token per sviluppatori.	Stringa
Password	Questo elemento è riservato per l'uso interno e verrà rimosso da una versione futura dell'API. È necessario usare l'elemento AuthenticationToken per impostare le credenziali utente.	Stringa
UserName	Questo elemento è riservato per l'uso interno e verrà rimosso da una versione futura dell'API. È necessario usare l'elemento AuthenticationToken per impostare le credenziali utente.	Stringa

Elementi di risposta

L'oggetto GetAuctionInsightDataResponse definisce il corpo e gli elementi dell'intestazione della risposta dell'operazione del servizio. Gli elementi vengono restituiti nello stesso ordine illustrato nella soap di risposta.

Elementi del corpo della risposta

Elemento	Descrizione	Tipo di dati
Risultato	Include le voci di informazioni dettagliate dell'asta per l'entità richiesta, l'intervallo di date e i parametri di ricerca del segmento.	AuctionInsightResult

Elementi dell'intestazione della risposta

Elemento	Descrizione	Tipo di dati
TrackingId	Identificatore della voce di log che contiene i dettagli della chiamata API.	Stringa

Richiedi SOAP

Questo modello è stato generato da uno strumento per visualizzare l'ordine degli elementi corpo e intestazione per la richiesta SOAP. Per i tipi supportati che è possibile usare con questa operazione del servizio, vedere il riferimento Request Body Elements sopra riportato.

<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>

SOAP della risposta

Questo modello è stato generato da uno strumento per visualizzare l'ordine degli elementi del corpo e dell'intestazione per la risposta SOAP.

<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>

Sintassi del codice

La sintassi di esempio può essere usata con gli SDK di Bing Ads. Per altri esempi, vedere Esempi di codice DELL'API Bing Ads .

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)

Requisiti

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

Condividi tramite