GetAdExtensionsByIds 服务操作 - 市场活动管理
从帐户的广告扩展库获取指定的广告扩展。
请求元素
GetAdExtensionsByIdsRequest 对象定义服务操作请求的正文和标头元素。 元素的顺序必须与 请求 SOAP 中所示的顺序相同。
注意
除非下面另有说明,否则需要所有请求元素。
请求正文元素
元素 | 说明 | 数据类型 |
---|---|---|
AccountId | 拥有广告扩展插件的帐户的标识符。 | long |
AdExtensionIds | 广告扩展标识符的列表。 最多可以指定 100 个标识符。 |
long 数组 |
AdExtensionType | 标识符列表包含的广告扩展的类型。 可以包含多个值作为标志。 如何指定多个标志取决于所使用的编程语言。 例如,C# 将这些值视为标志值,Java 将它们视为字符串数组。 SOAP 应包含一个字符串,其中包含以空格分隔的值列表, <AdExtensionType>LocationAdExtension CallAdExtension</AdExtensionType> 例如 。 |
AdExtensionsTypeFilter |
ReturnAdditionalFields | 保留供以后使用。 | AdExtensionAdditionalField |
请求标头元素
元素 | 说明 | 数据类型 |
---|---|---|
AuthenticationToken | OAuth 访问令牌,表示有权Microsoft广告帐户的用户的凭据。 有关详细信息,请参阅 使用 OAuth 进行身份验证。 |
string |
CustomerAccountId | 拥有或与请求中的实体关联的广告帐户的标识符。 如果需要这两个元素,此标头元素必须与 AccountId 正文元素具有相同的值。 此元素是大多数服务操作所必需的,作为最佳做法,应始终设置它。 有关详细信息,请参阅 获取帐户和客户 ID。 |
string |
CustomerId | 用户正在访问或操作的客户) 经理帐户 (标识符。 用户可以访问多个经理帐户。 此元素是大多数服务操作所必需的,作为最佳做法,应始终设置它。 有关详细信息,请参阅 获取帐户和客户 ID。 |
string |
DeveloperToken | 用于访问必应广告 API 的开发人员令牌。 有关详细信息,请参阅 获取开发人员令牌。 |
string |
Password | 此元素保留供内部使用,将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。 | string |
UserName | 此元素保留供内部使用,将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。 | string |
响应元素
GetAdExtensionsByIdsResponse 对象定义服务操作响应的正文和标头元素。 元素的返回顺序与 响应 SOAP 中所示的顺序相同。
响应正文元素
元素 | 说明 | 数据类型 |
---|---|---|
AdExtensions | AdExtension 对象的列表。 该列表直接对应于请求中的标识符列表。 如果请求中的广告扩展 ID 无效或扩展不是指定的类型,则此列表中的相应项为 null。 | AdExtension 数组 |
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">GetAdExtensionsByIds</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>
<GetAdExtensionsByIdsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<AccountId>ValueHere</AccountId>
<AdExtensionIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:long>ValueHere</a1:long>
</AdExtensionIds>
<AdExtensionType>ValueHere</AdExtensionType>
<ReturnAdditionalFields i:nil="false">ValueHere</ReturnAdditionalFields>
</GetAdExtensionsByIdsRequest>
</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>
<GetAdExtensionsByIdsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<AdExtensions d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<AdExtension d4p1:type="-- derived type specified here with the appropriate prefix --">
<DevicePreference d4p1:nil="false">ValueHere</DevicePreference>
<ForwardCompatibilityMap xmlns:e361="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
<e361:KeyValuePairOfstringstring>
<e361:key d4p1:nil="false">ValueHere</e361:key>
<e361:value d4p1:nil="false">ValueHere</e361:value>
</e361:KeyValuePairOfstringstring>
</ForwardCompatibilityMap>
<Id d4p1:nil="false">ValueHere</Id>
<Scheduling d4p1:nil="false">
<DayTimeRanges d4p1:nil="false">
<DayTime>
<Day>ValueHere</Day>
<EndHour>ValueHere</EndHour>
<EndMinute>ValueHere</EndMinute>
<StartHour>ValueHere</StartHour>
<StartMinute>ValueHere</StartMinute>
</DayTime>
</DayTimeRanges>
<EndDate d4p1:nil="false">
<Day>ValueHere</Day>
<Month>ValueHere</Month>
<Year>ValueHere</Year>
</EndDate>
<StartDate d4p1:nil="false">
<Day>ValueHere</Day>
<Month>ValueHere</Month>
<Year>ValueHere</Year>
</StartDate>
<UseSearcherTimeZone d4p1:nil="false">ValueHere</UseSearcherTimeZone>
</Scheduling>
<Status d4p1:nil="false">ValueHere</Status>
<Type d4p1:nil="false">ValueHere</Type>
<Version d4p1:nil="false">ValueHere</Version>
<!--These fields are applicable if the derived type attribute is set to LocationAdExtension-->
<Address d4p1:nil="false">
<CityName d4p1:nil="false">ValueHere</CityName>
<CountryCode d4p1:nil="false">ValueHere</CountryCode>
<PostalCode d4p1:nil="false">ValueHere</PostalCode>
<ProvinceCode d4p1:nil="false">ValueHere</ProvinceCode>
<ProvinceName d4p1:nil="false">ValueHere</ProvinceName>
<StreetAddress d4p1:nil="false">ValueHere</StreetAddress>
<StreetAddress2 d4p1:nil="false">ValueHere</StreetAddress2>
</Address>
<CompanyName d4p1:nil="false">ValueHere</CompanyName>
<GeoCodeStatus d4p1:nil="false">ValueHere</GeoCodeStatus>
<GeoPoint d4p1:nil="false">
<LatitudeInMicroDegrees>ValueHere</LatitudeInMicroDegrees>
<LongitudeInMicroDegrees>ValueHere</LongitudeInMicroDegrees>
</GeoPoint>
<PhoneNumber d4p1:nil="false">ValueHere</PhoneNumber>
<!--These fields are applicable if the derived type attribute is set to CallAdExtension-->
<CountryCode d4p1:nil="false">ValueHere</CountryCode>
<IsCallOnly d4p1:nil="false">ValueHere</IsCallOnly>
<IsCallTrackingEnabled d4p1:nil="false">ValueHere</IsCallTrackingEnabled>
<PhoneNumber d4p1:nil="false">ValueHere</PhoneNumber>
<RequireTollFreeTrackingNumber d4p1:nil="false">ValueHere</RequireTollFreeTrackingNumber>
<!--These fields are applicable if the derived type attribute is set to ImageAdExtension-->
<AlternativeText d4p1:nil="false">ValueHere</AlternativeText>
<Description d4p1:nil="false">ValueHere</Description>
<DestinationUrl d4p1:nil="false">ValueHere</DestinationUrl>
<DisplayText d4p1:nil="false">ValueHere</DisplayText>
<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>
<ImageMediaIds d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:long>ValueHere</a1:long>
</ImageMediaIds>
<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>
<Layouts d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:string>ValueHere</a1:string>
</Layouts>
<SourceType d4p1:nil="false">ValueHere</SourceType>
<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>
<!--These fields are applicable if the derived type attribute is set to AppAdExtension-->
<AppPlatform d4p1:nil="false">ValueHere</AppPlatform>
<AppStoreId d4p1:nil="false">ValueHere</AppStoreId>
<DestinationUrl d4p1:nil="false">ValueHere</DestinationUrl>
<DisplayText d4p1:nil="false">ValueHere</DisplayText>
<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>
<!--These fields are applicable if the derived type attribute is set to ReviewAdExtension-->
<IsExact>ValueHere</IsExact>
<Source d4p1:nil="false">ValueHere</Source>
<Text d4p1:nil="false">ValueHere</Text>
<Url d4p1:nil="false">ValueHere</Url>
<!--This field is applicable if the derived type attribute is set to CalloutAdExtension-->
<Text d4p1:nil="false">ValueHere</Text>
<!--These fields are applicable if the derived type attribute is set to SitelinkAdExtension-->
<Description1 d4p1:nil="false">ValueHere</Description1>
<Description2 d4p1:nil="false">ValueHere</Description2>
<DestinationUrl d4p1:nil="false">ValueHere</DestinationUrl>
<DisplayText d4p1:nil="false">ValueHere</DisplayText>
<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>
<!--These fields are applicable if the derived type attribute is set to ActionAdExtension-->
<ActionType>ValueHere</ActionType>
<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>
<Language d4p1:nil="false">ValueHere</Language>
<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>
<!--These fields are applicable if the derived type attribute is set to StructuredSnippetAdExtension-->
<Header d4p1:nil="false">ValueHere</Header>
<Values d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:string>ValueHere</a1:string>
</Values>
<!--These fields are applicable if the derived type attribute is set to PriceAdExtension-->
<FinalUrlSuffix d4p1:nil="false">ValueHere</FinalUrlSuffix>
<Language d4p1:nil="false">ValueHere</Language>
<PriceExtensionType>ValueHere</PriceExtensionType>
<TableRows d4p1:nil="false">
<PriceTableRow>
<CurrencyCode d4p1:nil="false">ValueHere</CurrencyCode>
<Description d4p1:nil="false">ValueHere</Description>
<FinalMobileUrls d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:string>ValueHere</a1:string>
</FinalMobileUrls>
<FinalUrls d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:string>ValueHere</a1:string>
</FinalUrls>
<Header d4p1:nil="false">ValueHere</Header>
<Price>ValueHere</Price>
<PriceQualifier>ValueHere</PriceQualifier>
<PriceUnit>ValueHere</PriceUnit>
<TermsAndConditions d4p1:nil="false">ValueHere</TermsAndConditions>
<TermsAndConditionsUrl d4p1:nil="false">ValueHere</TermsAndConditionsUrl>
</PriceTableRow>
</TableRows>
<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>
<!--These fields are applicable if the derived type attribute is set to PromotionAdExtension-->
<CurrencyCode d4p1:nil="false">ValueHere</CurrencyCode>
<DiscountModifier d4p1:nil="false">ValueHere</DiscountModifier>
<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>
<Language d4p1:nil="false">ValueHere</Language>
<MoneyAmountOff d4p1:nil="false">ValueHere</MoneyAmountOff>
<OrdersOverAmount d4p1:nil="false">ValueHere</OrdersOverAmount>
<PercentOff d4p1:nil="false">ValueHere</PercentOff>
<PromotionCode d4p1:nil="false">ValueHere</PromotionCode>
<PromotionEndDate d4p1:nil="false">
<Day>ValueHere</Day>
<Month>ValueHere</Month>
<Year>ValueHere</Year>
</PromotionEndDate>
<PromotionItem d4p1:nil="false">ValueHere</PromotionItem>
<PromotionOccasion d4p1:nil="false">ValueHere</PromotionOccasion>
<PromotionStartDate d4p1:nil="false">
<Day>ValueHere</Day>
<Month>ValueHere</Month>
<Year>ValueHere</Year>
</PromotionStartDate>
<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>
<!--These fields are applicable if the derived type attribute is set to FilterLinkAdExtension-->
<AdExtensionHeaderType d4p1:nil="false">ValueHere</AdExtensionHeaderType>
<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>
<Language d4p1:nil="false">ValueHere</Language>
<Texts d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:string>ValueHere</a1:string>
</Texts>
<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>
<!--These fields are applicable if the derived type attribute is set to FlyerAdExtension-->
<Description d4p1:nil="false">ValueHere</Description>
<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>
<FlyerName d4p1:nil="false">ValueHere</FlyerName>
<ImageMediaIds d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:long>ValueHere</a1:long>
</ImageMediaIds>
<ImageMediaUrls d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:string>ValueHere</a1:string>
</ImageMediaUrls>
<StoreId d4p1:nil="false">ValueHere</StoreId>
<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>
<!--These fields are applicable if the derived type attribute is set to VideoAdExtension-->
<ActionText d4p1:nil="false">ValueHere</ActionText>
<AlternativeText d4p1:nil="false">ValueHere</AlternativeText>
<DisplayText d4p1:nil="false">ValueHere</DisplayText>
<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>
<Name d4p1:nil="false">ValueHere</Name>
<ThumbnailId d4p1:nil="false">ValueHere</ThumbnailId>
<ThumbnailUrl d4p1:nil="false">ValueHere</ThumbnailUrl>
<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>
<VideoId d4p1:nil="false">ValueHere</VideoId>
<!--These fields are applicable if the derived type attribute is set to DisclaimerAdExtension-->
<DisclaimerLayout d4p1:nil="false">ValueHere</DisclaimerLayout>
<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>
<LineText d4p1:nil="false">ValueHere</LineText>
<Name d4p1:nil="false">ValueHere</Name>
<PopupText d4p1:nil="false">ValueHere</PopupText>
<Title d4p1:nil="false">ValueHere</Title>
<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>
<!--These fields are applicable if the derived type attribute is set to LogoAdExtension-->
<BusinessLogo d4p1:nil="false">ValueHere</BusinessLogo>
<BusinessLogoUrl d4p1:nil="false">ValueHere</BusinessLogoUrl>
<BusinessName d4p1:nil="false">ValueHere</BusinessName>
<DomainName d4p1:nil="false">ValueHere</DomainName>
</AdExtension>
</AdExtensions>
<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:e362="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
<e362:KeyValuePairOfstringstring>
<e362:key d4p1:nil="false">ValueHere</e362:key>
<e362:value d4p1:nil="false">ValueHere</e362:value>
</e362: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>
</GetAdExtensionsByIdsResponse>
</s:Body>
</s:Envelope>
代码语法
示例语法可用于 必应广告 SDK。 有关更多示例,请参阅 必应广告 API 代码示例 。
public async Task<GetAdExtensionsByIdsResponse> GetAdExtensionsByIdsAsync(
long accountId,
IList<long> adExtensionIds,
AdExtensionsTypeFilter adExtensionType,
AdExtensionAdditionalField? returnAdditionalFields)
{
var request = new GetAdExtensionsByIdsRequest
{
AccountId = accountId,
AdExtensionIds = adExtensionIds,
AdExtensionType = adExtensionType,
ReturnAdditionalFields = returnAdditionalFields
};
return (await CampaignManagementService.CallAsync((s, r) => s.GetAdExtensionsByIdsAsync(r), request));
}
static GetAdExtensionsByIdsResponse getAdExtensionsByIds(
java.lang.Long accountId,
ArrayOflong adExtensionIds,
ArrayList<AdExtensionsTypeFilter> adExtensionType,
ArrayList<AdExtensionAdditionalField> returnAdditionalFields) throws RemoteException, Exception
{
GetAdExtensionsByIdsRequest request = new GetAdExtensionsByIdsRequest();
request.setAccountId(accountId);
request.setAdExtensionIds(adExtensionIds);
request.setAdExtensionType(adExtensionType);
request.setReturnAdditionalFields(returnAdditionalFields);
return CampaignManagementService.getService().getAdExtensionsByIds(request);
}
static function GetAdExtensionsByIds(
$accountId,
$adExtensionIds,
$adExtensionType,
$returnAdditionalFields)
{
$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];
$request = new GetAdExtensionsByIdsRequest();
$request->AccountId = $accountId;
$request->AdExtensionIds = $adExtensionIds;
$request->AdExtensionType = $adExtensionType;
$request->ReturnAdditionalFields = $returnAdditionalFields;
return $GLOBALS['CampaignManagementProxy']->GetService()->GetAdExtensionsByIds($request);
}
response=campaignmanagement_service.GetAdExtensionsByIds(
AccountId=AccountId,
AdExtensionIds=AdExtensionIds,
AdExtensionType=AdExtensionType,
ReturnAdditionalFields=ReturnAdditionalFields)
要求
服务: CampaignManagementService.svc v13
命名空间: https://bingads.microsoft.com/CampaignManagement/v13
请求 URL
https://campaign.api.bingads.microsoft.com/CampaignManagement/v13/AdExtensions/QueryByIds
请求元素
GetAdExtensionsByIdsRequest 对象定义服务操作请求的正文和标头元素。
注意
除非下面另有说明,否则需要所有请求元素。
请求正文元素
元素 | 说明 | 数据类型 |
---|---|---|
AccountId | 拥有广告扩展插件的帐户的标识符。 | long |
AdExtensionIds | 广告扩展标识符的列表。 最多可以指定 100 个标识符。 |
long 数组 |
AdExtensionType | 标识符列表包含的广告扩展的类型。 可以包含多个值作为标志。 如何指定多个标志取决于所使用的编程语言。 例如,C# 将这些值视为标志值,Java 将它们视为字符串数组。 SOAP 应包含一个字符串,其中包含以空格分隔的值列表, <AdExtensionType>LocationAdExtension CallAdExtension</AdExtensionType> 例如 。 |
AdExtensionsTypeFilter |
ReturnAdditionalFields | 保留供以后使用。 | AdExtensionAdditionalField |
请求标头元素
元素 | 说明 | 数据类型 |
---|---|---|
Authorization | OAuth 访问令牌,表示有权Microsoft广告帐户的用户的凭据。 请确保令牌的前缀为“持有者”,这是正确身份验证所必需的。 有关详细信息,请参阅 使用 OAuth 进行身份验证。 |
string |
CustomerAccountId | 拥有或与请求中的实体关联的广告帐户的标识符。 如果需要这两个元素,此标头元素必须与 AccountId 正文元素具有相同的值。 此元素是大多数服务操作所必需的,作为最佳做法,应始终设置它。 有关详细信息,请参阅 获取帐户和客户 ID。 |
string |
CustomerId | 用户正在访问或操作的客户) 经理帐户 (标识符。 用户可以访问多个经理帐户。 此元素是大多数服务操作所必需的,作为最佳做法,应始终设置它。 有关详细信息,请参阅 获取帐户和客户 ID。 |
string |
DeveloperToken | 用于访问必应广告 API 的开发人员令牌。 有关详细信息,请参阅 获取开发人员令牌。 |
string |
Password | 此元素保留供内部使用,将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。 | string |
UserName | 此元素保留供内部使用,将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。 | string |
响应元素
GetAdExtensionsByIdsResponse 对象定义服务操作响应的正文和标头元素。 元素的返回顺序与 响应 JSON 中所示的顺序相同。
响应正文元素
元素 | 说明 | 数据类型 |
---|---|---|
AdExtensions | AdExtension 对象的列表。 该列表直接对应于请求中的标识符列表。 如果请求中的广告扩展 ID 无效或扩展不是指定的类型,则此列表中的相应项为 null。 | AdExtension 数组 |
PartialErrors |
BatchError 对象的数组,其中包含未成功的任何请求项的详细信息。 错误列表与请求中的项列表不直接对应。 如果没有错误,列表可以为空,也可以包含与请求中每个不成功的列表项对应的一个或多个错误对象。 |
BatchError 数组 |
响应标头元素
元素 | 说明 | 数据类型 |
---|---|---|
跟踪 ID | 包含 API 调用详细信息的日志条目的标识符。 | string |
请求 JSON
此模板由显示 JSON 请求的 正文 和 标头 元素的工具生成。 有关可用于此服务操作的支持类型,请参阅上面的 请求正文元素 参考。
{
"AccountId": "LongValueHere",
"AdExtensionIds": [
"LongValueHere"
],
"AdExtensionType": "ValueHere",
"ReturnAdditionalFields": "ValueHere"
}
响应 JSON
此模板由一个工具生成,用于显示 JSON 响应的 正文 和 标头 元素。
以下示例适用于 AdExtension 的类型为 ActionAdExtension,BatchError 为 EditorialError。
{
"AdExtensions": [
{
"DevicePreference": "LongValueHere",
"ForwardCompatibilityMap": [
{
"key": "ValueHere",
"value": "ValueHere"
}
],
"Id": "LongValueHere",
"Scheduling": {
"DayTimeRanges": [
{
"Day": "ValueHere",
"EndHour": IntValueHere,
"EndMinute": "ValueHere",
"StartHour": IntValueHere,
"StartMinute": "ValueHere"
}
],
"EndDate": {
"Day": IntValueHere,
"Month": IntValueHere,
"Year": IntValueHere
},
"StartDate": {
"Day": IntValueHere,
"Month": IntValueHere,
"Year": IntValueHere
},
"UseSearcherTimeZone": "ValueHere"
},
"Status": "ValueHere",
"Type": "ActionAdExtension",
"Version": IntValueHere,
"ActionType": "ValueHere",
"FinalMobileUrls": [
"ValueHere"
],
"FinalUrls": [
"ValueHere"
],
"FinalUrlSuffix": "ValueHere",
"Language": "ValueHere",
"TrackingUrlTemplate": "ValueHere",
"UrlCustomParameters": {
"Parameters": [
{
"Key": "ValueHere",
"Value": "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<GetAdExtensionsByIdsResponse> GetAdExtensionsByIdsAsync(
long accountId,
IList<long> adExtensionIds,
AdExtensionsTypeFilter adExtensionType,
AdExtensionAdditionalField? returnAdditionalFields)
{
var request = new GetAdExtensionsByIdsRequest
{
AccountId = accountId,
AdExtensionIds = adExtensionIds,
AdExtensionType = adExtensionType,
ReturnAdditionalFields = returnAdditionalFields
};
return (await CampaignManagementService.CallAsync((s, r) => s.GetAdExtensionsByIdsAsync(r), request));
}
static GetAdExtensionsByIdsResponse getAdExtensionsByIds(
java.lang.Long accountId,
ArrayOflong adExtensionIds,
ArrayList<AdExtensionsTypeFilter> adExtensionType,
ArrayList<AdExtensionAdditionalField> returnAdditionalFields) throws RemoteException, Exception
{
GetAdExtensionsByIdsRequest request = new GetAdExtensionsByIdsRequest();
request.setAccountId(accountId);
request.setAdExtensionIds(adExtensionIds);
request.setAdExtensionType(adExtensionType);
request.setReturnAdditionalFields(returnAdditionalFields);
return CampaignManagementService.getService().getAdExtensionsByIds(request);
}
static function GetAdExtensionsByIds(
$accountId,
$adExtensionIds,
$adExtensionType,
$returnAdditionalFields)
{
$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];
$request = new GetAdExtensionsByIdsRequest();
$request->AccountId = $accountId;
$request->AdExtensionIds = $adExtensionIds;
$request->AdExtensionType = $adExtensionType;
$request->ReturnAdditionalFields = $returnAdditionalFields;
return $GLOBALS['CampaignManagementProxy']->GetService()->GetAdExtensionsByIds($request);
}
response=campaignmanagement_service.GetAdExtensionsByIds(
AccountId=AccountId,
AdExtensionIds=AdExtensionIds,
AdExtensionType=AdExtensionType,
ReturnAdditionalFields=ReturnAdditionalFields)