GetMediaMetaDataByAccountId Service Operation - Campaign Management
Gets the media meta data of the specified entity type from an account's media library.
Request Elements
The GetMediaMetaDataByAccountIdRequest object defines the body and header elements of the service operation request. The elements must be in the same order as shown in the Request SOAP.
Note
Unless otherwise noted below, all request elements are required.
Request Body Elements
| Element | Description | Data Type |
|---|---|---|
| MediaEnabledEntities | Determines the type of media enabled entity to get meta data. Supported values are ImageAdExtension and ResponsiveAd. You may include multiple values as flags. How you specify multiple flags depends on the programming language that you use. For example, C# treats these values as flag values and Java treats them as an array of strings. The SOAP should include a string that contains a space-delimited list of values for example, <MediaEnabledEntities>ImageAdExtension ResponsiveAd</MediaEnabledEntities>. |
MediaEnabledEntityFilter |
| PageInfo | Determines the index and size of media meta data results per page. By default if this element is not specified, the defaut page Index is 0 and the default Size is 1,000. |
Paging |
| ReturnAdditionalFields | The list of additional properties that you want included within each returned auction insight KPI. The additional field values enable you to get the latest features using the current version of the Ad Insight API, and in the next version the corresponding elements will be included by default. This request element is optional. |
MediaAdditionalField |
Request Header Elements
| Element | Description | Data Type |
|---|---|---|
| AuthenticationToken | The OAuth access token that represents the credentials of a user who has permissions to Microsoft Advertising accounts. For more information see Authentication with OAuth. |
string |
| CustomerAccountId | The identifier of the ad account that owns or is associated with the entities in the request. This header element must have the same value as the AccountId body element when both are required. This element is required for most service operations, and as a best practice you should always set it. For more information see Get Your Account and Customer IDs. |
string |
| CustomerId | The identifier of the manager account (customer) the user is accessing or operating from. A user can have access to multiple manager accounts. This element is required for most service operations, and as a best practice you should always set it. For more information see Get Your Account and Customer IDs. |
string |
| DeveloperToken | The developer token used to access the Bing Ads API. For more information see Get a Developer Token. |
string |
| Password | This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials. | string |
| UserName | This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials. | string |
Response Elements
The GetMediaMetaDataByAccountIdResponse object defines the body and header elements of the service operation response. The elements are returned in the same order as shown in the Response SOAP.
Response Body Elements
| Element | Description | Data Type |
|---|---|---|
| MediaMetaData | The specified media meta data from the library. The meta data includes download URLs for one or more media representations. |
MediaMetaData array |
Response Header Elements
| Element | Description | Data Type |
|---|---|---|
| TrackingId | The identifier of the log entry that contains the details of the API call. | string |
Request SOAP
This template was generated by a tool to show the order of the body and header elements for the SOAP request. For supported types that you can use with this service operation, see the Request Body Elements reference above.
<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>
Response SOAP
This template was generated by a tool to show the order of the body and header elements for the SOAP response.
<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>
Code Syntax
The example syntax can be used with Bing Ads SDKs. See Bing Ads API Code Examples for more examples.
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)
Requirements
Service: CampaignManagementService.svc v13
Namespace: https://bingads.microsoft.com/CampaignManagement/v13
Request Url
https://campaign.api.bingads.microsoft.com/CampaignManagement/v13/MediaMetaData/QueryByAccountId
Request Elements
The GetMediaMetaDataByAccountIdRequest object defines the body and header elements of the service operation request.
Note
Unless otherwise noted below, all request elements are required.
Request Body Elements
| Element | Description | Data Type |
|---|---|---|
| MediaEnabledEntities | Determines the type of media enabled entity to get meta data. Supported values are ImageAdExtension and ResponsiveAd. You may include multiple values as flags. How you specify multiple flags depends on the programming language that you use. For example, C# treats these values as flag values and Java treats them as an array of strings. The SOAP should include a string that contains a space-delimited list of values for example, <MediaEnabledEntities>ImageAdExtension ResponsiveAd</MediaEnabledEntities>. |
MediaEnabledEntityFilter |
| PageInfo | Determines the index and size of media meta data results per page. By default if this element is not specified, the defaut page Index is 0 and the default Size is 1,000. |
Paging |
| ReturnAdditionalFields | The list of additional properties that you want included within each returned auction insight KPI. The additional field values enable you to get the latest features using the current version of the Ad Insight API, and in the next version the corresponding elements will be included by default. This request element is optional. |
MediaAdditionalField |
Request Header Elements
| Element | Description | Data Type |
|---|---|---|
| Authorization | The OAuth access token that represents the credentials of a user who has permissions to Microsoft Advertising accounts. Please ensure that the token is prefixed with "Bearer ", this is necessary for proper authentication. For more information see Authentication with OAuth. |
string |
| CustomerAccountId | The identifier of the ad account that owns or is associated with the entities in the request. This header element must have the same value as the AccountId body element when both are required. This element is required for most service operations, and as a best practice you should always set it. For more information see Get Your Account and Customer IDs. |
string |
| CustomerId | The identifier of the manager account (customer) the user is accessing or operating from. A user can have access to multiple manager accounts. This element is required for most service operations, and as a best practice you should always set it. For more information see Get Your Account and Customer IDs. |
string |
| DeveloperToken | The developer token used to access the Bing Ads API. For more information see Get a Developer Token. |
string |
| Password | This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials. | string |
| UserName | This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials. | string |
Response Elements
The GetMediaMetaDataByAccountIdResponse object defines the body and header elements of the service operation response. The elements are returned in the same order as shown in the Response JSON.
Response Body Elements
| Element | Description | Data Type |
|---|---|---|
| MediaMetaData | The specified media meta data from the library. The meta data includes download URLs for one or more media representations. |
MediaMetaData array |
Response Header Elements
| Element | Description | Data Type |
|---|---|---|
| TrackingId | The identifier of the log entry that contains the details of the API call. | string |
Request JSON
This template was generated by a tool to show the body and header elements for the JSON request. For supported types that you can use with this service operation, see the Request Body Elements reference above.
{
"MediaEnabledEntities": "ValueHere",
"PageInfo": {
"Index": IntValueHere,
"Size": IntValueHere
},
"ReturnAdditionalFields": "ValueHere"
}
Response JSON
This template was generated by a tool to show the body and header elements for the JSON response.
Below is an example that is applicable if the type of MediaRepresentation is ImageMediaRepresentation.
{
"MediaMetaData": [
{
"Id": "LongValueHere",
"MediaType": "ValueHere",
"Representations": [
{
"Name": "ValueHere",
"Type": "ImageMediaRepresentation",
"Url": "ValueHere",
"Height": IntValueHere,
"Width": IntValueHere
}
],
"Text": "ValueHere",
"Type": "ValueHere"
}
]
}
Code Syntax
To call REST API through SDKs, you need to upgrade SDK to a certain version and configure the system parameters.The example syntax can be used with Bing Ads SDKs. See Bing Ads API Code Examples for more examples.
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)