GetMediaMetaDataByAccountId Service Operation

 

Gets the media meta data of the specified entity type from an account’s media library.

System_CAPS_ICON_note.jpg Note

This operation does not return media meta data for location ad extensions. For getting location ad extension media, you should use GetMediaByIds.

Request | Response

Error Codes

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

Request Body

The GetMediaMetaDataByAccountIdRequest object defines the elements of the request’s body. The elements must be in the same order as shown in the SOAP Request SOAP.

System_CAPS_ICON_note.jpg Note

You must specify the account identifier in the CustomerAccountId header element.

ElementDescriptionData Type
MediaEnabledEntitiesDetermines the type of media enabled entity to get meta data. Currently only ImageAdExtension is supported.MediaEnabledEntityFilter

Request Headers

Set the required header elements for each service request. New customers are required to sign up for Bing Ads with a Microsoft Account, and to manage those accounts you must use OAuth. Existing users with legacy Bing Ads credentials may continue to specify the UserName and Password header elements. In future versions of the API, Bing Ads will transition exclusively to Microsoft Account authentication. For more information, see Getting Started With the Bing Ads API.

OAuth Authentication

These request headers are required for Authentication with OAuth.

ElementDescriptionData Type
AuthenticationTokenThe OAuth access token that represents a Microsoft Account user who has permissions to Bing Ads accounts.string
CustomerAccountIdThe identifier of the account that owns the entities in the request. This header element must have the same value as the AccountId body element when both are required.

Note: Required for most service operations, and as a best practice you should always specify this element.
string
CustomerIdThe identifier of the customer that contains and owns the account. If you manage an account of another customer, you should use that customer ID instead of your own customer ID.

Note: Required for most service operations, and as a best practice you should always specify this element.
string
DeveloperTokenThe developer token used to access the Bing Ads API.string

Password Authentication

These request headers are required for legacy username and password authentication.

ElementDescriptionData Type
CustomerAccountIdThe identifier of the account that owns the entities in the request. This header element must have the same value as the AccountId body element when both are required.

Note: Required for most service operations, and as a best practice you should always specify this element.
string
CustomerIdThe identifier of the customer that contains and owns the account. If you manage an account of another customer, you should use that customer ID instead of your own customer ID.

Note: Required for most service operations, and as a best practice you should always specify this element.
string
DeveloperTokenThe developer token used to access the Bing Ads API.string
PasswordThe Bing Ads user's sign-in password.string
UserNameThe Bing Ads user's sign-in user name. You must not set this element to a Microsoft account or email address. To authenticate a Microsoft account, use the AuthenticationToken header instead of UserName and Password.string

Request SOAP

The following example shows the complete request envelope.

<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/v11">
    <Action mustUnderstand="1">GetMediaMetaDataByAccountId</Action>
    <ApplicationToken i:nil="false"></ApplicationToken>
    <AuthenticationToken i:nil="false"></AuthenticationToken>
    <CustomerAccountId i:nil="false"></CustomerAccountId>
    <CustomerId i:nil="false"></CustomerId>
    <DeveloperToken i:nil="false"></DeveloperToken>
    <Password i:nil="false"></Password>
    <UserName i:nil="false"></UserName>
  </s:Header>
  <s:Body>
    <GetMediaMetaDataByAccountIdRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v11">
      <MediaEnabledEntities></MediaEnabledEntities>
    </GetMediaMetaDataByAccountIdRequest>
  </s:Body>
</s:Envelope>

Response Body

ElementDescriptionData Type
MediaMetaDataThe specified media meta data from the library.

The meta data includes download Urls for one or more media representations. The number of representations depends on the type of media. For example media for image ad extensions have multiple height and width representations, and you can access each individually. For more information see MediaEnabledEntityFilter.
MediaMetaData array

Response Header

ElementDescriptionData Type
TrackingIdThe identifier of the log entry that contains details about the API call.string

Response SOAP

The following example shows the complete response envelope.

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header xmlns="https://bingads.microsoft.com/CampaignManagement/v11">
    <TrackingId p4:nil="false" xmlns:p4="http://www.w3.org/2001/XMLSchema-instance"></TrackingId>
  </s:Header>
  <s:Body>
    <GetMediaMetaDataByAccountIdResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v11">
      <MediaMetaData p4:nil="false" xmlns:p4="http://www.w3.org/2001/XMLSchema-instance">
        <MediaMetaData>
          <Id></Id>
          <MediaType p4:nil="false"></MediaType>
          <Representations p4:nil="false">
            <MediaRepresentation p4:type="-- specify derived type here with the appropriate prefix --">
              <Name p4:nil="false"></Name>
              <Type p4:nil="false"></Type>
              <Url p4:nil="false"></Url>
              <!--Keep these fields if you set the i:type attribute to ImageMediaRepresentation-->
              <Height></Height>
              <Width></Width>
            </MediaRepresentation>
          </Representations>
          <Type p4:nil="false"></Type>
        </MediaMetaData>
      </MediaMetaData>
    </GetMediaMetaDataByAccountIdResponse>
  </s:Body>
</s:Envelope>

If the service operation fails, it throws a FaultException exception, which contains one or more of the Bing Ads API error data objects. For information about the fault detail objects, see Campaign Management Error Data Objects and Handling Service Errors and Exceptions.The following are example error codes that the error objects can include when using this service operation. For all documented error codes, please see Bing Ads Operation Error Codes.

Error Code
InvalidCredentials

AddMedia
DeleteMedia
GetMediaMetaDataByIds

Show: