GetSharedEntities Service Operation - Campaign Management

Gets negative keyword lists or website exclusion lists.

Tip

For an overview, see the Negative Keywords and Negative Sites technical guides.

Important

Only the users of the manager account (customer) that owns a website exclusion list (PlacementExclusionList) can update or delete the list, add or delete list items, and associate the list with ad accounts. If your ad account is associated with a website exclusion list that you do not own, you can disassociate the list from your account, but the list and list items are read-only. The owner of the list is determined by the association's SharedEntityCustomerId element.

If you have access to multiple manager accounts in an account hierarchy, the operation's results can vary depending on the CustomerId request header element that you set.

Request Elements

The GetSharedEntitiesRequest 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
SharedEntityScope	Indicates whether the shared entity is available at the ad account (Account) or manager account (Customer) level. This element is optional and defaults to Account scope. The ad account scope is only applicable for negative keyword lists. Set this element to Customer to get website exclusion lists in your manager account (customer) shared library.	EntityScope
SharedEntityType	The type of shared entity to get from the ad account or manager account (customer) library. Set this element to NegativeKeywordList to get negative keyword lists (NegativeKeywordList) in your ad account shared library. Set this element to PlacementExclusionList to get website exclusion lists (PlacementExclusionList) in your manager account (customer) shared library.	string

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 GetSharedEntitiesResponse 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
SharedEntities	The negative keyword lists or website exclusion lists.	SharedEntity 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">GetSharedEntities</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>
    <GetSharedEntitiesRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <SharedEntityType i:nil="false">ValueHere</SharedEntityType>
      <SharedEntityScope i:nil="false">ValueHere</SharedEntityScope>
    </GetSharedEntitiesRequest>
  </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>
    <GetSharedEntitiesResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <SharedEntities d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <SharedEntity d4p1:type="-- derived type specified here with the appropriate prefix --">
          <AssociationCount d4p1:nil="false">ValueHere</AssociationCount>
          <ForwardCompatibilityMap xmlns:e351="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
            <e351:KeyValuePairOfstringstring>
              <e351:key d4p1:nil="false">ValueHere</e351:key>
              <e351:value d4p1:nil="false">ValueHere</e351:value>
            </e351:KeyValuePairOfstringstring>
          </ForwardCompatibilityMap>
          <Id d4p1:nil="false">ValueHere</Id>
          <Name d4p1:nil="false">ValueHere</Name>
          <Type d4p1:nil="false">ValueHere</Type>
          <!--This field is applicable if the derived type attribute is set to SharedList-->
          <ItemCount d4p1:nil="false">ValueHere</ItemCount>
        </SharedEntity>
      </SharedEntities>
    </GetSharedEntitiesResponse>
  </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<GetSharedEntitiesResponse> GetSharedEntitiesAsync(
	string sharedEntityType,
	EntityScope? sharedEntityScope)
{
	var request = new GetSharedEntitiesRequest
	{
		SharedEntityType = sharedEntityType,
		SharedEntityScope = sharedEntityScope
	};

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

static GetSharedEntitiesResponse getSharedEntities(
	java.lang.String sharedEntityType,
	EntityScope sharedEntityScope) throws RemoteException, Exception
{
	GetSharedEntitiesRequest request = new GetSharedEntitiesRequest();

	request.setSharedEntityType(sharedEntityType);
	request.setSharedEntityScope(sharedEntityScope);

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

static function GetSharedEntities(
	$sharedEntityType,
	$sharedEntityScope)
{

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

	$request = new GetSharedEntitiesRequest();

	$request->SharedEntityType = $sharedEntityType;
	$request->SharedEntityScope = $sharedEntityScope;

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

response=campaignmanagement_service.GetSharedEntities(
	SharedEntityType=SharedEntityType,
	SharedEntityScope=SharedEntityScope)

Requirements

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

Request Url

Production URL

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

Sandbox URL

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

Request Elements

The GetSharedEntitiesRequest 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
SharedEntityScope	Indicates whether the shared entity is available at the ad account (Account) or manager account (Customer) level. This element is optional and defaults to Account scope. The ad account scope is only applicable for negative keyword lists. Set this element to Customer to get website exclusion lists in your manager account (customer) shared library.	EntityScope
SharedEntityType	The type of shared entity to get from the ad account or manager account (customer) library. Set this element to NegativeKeywordList to get negative keyword lists (NegativeKeywordList) in your ad account shared library. Set this element to PlacementExclusionList to get website exclusion lists (PlacementExclusionList) in your manager account (customer) shared library.	string

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 GetSharedEntitiesResponse 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
SharedEntities	The negative keyword lists or website exclusion lists.	SharedEntity 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.

{
  "SharedEntityType": "ValueHere",
  "SharedEntityScope": "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 SharedEntity is SharedList.

{
  "SharedEntities": [
    {
      "AssociationCount": IntValueHere,
      "ForwardCompatibilityMap": [
        {
          "key": "ValueHere",
          "value": "ValueHere"
        }
      ],
      "Id": "LongValueHere",
      "Name": "ValueHere",
      "Type": "SharedList",
      "ItemCount": 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<GetSharedEntitiesResponse> GetSharedEntitiesAsync(
	string sharedEntityType,
	EntityScope? sharedEntityScope)
{
	var request = new GetSharedEntitiesRequest
	{
		SharedEntityType = sharedEntityType,
		SharedEntityScope = sharedEntityScope
	};

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

static GetSharedEntitiesResponse getSharedEntities(
	java.lang.String sharedEntityType,
	EntityScope sharedEntityScope) throws RemoteException, Exception
{
	GetSharedEntitiesRequest request = new GetSharedEntitiesRequest();

	request.setSharedEntityType(sharedEntityType);
	request.setSharedEntityScope(sharedEntityScope);

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

static function GetSharedEntities(
	$sharedEntityType,
	$sharedEntityScope)
{

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

	$request = new GetSharedEntitiesRequest();

	$request->SharedEntityType = $sharedEntityType;
	$request->SharedEntityScope = $sharedEntityScope;

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

response=campaignmanagement_service.GetSharedEntities(
	SharedEntityType=SharedEntityType,
	SharedEntityScope=SharedEntityScope)