GetImportEntityIdsMapping Service Operation - Campaign Management

Gets mappings of your source entity IDs to Microsoft Advertising entity IDs.

Request Elements

The GetImportEntityIdsMappingRequest 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
ImportEntityType	The type of entity to get ID mappings. For example, set this element to "Campaign" to get campaign ID mappings.	ImportEntityType
ImportType	The type of import job to get entity ID mappings. To get Google Ads to Microsoft Advertising entity ID mappings for each GoogleImportJob, set this element to "GoogleImportJob".	string
SourceEntityIds	The source entity IDs that you want mapped to Microsoft Advertising entity IDs. If ImportEntityType is set to "Campaign" and ImportType is set to "GoogleImportJob", the operation will return Google Ads to Microsoft Advertising entity ID mappings. You can specify a maximum of 100 source IDs.	long array
SourceParentId	The ID of the source parent.	long

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 GetImportEntityIdsMappingResponse 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
EntityIdsMapping	The resulting list of key and value pairs. Each key represents a source ID that you requested mappings for. The referenced key is the mapped Microsoft Advertising entity ID. If you requested a mapping with an invalid source ID, it will still be returned as the key but the referenced value will be set to 0 (zero).	KeyValuePairOflonglong array
PartialErrors	An array of BatchError objects that contain details for any request items that were not successful. The list of errors do not correspond directly to the list of items in the request. The list can be empty if there were no errors, or can include one or more error objects corresponding to each unsuccessful list item in the request.	BatchError 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">GetImportEntityIdsMapping</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>
    <GetImportEntityIdsMappingRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <ImportType i:nil="false">ValueHere</ImportType>
      <SourceEntityIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <a1:long>ValueHere</a1:long>
      </SourceEntityIds>
      <ImportEntityType>ValueHere</ImportEntityType>
      <SourceParentId i:nil="false">ValueHere</SourceParentId>
    </GetImportEntityIdsMappingRequest>
  </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>
    <GetImportEntityIdsMappingResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <EntityIdsMapping xmlns:e305="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <e305:KeyValuePairOflonglong>
          <e305:key>ValueHere</e305:key>
          <e305:value>ValueHere</e305:value>
        </e305:KeyValuePairOflonglong>
      </EntityIdsMapping>
      <PartialErrors d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <BatchError d4p1:type="-- derived type specified here with the appropriate prefix --">
          <Code>ValueHere</Code>
          <Details d4p1:nil="false">ValueHere</Details>
          <ErrorCode d4p1:nil="false">ValueHere</ErrorCode>
          <FieldPath d4p1:nil="false">ValueHere</FieldPath>
          <ForwardCompatibilityMap xmlns:e306="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
            <e306:KeyValuePairOfstringstring>
              <e306:key d4p1:nil="false">ValueHere</e306:key>
              <e306:value d4p1:nil="false">ValueHere</e306:value>
            </e306:KeyValuePairOfstringstring>
          </ForwardCompatibilityMap>
          <Index>ValueHere</Index>
          <Message d4p1:nil="false">ValueHere</Message>
          <Type d4p1:nil="false">ValueHere</Type>
          <!--These fields are applicable if the derived type attribute is set to EditorialError-->
          <Appealable d4p1:nil="false">ValueHere</Appealable>
          <DisapprovedText d4p1:nil="false">ValueHere</DisapprovedText>
          <Location d4p1:nil="false">ValueHere</Location>
          <PublisherCountry d4p1:nil="false">ValueHere</PublisherCountry>
          <ReasonCode>ValueHere</ReasonCode>
        </BatchError>
      </PartialErrors>
    </GetImportEntityIdsMappingResponse>
  </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<GetImportEntityIdsMappingResponse> GetImportEntityIdsMappingAsync(
	string importType,
	IList<long> sourceEntityIds,
	ImportEntityType importEntityType,
	long? sourceParentId)
{
	var request = new GetImportEntityIdsMappingRequest
	{
		ImportType = importType,
		SourceEntityIds = sourceEntityIds,
		ImportEntityType = importEntityType,
		SourceParentId = sourceParentId
	};

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

static GetImportEntityIdsMappingResponse getImportEntityIdsMapping(
	java.lang.String importType,
	ArrayOflong sourceEntityIds,
	ImportEntityType importEntityType,
	java.lang.Long sourceParentId) throws RemoteException, Exception
{
	GetImportEntityIdsMappingRequest request = new GetImportEntityIdsMappingRequest();

	request.setImportType(importType);
	request.setSourceEntityIds(sourceEntityIds);
	request.setImportEntityType(importEntityType);
	request.setSourceParentId(sourceParentId);

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

static function GetImportEntityIdsMapping(
	$importType,
	$sourceEntityIds,
	$importEntityType,
	$sourceParentId)
{

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

	$request = new GetImportEntityIdsMappingRequest();

	$request->ImportType = $importType;
	$request->SourceEntityIds = $sourceEntityIds;
	$request->ImportEntityType = $importEntityType;
	$request->SourceParentId = $sourceParentId;

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

response=campaignmanagement_service.GetImportEntityIdsMapping(
	ImportType=ImportType,
	SourceEntityIds=SourceEntityIds,
	ImportEntityType=ImportEntityType,
	SourceParentId=SourceParentId)

Requirements

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

Request Url

Production URL

https://campaign.api.bingads.microsoft.com/CampaignManagement/v13/ImportEntityIdsMapping/Query

Sandbox URL

https://campaign.api.sandbox.bingads.microsoft.com/CampaignManagement/v13/ImportEntityIdsMapping/Query

Request Elements

The GetImportEntityIdsMappingRequest 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
ImportEntityType	The type of entity to get ID mappings. For example, set this element to "Campaign" to get campaign ID mappings.	ImportEntityType
ImportType	The type of import job to get entity ID mappings. To get Google Ads to Microsoft Advertising entity ID mappings for each GoogleImportJob, set this element to "GoogleImportJob".	string
SourceEntityIds	The source entity IDs that you want mapped to Microsoft Advertising entity IDs. If ImportEntityType is set to "Campaign" and ImportType is set to "GoogleImportJob", the operation will return Google Ads to Microsoft Advertising entity ID mappings. You can specify a maximum of 100 source IDs.	long array
SourceParentId	The ID of the source parent.	long

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 GetImportEntityIdsMappingResponse 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
EntityIdsMapping	The resulting list of key and value pairs. Each key represents a source ID that you requested mappings for. The referenced key is the mapped Microsoft Advertising entity ID. If you requested a mapping with an invalid source ID, it will still be returned as the key but the referenced value will be set to 0 (zero).	KeyValuePairOflonglong array
PartialErrors	An array of BatchError objects that contain details for any request items that were not successful. The list of errors do not correspond directly to the list of items in the request. The list can be empty if there were no errors, or can include one or more error objects corresponding to each unsuccessful list item in the request.	BatchError 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.

{
  "ImportType": "ValueHere",
  "SourceEntityIds": [
    "LongValueHere"
  ],
  "ImportEntityType": "ValueHere",
  "SourceParentId": "LongValueHere"
}

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 BatchError is EditorialError.

{
  "EntityIdsMapping": [
    {
      "key": "LongValueHere",
      "value": "LongValueHere"
    }
  ],
  "PartialErrors": [
    {
      "Code": IntValueHere,
      "Details": "ValueHere",
      "ErrorCode": "ValueHere",
      "FieldPath": "ValueHere",
      "ForwardCompatibilityMap": [
        {
          "key": "ValueHere",
          "value": "ValueHere"
        }
      ],
      "Index": IntValueHere,
      "Message": "ValueHere",
      "Type": "EditorialError",
      "Appealable": "ValueHere",
      "DisapprovedText": "ValueHere",
      "Location": "ValueHere",
      "PublisherCountry": "ValueHere",
      "ReasonCode": IntValueHere
    }
  ]
}

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<GetImportEntityIdsMappingResponse> GetImportEntityIdsMappingAsync(
	string importType,
	IList<long> sourceEntityIds,
	ImportEntityType importEntityType,
	long? sourceParentId)
{
	var request = new GetImportEntityIdsMappingRequest
	{
		ImportType = importType,
		SourceEntityIds = sourceEntityIds,
		ImportEntityType = importEntityType,
		SourceParentId = sourceParentId
	};

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

static GetImportEntityIdsMappingResponse getImportEntityIdsMapping(
	java.lang.String importType,
	ArrayOflong sourceEntityIds,
	ImportEntityType importEntityType,
	java.lang.Long sourceParentId) throws RemoteException, Exception
{
	GetImportEntityIdsMappingRequest request = new GetImportEntityIdsMappingRequest();

	request.setImportType(importType);
	request.setSourceEntityIds(sourceEntityIds);
	request.setImportEntityType(importEntityType);
	request.setSourceParentId(sourceParentId);

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

static function GetImportEntityIdsMapping(
	$importType,
	$sourceEntityIds,
	$importEntityType,
	$sourceParentId)
{

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

	$request = new GetImportEntityIdsMappingRequest();

	$request->ImportType = $importType;
	$request->SourceEntityIds = $sourceEntityIds;
	$request->ImportEntityType = $importEntityType;
	$request->SourceParentId = $sourceParentId;

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

response=campaignmanagement_service.GetImportEntityIdsMapping(
	ImportType=ImportType,
	SourceEntityIds=SourceEntityIds,
	ImportEntityType=ImportEntityType,
	SourceParentId=SourceParentId)