通过

GetSharedEntitiesByAccountId 服务操作 - 市场活动管理

  • 项目

获取负关键字 (keyword) 列表。

注意

此操作已弃用，并将在必应广告 API 的未来版本中删除。 应改用 GetSharedEntities 操作。 若要获取网站排除列表，必须使用 GetSharedEntities 操作。

请求元素

GetSharedEntitiesByAccountIdRequest 对象定义服务操作请求的正文和标头元素。 元素的顺序必须与 请求 SOAP 中所示的顺序相同。

注意

除非下面另有说明，否则需要所有请求元素。

请求正文元素

元素 说明 数据类型
SharedEntityType 要从广告帐户共享库获取的共享实体的类型。

将此元素设置为 NegativeKeywordList， (广告帐户共享库中的 NegativeKeywordList) 获取负面关键字 (keyword) 列表。		 string

请求标头元素

元素 说明 数据类型
AuthenticationToken OAuth 访问令牌，表示有权Microsoft广告帐户的用户的凭据。

有关详细信息，请参阅 使用 OAuth 进行身份验证。		 string
CustomerAccountId 拥有或与请求中的实体关联的广告帐户的标识符。 如果需要这两个元素，此标头元素必须与 AccountId 正文元素具有相同的值。 此元素是大多数服务操作所必需的，作为最佳做法，应始终设置它。

有关详细信息，请参阅 获取帐户和客户 ID。		 string
CustomerId 用户正在访问或操作的客户) 经理帐户 (标识符。 用户可以访问多个经理帐户。 此元素是大多数服务操作所必需的，作为最佳做法，应始终设置它。

有关详细信息，请参阅 获取帐户和客户 ID。		 string
DeveloperToken 用于访问必应广告 API 的开发人员令牌。

有关详细信息，请参阅 获取开发人员令牌。		 string
Password 此元素保留供内部使用，将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。 string
UserName 此元素保留供内部使用，将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。 string

响应元素

GetSharedEntitiesByAccountIdResponse 对象定义服务操作响应的正文和标头元素。 元素的返回顺序与 响应 SOAP 中所示的顺序相同。

响应正文元素

元素 说明 数据类型
SharedEntities 负关键字 (keyword) 共享库中的列表。 SharedEntity 数组

响应标头元素

元素 说明 数据类型
跟踪 ID 包含 API 调用详细信息的日志条目的标识符。 string

请求 SOAP

此模板由一个工具生成，用于显示 SOAP 请求的正文和标头元素的顺序。 有关可用于此服务操作的支持类型，请参阅上面的 请求正文元素 参考。

<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">GetSharedEntitiesByAccountId</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>
    <GetSharedEntitiesByAccountIdRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <SharedEntityType i:nil="false">ValueHere</SharedEntityType>
    </GetSharedEntitiesByAccountIdRequest>
  </s:Body>
</s:Envelope>

响应 SOAP

此模板由一个工具生成，用于显示 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>
    <GetSharedEntitiesByAccountIdResponse 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:e499="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
            <e499:KeyValuePairOfstringstring>
              <e499:key d4p1:nil="false">ValueHere</e499:key>
              <e499:value d4p1:nil="false">ValueHere</e499:value>
            </e499: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>
    </GetSharedEntitiesByAccountIdResponse>
  </s:Body>
</s:Envelope>

代码语法

示例语法可用于 必应广告 SDK。 有关更多示例，请参阅 必应广告 API 代码示例 。

public async Task<GetSharedEntitiesByAccountIdResponse> GetSharedEntitiesByAccountIdAsync(
	string sharedEntityType)
{
	var request = new GetSharedEntitiesByAccountIdRequest
	{
		SharedEntityType = sharedEntityType
	};

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

static GetSharedEntitiesByAccountIdResponse getSharedEntitiesByAccountId(
	java.lang.String sharedEntityType) throws RemoteException, Exception
{
	GetSharedEntitiesByAccountIdRequest request = new GetSharedEntitiesByAccountIdRequest();

	request.setSharedEntityType(sharedEntityType);

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

static function GetSharedEntitiesByAccountId(
	$sharedEntityType)
{

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

	$request = new GetSharedEntitiesByAccountIdRequest();

	$request->SharedEntityType = $sharedEntityType;

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

response=campaignmanagement_service.GetSharedEntitiesByAccountId(
	SharedEntityType=SharedEntityType)

要求

服务： CampaignManagementService.svc v13
命名空间： https://bingads.microsoft.com/CampaignManagement/v13

请求 URL

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

请求元素

GetSharedEntitiesByAccountIdRequest 对象定义服务操作请求的正文和标头元素。

注意

除非下面另有说明，否则需要所有请求元素。

请求正文元素

元素 说明 数据类型
SharedEntityType 要从广告帐户共享库获取的共享实体的类型。

将此元素设置为 NegativeKeywordList， (广告帐户共享库中的 NegativeKeywordList) 获取负面关键字 (keyword) 列表。		 string

请求标头元素

元素 说明 数据类型
Authorization OAuth 访问令牌，表示有权Microsoft广告帐户的用户的凭据。 请确保令牌的前缀为“持有者”，这是正确身份验证所必需的。

有关详细信息，请参阅 使用 OAuth 进行身份验证。		 string
CustomerAccountId 拥有或与请求中的实体关联的广告帐户的标识符。 如果需要这两个元素，此标头元素必须与 AccountId 正文元素具有相同的值。 此元素是大多数服务操作所必需的，作为最佳做法，应始终设置它。

有关详细信息，请参阅 获取帐户和客户 ID。		 string
CustomerId 用户正在访问或操作的客户) 经理帐户 (标识符。 用户可以访问多个经理帐户。 此元素是大多数服务操作所必需的，作为最佳做法，应始终设置它。

有关详细信息，请参阅 获取帐户和客户 ID。		 string
DeveloperToken 用于访问必应广告 API 的开发人员令牌。

有关详细信息，请参阅 获取开发人员令牌。		 string
Password 此元素保留供内部使用，将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。 string
UserName 此元素保留供内部使用，将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。 string

响应元素

GetSharedEntitiesByAccountIdResponse 对象定义服务操作响应的正文和标头元素。 元素的返回顺序与 响应 JSON 中所示的顺序相同。

响应正文元素

元素 说明 数据类型
SharedEntities 负关键字 (keyword) 共享库中的列表。 SharedEntity 数组

响应标头元素

元素 说明 数据类型
跟踪 ID 包含 API 调用详细信息的日志条目的标识符。 string

请求 JSON

此模板由显示 JSON 请求的 正文 和 标头 元素的工具生成。 有关可用于此服务操作的支持类型，请参阅上面的 请求正文元素 参考。

{
  "SharedEntityType": "ValueHere"
}

响应 JSON

此模板由一个工具生成，用于显示 JSON 响应的 正文 和 标头 元素。

下面是一个示例，如果 SharedEntity 的类型为 SharedList，则适用。

{
  "SharedEntities": [
    {
      "AssociationCount": IntValueHere,
      "ForwardCompatibilityMap": [
        {
          "key": "ValueHere",
          "value": "ValueHere"
        }
      ],
      "Id": "LongValueHere",
      "Name": "ValueHere",
      "Type": "SharedList",
      "ItemCount": IntValueHere
    }
  ]
}

代码语法

若要通过 SDK 调用 REST API，需要将 SDK 升级到特定版本并配置系统参数。示例语法可用于 必应广告 SDK。 有关更多示例，请参阅 必应广告 API 代码示例 。

public async Task<GetSharedEntitiesByAccountIdResponse> GetSharedEntitiesByAccountIdAsync(
	string sharedEntityType)
{
	var request = new GetSharedEntitiesByAccountIdRequest
	{
		SharedEntityType = sharedEntityType
	};

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

static GetSharedEntitiesByAccountIdResponse getSharedEntitiesByAccountId(
	java.lang.String sharedEntityType) throws RemoteException, Exception
{
	GetSharedEntitiesByAccountIdRequest request = new GetSharedEntitiesByAccountIdRequest();

	request.setSharedEntityType(sharedEntityType);

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

static function GetSharedEntitiesByAccountId(
	$sharedEntityType)
{

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

	$request = new GetSharedEntitiesByAccountIdRequest();

	$request->SharedEntityType = $sharedEntityType;

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

response=campaignmanagement_service.GetSharedEntitiesByAccountId(
	SharedEntityType=SharedEntityType)