Operação do Serviço GetDomainCategories - Ad Insight

Artigo
12/21/2023

Obtém a lista de categorias disponíveis para o domínio e idioma do site.

Elementos do Pedido

O objeto GetDomainCategoriesRequest 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
CategoryName	O filtro de nome da categoria. Se já souber uma ou mais categorias, pode filtrar opcionalmente a lista de resultados por subcategoria. Podem ser especificados até três níveis de categoria e têm de ser separados por uma barra ("/"). Por exemplo, pode formatar o filtro como CategoryL1/CategoryL2/CategoryL3. Se não incluir nenhum nome de categoria, todas as categorias para o domínio e idioma serão devolvidas.	cadeia
DomainName	O nome do site correspondente às páginas que pretende que os seus anúncios sejam direcionados. O comprimento máximo do domínio é de 2048 carateres. Não precisa de incluir o prefixo http, https ou www .	cadeia
Idioma	O idioma do domínio do site. Atualmente, apenas o inglês é suportado, pelo que tem de definir este elemento como EN.	cadeia

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 GetDomainCategoriesResponse 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
Categorias	A lista de categorias de domínio.	Matriz DomainCategory

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">GetDomainCategories</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>
    <GetDomainCategoriesRequest xmlns="https://bingads.microsoft.com/AdInsight/v13">
      <CategoryName i:nil="false">ValueHere</CategoryName>
      <DomainName i:nil="false">ValueHere</DomainName>
      <Language i:nil="false">ValueHere</Language>
    </GetDomainCategoriesRequest>
  </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>
    <GetDomainCategoriesResponse xmlns="https://bingads.microsoft.com/AdInsight/v13">
      <Categories d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <DomainCategory>
          <Bid>ValueHere</Bid>
          <CategoryName d4p1:nil="false">ValueHere</CategoryName>
          <Coverage>ValueHere</Coverage>
        </DomainCategory>
      </Categories>
    </GetDomainCategoriesResponse>
  </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<GetDomainCategoriesResponse> GetDomainCategoriesAsync(
	string categoryName,
	string domainName,
	string language)
{
	var request = new GetDomainCategoriesRequest
	{
		CategoryName = categoryName,
		DomainName = domainName,
		Language = language
	};

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

static GetDomainCategoriesResponse getDomainCategories(
	java.lang.String categoryName,
	java.lang.String domainName,
	java.lang.String language) throws RemoteException, Exception
{
	GetDomainCategoriesRequest request = new GetDomainCategoriesRequest();

	request.setCategoryName(categoryName);
	request.setDomainName(domainName);
	request.setLanguage(language);

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

static function GetDomainCategories(
	$categoryName,
	$domainName,
	$language)
{

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

	$request = new GetDomainCategoriesRequest();

	$request->CategoryName = $categoryName;
	$request->DomainName = $domainName;
	$request->Language = $language;

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

response=adinsight_service.GetDomainCategories(
	CategoryName=CategoryName,
	DomainName=DomainName,
	Language=Language)

Requisitos

Serviço: AdInsightService.svc v13
Espaço de nomes: https://bingads.microsoft.com/AdInsight/v13

Partilhar via