Opération de service GetKeywordOpportunities - Ad Insight

Article
12/21/2023

Obtient une liste de suggestions mot clé pertinentes pour le groupe d’annonces spécifié. La suggestion mot clé inclut également une valeur d’enchère suggérée.

Éléments de demande

L’objet GetKeywordOpportunitiesRequest définit le corps et les éléments d’en-tête de la demande d’opération de service. Les éléments doivent être dans le même ordre que celui indiqué dans la requête SOAP.

Remarque

Sauf indication contraire ci-dessous, tous les éléments de requête sont requis.

Éléments du corps de la requête

Élément	Description	Type de données
AdGroupId	Identificateur du groupe d’annonces pour lequel obtenir mot clé suggestions. Les restrictions suivantes s’appliquent au groupe d’annonces spécifié : - Sa langue doit être définie sur l’anglais. - Son milieu de distribution doit inclure La recherche. - Il doit contenir des mots clés et des publicités. L’opération suggère des mots clés uniquement si le groupe d’annonces contient une ou plusieurs annonces et mots clés ; Plus le groupe d’annonces contient de mots clés et d’annonces, plus l’ensemble de mots clés suggérés est riche. Si AdGroupId est nul ou vide, l’opération retourne toutes les opportunités mot clé pour la campagne spécifiée.	Long
CampaignId	Identificateur de la campagne propriétaire du groupe d’annonces spécifié. Si l’élément CampaignId est nul ou vide, l’AdGroupId doit également être nul ou vide, et l’opération retourne toutes les opportunités mot clé pour le compte.	Long
OpportunityType	Détermine le ou les types d’opportunités de mot clé que vous souhaitez. Vous pouvez inclure plusieurs valeurs en tant qu’indicateurs. La façon dont vous spécifiez plusieurs indicateurs dépend du langage de programmation que vous utilisez. Par exemple, C# traite ces valeurs comme des valeurs d’indicateur et Java les traite comme un tableau de chaînes. Le soap doit inclure une chaîne qui contient une liste de valeurs délimitées par des espaces, par exemple. `<OpportunityType>BroadMatch CampaignContext</OpportunityType>`	KeywordOpportunityType

Éléments d’en-tête de requête

Élément	Description	Type de données
AuthenticationToken	Jeton d’accès OAuth qui représente les informations d’identification d’un utilisateur disposant d’autorisations sur les comptes Microsoft Advertising. Pour plus d’informations, consultez Authentification avec OAuth.	chaîne
CustomerAccountId	Identificateur du compte publicitaire qui possède ou est associé aux entités dans la demande. Cet élément d’en-tête doit avoir la même valeur que l’élément de corps AccountId lorsque les deux sont nécessaires. Cet élément est requis pour la plupart des opérations de service et, à titre de bonne pratique, vous devez toujours le définir. Pour plus d’informations, consultez Obtenir votre compte et ID de client.	chaîne
Customerid	Identificateur du compte de responsable (client) auquel l’utilisateur accède ou à partir duquel il opère. Un utilisateur peut avoir accès à plusieurs comptes de gestionnaire. Cet élément est requis pour la plupart des opérations de service et, à titre de bonne pratique, vous devez toujours le définir. Pour plus d’informations, consultez Obtenir votre compte et ID de client.	chaîne
DeveloperToken	Jeton de développeur utilisé pour accéder à l’API Bing Ads. Pour plus d’informations, consultez Obtenir un jeton de développeur.	chaîne
Password	Cet élément est réservé à un usage interne et sera supprimé d’une version ultérieure de l’API. Vous devez utiliser l’élément AuthenticationToken pour définir les informations d’identification de l’utilisateur.	chaîne
UserName	Cet élément est réservé à un usage interne et sera supprimé d’une version ultérieure de l’API. Vous devez utiliser l’élément AuthenticationToken pour définir les informations d’identification de l’utilisateur.	chaîne

Éléments Response

L’objet GetKeywordOpportunitiesResponse définit le corps et les éléments d’en-tête de la réponse de l’opération de service. Les éléments sont retournés dans le même ordre que celui indiqué dans la réponse SOAP.

Response Body, éléments

Élément	Description	Type de données
Possibilités	Liste d’objets de données KeywordOpportunity qui identifie une mot clé suggérée et une valeur d’enchère. La liste est vide s’il n’y a pas de suggestions, ce qui peut se produire si le groupe d’annonces ne contient pas de mots clés et d’annonces existants. Actuellement, jusqu’à 1 000 éléments de liste peuvent être retournés, bien que la limite soit susceptible d’être modifiée.	Tableau KeywordOpportunity

Éléments d’en-tête de réponse

Élément	Description	Type de données
TrackingId	Identificateur de l’entrée de journal qui contient les détails de l’appel d’API.	chaîne

Requête SOAP

Ce modèle a été généré par un outil pour afficher l’ordre des éléments body et header pour la requête SOAP. Pour connaître les types pris en charge que vous pouvez utiliser avec cette opération de service, consultez la référence Éléments du corps de la demande ci-dessus.

<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 de réponse

Ce modèle a été généré par un outil pour afficher l’ordre des éléments de corps et d’en-tête pour la réponse 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>

Syntaxe du code

L’exemple de syntaxe peut être utilisé avec les Kits de développement logiciel (SDK) Bing Ads. Pour plus d’exemples, consultez Exemples de code de l’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)

Configuration requise

Service : AdInsightService.svc v13
Noms: https://bingads.microsoft.com/AdInsight/v13

Partager via