GetAdExtensionsAssociations 服務作業 - 活動管理
依指定的營銷活動和廣告群組標識符,取得個別的廣告延伸模塊關聯。
要求專案
GetAdExtensionsAssociationsRequest 物件會定義服務作業要求的主體和標頭元素。 元素的順序必須與 要求SOAP中所示的順序相同。
注意事項
除非下面另有說明,否則所有要求專案都是必要的。
要求本文專案
元素 | 描述 | 資料類型 |
---|---|---|
AccountId | 擁有擴充功能之帳戶的標識碼。 | 長 |
AdExtensionType | 依廣告延伸模組類型篩選傳回的關聯。 您可以將多個值包含為旗標。 指定多個旗標的方式取決於您使用的程式設計語言。 例如,C# 會將這些值視為旗標值,而 Java 會將它們視為字串數位。 SOAP 應該包含字串,其中包含以空白分隔的值清單, <AdExtensionType>LocationAdExtension CallAdExtension</AdExtensionType> 例如 。 |
AdExtensionsTypeFilter |
AssociationType | 依實體類型篩選傳回的關聯。 | AssociationType |
EntityIds | 您可以要求個別廣告延伸模組關聯的實體標識碼清單。 | long 陣列 |
ReturnAdditionalFields | 保留供日後使用。 | AdExtensionAdditionalField |
要求標頭元素
元素 | 描述 | 資料類型 |
---|---|---|
AuthenticationToken | OAuth 存取令牌,代表有權Microsoft Advertising 帳戶之用戶的認證。 如需詳細資訊,請 參閱使用 OAuth 進行驗證。 |
string |
CustomerAccountId | 擁有或與要求中實體相關聯之廣告帳戶的標識碼。 當兩者都需要時,此標頭元素必須具有與 AccountId body 元素相同的值。 此元素是大部分服務作業的必要專案,最佳做法是一律加以設定。 如需詳細資訊, 請參閱取得您的帳戶和客戶標識符。 |
string |
CustomerId | (使用者存取或操作之使用者) 客戶的管理員帳戶標識碼。 用戶可以存取多個管理員帳戶。 此元素是大部分服務作業的必要專案,最佳做法是一律加以設定。 如需詳細資訊, 請參閱取得您的帳戶和客戶標識符。 |
string |
DeveloperToken | 用來存取 Bing 廣告 API 的開發人員令牌。 如需詳細資訊 ,請參閱取得開發人員令牌。 |
string |
密碼 | 此元素會保留供內部使用,並會從未來的 API 版本中移除。 您必須使用 AuthenticationToken 元素來設定用戶認證。 | string |
UserName | 此元素會保留供內部使用,並會從未來的 API 版本中移除。 您必須使用 AuthenticationToken 元素來設定用戶認證。 | string |
Response 元素
GetAdExtensionsAssociationsResponse 物件會定義服務作業響應的主體和標頭元素。 這些元素的傳回順序與 回應SOAP中所示的順序相同。
回應本文專案
元素 | 描述 | 資料類型 |
---|---|---|
AdExtensionAssociationCollection | 廣告延伸模組關聯集合的陣列。 針對要求中指定的每個實體標識符,會傳回 AdExtensionAssociationCollection 。 |
AdExtensionAssociationCollection 陣 列 |
PartialErrors |
BatchError 物件的陣列,其中包含未成功擷取之任何關聯的詳細數據。 錯誤清單會直接對應至要求中的關聯清單。 清單的專案可能會傳回為 Null。 針對已成功擷取關聯的每個清單索引,對應的錯誤專案會是 Null。 在理想情況下,會成功擷取所有關聯,而且此清單中的所有元素都是 Null。 |
BatchError 陣 列 |
回應標頭元素
元素 | 描述 | 資料類型 |
---|---|---|
TrackingId | 包含 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">GetAdExtensionsAssociations</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>
<GetAdExtensionsAssociationsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<AccountId>ValueHere</AccountId>
<AdExtensionType>ValueHere</AdExtensionType>
<AssociationType>ValueHere</AssociationType>
<EntityIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:long>ValueHere</a1:long>
</EntityIds>
<ReturnAdditionalFields i:nil="false">ValueHere</ReturnAdditionalFields>
</GetAdExtensionsAssociationsRequest>
</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>
<GetAdExtensionsAssociationsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<AdExtensionAssociationCollection d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<AdExtensionAssociationCollection>
<AdExtensionAssociations d4p1:nil="false">
<AdExtensionAssociation>
<AdExtension d4p1:nil="false" d4p1:type="-- derived type specified here with the appropriate prefix --">
<DevicePreference d4p1:nil="false">ValueHere</DevicePreference>
<ForwardCompatibilityMap xmlns:e357="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
<e357:KeyValuePairOfstringstring>
<e357:key d4p1:nil="false">ValueHere</e357:key>
<e357:value d4p1:nil="false">ValueHere</e357:value>
</e357: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>
<AssociationType>ValueHere</AssociationType>
<EditorialStatus d4p1:nil="false">ValueHere</EditorialStatus>
<EntityId>ValueHere</EntityId>
</AdExtensionAssociation>
</AdExtensionAssociations>
</AdExtensionAssociationCollection>
</AdExtensionAssociationCollection>
<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:e358="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
<e358:KeyValuePairOfstringstring>
<e358:key d4p1:nil="false">ValueHere</e358:key>
<e358:value d4p1:nil="false">ValueHere</e358:value>
</e358: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>
</GetAdExtensionsAssociationsResponse>
</s:Body>
</s:Envelope>
程序代碼語法
範例語法可以與 Bing 廣告 SDK 搭配使用。 如需更多範例,請參閱 Bing 廣告 API 程式代碼範 例。
public async Task<GetAdExtensionsAssociationsResponse> GetAdExtensionsAssociationsAsync(
long accountId,
AdExtensionsTypeFilter adExtensionType,
AssociationType associationType,
IList<long> entityIds,
AdExtensionAdditionalField? returnAdditionalFields)
{
var request = new GetAdExtensionsAssociationsRequest
{
AccountId = accountId,
AdExtensionType = adExtensionType,
AssociationType = associationType,
EntityIds = entityIds,
ReturnAdditionalFields = returnAdditionalFields
};
return (await CampaignManagementService.CallAsync((s, r) => s.GetAdExtensionsAssociationsAsync(r), request));
}
static GetAdExtensionsAssociationsResponse getAdExtensionsAssociations(
java.lang.Long accountId,
ArrayList<AdExtensionsTypeFilter> adExtensionType,
AssociationType associationType,
ArrayOflong entityIds,
ArrayList<AdExtensionAdditionalField> returnAdditionalFields) throws RemoteException, Exception
{
GetAdExtensionsAssociationsRequest request = new GetAdExtensionsAssociationsRequest();
request.setAccountId(accountId);
request.setAdExtensionType(adExtensionType);
request.setAssociationType(associationType);
request.setEntityIds(entityIds);
request.setReturnAdditionalFields(returnAdditionalFields);
return CampaignManagementService.getService().getAdExtensionsAssociations(request);
}
static function GetAdExtensionsAssociations(
$accountId,
$adExtensionType,
$associationType,
$entityIds,
$returnAdditionalFields)
{
$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];
$request = new GetAdExtensionsAssociationsRequest();
$request->AccountId = $accountId;
$request->AdExtensionType = $adExtensionType;
$request->AssociationType = $associationType;
$request->EntityIds = $entityIds;
$request->ReturnAdditionalFields = $returnAdditionalFields;
return $GLOBALS['CampaignManagementProxy']->GetService()->GetAdExtensionsAssociations($request);
}
response=campaignmanagement_service.GetAdExtensionsAssociations(
AccountId=AccountId,
AdExtensionType=AdExtensionType,
AssociationType=AssociationType,
EntityIds=EntityIds,
ReturnAdditionalFields=ReturnAdditionalFields)
需求
服務: CampaignManagementService.svc v13
命名空間: https://bingads.microsoft.com/CampaignManagement/v13
要求 URL
https://campaign.api.bingads.microsoft.com/CampaignManagement/v13/AdExtensionsAssociations/Query
要求專案
GetAdExtensionsAssociationsRequest 物件會定義服務作業要求的主體和標頭元素。
注意事項
除非下面另有說明,否則所有要求專案都是必要的。
要求本文專案
元素 | 描述 | 資料類型 |
---|---|---|
AccountId | 擁有擴充功能之帳戶的標識碼。 | 長 |
AdExtensionType | 依廣告延伸模組類型篩選傳回的關聯。 您可以將多個值包含為旗標。 指定多個旗標的方式取決於您使用的程式設計語言。 例如,C# 會將這些值視為旗標值,而 Java 會將它們視為字串數位。 SOAP 應該包含字串,其中包含以空白分隔的值清單, <AdExtensionType>LocationAdExtension CallAdExtension</AdExtensionType> 例如 。 |
AdExtensionsTypeFilter |
AssociationType | 依實體類型篩選傳回的關聯。 | AssociationType |
EntityIds | 您可以要求個別廣告延伸模組關聯的實體標識碼清單。 | long 陣列 |
ReturnAdditionalFields | 保留供日後使用。 | AdExtensionAdditionalField |
要求標頭元素
元素 | 描述 | 資料類型 |
---|---|---|
授權 | OAuth 存取令牌,代表有權Microsoft Advertising 帳戶之用戶的認證。 請確定令牌前面加上 「Bearer」 ,這是正確驗證的必要專案。 如需詳細資訊,請 參閱使用 OAuth 進行驗證。 |
string |
CustomerAccountId | 擁有或與要求中實體相關聯之廣告帳戶的標識碼。 當兩者都需要時,此標頭元素必須具有與 AccountId body 元素相同的值。 此元素是大部分服務作業的必要專案,最佳做法是一律加以設定。 如需詳細資訊, 請參閱取得您的帳戶和客戶標識符。 |
string |
CustomerId | (使用者存取或操作之使用者) 客戶的管理員帳戶標識碼。 用戶可以存取多個管理員帳戶。 此元素是大部分服務作業的必要專案,最佳做法是一律加以設定。 如需詳細資訊, 請參閱取得您的帳戶和客戶標識符。 |
string |
DeveloperToken | 用來存取 Bing 廣告 API 的開發人員令牌。 如需詳細資訊 ,請參閱取得開發人員令牌。 |
string |
密碼 | 此元素會保留供內部使用,並會從未來的 API 版本中移除。 您必須使用 AuthenticationToken 元素來設定用戶認證。 | string |
UserName | 此元素會保留供內部使用,並會從未來的 API 版本中移除。 您必須使用 AuthenticationToken 元素來設定用戶認證。 | string |
Response 元素
GetAdExtensionsAssociationsResponse 物件會定義服務作業響應的主體和標頭元素。 這些元素的傳回順序與 回應 JSON 中所示的順序相同。
回應本文專案
元素 | 描述 | 資料類型 |
---|---|---|
AdExtensionAssociationCollection | 廣告延伸模組關聯集合的陣列。 針對要求中指定的每個實體標識符,會傳回 AdExtensionAssociationCollection 。 |
AdExtensionAssociationCollection 陣 列 |
PartialErrors |
BatchError 物件的陣列,其中包含未成功擷取之任何關聯的詳細數據。 錯誤清單會直接對應至要求中的關聯清單。 清單的專案可能會傳回為 Null。 針對已成功擷取關聯的每個清單索引,對應的錯誤專案會是 Null。 在理想情況下,會成功擷取所有關聯,而且此清單中的所有元素都是 Null。 |
BatchError 陣 列 |
回應標頭元素
元素 | 描述 | 資料類型 |
---|---|---|
TrackingId | 包含 API 呼叫詳細數據的記錄項目識別碼。 | string |
要求 JSON
此範本是由工具所產生,用來顯示 JSON 要求的 主體 和 標頭 元素。 如需可搭配此服務作業使用的支援類型,請參閱上述 的要求本文項目 參考。
{
"AccountId": "LongValueHere",
"AdExtensionType": "ValueHere",
"AssociationType": "ValueHere",
"EntityIds": [
"LongValueHere"
],
"ReturnAdditionalFields": "ValueHere"
}
回應 JSON
此範本是由工具所產生,用來顯示 JSON 回應的 主體 和 標頭 元素。
以下範例適用於 AdExtension 類型為 ActionAdExtension,BatchError 為編輯 器。
{
"AdExtensionAssociationCollection": [
{
"AdExtensionAssociations": [
{
"AdExtension": {
"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"
}
]
}
},
"AssociationType": "ValueHere",
"EditorialStatus": "ValueHere",
"EntityId": "LongValueHere"
}
]
}
],
"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 升級至特定版本並設定系統參數。範例語法可以與 Bing 廣告 SDK 搭配使用。 如需更多範例,請參閱 Bing 廣告 API 程式代碼範 例。
public async Task<GetAdExtensionsAssociationsResponse> GetAdExtensionsAssociationsAsync(
long accountId,
AdExtensionsTypeFilter adExtensionType,
AssociationType associationType,
IList<long> entityIds,
AdExtensionAdditionalField? returnAdditionalFields)
{
var request = new GetAdExtensionsAssociationsRequest
{
AccountId = accountId,
AdExtensionType = adExtensionType,
AssociationType = associationType,
EntityIds = entityIds,
ReturnAdditionalFields = returnAdditionalFields
};
return (await CampaignManagementService.CallAsync((s, r) => s.GetAdExtensionsAssociationsAsync(r), request));
}
static GetAdExtensionsAssociationsResponse getAdExtensionsAssociations(
java.lang.Long accountId,
ArrayList<AdExtensionsTypeFilter> adExtensionType,
AssociationType associationType,
ArrayOflong entityIds,
ArrayList<AdExtensionAdditionalField> returnAdditionalFields) throws RemoteException, Exception
{
GetAdExtensionsAssociationsRequest request = new GetAdExtensionsAssociationsRequest();
request.setAccountId(accountId);
request.setAdExtensionType(adExtensionType);
request.setAssociationType(associationType);
request.setEntityIds(entityIds);
request.setReturnAdditionalFields(returnAdditionalFields);
return CampaignManagementService.getService().getAdExtensionsAssociations(request);
}
static function GetAdExtensionsAssociations(
$accountId,
$adExtensionType,
$associationType,
$entityIds,
$returnAdditionalFields)
{
$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];
$request = new GetAdExtensionsAssociationsRequest();
$request->AccountId = $accountId;
$request->AdExtensionType = $adExtensionType;
$request->AssociationType = $associationType;
$request->EntityIds = $entityIds;
$request->ReturnAdditionalFields = $returnAdditionalFields;
return $GLOBALS['CampaignManagementProxy']->GetService()->GetAdExtensionsAssociations($request);
}
response=campaignmanagement_service.GetAdExtensionsAssociations(
AccountId=AccountId,
AdExtensionType=AdExtensionType,
AssociationType=AssociationType,
EntityIds=EntityIds,
ReturnAdditionalFields=ReturnAdditionalFields)