Partager via

Opération de service GetMediaMetaDataByAccountId - Gestion des campagnes

  • Article

Obtient les métadonnées de média du type d’entité spécifié à partir de la bibliothèque multimédia d’un compte.

Éléments de demande

L’objet GetMediaMetaDataByAccountIdRequest définit les éléments body et header 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
MediaEnabledEntities Détermine le type d’entité prenant en charge le média pour obtenir les métadonnées.

Les valeurs prises en charge sont ImageAdExtension et ResponsiveAd.

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. <MediaEnabledEntities>ImageAdExtension ResponsiveAd</MediaEnabledEntities>		 MediaEnabledEntityFilter
PageInfo Détermine l’index et la taille des résultats des métadonnées de média par page.

Par défaut, si cet élément n’est pas spécifié, l’index de la page defaut est 0 et la valeur par défaut Size est 1 000.		 Pagination
ReturnAdditionalFields Liste des propriétés supplémentaires que vous souhaitez inclure dans chaque indicateur de performance clé d’analyse de l’enchère retourné. Les valeurs de champ supplémentaires vous permettent d’obtenir les dernières fonctionnalités à l’aide de la version actuelle de l’API Ad Insight, et dans la version suivante, les éléments correspondants seront inclus par défaut.

Cet élément de requête est facultatif.		 MediaAdditionalField

É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
Mot de passe 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 GetMediaMetaDataByAccountIdResponse définit les éléments body et header 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
MediaMetaData Métadonnées de média spécifiées à partir de la bibliothèque.

Les métadonnées incluent des URL de téléchargement pour une ou plusieurs représentations multimédias.		 Tableau MediaMetaData

É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/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 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/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>

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<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)

Configuration requise

Service : CampaignManagementService.svc v13
Namespace: https://bingads.microsoft.com/CampaignManagement/v13

URL de la demande

https://campaign.api.bingads.microsoft.com/CampaignManagement/v13/MediaMetaData/QueryByAccountId

Éléments de demande

L’objet GetMediaMetaDataByAccountIdRequest définit les éléments body et header de la demande d’opération de service.

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
MediaEnabledEntities Détermine le type d’entité prenant en charge le média pour obtenir les métadonnées.

Les valeurs prises en charge sont ImageAdExtension et ResponsiveAd.

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. <MediaEnabledEntities>ImageAdExtension ResponsiveAd</MediaEnabledEntities>		 MediaEnabledEntityFilter
PageInfo Détermine l’index et la taille des résultats des métadonnées de média par page.

Par défaut, si cet élément n’est pas spécifié, l’index de la page defaut est 0 et la valeur par défaut Size est 1 000.		 Pagination
ReturnAdditionalFields Liste des propriétés supplémentaires que vous souhaitez inclure dans chaque indicateur de performance clé d’analyse de l’enchère retourné. Les valeurs de champ supplémentaires vous permettent d’obtenir les dernières fonctionnalités à l’aide de la version actuelle de l’API Ad Insight, et dans la version suivante, les éléments correspondants seront inclus par défaut.

Cet élément de requête est facultatif.		 MediaAdditionalField

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

Élément Description Type de données
Autorisation Jeton d’accès OAuth qui représente les informations d’identification d’un utilisateur disposant d’autorisations sur les comptes Microsoft Advertising. Vérifiez que le jeton est précédé de « Porteur », ce qui est nécessaire pour une authentification appropriée.

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
Mot de passe 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 GetMediaMetaDataByAccountIdResponse définit les éléments body et header 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 le json de réponse.

Response Body, éléments

Élément Description Type de données
MediaMetaData Métadonnées de média spécifiées à partir de la bibliothèque.

Les métadonnées incluent des URL de téléchargement pour une ou plusieurs représentations multimédias.		 Tableau MediaMetaData

É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 JSON

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

{
  "MediaEnabledEntities": "ValueHere",
  "PageInfo": {
    "Index": IntValueHere,
    "Size": IntValueHere
  },
  "ReturnAdditionalFields": "ValueHere"
}

JSON de réponse

Ce modèle a été généré par un outil pour afficher le corps et les éléments d’en-tête de la réponse JSON.

Voici un exemple qui s’applique si le type de MediaRepresentation est ImageMediaRepresentation.

{
  "MediaMetaData": [
    {
      "Id": "LongValueHere",
      "MediaType": "ValueHere",
      "Representations": [
        {
          "Name": "ValueHere",
          "Type": "ImageMediaRepresentation",
          "Url": "ValueHere",
          "Height": IntValueHere,
          "Width": IntValueHere
        }
      ],
      "Text": "ValueHere",
      "Type": "ValueHere"
    }
  ]
}

Syntaxe du code

Pour appeler l’API REST via des kits SDK, vous devez mettre à niveau le KIT de développement logiciel (SDK) vers une certaine version et configurer les paramètres système. 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<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)