Operação do Serviço GetKeywordOpportunities - Ad Insight
Obtém uma lista de sugestões de palavras-chave relevantes para o grupo de anúncios especificado. A sugestão de palavra-chave também inclui um valor de oferta sugerido.
Elementos do Pedido
O objeto GetKeywordOpportunitiesRequest define os elementos do corpo e do cabeçalho do pedido de operação do serviço. Os elementos têm de estar na mesma ordem mostrada no Pedido SOAP.
Nota
Salvo indicação em contrário abaixo, todos os elementos do pedido são necessários.
Elementos do Corpo do Pedido
| Elemento | Descrição | Tipo de Dados |
|---|---|---|
| AdGroupId | O identificador do grupo de anúncios para o qual obter sugestões de palavras-chave. As seguintes restrições aplicam-se ao grupo de anúncios especificado: - O respetivo idioma tem de estar definido como inglês. - O respetivo meio de distribuição tem de incluir a Pesquisa. - Deve conter palavras-chave e anúncios. A operação só sugerirá palavras-chave se o grupo de anúncios contiver um ou mais anúncios e palavras-chave; quanto mais palavras-chave e anúncios o grupo de anúncios contiver, mais avançado será o conjunto de palavras-chave sugeridas. Se AdGroupId for nulo ou estiver vazio, a operação devolverá todas as oportunidades de palavra-chave para a campanha especificada. |
long |
| CampaignId | O identificador da campanha que detém o grupo de anúncios especificado. Se o elemento CampaignId for nulo ou estiver vazio, o AdGroupId também tem de ser nulo ou estar vazio e a operação devolverá todas as oportunidades de palavra-chave para a conta. |
long |
| OpportunityType | Determina o tipo ou tipos de oportunidades de palavras-chave que pretende. Pode incluir múltiplos valores como sinalizadores. A forma como especifica vários sinalizadores depende da linguagem de programação que utiliza. Por exemplo, C# trata estes valores como valores de sinalizador e Java trata-os como uma matriz de cadeias. O SOAP deve incluir uma cadeia que contém uma lista delimitada por espaço de valores, por exemplo, <OpportunityType>BroadMatch CampaignContext</OpportunityType>. |
KeywordOpportunityType |
Elementos do Cabeçalho do Pedido
| Elemento | Descrição | Tipo de Dados |
|---|---|---|
| AuthenticationToken | O token de acesso OAuth que representa as credenciais de um utilizador que tem permissões para contas do Microsoft Advertising. Para obter mais informações, veja Authentication with OAuth (Autenticação com OAuth). |
cadeia |
| CustomerAccountId | O identificador da conta de anúncio que detém ou está associada às entidades no pedido. Este elemento de cabeçalho tem de ter o mesmo valor que o elemento do corpo AccountId quando ambos são necessários. Este elemento é necessário para a maioria das operações de serviço e, como melhor prática, deve sempre defini-lo. Para obter mais informações, veja Obter a Sua Conta e IDs de Cliente. |
cadeia |
| CustomerId | O identificador da conta de gestor (cliente) a partir da qual o utilizador está a aceder ou a operar. Um utilizador pode ter acesso a várias contas de gestor. Este elemento é necessário para a maioria das operações de serviço e, como melhor prática, deve sempre defini-lo. Para obter mais informações, veja Obter a Sua Conta e IDs de Cliente. |
cadeia |
| DeveloperToken | O token de programador utilizado para aceder à API de Anúncios do Bing. Para obter mais informações, veja Obter um Token de Programador. |
cadeia |
| Palavra-passe | Este elemento está reservado para utilização interna e será removido de uma versão futura da API. Tem de utilizar o elemento AuthenticationToken para definir credenciais de utilizador. | cadeia |
| Nome de Utilizador | Este elemento está reservado para utilização interna e será removido de uma versão futura da API. Tem de utilizar o elemento AuthenticationToken para definir credenciais de utilizador. | cadeia |
Elementos de Resposta
O objeto GetKeywordOpportunitiesResponse define os elementos do corpo e do cabeçalho da resposta da operação do serviço. Os elementos são devolvidos pela mesma ordem mostrada no SOAP de Resposta.
Elementos do Corpo da Resposta
| Elemento | Descrição | Tipo de Dados |
|---|---|---|
| Oportunidades | Uma lista de objetos de dados KeywordOpportunity que identifica uma palavra-chave sugerida e um valor de licitação. A lista estará vazia se não existirem sugestões, o que poderá ocorrer se o grupo de anúncios não contiver anúncios e palavras-chave existentes. Atualmente, podem ser devolvidos até 1000 itens de lista, embora o limite esteja sujeito a alterações. |
Matriz KeywordOpportunity |
Elementos do Cabeçalho de Resposta
| Elemento | Descrição | Tipo de Dados |
|---|---|---|
| TrackingId | O identificador da entrada de registo que contém os detalhes da chamada à API. | cadeia |
Pedir SOAP
Este modelo foi gerado por uma ferramenta para mostrar a ordem dos elementos do corpo e do cabeçalho do pedido SOAP. Para tipos suportados que pode utilizar com esta operação de serviço, veja a referência Request Body Elements (Elementos do Corpo do Pedido ) acima.
<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 Resposta
Este modelo foi gerado por uma ferramenta para mostrar a ordem dos elementos do corpo e do cabeçalho para a resposta 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>
Sintaxe de Código
A sintaxe de exemplo pode ser utilizada com os SDKs de Anúncios do Bing. Veja Exemplos de Código da API de Anúncios do Bing para obter mais exemplos.
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)
Requisitos
Serviço: AdInsightService.svc v13
Espaço de nomes: https://bingads.microsoft.com/AdInsight/v13
Comentários
Brevemente: Ao longo de 2024, vamos descontinuar progressivamente o GitHub Issues como mecanismo de feedback para conteúdos e substituí-lo por um novo sistema de feedback. Para obter mais informações, veja: https://aka.ms/ContentUserFeedback.
Submeter e ver comentários