GetAdsByIds 服务操作 - 市场活动管理
从指定的广告组检索指定的广告。
请求元素
GetAdsByIdsRequest 对象定义服务操作请求的正文和标头元素。 元素的顺序必须与 请求 SOAP 中所示的顺序相同。
注意
除非下面另有说明,否则需要所有请求元素。
请求正文元素
元素 | 说明 | 数据类型 |
---|---|---|
AdGroupId | 包含要获取的广告的广告组的标识符。 | long |
AdIds | 最多 20 个所请求广告的标识符。 如果广告标识符与请求的广告类型不匹配,则该操作将为每个请求的广告返回批处理错误。 |
long 数组 |
AdTypes | 要返回的一个或多个广告类型。 | AdType 数组 |
ReturnAdditionalFields | 借助其他字段值,可以使用当前版本的市场活动管理 API 获取最新功能,并在下一个版本中默认包含相应的元素。 此请求元素是可选的。 |
AdAdditionalField |
请求标头元素
元素 | 说明 | 数据类型 |
---|---|---|
AuthenticationToken | OAuth 访问令牌,表示有权Microsoft广告帐户的用户的凭据。 有关详细信息,请参阅 使用 OAuth 进行身份验证。 |
string |
CustomerAccountId | 拥有或与请求中的实体关联的广告帐户的标识符。 如果需要这两个元素,此标头元素必须与 AccountId 正文元素具有相同的值。 此元素是大多数服务操作所必需的,作为最佳做法,应始终设置它。 有关详细信息,请参阅 获取帐户和客户 ID。 |
string |
CustomerId | 用户正在访问或操作的客户) 经理帐户 (标识符。 用户可以访问多个经理帐户。 此元素是大多数服务操作所必需的,作为最佳做法,应始终设置它。 有关详细信息,请参阅 获取帐户和客户 ID。 |
string |
DeveloperToken | 用于访问必应广告 API 的开发人员令牌。 有关详细信息,请参阅 获取开发人员令牌。 |
string |
Password | 此元素保留供内部使用,将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。 | string |
UserName | 此元素保留供内部使用,将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。 | string |
响应元素
GetAdsByIdsResponse 对象定义服务操作响应的正文和标头元素。 元素的返回顺序与 响应 SOAP 中所示的顺序相同。
响应正文元素
元素 | 说明 | 数据类型 |
---|---|---|
广告 | 与请求中指定的广告标识符直接对应的 Ad 对象的数组。 列表的项可能返回为 null。 对于未检索广告的每个列表索引,相应的元素将为 null。 | 广告 数组 |
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">GetAdsByIds</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>
<GetAdsByIdsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<AdGroupId>ValueHere</AdGroupId>
<AdIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:long>ValueHere</a1:long>
</AdIds>
<AdTypes i:nil="false">
<AdType>ValueHere</AdType>
</AdTypes>
<ReturnAdditionalFields i:nil="false">ValueHere</ReturnAdditionalFields>
</GetAdsByIdsRequest>
</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>
<GetAdsByIdsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<Ads d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<Ad d4p1:type="-- derived type specified here with the appropriate prefix --">
<AdFormatPreference d4p1:nil="false">ValueHere</AdFormatPreference>
<DevicePreference d4p1:nil="false">ValueHere</DevicePreference>
<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>
<ForwardCompatibilityMap xmlns:e395="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
<e395:KeyValuePairOfstringstring>
<e395:key d4p1:nil="false">ValueHere</e395:key>
<e395:value d4p1:nil="false">ValueHere</e395:value>
</e395:KeyValuePairOfstringstring>
</ForwardCompatibilityMap>
<Id d4p1:nil="false">ValueHere</Id>
<Status d4p1:nil="false">ValueHere</Status>
<TrackingUrlTemplate d4p1:nil="false">ValueHere</TrackingUrlTemplate>
<Type d4p1:nil="false">ValueHere</Type>
<UrlCustomParameters d4p1:nil="false">
<Parameters d4p1:nil="false">
<CustomParameter>
<Key d4p1:nil="false">ValueHere</Key>
<Value d4p1:nil="false">ValueHere</Value>
</CustomParameter>
</Parameters>
</UrlCustomParameters>
<!--These fields are applicable if the derived type attribute is set to TextAd-->
<DestinationUrl d4p1:nil="false">ValueHere</DestinationUrl>
<DisplayUrl d4p1:nil="false">ValueHere</DisplayUrl>
<Text d4p1:nil="false">ValueHere</Text>
<Title d4p1:nil="false">ValueHere</Title>
<!--This field is applicable if the derived type attribute is set to ProductAd-->
<PromotionalText d4p1:nil="false">ValueHere</PromotionalText>
<!--No additional fields are applicable if the derived type attribute is set to HotelAd-->
<!--These fields are applicable if the derived type attribute is set to AppInstallAd-->
<AppPlatform d4p1:nil="false">ValueHere</AppPlatform>
<AppStoreId d4p1:nil="false">ValueHere</AppStoreId>
<Text d4p1:nil="false">ValueHere</Text>
<Title d4p1:nil="false">ValueHere</Title>
<!--These fields are applicable if the derived type attribute is set to ExpandedTextAd-->
<Domain d4p1:nil="false">ValueHere</Domain>
<Path1 d4p1:nil="false">ValueHere</Path1>
<Path2 d4p1:nil="false">ValueHere</Path2>
<Text d4p1:nil="false">ValueHere</Text>
<TextPart2 d4p1:nil="false">ValueHere</TextPart2>
<TitlePart1 d4p1:nil="false">ValueHere</TitlePart1>
<TitlePart2 d4p1:nil="false">ValueHere</TitlePart2>
<TitlePart3 d4p1:nil="false">ValueHere</TitlePart3>
<!--These fields are applicable if the derived type attribute is set to DynamicSearchAd-->
<Path1 d4p1:nil="false">ValueHere</Path1>
<Path2 d4p1:nil="false">ValueHere</Path2>
<Text d4p1:nil="false">ValueHere</Text>
<TextPart2 d4p1:nil="false">ValueHere</TextPart2>
<!--These fields are applicable if the derived type attribute is set to ResponsiveAd-->
<AdSubType d4p1:nil="false">ValueHere</AdSubType>
<BusinessName d4p1:nil="false">ValueHere</BusinessName>
<CallToAction d4p1:nil="false">ValueHere</CallToAction>
<CallToActionLanguage d4p1:nil="false">ValueHere</CallToActionLanguage>
<Descriptions d4p1:nil="false">
<AssetLink>
<Asset d4p1:nil="false" d4p1:type="-- derived type specified here with the appropriate prefix --">
<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 TextAsset-->
<Text d4p1:nil="false">ValueHere</Text>
<!--These fields are applicable if the derived type attribute is set to ImageAsset-->
<CropHeight d4p1:nil="false">ValueHere</CropHeight>
<CropWidth d4p1:nil="false">ValueHere</CropWidth>
<CropX d4p1:nil="false">ValueHere</CropX>
<CropY d4p1:nil="false">ValueHere</CropY>
<SubType d4p1:nil="false">ValueHere</SubType>
<TargetHeight d4p1:nil="false">ValueHere</TargetHeight>
<TargetWidth d4p1:nil="false">ValueHere</TargetWidth>
<!--These fields are applicable if the derived type attribute is set to VideoAsset-->
<SubType d4p1:nil="false">ValueHere</SubType>
<ThumbnailImage d4p1:nil="false">
<CropHeight d4p1:nil="false">ValueHere</CropHeight>
<CropWidth d4p1:nil="false">ValueHere</CropWidth>
<CropX d4p1:nil="false">ValueHere</CropX>
<CropY d4p1:nil="false">ValueHere</CropY>
<SubType d4p1:nil="false">ValueHere</SubType>
<TargetHeight d4p1:nil="false">ValueHere</TargetHeight>
<TargetWidth d4p1:nil="false">ValueHere</TargetWidth>
</ThumbnailImage>
</Asset>
<AssetPerformanceLabel d4p1:nil="false">ValueHere</AssetPerformanceLabel>
<EditorialStatus d4p1:nil="false">ValueHere</EditorialStatus>
<PinnedField d4p1:nil="false">ValueHere</PinnedField>
</AssetLink>
</Descriptions>
<Headline d4p1:nil="false">ValueHere</Headline>
<Headlines d4p1:nil="false">
<AssetLink>
<Asset d4p1:nil="false" d4p1:type="-- derived type specified here with the appropriate prefix --">
<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 TextAsset-->
<Text d4p1:nil="false">ValueHere</Text>
<!--These fields are applicable if the derived type attribute is set to ImageAsset-->
<CropHeight d4p1:nil="false">ValueHere</CropHeight>
<CropWidth d4p1:nil="false">ValueHere</CropWidth>
<CropX d4p1:nil="false">ValueHere</CropX>
<CropY d4p1:nil="false">ValueHere</CropY>
<SubType d4p1:nil="false">ValueHere</SubType>
<TargetHeight d4p1:nil="false">ValueHere</TargetHeight>
<TargetWidth d4p1:nil="false">ValueHere</TargetWidth>
<!--These fields are applicable if the derived type attribute is set to VideoAsset-->
<SubType d4p1:nil="false">ValueHere</SubType>
<ThumbnailImage d4p1:nil="false">
<CropHeight d4p1:nil="false">ValueHere</CropHeight>
<CropWidth d4p1:nil="false">ValueHere</CropWidth>
<CropX d4p1:nil="false">ValueHere</CropX>
<CropY d4p1:nil="false">ValueHere</CropY>
<SubType d4p1:nil="false">ValueHere</SubType>
<TargetHeight d4p1:nil="false">ValueHere</TargetHeight>
<TargetWidth d4p1:nil="false">ValueHere</TargetWidth>
</ThumbnailImage>
</Asset>
<AssetPerformanceLabel d4p1:nil="false">ValueHere</AssetPerformanceLabel>
<EditorialStatus d4p1:nil="false">ValueHere</EditorialStatus>
<PinnedField d4p1:nil="false">ValueHere</PinnedField>
</AssetLink>
</Headlines>
<Images d4p1:nil="false">
<AssetLink>
<Asset d4p1:nil="false" d4p1:type="-- derived type specified here with the appropriate prefix --">
<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 TextAsset-->
<Text d4p1:nil="false">ValueHere</Text>
<!--These fields are applicable if the derived type attribute is set to ImageAsset-->
<CropHeight d4p1:nil="false">ValueHere</CropHeight>
<CropWidth d4p1:nil="false">ValueHere</CropWidth>
<CropX d4p1:nil="false">ValueHere</CropX>
<CropY d4p1:nil="false">ValueHere</CropY>
<SubType d4p1:nil="false">ValueHere</SubType>
<TargetHeight d4p1:nil="false">ValueHere</TargetHeight>
<TargetWidth d4p1:nil="false">ValueHere</TargetWidth>
<!--These fields are applicable if the derived type attribute is set to VideoAsset-->
<SubType d4p1:nil="false">ValueHere</SubType>
<ThumbnailImage d4p1:nil="false">
<CropHeight d4p1:nil="false">ValueHere</CropHeight>
<CropWidth d4p1:nil="false">ValueHere</CropWidth>
<CropX d4p1:nil="false">ValueHere</CropX>
<CropY d4p1:nil="false">ValueHere</CropY>
<SubType d4p1:nil="false">ValueHere</SubType>
<TargetHeight d4p1:nil="false">ValueHere</TargetHeight>
<TargetWidth d4p1:nil="false">ValueHere</TargetWidth>
</ThumbnailImage>
</Asset>
<AssetPerformanceLabel d4p1:nil="false">ValueHere</AssetPerformanceLabel>
<EditorialStatus d4p1:nil="false">ValueHere</EditorialStatus>
<PinnedField d4p1:nil="false">ValueHere</PinnedField>
</AssetLink>
</Images>
<ImpressionTrackingUrls d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:string>ValueHere</a1:string>
</ImpressionTrackingUrls>
<LongHeadline d4p1:nil="false">
<Asset d4p1:nil="false" d4p1:type="-- derived type specified here with the appropriate prefix --">
<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 TextAsset-->
<Text d4p1:nil="false">ValueHere</Text>
<!--These fields are applicable if the derived type attribute is set to ImageAsset-->
<CropHeight d4p1:nil="false">ValueHere</CropHeight>
<CropWidth d4p1:nil="false">ValueHere</CropWidth>
<CropX d4p1:nil="false">ValueHere</CropX>
<CropY d4p1:nil="false">ValueHere</CropY>
<SubType d4p1:nil="false">ValueHere</SubType>
<TargetHeight d4p1:nil="false">ValueHere</TargetHeight>
<TargetWidth d4p1:nil="false">ValueHere</TargetWidth>
<!--These fields are applicable if the derived type attribute is set to VideoAsset-->
<SubType d4p1:nil="false">ValueHere</SubType>
<ThumbnailImage d4p1:nil="false">
<CropHeight d4p1:nil="false">ValueHere</CropHeight>
<CropWidth d4p1:nil="false">ValueHere</CropWidth>
<CropX d4p1:nil="false">ValueHere</CropX>
<CropY d4p1:nil="false">ValueHere</CropY>
<SubType d4p1:nil="false">ValueHere</SubType>
<TargetHeight d4p1:nil="false">ValueHere</TargetHeight>
<TargetWidth d4p1:nil="false">ValueHere</TargetWidth>
</ThumbnailImage>
</Asset>
<AssetPerformanceLabel d4p1:nil="false">ValueHere</AssetPerformanceLabel>
<EditorialStatus d4p1:nil="false">ValueHere</EditorialStatus>
<PinnedField d4p1:nil="false">ValueHere</PinnedField>
</LongHeadline>
<LongHeadlineString d4p1:nil="false">ValueHere</LongHeadlineString>
<LongHeadlines d4p1:nil="false">
<AssetLink>
<Asset d4p1:nil="false" d4p1:type="-- derived type specified here with the appropriate prefix --">
<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 TextAsset-->
<Text d4p1:nil="false">ValueHere</Text>
<!--These fields are applicable if the derived type attribute is set to ImageAsset-->
<CropHeight d4p1:nil="false">ValueHere</CropHeight>
<CropWidth d4p1:nil="false">ValueHere</CropWidth>
<CropX d4p1:nil="false">ValueHere</CropX>
<CropY d4p1:nil="false">ValueHere</CropY>
<SubType d4p1:nil="false">ValueHere</SubType>
<TargetHeight d4p1:nil="false">ValueHere</TargetHeight>
<TargetWidth d4p1:nil="false">ValueHere</TargetWidth>
<!--These fields are applicable if the derived type attribute is set to VideoAsset-->
<SubType d4p1:nil="false">ValueHere</SubType>
<ThumbnailImage d4p1:nil="false">
<CropHeight d4p1:nil="false">ValueHere</CropHeight>
<CropWidth d4p1:nil="false">ValueHere</CropWidth>
<CropX d4p1:nil="false">ValueHere</CropX>
<CropY d4p1:nil="false">ValueHere</CropY>
<SubType d4p1:nil="false">ValueHere</SubType>
<TargetHeight d4p1:nil="false">ValueHere</TargetHeight>
<TargetWidth d4p1:nil="false">ValueHere</TargetWidth>
</ThumbnailImage>
</Asset>
<AssetPerformanceLabel d4p1:nil="false">ValueHere</AssetPerformanceLabel>
<EditorialStatus d4p1:nil="false">ValueHere</EditorialStatus>
<PinnedField d4p1:nil="false">ValueHere</PinnedField>
</AssetLink>
</LongHeadlines>
<Text d4p1:nil="false">ValueHere</Text>
<VerifiedTrackingSettings d4p1:nil="false">
<Details xmlns:e396="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
<e396:ArrayOfKeyValuePairOfstringstring>
<e396:KeyValuePairOfstringstring>
<e396:key d4p1:nil="false">ValueHere</e396:key>
<e396:value d4p1:nil="false">ValueHere</e396:value>
</e396:KeyValuePairOfstringstring>
</e396:ArrayOfKeyValuePairOfstringstring>
</Details>
</VerifiedTrackingSettings>
<Videos d4p1:nil="false">
<AssetLink>
<Asset d4p1:nil="false" d4p1:type="-- derived type specified here with the appropriate prefix --">
<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 TextAsset-->
<Text d4p1:nil="false">ValueHere</Text>
<!--These fields are applicable if the derived type attribute is set to ImageAsset-->
<CropHeight d4p1:nil="false">ValueHere</CropHeight>
<CropWidth d4p1:nil="false">ValueHere</CropWidth>
<CropX d4p1:nil="false">ValueHere</CropX>
<CropY d4p1:nil="false">ValueHere</CropY>
<SubType d4p1:nil="false">ValueHere</SubType>
<TargetHeight d4p1:nil="false">ValueHere</TargetHeight>
<TargetWidth d4p1:nil="false">ValueHere</TargetWidth>
<!--These fields are applicable if the derived type attribute is set to VideoAsset-->
<SubType d4p1:nil="false">ValueHere</SubType>
<ThumbnailImage d4p1:nil="false">
<CropHeight d4p1:nil="false">ValueHere</CropHeight>
<CropWidth d4p1:nil="false">ValueHere</CropWidth>
<CropX d4p1:nil="false">ValueHere</CropX>
<CropY d4p1:nil="false">ValueHere</CropY>
<SubType d4p1:nil="false">ValueHere</SubType>
<TargetHeight d4p1:nil="false">ValueHere</TargetHeight>
<TargetWidth d4p1:nil="false">ValueHere</TargetWidth>
</ThumbnailImage>
</Asset>
<AssetPerformanceLabel d4p1:nil="false">ValueHere</AssetPerformanceLabel>
<EditorialStatus d4p1:nil="false">ValueHere</EditorialStatus>
<PinnedField d4p1:nil="false">ValueHere</PinnedField>
</AssetLink>
</Videos>
<!--These fields are applicable if the derived type attribute is set to ResponsiveSearchAd-->
<Descriptions d4p1:nil="false">
<AssetLink>
<Asset d4p1:nil="false" d4p1:type="-- derived type specified here with the appropriate prefix --">
<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 TextAsset-->
<Text d4p1:nil="false">ValueHere</Text>
<!--These fields are applicable if the derived type attribute is set to ImageAsset-->
<CropHeight d4p1:nil="false">ValueHere</CropHeight>
<CropWidth d4p1:nil="false">ValueHere</CropWidth>
<CropX d4p1:nil="false">ValueHere</CropX>
<CropY d4p1:nil="false">ValueHere</CropY>
<SubType d4p1:nil="false">ValueHere</SubType>
<TargetHeight d4p1:nil="false">ValueHere</TargetHeight>
<TargetWidth d4p1:nil="false">ValueHere</TargetWidth>
<!--These fields are applicable if the derived type attribute is set to VideoAsset-->
<SubType d4p1:nil="false">ValueHere</SubType>
<ThumbnailImage d4p1:nil="false">
<CropHeight d4p1:nil="false">ValueHere</CropHeight>
<CropWidth d4p1:nil="false">ValueHere</CropWidth>
<CropX d4p1:nil="false">ValueHere</CropX>
<CropY d4p1:nil="false">ValueHere</CropY>
<SubType d4p1:nil="false">ValueHere</SubType>
<TargetHeight d4p1:nil="false">ValueHere</TargetHeight>
<TargetWidth d4p1:nil="false">ValueHere</TargetWidth>
</ThumbnailImage>
</Asset>
<AssetPerformanceLabel d4p1:nil="false">ValueHere</AssetPerformanceLabel>
<EditorialStatus d4p1:nil="false">ValueHere</EditorialStatus>
<PinnedField d4p1:nil="false">ValueHere</PinnedField>
</AssetLink>
</Descriptions>
<Domain d4p1:nil="false">ValueHere</Domain>
<Headlines d4p1:nil="false">
<AssetLink>
<Asset d4p1:nil="false" d4p1:type="-- derived type specified here with the appropriate prefix --">
<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 TextAsset-->
<Text d4p1:nil="false">ValueHere</Text>
<!--These fields are applicable if the derived type attribute is set to ImageAsset-->
<CropHeight d4p1:nil="false">ValueHere</CropHeight>
<CropWidth d4p1:nil="false">ValueHere</CropWidth>
<CropX d4p1:nil="false">ValueHere</CropX>
<CropY d4p1:nil="false">ValueHere</CropY>
<SubType d4p1:nil="false">ValueHere</SubType>
<TargetHeight d4p1:nil="false">ValueHere</TargetHeight>
<TargetWidth d4p1:nil="false">ValueHere</TargetWidth>
<!--These fields are applicable if the derived type attribute is set to VideoAsset-->
<SubType d4p1:nil="false">ValueHere</SubType>
<ThumbnailImage d4p1:nil="false">
<CropHeight d4p1:nil="false">ValueHere</CropHeight>
<CropWidth d4p1:nil="false">ValueHere</CropWidth>
<CropX d4p1:nil="false">ValueHere</CropX>
<CropY d4p1:nil="false">ValueHere</CropY>
<SubType d4p1:nil="false">ValueHere</SubType>
<TargetHeight d4p1:nil="false">ValueHere</TargetHeight>
<TargetWidth d4p1:nil="false">ValueHere</TargetWidth>
</ThumbnailImage>
</Asset>
<AssetPerformanceLabel d4p1:nil="false">ValueHere</AssetPerformanceLabel>
<EditorialStatus d4p1:nil="false">ValueHere</EditorialStatus>
<PinnedField d4p1:nil="false">ValueHere</PinnedField>
</AssetLink>
</Headlines>
<Path1 d4p1:nil="false">ValueHere</Path1>
<Path2 d4p1:nil="false">ValueHere</Path2>
</Ad>
</Ads>
<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:e397="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
<e397:KeyValuePairOfstringstring>
<e397:key d4p1:nil="false">ValueHere</e397:key>
<e397:value d4p1:nil="false">ValueHere</e397:value>
</e397: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>
</GetAdsByIdsResponse>
</s:Body>
</s:Envelope>
代码语法
示例语法可用于 必应广告 SDK。 有关更多示例,请参阅 必应广告 API 代码示例 。
public async Task<GetAdsByIdsResponse> GetAdsByIdsAsync(
long adGroupId,
IList<long> adIds,
IList<AdType> adTypes,
AdAdditionalField? returnAdditionalFields)
{
var request = new GetAdsByIdsRequest
{
AdGroupId = adGroupId,
AdIds = adIds,
AdTypes = adTypes,
ReturnAdditionalFields = returnAdditionalFields
};
return (await CampaignManagementService.CallAsync((s, r) => s.GetAdsByIdsAsync(r), request));
}
static GetAdsByIdsResponse getAdsByIds(
java.lang.Long adGroupId,
ArrayOflong adIds,
ArrayOfAdType adTypes,
ArrayList<AdAdditionalField> returnAdditionalFields) throws RemoteException, Exception
{
GetAdsByIdsRequest request = new GetAdsByIdsRequest();
request.setAdGroupId(adGroupId);
request.setAdIds(adIds);
request.setAdTypes(adTypes);
request.setReturnAdditionalFields(returnAdditionalFields);
return CampaignManagementService.getService().getAdsByIds(request);
}
static function GetAdsByIds(
$adGroupId,
$adIds,
$adTypes,
$returnAdditionalFields)
{
$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];
$request = new GetAdsByIdsRequest();
$request->AdGroupId = $adGroupId;
$request->AdIds = $adIds;
$request->AdTypes = $adTypes;
$request->ReturnAdditionalFields = $returnAdditionalFields;
return $GLOBALS['CampaignManagementProxy']->GetService()->GetAdsByIds($request);
}
response=campaignmanagement_service.GetAdsByIds(
AdGroupId=AdGroupId,
AdIds=AdIds,
AdTypes=AdTypes,
ReturnAdditionalFields=ReturnAdditionalFields)
要求
服务: CampaignManagementService.svc v13
命名空间: https://bingads.microsoft.com/CampaignManagement/v13
请求 URL
请求元素
GetAdsByIdsRequest 对象定义服务操作请求的正文和标头元素。
注意
除非下面另有说明,否则需要所有请求元素。
请求正文元素
元素 | 说明 | 数据类型 |
---|---|---|
AdGroupId | 包含要获取的广告的广告组的标识符。 | long |
AdIds | 最多 20 个所请求广告的标识符。 如果广告标识符与请求的广告类型不匹配,则该操作将为每个请求的广告返回批处理错误。 |
long 数组 |
AdTypes | 要返回的一个或多个广告类型。 | AdType 数组 |
ReturnAdditionalFields | 借助其他字段值,可以使用当前版本的市场活动管理 API 获取最新功能,并在下一个版本中默认包含相应的元素。 此请求元素是可选的。 |
AdAdditionalField |
请求标头元素
元素 | 说明 | 数据类型 |
---|---|---|
Authorization | OAuth 访问令牌,表示有权Microsoft广告帐户的用户的凭据。 请确保令牌的前缀为“持有者”,这是正确身份验证所必需的。 有关详细信息,请参阅 使用 OAuth 进行身份验证。 |
string |
CustomerAccountId | 拥有或与请求中的实体关联的广告帐户的标识符。 如果需要这两个元素,此标头元素必须与 AccountId 正文元素具有相同的值。 此元素是大多数服务操作所必需的,作为最佳做法,应始终设置它。 有关详细信息,请参阅 获取帐户和客户 ID。 |
string |
CustomerId | 用户正在访问或操作的客户) 经理帐户 (标识符。 用户可以访问多个经理帐户。 此元素是大多数服务操作所必需的,作为最佳做法,应始终设置它。 有关详细信息,请参阅 获取帐户和客户 ID。 |
string |
DeveloperToken | 用于访问必应广告 API 的开发人员令牌。 有关详细信息,请参阅 获取开发人员令牌。 |
string |
Password | 此元素保留供内部使用,将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。 | string |
UserName | 此元素保留供内部使用,将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。 | string |
响应元素
GetAdsByIdsResponse 对象定义服务操作响应的正文和标头元素。 元素的返回顺序与 响应 JSON 中所示的顺序相同。
响应正文元素
元素 | 说明 | 数据类型 |
---|---|---|
广告 | 与请求中指定的广告标识符直接对应的 Ad 对象的数组。 列表的项可能返回为 null。 对于未检索广告的每个列表索引,相应的元素将为 null。 | 广告 数组 |
PartialErrors |
BatchError 对象的数组,其中包含未成功的任何请求项的详细信息。 错误列表与请求中的项列表不直接对应。 如果没有错误,列表可以为空,也可以包含与请求中每个不成功的列表项对应的一个或多个错误对象。 |
BatchError 数组 |
响应标头元素
元素 | 说明 | 数据类型 |
---|---|---|
跟踪 ID | 包含 API 调用详细信息的日志条目的标识符。 | string |
请求 JSON
此模板由显示 JSON 请求的 正文 和 标头 元素的工具生成。 有关可用于此服务操作的支持类型,请参阅上面的 请求正文元素 参考。
{
"AdGroupId": "LongValueHere",
"AdIds": [
"LongValueHere"
],
"AdTypes": [
"ValueHere"
],
"ReturnAdditionalFields": "ValueHere"
}
响应 JSON
此模板由一个工具生成,用于显示 JSON 响应的 正文 和 标头 元素。
以下示例适用于 Ad 类型为 AppInstallAd,BatchError 为 EditorialError。
{
"Ads": [
{
"AdFormatPreference": "ValueHere",
"DevicePreference": "LongValueHere",
"EditorialStatus": "ValueHere",
"FinalAppUrls": [
{
"OsType": "ValueHere",
"Url": "ValueHere"
}
],
"FinalMobileUrls": [
"ValueHere"
],
"FinalUrls": [
"ValueHere"
],
"FinalUrlSuffix": "ValueHere",
"ForwardCompatibilityMap": [
{
"key": "ValueHere",
"value": "ValueHere"
}
],
"Id": "LongValueHere",
"Status": "ValueHere",
"TrackingUrlTemplate": "ValueHere",
"Type": "AppInstall",
"UrlCustomParameters": {
"Parameters": [
{
"Key": "ValueHere",
"Value": "ValueHere"
}
]
},
"AppPlatform": "ValueHere",
"AppStoreId": "ValueHere",
"Text": "ValueHere",
"Title": "ValueHere"
}
],
"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<GetAdsByIdsResponse> GetAdsByIdsAsync(
long adGroupId,
IList<long> adIds,
IList<AdType> adTypes,
AdAdditionalField? returnAdditionalFields)
{
var request = new GetAdsByIdsRequest
{
AdGroupId = adGroupId,
AdIds = adIds,
AdTypes = adTypes,
ReturnAdditionalFields = returnAdditionalFields
};
return (await CampaignManagementService.CallAsync((s, r) => s.GetAdsByIdsAsync(r), request));
}
static GetAdsByIdsResponse getAdsByIds(
java.lang.Long adGroupId,
ArrayOflong adIds,
ArrayOfAdType adTypes,
ArrayList<AdAdditionalField> returnAdditionalFields) throws RemoteException, Exception
{
GetAdsByIdsRequest request = new GetAdsByIdsRequest();
request.setAdGroupId(adGroupId);
request.setAdIds(adIds);
request.setAdTypes(adTypes);
request.setReturnAdditionalFields(returnAdditionalFields);
return CampaignManagementService.getService().getAdsByIds(request);
}
static function GetAdsByIds(
$adGroupId,
$adIds,
$adTypes,
$returnAdditionalFields)
{
$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];
$request = new GetAdsByIdsRequest();
$request->AdGroupId = $adGroupId;
$request->AdIds = $adIds;
$request->AdTypes = $adTypes;
$request->ReturnAdditionalFields = $returnAdditionalFields;
return $GLOBALS['CampaignManagementProxy']->GetService()->GetAdsByIds($request);
}
response=campaignmanagement_service.GetAdsByIds(
AdGroupId=AdGroupId,
AdIds=AdIds,
AdTypes=AdTypes,
ReturnAdditionalFields=ReturnAdditionalFields)