GetAdGroupCriterionsByIds 服务操作 - 市场活动管理
按标识符和类型获取广告组条件。
请求元素
GetAdGroupCriterionsByIdsRequest 对象定义服务操作请求的正文和标头元素。 元素的顺序必须与 请求 SOAP 中所示的顺序相同。
注意
除非下面另有说明，否则需要所有请求元素。
请求正文元素
| 元素 | 说明 | 数据类型 |
|---|---|---|
| AdGroupCriterionIds | 标识要获取的条件的唯一标识符的列表。 每个请求最多可以包含 1,000 个广告组条件标识符。 如果此元素为 null，则将检索指定 AdGroupId 的所有条件。 |
long 数组 |
| AdGroupId | 拥有要获取的条件的广告组的标识符。 | long |
| CriterionType | 要获取的条件类型，例如 网页。 只能指定一种类型。 此操作不允许 使用“目标 ”和“ 访问群体 ”值。 | AdGroupCriterionType |
| 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 |
响应元素
GetAdGroupCriterionsByIdsResponse 对象定义服务操作响应的正文和标头元素。 元素的返回顺序与 响应 SOAP 中所示的顺序相同。
响应正文元素
| 元素 | 说明 | 数据类型 |
|---|---|---|
| AdGroupCriterions | 与请求中指定的标识符直接对应的条件列表。 如果列表中的标识符无效，响应中的相应项将设置为 null。 | AdGroupCriterion 数组 |
响应标头元素
| 元素 | 说明 | 数据类型 |
|---|---|---|
| 跟踪 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">GetAdGroupCriterionsByIds</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>
<GetAdGroupCriterionsByIdsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<AdGroupCriterionIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:long>ValueHere</a1:long>
</AdGroupCriterionIds>
<AdGroupId>ValueHere</AdGroupId>
<CriterionType>ValueHere</CriterionType>
<ReturnAdditionalFields i:nil="false">ValueHere</ReturnAdditionalFields>
</GetAdGroupCriterionsByIdsRequest>
</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>
<GetAdGroupCriterionsByIdsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<AdGroupCriterions d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<AdGroupCriterion d4p1:type="-- derived type specified here with the appropriate prefix --">
<AdGroupId>ValueHere</AdGroupId>
<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>
<Id d4p1:nil="false">ValueHere</Id>
<Status d4p1:nil="false">ValueHere</Status>
<Type d4p1:nil="false">ValueHere</Type>
<!--These fields are applicable if the derived type attribute is set to BiddableAdGroupCriterion-->
<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>
<DestinationUrl d4p1:nil="false">ValueHere</DestinationUrl>
<EditorialStatus d4p1:nil="false">ValueHere</EditorialStatus>
<FinalAppUrls d4p1:nil="false">
<AppUrl>
<OsType d4p1:nil="false">ValueHere</OsType>
<Url d4p1:nil="false">ValueHere</Url>
</AppUrl>
</FinalAppUrls>
<FinalMobileUrls d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:string>ValueHere</a1:string>
</FinalMobileUrls>
<FinalUrlSuffix d4p1:nil="false">ValueHere</FinalUrlSuffix>
<FinalUrls d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:string>ValueHere</a1:string>
</FinalUrls>
<TrackingUrlTemplate d4p1:nil="false">ValueHere</TrackingUrlTemplate>
<UrlCustomParameters d4p1:nil="false">
<Parameters d4p1:nil="false">
<CustomParameter>
<Key d4p1:nil="false">ValueHere</Key>
<Value d4p1:nil="false">ValueHere</Value>
</CustomParameter>
</Parameters>
</UrlCustomParameters>
<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>
<!--No additional fields are applicable if the derived type attribute is set to NegativeAdGroupCriterion-->
</AdGroupCriterion>
</AdGroupCriterions>
</GetAdGroupCriterionsByIdsResponse>
</s:Body>
</s:Envelope>
代码语法
示例语法可用于 必应广告 SDK。 有关更多示例，请参阅 必应广告 API 代码示例 。
public async Task<GetAdGroupCriterionsByIdsResponse> GetAdGroupCriterionsByIdsAsync(
IList<long> adGroupCriterionIds,
long adGroupId,
AdGroupCriterionType criterionType,
CriterionAdditionalField? returnAdditionalFields)
{
var request = new GetAdGroupCriterionsByIdsRequest
{
AdGroupCriterionIds = adGroupCriterionIds,
AdGroupId = adGroupId,
CriterionType = criterionType,
ReturnAdditionalFields = returnAdditionalFields
};
return (await CampaignManagementService.CallAsync((s, r) => s.GetAdGroupCriterionsByIdsAsync(r), request));
}
static GetAdGroupCriterionsByIdsResponse getAdGroupCriterionsByIds(
ArrayOflong adGroupCriterionIds,
java.lang.Long adGroupId,
ArrayList<AdGroupCriterionType> criterionType,
ArrayList<CriterionAdditionalField> returnAdditionalFields) throws RemoteException, Exception
{
GetAdGroupCriterionsByIdsRequest request = new GetAdGroupCriterionsByIdsRequest();
request.setAdGroupCriterionIds(adGroupCriterionIds);
request.setAdGroupId(adGroupId);
request.setCriterionType(criterionType);
request.setReturnAdditionalFields(returnAdditionalFields);
return CampaignManagementService.getService().getAdGroupCriterionsByIds(request);
}
static function GetAdGroupCriterionsByIds(
$adGroupCriterionIds,
$adGroupId,
$criterionType,
$returnAdditionalFields)
{
$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];
$request = new GetAdGroupCriterionsByIdsRequest();
$request->AdGroupCriterionIds = $adGroupCriterionIds;
$request->AdGroupId = $adGroupId;
$request->CriterionType = $criterionType;
$request->ReturnAdditionalFields = $returnAdditionalFields;
return $GLOBALS['CampaignManagementProxy']->GetService()->GetAdGroupCriterionsByIds($request);
}
response=campaignmanagement_service.GetAdGroupCriterionsByIds(
AdGroupCriterionIds=AdGroupCriterionIds,
AdGroupId=AdGroupId,
CriterionType=CriterionType,
ReturnAdditionalFields=ReturnAdditionalFields)
要求
服务： CampaignManagementService.svc v13
命名空间： https://bingads.microsoft.com/CampaignManagement/v13
请求 URL
https://campaign.api.bingads.microsoft.com/CampaignManagement/v13/AdGroupCriterions/QueryByIds
请求元素
GetAdGroupCriterionsByIdsRequest 对象定义服务操作请求的正文和标头元素。
注意
除非下面另有说明，否则需要所有请求元素。
请求正文元素
| 元素 | 说明 | 数据类型 |
|---|---|---|
| AdGroupCriterionIds | 标识要获取的条件的唯一标识符的列表。 每个请求最多可以包含 1,000 个广告组条件标识符。 如果此元素为 null，则将检索指定 AdGroupId 的所有条件。 |
long 数组 |
| AdGroupId | 拥有要获取的条件的广告组的标识符。 | long |
| CriterionType | 要获取的条件类型，例如 网页。 只能指定一种类型。 此操作不允许 使用“目标 ”和“ 访问群体 ”值。 | AdGroupCriterionType |
| 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 |
响应元素
GetAdGroupCriterionsByIdsResponse 对象定义服务操作响应的正文和标头元素。 元素的返回顺序与 响应 JSON 中所示的顺序相同。
响应正文元素
| 元素 | 说明 | 数据类型 |
|---|---|---|
| AdGroupCriterions | 与请求中指定的标识符直接对应的条件列表。 如果列表中的标识符无效，响应中的相应项将设置为 null。 | AdGroupCriterion 数组 |
响应标头元素
| 元素 | 说明 | 数据类型 |
|---|---|---|
| 跟踪 ID | 包含 API 调用详细信息的日志条目的标识符。 | string |
请求 JSON
此模板由显示 JSON 请求的 正文 和 标头 元素的工具生成。 有关可用于此服务操作的支持类型，请参阅上面的 请求正文元素 参考。
{
"AdGroupCriterionIds": [
"LongValueHere"
],
"AdGroupId": "LongValueHere",
"CriterionType": "ValueHere",
"ReturnAdditionalFields": "ValueHere"
}
响应 JSON
此模板由一个工具生成，用于显示 JSON 响应的 正文 和 标头 元素。
下面是一个示例，如果 AdGroupCriterion 的类型为 BiddableAdGroupCriterion，Criterion 为 AgeCriterion，CriterionBid 为 BidMultiplier，CriterionCashback 为 CashbackAdjustment，则适用。
{
"AdGroupCriterions": [
{
"AdGroupId": "LongValueHere",
"Criterion": {
"Type": "AgeCriterion",
"AgeRange": "ValueHere"
},
"Id": "LongValueHere",
"Status": "ValueHere",
"Type": "BiddableAdGroupCriterion",
"CriterionBid": {
"Type": "BidMultiplier",
"Multiplier": DoubleValueHere
},
"CriterionCashback": {
"Type": "CashbackAdjustment",
"CashbackPercent": DoubleValueHere
},
"DestinationUrl": "ValueHere",
"EditorialStatus": "ValueHere",
"FinalAppUrls": [
{
"OsType": "ValueHere",
"Url": "ValueHere"
}
],
"FinalMobileUrls": [
"ValueHere"
],
"FinalUrls": [
"ValueHere"
],
"FinalUrlSuffix": "ValueHere",
"TrackingUrlTemplate": "ValueHere",
"UrlCustomParameters": {
"Parameters": [
{
"Key": "ValueHere",
"Value": "ValueHere"
}
]
}
}
]
}
代码语法
若要通过 SDK 调用 REST API，需要将 SDK 升级到特定版本并配置系统参数。示例语法可用于 必应广告 SDK。 有关更多示例，请参阅 必应广告 API 代码示例 。
public async Task<GetAdGroupCriterionsByIdsResponse> GetAdGroupCriterionsByIdsAsync(
IList<long> adGroupCriterionIds,
long adGroupId,
AdGroupCriterionType criterionType,
CriterionAdditionalField? returnAdditionalFields)
{
var request = new GetAdGroupCriterionsByIdsRequest
{
AdGroupCriterionIds = adGroupCriterionIds,
AdGroupId = adGroupId,
CriterionType = criterionType,
ReturnAdditionalFields = returnAdditionalFields
};
return (await CampaignManagementService.CallAsync((s, r) => s.GetAdGroupCriterionsByIdsAsync(r), request));
}
static GetAdGroupCriterionsByIdsResponse getAdGroupCriterionsByIds(
ArrayOflong adGroupCriterionIds,
java.lang.Long adGroupId,
ArrayList<AdGroupCriterionType> criterionType,
ArrayList<CriterionAdditionalField> returnAdditionalFields) throws RemoteException, Exception
{
GetAdGroupCriterionsByIdsRequest request = new GetAdGroupCriterionsByIdsRequest();
request.setAdGroupCriterionIds(adGroupCriterionIds);
request.setAdGroupId(adGroupId);
request.setCriterionType(criterionType);
request.setReturnAdditionalFields(returnAdditionalFields);
return CampaignManagementService.getService().getAdGroupCriterionsByIds(request);
}
static function GetAdGroupCriterionsByIds(
$adGroupCriterionIds,
$adGroupId,
$criterionType,
$returnAdditionalFields)
{
$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];
$request = new GetAdGroupCriterionsByIdsRequest();
$request->AdGroupCriterionIds = $adGroupCriterionIds;
$request->AdGroupId = $adGroupId;
$request->CriterionType = $criterionType;
$request->ReturnAdditionalFields = $returnAdditionalFields;
return $GLOBALS['CampaignManagementProxy']->GetService()->GetAdGroupCriterionsByIds($request);
}
response=campaignmanagement_service.GetAdGroupCriterionsByIds(
AdGroupCriterionIds=AdGroupCriterionIds,
AdGroupId=AdGroupId,
CriterionType=CriterionType,
ReturnAdditionalFields=ReturnAdditionalFields)