SetAdExtensionsAssociations 服务操作 - 市场活动管理
将指定的广告扩展插件与相应的市场活动或广告组相关联。
注意
呼叫和位置广告扩展不能与广告组相关联。 呼叫广告扩展插件不能与帐户关联。
请求元素
SetAdExtensionsAssociationsRequest 对象定义服务操作请求的正文和标头元素。 元素的顺序必须与 请求 SOAP 中所示的顺序相同。
注意
除非下面另有说明,否则需要所有请求元素。
请求正文元素
元素 | 说明 | 数据类型 |
---|---|---|
AccountId | 拥有扩展的帐户的标识符。 | long |
AdExtensionIdToEntityIdAssociations | 包含关联帐户、市场活动或广告组的广告扩展列表。 每个服务调用只能将广告扩展与一种类型的实体相关联。 使用 AssociationType 元素指定实体类型。 呼叫和位置广告扩展不能与广告组相关联。 呼叫广告扩展插件不能与帐户关联。 每个服务调用最多可以设置 100 个关联。 |
AdExtensionIdToEntityIdAssociation 数组 |
AssociationType | AdExtensionIdToEntityIdAssociations 列表中指定的所有实体的类型。 | AssociationType |
请求标头元素
元素 | 说明 | 数据类型 |
---|---|---|
AuthenticationToken | OAuth 访问令牌,表示有权Microsoft广告帐户的用户的凭据。 有关详细信息,请参阅 使用 OAuth 进行身份验证。 |
string |
CustomerAccountId | 拥有或与请求中的实体关联的广告帐户的标识符。 如果需要这两个元素,此标头元素必须与 AccountId 正文元素具有相同的值。 此元素是大多数服务操作所必需的,作为最佳做法,应始终设置它。 有关详细信息,请参阅 获取帐户和客户 ID。 |
string |
CustomerId | 用户正在访问或操作的客户) 经理帐户 (标识符。 用户可以访问多个经理帐户。 此元素是大多数服务操作所必需的,作为最佳做法,应始终设置它。 有关详细信息,请参阅 获取帐户和客户 ID。 |
string |
DeveloperToken | 用于访问必应广告 API 的开发人员令牌。 有关详细信息,请参阅 获取开发人员令牌。 |
string |
Password | 此元素保留供内部使用,将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。 | string |
UserName | 此元素保留供内部使用,将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。 | string |
响应元素
SetAdExtensionsAssociationsResponse 对象定义服务操作响应的正文和标头元素。 元素的返回顺序与 响应 SOAP 中所示的顺序相同。
响应正文元素
元素 | 说明 | 数据类型 |
---|---|---|
PartialErrors |
BatchError 对象的数组,其中包含未成功的任何请求项的详细信息。 错误列表与请求中的项列表不直接对应。 如果没有错误,列表可以为空,也可以包含与请求中每个不成功的列表项对应的一个或多个错误对象。 |
BatchError 数组 |
响应标头元素
元素 | 说明 | 数据类型 |
---|---|---|
跟踪 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">SetAdExtensionsAssociations</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>
<SetAdExtensionsAssociationsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<AccountId>ValueHere</AccountId>
<AdExtensionIdToEntityIdAssociations i:nil="false">
<AdExtensionIdToEntityIdAssociation>
<AdExtensionId>ValueHere</AdExtensionId>
<EntityId>ValueHere</EntityId>
</AdExtensionIdToEntityIdAssociation>
</AdExtensionIdToEntityIdAssociations>
<AssociationType>ValueHere</AssociationType>
</SetAdExtensionsAssociationsRequest>
</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>
<SetAdExtensionsAssociationsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<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:e513="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
<e513:KeyValuePairOfstringstring>
<e513:key d4p1:nil="false">ValueHere</e513:key>
<e513:value d4p1:nil="false">ValueHere</e513:value>
</e513: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>
</SetAdExtensionsAssociationsResponse>
</s:Body>
</s:Envelope>
代码语法
示例语法可用于 必应广告 SDK。 有关更多示例,请参阅 必应广告 API 代码示例 。
public async Task<SetAdExtensionsAssociationsResponse> SetAdExtensionsAssociationsAsync(
long accountId,
IList<AdExtensionIdToEntityIdAssociation> adExtensionIdToEntityIdAssociations,
AssociationType associationType)
{
var request = new SetAdExtensionsAssociationsRequest
{
AccountId = accountId,
AdExtensionIdToEntityIdAssociations = adExtensionIdToEntityIdAssociations,
AssociationType = associationType
};
return (await CampaignManagementService.CallAsync((s, r) => s.SetAdExtensionsAssociationsAsync(r), request));
}
static SetAdExtensionsAssociationsResponse setAdExtensionsAssociations(
java.lang.Long accountId,
ArrayOfAdExtensionIdToEntityIdAssociation adExtensionIdToEntityIdAssociations,
AssociationType associationType) throws RemoteException, Exception
{
SetAdExtensionsAssociationsRequest request = new SetAdExtensionsAssociationsRequest();
request.setAccountId(accountId);
request.setAdExtensionIdToEntityIdAssociations(adExtensionIdToEntityIdAssociations);
request.setAssociationType(associationType);
return CampaignManagementService.getService().setAdExtensionsAssociations(request);
}
static function SetAdExtensionsAssociations(
$accountId,
$adExtensionIdToEntityIdAssociations,
$associationType)
{
$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];
$request = new SetAdExtensionsAssociationsRequest();
$request->AccountId = $accountId;
$request->AdExtensionIdToEntityIdAssociations = $adExtensionIdToEntityIdAssociations;
$request->AssociationType = $associationType;
return $GLOBALS['CampaignManagementProxy']->GetService()->SetAdExtensionsAssociations($request);
}
response=campaignmanagement_service.SetAdExtensionsAssociations(
AccountId=AccountId,
AdExtensionIdToEntityIdAssociations=AdExtensionIdToEntityIdAssociations,
AssociationType=AssociationType)
要求
服务: CampaignManagementService.svc v13
命名空间: https://bingads.microsoft.com/CampaignManagement/v13
请求 URL
https://campaign.api.bingads.microsoft.com/CampaignManagement/v13/AdExtensionsAssociations/Set
请求元素
SetAdExtensionsAssociationsRequest 对象定义服务操作请求的正文和标头元素。
注意
除非下面另有说明,否则需要所有请求元素。
请求正文元素
元素 | 说明 | 数据类型 |
---|---|---|
AccountId | 拥有扩展的帐户的标识符。 | long |
AdExtensionIdToEntityIdAssociations | 包含关联帐户、市场活动或广告组的广告扩展列表。 每个服务调用只能将广告扩展与一种类型的实体相关联。 使用 AssociationType 元素指定实体类型。 呼叫和位置广告扩展不能与广告组相关联。 呼叫广告扩展插件不能与帐户关联。 每个服务调用最多可以设置 100 个关联。 |
AdExtensionIdToEntityIdAssociation 数组 |
AssociationType | AdExtensionIdToEntityIdAssociations 列表中指定的所有实体的类型。 | AssociationType |
请求标头元素
元素 | 说明 | 数据类型 |
---|---|---|
Authorization | OAuth 访问令牌,表示有权Microsoft广告帐户的用户的凭据。 请确保令牌的前缀为“持有者”,这是正确身份验证所必需的。 有关详细信息,请参阅 使用 OAuth 进行身份验证。 |
string |
CustomerAccountId | 拥有或与请求中的实体关联的广告帐户的标识符。 如果需要这两个元素,此标头元素必须与 AccountId 正文元素具有相同的值。 此元素是大多数服务操作所必需的,作为最佳做法,应始终设置它。 有关详细信息,请参阅 获取帐户和客户 ID。 |
string |
CustomerId | 用户正在访问或操作的客户) 经理帐户 (标识符。 用户可以访问多个经理帐户。 此元素是大多数服务操作所必需的,作为最佳做法,应始终设置它。 有关详细信息,请参阅 获取帐户和客户 ID。 |
string |
DeveloperToken | 用于访问必应广告 API 的开发人员令牌。 有关详细信息,请参阅 获取开发人员令牌。 |
string |
Password | 此元素保留供内部使用,将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。 | string |
UserName | 此元素保留供内部使用,将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。 | string |
响应元素
SetAdExtensionsAssociationsResponse 对象定义服务操作响应的正文和标头元素。 元素的返回顺序与 响应 JSON 中所示的顺序相同。
响应正文元素
元素 | 说明 | 数据类型 |
---|---|---|
PartialErrors |
BatchError 对象的数组,其中包含未成功的任何请求项的详细信息。 错误列表与请求中的项列表不直接对应。 如果没有错误,列表可以为空,也可以包含与请求中每个不成功的列表项对应的一个或多个错误对象。 |
BatchError 数组 |
响应标头元素
元素 | 说明 | 数据类型 |
---|---|---|
跟踪 ID | 包含 API 调用详细信息的日志条目的标识符。 | string |
请求 JSON
此模板由显示 JSON 请求的 正文 和 标头 元素的工具生成。 有关可用于此服务操作的支持类型,请参阅上面的 请求正文元素 参考。
{
"AccountId": "LongValueHere",
"AdExtensionIdToEntityIdAssociations": [
{
"AdExtensionId": "LongValueHere",
"EntityId": "LongValueHere"
}
],
"AssociationType": "ValueHere"
}
响应 JSON
此模板由一个工具生成,用于显示 JSON 响应的 正文 和 标头 元素。
以下示例适用于 BatchError 的类型为 EditorialError。
{
"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
}
]
}
代码语法
若要通过 SDK 调用 REST API,需要将 SDK 升级到特定版本并配置系统参数。示例语法可用于 必应广告 SDK。 有关更多示例,请参阅 必应广告 API 代码示例 。
public async Task<SetAdExtensionsAssociationsResponse> SetAdExtensionsAssociationsAsync(
long accountId,
IList<AdExtensionIdToEntityIdAssociation> adExtensionIdToEntityIdAssociations,
AssociationType associationType)
{
var request = new SetAdExtensionsAssociationsRequest
{
AccountId = accountId,
AdExtensionIdToEntityIdAssociations = adExtensionIdToEntityIdAssociations,
AssociationType = associationType
};
return (await CampaignManagementService.CallAsync((s, r) => s.SetAdExtensionsAssociationsAsync(r), request));
}
static SetAdExtensionsAssociationsResponse setAdExtensionsAssociations(
java.lang.Long accountId,
ArrayOfAdExtensionIdToEntityIdAssociation adExtensionIdToEntityIdAssociations,
AssociationType associationType) throws RemoteException, Exception
{
SetAdExtensionsAssociationsRequest request = new SetAdExtensionsAssociationsRequest();
request.setAccountId(accountId);
request.setAdExtensionIdToEntityIdAssociations(adExtensionIdToEntityIdAssociations);
request.setAssociationType(associationType);
return CampaignManagementService.getService().setAdExtensionsAssociations(request);
}
static function SetAdExtensionsAssociations(
$accountId,
$adExtensionIdToEntityIdAssociations,
$associationType)
{
$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];
$request = new SetAdExtensionsAssociationsRequest();
$request->AccountId = $accountId;
$request->AdExtensionIdToEntityIdAssociations = $adExtensionIdToEntityIdAssociations;
$request->AssociationType = $associationType;
return $GLOBALS['CampaignManagementProxy']->GetService()->SetAdExtensionsAssociations($request);
}
response=campaignmanagement_service.SetAdExtensionsAssociations(
AccountId=AccountId,
AdExtensionIdToEntityIdAssociations=AdExtensionIdToEntityIdAssociations,
AssociationType=AssociationType)