Operazione del servizio GetKeywordOpportunities - Ad Insight

Articolo
12/21/2023

Ottiene un elenco di suggerimenti di parole chiave rilevanti per il gruppo di annunci specificato. Il suggerimento per la parola chiave include anche un valore di offerta suggerito.

Elementi della richiesta

L'oggetto GetKeywordOpportunitiesRequest definisce il corpo e gli elementi di 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
AdGroupId	Identificatore del gruppo di annunci per cui ottenere suggerimenti per le parole chiave. Le restrizioni seguenti si applicano al gruppo di annunci specificato: - La lingua deve essere impostata su Inglese. - Il supporto di distribuzione deve includere Ricerca. - Deve contenere parole chiave e annunci. L'operazione suggerirà parole chiave solo se il gruppo di annunci contiene uno o più annunci e parole chiave; più parole chiave e annunci contiene il gruppo di annunci, più ricco sarà il set di parole chiave suggerite. Se AdGroupId è nil o vuoto, l'operazione restituirà tutte le opportunità di parola chiave per la campagna specificata.	long
CampaignId	Identificatore della campagna proprietaria del gruppo di annunci specificato. Se l'elemento CampaignId è nil o vuoto, anche AdGroupId deve essere nil o vuoto e l'operazione restituirà tutte le opportunità di parola chiave per l'account.	long
OpportunityType	Determina il tipo o i tipi di opportunità di parole chiave desiderate. È possibile includere più valori come flag. Il modo in cui si specificano più flag dipende dal linguaggio di programmazione usato. Ad esempio, C# considera questi valori come valori flag e Java li considera come una matrice di stringhe. Soap deve includere una stringa che contiene un elenco di valori delimitato da spazi, `<OpportunityType>BroadMatch CampaignContext</OpportunityType>`ad esempio .	KeywordOpportunityType

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 GetKeywordOpportunitiesResponse definisce gli elementi corpo e 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
Opportunità	Elenco di oggetti dati KeywordOpportunity che identificano una parola chiave suggerita e un valore di offerta. L'elenco sarà vuoto se non sono presenti suggerimenti, che possono verificarsi se il gruppo di annunci non contiene annunci e parole chiave esistenti. Attualmente è possibile restituire fino a 1.000 voci di elenco, anche se il limite è soggetto a modifiche.	Matrice KeywordOpportunity

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">GetKeywordOpportunities</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>
    <GetKeywordOpportunitiesRequest xmlns="https://bingads.microsoft.com/AdInsight/v13">
      <AdGroupId i:nil="false">ValueHere</AdGroupId>
      <CampaignId i:nil="false">ValueHere</CampaignId>
      <OpportunityType>ValueHere</OpportunityType>
    </GetKeywordOpportunitiesRequest>
  </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>
    <GetKeywordOpportunitiesResponse xmlns="https://bingads.microsoft.com/AdInsight/v13">
      <Opportunities d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <KeywordOpportunity d4p1:type="-- derived type specified here with the appropriate prefix --">
          <AdGroupId>ValueHere</AdGroupId>
          <AdGroupName d4p1:nil="false">ValueHere</AdGroupName>
          <CampaignId>ValueHere</CampaignId>
          <CampaignName d4p1:nil="false">ValueHere</CampaignName>
          <Competition>ValueHere</Competition>
          <EstimatedIncreaseInClicks>ValueHere</EstimatedIncreaseInClicks>
          <EstimatedIncreaseInCost>ValueHere</EstimatedIncreaseInCost>
          <EstimatedIncreaseInImpressions>ValueHere</EstimatedIncreaseInImpressions>
          <MatchType>ValueHere</MatchType>
          <MonthlySearches>ValueHere</MonthlySearches>
          <SuggestedBid>ValueHere</SuggestedBid>
          <SuggestedKeyword d4p1:nil="false">ValueHere</SuggestedKeyword>
          <!--These fields are applicable if the derived type attribute is set to BroadMatchKeywordOpportunity-->
          <AverageCPC>ValueHere</AverageCPC>
          <AverageCTR>ValueHere</AverageCTR>
          <ClickShare>ValueHere</ClickShare>
          <ImpressionShare>ValueHere</ImpressionShare>
          <ReferenceKeywordBid>ValueHere</ReferenceKeywordBid>
          <ReferenceKeywordId>ValueHere</ReferenceKeywordId>
          <ReferenceKeywordMatchType>ValueHere</ReferenceKeywordMatchType>
          <SearchQueryKPIs d4p1:nil="false">
            <BroadMatchSearchQueryKPI>
              <AverageCTR>ValueHere</AverageCTR>
              <Clicks>ValueHere</Clicks>
              <Impressions>ValueHere</Impressions>
              <SRPV>ValueHere</SRPV>
              <SearchQuery d4p1:nil="false">ValueHere</SearchQuery>
            </BroadMatchSearchQueryKPI>
          </SearchQueryKPIs>
        </KeywordOpportunity>
      </Opportunities>
    </GetKeywordOpportunitiesResponse>
  </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<GetKeywordOpportunitiesResponse> GetKeywordOpportunitiesAsync(
	long? adGroupId,
	long? campaignId,
	KeywordOpportunityType opportunityType)
{
	var request = new GetKeywordOpportunitiesRequest
	{
		AdGroupId = adGroupId,
		CampaignId = campaignId,
		OpportunityType = opportunityType
	};

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

static GetKeywordOpportunitiesResponse getKeywordOpportunities(
	java.lang.Long adGroupId,
	java.lang.Long campaignId,
	ArrayList<KeywordOpportunityType> opportunityType) throws RemoteException, Exception
{
	GetKeywordOpportunitiesRequest request = new GetKeywordOpportunitiesRequest();

	request.setAdGroupId(adGroupId);
	request.setCampaignId(campaignId);
	request.setOpportunityType(opportunityType);

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

static function GetKeywordOpportunities(
	$adGroupId,
	$campaignId,
	$opportunityType)
{

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

	$request = new GetKeywordOpportunitiesRequest();

	$request->AdGroupId = $adGroupId;
	$request->CampaignId = $campaignId;
	$request->OpportunityType = $opportunityType;

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

response=adinsight_service.GetKeywordOpportunities(
	AdGroupId=AdGroupId,
	CampaignId=CampaignId,
	OpportunityType=OpportunityType)

Requisiti

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

Condividi tramite