GetCampaignCriterionsByIds 服务操作 - 市场活动管理
获取指定的市场活动条件。
请求元素
GetCampaignCriterionsByIdsRequest 对象定义服务操作请求的正文和标头元素。 元素的顺序必须与 请求 SOAP 中所示的顺序相同。
注意
除非下面另有说明,否则需要所有请求元素。
请求正文元素
元素 | 说明 | 数据类型 |
---|---|---|
CampaignCriterionIds | 标识要获取的活动条件的唯一标识符列表。 每个请求最多可以包含 100 个市场活动条件标识符。 如果此元素为 null,则将检索指定 CampaignId 的所有条件。 |
long 数组 |
CampaignId | 要获取其条件的市场活动的唯一标识符。 | long |
CriterionType | 要获取的条件类型,例如 网页。 只能指定一种类型。 此操作不允许 使用 Targets 值。 | CampaignCriterionType |
ReturnAdditionalFields | 要包含在每个返回的市场活动条件中的其他属性的列表。 借助其他字段值,可以使用当前版本的市场活动管理 API 获取最新功能,并在下一个版本中默认包含相应的元素。 此请求元素是可选的。 |
CriterionAdditionalField |
请求标头元素
元素 | 说明 | 数据类型 |
---|---|---|
AuthenticationToken | OAuth 访问令牌,表示有权Microsoft广告帐户的用户的凭据。 有关详细信息,请参阅 使用 OAuth 进行身份验证。 |
string |
CustomerAccountId | 拥有或与请求中的实体关联的广告帐户的标识符。 如果需要这两个元素,此标头元素必须与 AccountId 正文元素具有相同的值。 此元素是大多数服务操作所必需的,作为最佳做法,应始终设置它。 有关详细信息,请参阅 获取帐户和客户 ID。 |
string |
CustomerId | 用户正在访问或操作的客户) 经理帐户 (标识符。 用户可以访问多个经理帐户。 此元素是大多数服务操作所必需的,作为最佳做法,应始终设置它。 有关详细信息,请参阅 获取帐户和客户 ID。 |
string |
DeveloperToken | 用于访问必应广告 API 的开发人员令牌。 有关详细信息,请参阅 获取开发人员令牌。 |
string |
Password | 此元素保留供内部使用,将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。 | string |
UserName | 此元素保留供内部使用,将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。 | string |
响应元素
GetCampaignCriterionsByIdsResponse 对象定义服务操作响应的正文和标头元素。 元素的返回顺序与 响应 SOAP 中所示的顺序相同。
响应正文元素
元素 | 说明 | 数据类型 |
---|---|---|
CampaignCriterions | 与请求中指定的标识符直接对应的市场活动条件列表。 列表的项可能返回为 null。 对于未检索条件的每个列表索引,相应的元素将为 null。 | CampaignCriterion 数组 |
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">GetCampaignCriterionsByIds</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>
<GetCampaignCriterionsByIdsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<CampaignCriterionIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:long>ValueHere</a1:long>
</CampaignCriterionIds>
<CampaignId>ValueHere</CampaignId>
<CriterionType>ValueHere</CriterionType>
<ReturnAdditionalFields i:nil="false">ValueHere</ReturnAdditionalFields>
</GetCampaignCriterionsByIdsRequest>
</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>
<GetCampaignCriterionsByIdsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<CampaignCriterions d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<CampaignCriterion d4p1:type="-- derived type specified here with the appropriate prefix --">
<CampaignId>ValueHere</CampaignId>
<Criterion d4p1:nil="false" d4p1:type="-- derived type specified here with the appropriate prefix --">
<Type d4p1:nil="false">ValueHere</Type>
<!--These fields are applicable if the derived type attribute is set to ProductPartition-->
<Condition d4p1:nil="false">
<Attribute d4p1:nil="false">ValueHere</Attribute>
<Operand d4p1:nil="false">ValueHere</Operand>
<Operator d4p1:nil="false">ValueHere</Operator>
</Condition>
<ParentCriterionId d4p1:nil="false">ValueHere</ParentCriterionId>
<PartitionType>ValueHere</PartitionType>
<!--These fields are applicable if the derived type attribute is set to HotelGroup-->
<Listing d4p1:nil="false">
<Attribute d4p1:nil="false">ValueHere</Attribute>
<Operand d4p1:nil="false">ValueHere</Operand>
</Listing>
<ListingType>ValueHere</ListingType>
<ParentCriterionId d4p1:nil="false">ValueHere</ParentCriterionId>
<!--These fields are applicable if the derived type attribute is set to HotelAdvanceBookingWindowCriterion-->
<MaxDays d4p1:nil="false">ValueHere</MaxDays>
<MinDays d4p1:nil="false">ValueHere</MinDays>
<!--These fields are applicable if the derived type attribute is set to HotelCheckInDateCriterion-->
<EndDate d4p1:nil="false">ValueHere</EndDate>
<StartDate d4p1:nil="false">ValueHere</StartDate>
<!--This field is applicable if the derived type attribute is set to HotelCheckInDayCriterion-->
<CheckInDay d4p1:nil="false">ValueHere</CheckInDay>
<!--This field is applicable if the derived type attribute is set to HotelDateSelectionTypeCriterion-->
<HotelDateSelectionType d4p1:nil="false">ValueHere</HotelDateSelectionType>
<!--These fields are applicable if the derived type attribute is set to HotelLengthOfStayCriterion-->
<MaxNights d4p1:nil="false">ValueHere</MaxNights>
<MinNights d4p1:nil="false">ValueHere</MinNights>
<!--This field is applicable if the derived type attribute is set to ProductScope-->
<Conditions d4p1:nil="false">
<ProductCondition>
<Attribute d4p1:nil="false">ValueHere</Attribute>
<Operand d4p1:nil="false">ValueHere</Operand>
<Operator d4p1:nil="false">ValueHere</Operator>
</ProductCondition>
</Conditions>
<!--This field is applicable if the derived type attribute is set to Webpage-->
<Parameter d4p1:nil="false">
<Conditions d4p1:nil="false">
<WebpageCondition>
<Argument d4p1:nil="false">ValueHere</Argument>
<Operand>ValueHere</Operand>
<Operator d4p1:nil="false">ValueHere</Operator>
</WebpageCondition>
</Conditions>
<CriterionName d4p1:nil="false">ValueHere</CriterionName>
</Parameter>
<!--This field is applicable if the derived type attribute is set to AgeCriterion-->
<AgeRange d4p1:nil="false">ValueHere</AgeRange>
<!--These fields are applicable if the derived type attribute is set to DeviceCriterion-->
<DeviceName d4p1:nil="false">ValueHere</DeviceName>
<OSName d4p1:nil="false">ValueHere</OSName>
<!--These fields are applicable if the derived type attribute is set to DayTimeCriterion-->
<Day d4p1:nil="false">ValueHere</Day>
<FromHour d4p1:nil="false">ValueHere</FromHour>
<FromMinute d4p1:nil="false">ValueHere</FromMinute>
<ToHour d4p1:nil="false">ValueHere</ToHour>
<ToMinute d4p1:nil="false">ValueHere</ToMinute>
<!--This field is applicable if the derived type attribute is set to GenderCriterion-->
<GenderType d4p1:nil="false">ValueHere</GenderType>
<!--These fields are applicable if the derived type attribute is set to RadiusCriterion-->
<LatitudeDegrees d4p1:nil="false">ValueHere</LatitudeDegrees>
<LongitudeDegrees d4p1:nil="false">ValueHere</LongitudeDegrees>
<Name d4p1:nil="false">ValueHere</Name>
<Radius d4p1:nil="false">ValueHere</Radius>
<RadiusUnit d4p1:nil="false">ValueHere</RadiusUnit>
<!--These fields are applicable if the derived type attribute is set to LocationCriterion-->
<DisplayName d4p1:nil="false">ValueHere</DisplayName>
<EnclosedLocationIds d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:long>ValueHere</a1:long>
</EnclosedLocationIds>
<LocationId d4p1:nil="false">ValueHere</LocationId>
<LocationType d4p1:nil="false">ValueHere</LocationType>
<!--This field is applicable if the derived type attribute is set to LocationIntentCriterion-->
<IntentOption d4p1:nil="false">ValueHere</IntentOption>
<!--These fields are applicable if the derived type attribute is set to AudienceCriterion-->
<AudienceId d4p1:nil="false">ValueHere</AudienceId>
<AudienceType d4p1:nil="false">ValueHere</AudienceType>
<!--These fields are applicable if the derived type attribute is set to ProfileCriterion-->
<ProfileId>ValueHere</ProfileId>
<ProfileType>ValueHere</ProfileType>
<!--This field is applicable if the derived type attribute is set to StoreCriterion-->
<StoreId d4p1:nil="false">ValueHere</StoreId>
<!--This field is applicable if the derived type attribute is set to DealCriterion-->
<DealId>ValueHere</DealId>
<!--This field is applicable if the derived type attribute is set to GenreCriterion-->
<GenreId>ValueHere</GenreId>
<!--These fields are applicable if the derived type attribute is set to PlacementCriterion-->
<PlacementId>ValueHere</PlacementId>
<PlacementName d4p1:nil="false">ValueHere</PlacementName>
</Criterion>
<ForwardCompatibilityMap xmlns:e419="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
<e419:KeyValuePairOfstringstring>
<e419:key d4p1:nil="false">ValueHere</e419:key>
<e419:value d4p1:nil="false">ValueHere</e419:value>
</e419:KeyValuePairOfstringstring>
</ForwardCompatibilityMap>
<Id d4p1:nil="false">ValueHere</Id>
<Status d4p1:nil="false">ValueHere</Status>
<Type d4p1:nil="false">ValueHere</Type>
<!--No additional fields are applicable if the derived type attribute is set to NegativeCampaignCriterion-->
<!--These fields are applicable if the derived type attribute is set to BiddableCampaignCriterion-->
<CriterionBid d4p1:nil="false" d4p1:type="-- derived type specified here with the appropriate prefix --">
<Type d4p1:nil="false">ValueHere</Type>
<!--This field is applicable if the derived type attribute is set to RateBid-->
<RateAmount d4p1:nil="false">
<Amount d4p1:nil="false">ValueHere</Amount>
</RateAmount>
<!--This field is applicable if the derived type attribute is set to FixedBid-->
<Amount>ValueHere</Amount>
<!--This field is applicable if the derived type attribute is set to BidMultiplier-->
<Multiplier>ValueHere</Multiplier>
</CriterionBid>
<CriterionCashback d4p1:nil="false" d4p1:type="-- derived type specified here with the appropriate prefix --">
<Type d4p1:nil="false">ValueHere</Type>
<!--This field is applicable if the derived type attribute is set to CashbackAdjustment-->
<CashbackPercent d4p1:nil="false">ValueHere</CashbackPercent>
</CriterionCashback>
</CampaignCriterion>
</CampaignCriterions>
<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:e420="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
<e420:KeyValuePairOfstringstring>
<e420:key d4p1:nil="false">ValueHere</e420:key>
<e420:value d4p1:nil="false">ValueHere</e420:value>
</e420: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>
</GetCampaignCriterionsByIdsResponse>
</s:Body>
</s:Envelope>
代码语法
示例语法可用于 必应广告 SDK。 有关更多示例,请参阅 必应广告 API 代码示例 。
public async Task<GetCampaignCriterionsByIdsResponse> GetCampaignCriterionsByIdsAsync(
IList<long> campaignCriterionIds,
long campaignId,
CampaignCriterionType criterionType,
CriterionAdditionalField? returnAdditionalFields)
{
var request = new GetCampaignCriterionsByIdsRequest
{
CampaignCriterionIds = campaignCriterionIds,
CampaignId = campaignId,
CriterionType = criterionType,
ReturnAdditionalFields = returnAdditionalFields
};
return (await CampaignManagementService.CallAsync((s, r) => s.GetCampaignCriterionsByIdsAsync(r), request));
}
static GetCampaignCriterionsByIdsResponse getCampaignCriterionsByIds(
ArrayOflong campaignCriterionIds,
java.lang.Long campaignId,
ArrayList<CampaignCriterionType> criterionType,
ArrayList<CriterionAdditionalField> returnAdditionalFields) throws RemoteException, Exception
{
GetCampaignCriterionsByIdsRequest request = new GetCampaignCriterionsByIdsRequest();
request.setCampaignCriterionIds(campaignCriterionIds);
request.setCampaignId(campaignId);
request.setCriterionType(criterionType);
request.setReturnAdditionalFields(returnAdditionalFields);
return CampaignManagementService.getService().getCampaignCriterionsByIds(request);
}
static function GetCampaignCriterionsByIds(
$campaignCriterionIds,
$campaignId,
$criterionType,
$returnAdditionalFields)
{
$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];
$request = new GetCampaignCriterionsByIdsRequest();
$request->CampaignCriterionIds = $campaignCriterionIds;
$request->CampaignId = $campaignId;
$request->CriterionType = $criterionType;
$request->ReturnAdditionalFields = $returnAdditionalFields;
return $GLOBALS['CampaignManagementProxy']->GetService()->GetCampaignCriterionsByIds($request);
}
response=campaignmanagement_service.GetCampaignCriterionsByIds(
CampaignCriterionIds=CampaignCriterionIds,
CampaignId=CampaignId,
CriterionType=CriterionType,
ReturnAdditionalFields=ReturnAdditionalFields)
要求
服务: CampaignManagementService.svc v13
命名空间: https://bingads.microsoft.com/CampaignManagement/v13
请求 URL
https://campaign.api.bingads.microsoft.com/CampaignManagement/v13/CampaignCriterions/QueryByIds
请求元素
GetCampaignCriterionsByIdsRequest 对象定义服务操作请求的正文和标头元素。
注意
除非下面另有说明,否则需要所有请求元素。
请求正文元素
元素 | 说明 | 数据类型 |
---|---|---|
CampaignCriterionIds | 标识要获取的活动条件的唯一标识符列表。 每个请求最多可以包含 100 个市场活动条件标识符。 如果此元素为 null,则将检索指定 CampaignId 的所有条件。 |
long 数组 |
CampaignId | 要获取其条件的市场活动的唯一标识符。 | long |
CriterionType | 要获取的条件类型,例如 网页。 只能指定一种类型。 此操作不允许 使用 Targets 值。 | CampaignCriterionType |
ReturnAdditionalFields | 要包含在每个返回的市场活动条件中的其他属性的列表。 借助其他字段值,可以使用当前版本的市场活动管理 API 获取最新功能,并在下一个版本中默认包含相应的元素。 此请求元素是可选的。 |
CriterionAdditionalField |
请求标头元素
元素 | 说明 | 数据类型 |
---|---|---|
Authorization | OAuth 访问令牌,表示有权Microsoft广告帐户的用户的凭据。 请确保令牌的前缀为“持有者”,这是正确身份验证所必需的。 有关详细信息,请参阅 使用 OAuth 进行身份验证。 |
string |
CustomerAccountId | 拥有或与请求中的实体关联的广告帐户的标识符。 如果需要这两个元素,此标头元素必须与 AccountId 正文元素具有相同的值。 此元素是大多数服务操作所必需的,作为最佳做法,应始终设置它。 有关详细信息,请参阅 获取帐户和客户 ID。 |
string |
CustomerId | 用户正在访问或操作的客户) 经理帐户 (标识符。 用户可以访问多个经理帐户。 此元素是大多数服务操作所必需的,作为最佳做法,应始终设置它。 有关详细信息,请参阅 获取帐户和客户 ID。 |
string |
DeveloperToken | 用于访问必应广告 API 的开发人员令牌。 有关详细信息,请参阅 获取开发人员令牌。 |
string |
Password | 此元素保留供内部使用,将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。 | string |
UserName | 此元素保留供内部使用,将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。 | string |
响应元素
GetCampaignCriterionsByIdsResponse 对象定义服务操作响应的正文和标头元素。 元素的返回顺序与 响应 JSON 中所示的顺序相同。
响应正文元素
元素 | 说明 | 数据类型 |
---|---|---|
CampaignCriterions | 与请求中指定的标识符直接对应的市场活动条件列表。 列表的项可能返回为 null。 对于未检索条件的每个列表索引,相应的元素将为 null。 | CampaignCriterion 数组 |
PartialErrors |
BatchError 对象的数组,其中包含未成功的任何请求项的详细信息。 错误列表与请求中的项列表不直接对应。 如果没有错误,列表可以为空,也可以包含与请求中每个不成功的列表项对应的一个或多个错误对象。 |
BatchError 数组 |
响应标头元素
元素 | 说明 | 数据类型 |
---|---|---|
跟踪 ID | 包含 API 调用详细信息的日志条目的标识符。 | string |
请求 JSON
此模板由显示 JSON 请求的 正文 和 标头 元素的工具生成。 有关可用于此服务操作的支持类型,请参阅上面的 请求正文元素 参考。
{
"CampaignCriterionIds": [
"LongValueHere"
],
"CampaignId": "LongValueHere",
"CriterionType": "ValueHere",
"ReturnAdditionalFields": "ValueHere"
}
响应 JSON
此模板由一个工具生成,用于显示 JSON 响应的 正文 和 标头 元素。
下面是一个适用的示例,如果 CampaignCriterion 的类型为 BiddableCampaignCriterion,Criterion 为 AgeCriterion,CriterionBid 为 BidMultiplier,CriterionCashback 为 CashbackAdjustment,BatchError 为 EditorialError。
{
"CampaignCriterions": [
{
"CampaignId": "LongValueHere",
"Criterion": {
"Type": "AgeCriterion",
"AgeRange": "ValueHere"
},
"ForwardCompatibilityMap": [
{
"key": "ValueHere",
"value": "ValueHere"
}
],
"Id": "LongValueHere",
"Status": "ValueHere",
"Type": "BiddableCampaignCriterion",
"CriterionBid": {
"Type": "BidMultiplier",
"Multiplier": DoubleValueHere
},
"CriterionCashback": {
"Type": "CashbackAdjustment",
"CashbackPercent": DoubleValueHere
}
}
],
"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<GetCampaignCriterionsByIdsResponse> GetCampaignCriterionsByIdsAsync(
IList<long> campaignCriterionIds,
long campaignId,
CampaignCriterionType criterionType,
CriterionAdditionalField? returnAdditionalFields)
{
var request = new GetCampaignCriterionsByIdsRequest
{
CampaignCriterionIds = campaignCriterionIds,
CampaignId = campaignId,
CriterionType = criterionType,
ReturnAdditionalFields = returnAdditionalFields
};
return (await CampaignManagementService.CallAsync((s, r) => s.GetCampaignCriterionsByIdsAsync(r), request));
}
static GetCampaignCriterionsByIdsResponse getCampaignCriterionsByIds(
ArrayOflong campaignCriterionIds,
java.lang.Long campaignId,
ArrayList<CampaignCriterionType> criterionType,
ArrayList<CriterionAdditionalField> returnAdditionalFields) throws RemoteException, Exception
{
GetCampaignCriterionsByIdsRequest request = new GetCampaignCriterionsByIdsRequest();
request.setCampaignCriterionIds(campaignCriterionIds);
request.setCampaignId(campaignId);
request.setCriterionType(criterionType);
request.setReturnAdditionalFields(returnAdditionalFields);
return CampaignManagementService.getService().getCampaignCriterionsByIds(request);
}
static function GetCampaignCriterionsByIds(
$campaignCriterionIds,
$campaignId,
$criterionType,
$returnAdditionalFields)
{
$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];
$request = new GetCampaignCriterionsByIdsRequest();
$request->CampaignCriterionIds = $campaignCriterionIds;
$request->CampaignId = $campaignId;
$request->CriterionType = $criterionType;
$request->ReturnAdditionalFields = $returnAdditionalFields;
return $GLOBALS['CampaignManagementProxy']->GetService()->GetCampaignCriterionsByIds($request);
}
response=campaignmanagement_service.GetCampaignCriterionsByIds(
CampaignCriterionIds=CampaignCriterionIds,
CampaignId=CampaignId,
CriterionType=CriterionType,
ReturnAdditionalFields=ReturnAdditionalFields)