Operação de Serviço GetMediaMetaDataByAccountId - Gestão de Campanhas

Artigo
10/17/2024

Obtém os metadados multimédia do tipo de entidade especificado a partir da biblioteca de multimédia de uma conta.

Elementos do Pedido

O objeto GetMediaMetaDataByAccountIdRequest 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
MediaEnabledEntities	Determina o tipo de entidade com suporte de dados ativado para obter metadados. Os valores suportados são ImageAdExtension e ResponsiveAd. 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, `<MediaEnabledEntities>ImageAdExtension ResponsiveAd</MediaEnabledEntities>`.	MediaEnabledEntityFilter
PageInfo	Determina o índice e o tamanho dos resultados de metadados multimédia por página. Por predefinição, se este elemento não for especificado, o Índice da página de desfasamento é 0 e o Tamanho predefinido é 1000.	Paginação
ReturnAdditionalFields	A lista de propriedades adicionais que pretende incluir em cada KPI de informações de leilão devolvidas. Os valores de campo adicionais permitem-lhe obter as funcionalidades mais recentes com a versão atual da API do Ad Insight e, na próxima versão, os elementos correspondentes serão incluídos por predefinição. Este elemento de pedido é opcional.	MediaAdditionalField

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 Bing Ads. 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 GetMediaMetaDataByAccountIdResponse 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
MediaMetaData	Os metadados de multimédia especificados da biblioteca. Os metadados incluem URLs de transferência para uma ou mais representações multimédia.	Matriz MediaMetaData

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/CampaignManagement/v13">
    <Action mustUnderstand="1">GetMediaMetaDataByAccountId</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>
    <GetMediaMetaDataByAccountIdRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <MediaEnabledEntities>ValueHere</MediaEnabledEntities>
      <PageInfo i:nil="false">
        <Index>ValueHere</Index>
        <Size>ValueHere</Size>
      </PageInfo>
      <ReturnAdditionalFields i:nil="false">ValueHere</ReturnAdditionalFields>
    </GetMediaMetaDataByAccountIdRequest>
  </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/CampaignManagement/v13">
    <TrackingId d3p1:nil="false" xmlns:d3p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</TrackingId>
  </s:Header>
  <s:Body>
    <GetMediaMetaDataByAccountIdResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <MediaMetaData d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <MediaMetaData>
          <Id>ValueHere</Id>
          <MediaType d4p1:nil="false">ValueHere</MediaType>
          <Representations d4p1:nil="false">
            <MediaRepresentation d4p1:type="-- derived type specified here with the appropriate prefix --">
              <Name d4p1:nil="false">ValueHere</Name>
              <Type d4p1:nil="false">ValueHere</Type>
              <Url d4p1:nil="false">ValueHere</Url>
              <!--These fields are applicable if the derived type attribute is set to ImageMediaRepresentation-->
              <Height>ValueHere</Height>
              <Width>ValueHere</Width>
            </MediaRepresentation>
          </Representations>
          <Text d4p1:nil="false">ValueHere</Text>
          <Type d4p1:nil="false">ValueHere</Type>
        </MediaMetaData>
      </MediaMetaData>
    </GetMediaMetaDataByAccountIdResponse>
  </s:Body>
</s:Envelope>

Sintaxe de Código

A sintaxe de exemplo pode ser utilizada com Bing Ads SDKs. Veja Bing Ads Exemplos de Código da API para obter mais exemplos.

public async Task<GetMediaMetaDataByAccountIdResponse> GetMediaMetaDataByAccountIdAsync(
	MediaEnabledEntityFilter mediaEnabledEntities,
	Paging pageInfo,
	MediaAdditionalField? returnAdditionalFields)
{
	var request = new GetMediaMetaDataByAccountIdRequest
	{
		MediaEnabledEntities = mediaEnabledEntities,
		PageInfo = pageInfo,
		ReturnAdditionalFields = returnAdditionalFields
	};

	return (await CampaignManagementService.CallAsync((s, r) => s.GetMediaMetaDataByAccountIdAsync(r), request));
}

static GetMediaMetaDataByAccountIdResponse getMediaMetaDataByAccountId(
	ArrayList<MediaEnabledEntityFilter> mediaEnabledEntities,
	Paging pageInfo,
	ArrayList<MediaAdditionalField> returnAdditionalFields) throws RemoteException, Exception
{
	GetMediaMetaDataByAccountIdRequest request = new GetMediaMetaDataByAccountIdRequest();

	request.setMediaEnabledEntities(mediaEnabledEntities);
	request.setPageInfo(pageInfo);
	request.setReturnAdditionalFields(returnAdditionalFields);

	return CampaignManagementService.getService().getMediaMetaDataByAccountId(request);
}

static function GetMediaMetaDataByAccountId(
	$mediaEnabledEntities,
	$pageInfo,
	$returnAdditionalFields)
{

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

	$request = new GetMediaMetaDataByAccountIdRequest();

	$request->MediaEnabledEntities = $mediaEnabledEntities;
	$request->PageInfo = $pageInfo;
	$request->ReturnAdditionalFields = $returnAdditionalFields;

	return $GLOBALS['CampaignManagementProxy']->GetService()->GetMediaMetaDataByAccountId($request);
}

response=campaignmanagement_service.GetMediaMetaDataByAccountId(
	MediaEnabledEntities=MediaEnabledEntities,
	PageInfo=PageInfo,
	ReturnAdditionalFields=ReturnAdditionalFields)

Requisitos

Serviço: CampaignManagementService.svc v13
Espaço de nomes: https://bingads.microsoft.com/CampaignManagement/v13

Partilhar via