AddAdExtensions サービス操作 - キャンペーン管理
アカウントの広告拡張機能ライブラリに 1 つ以上の広告表示オプションを追加します。
Request 要素
AddAdExtensionsRequest オブジェクトは、サービス操作要求の本文要素とヘッダー要素を定義します。 要素は、 要求 SOAP に示されている順序と同じ順序である必要があります。
注:
以下に特に記載がない限り、すべての要求要素が必要です。
要求本文要素
要素 | 説明 | データ型 |
---|---|---|
AccountId | 拡張機能を追加するアカウントの識別子。 | long |
AdExtensions | アカウントに追加する任意の種類の広告表示オプションの一覧。 呼び出しごとに最大 100 個の拡張機能を指定できます。 | AdExtension 配列 |
要求ヘッダー要素
要素 | 説明 | データ型 |
---|---|---|
AuthenticationToken | Microsoft Advertising アカウントへのアクセス許可を持つユーザーの資格情報を表す OAuth アクセス トークン。 詳細については、「 OAuth による認証」を参照してください。 |
string |
CustomerAccountId | 要求のエンティティを所有または関連付けられている広告アカウントの識別子。 両方が必要な場合、このヘッダー要素の値は AccountId 本文要素と同じである必要があります。 この要素は、ほとんどのサービス操作に必要であり、ベスト プラクティスとして常に設定する必要があります。 詳細については、「 アカウントと顧客 ID を取得する」を参照してください。 |
string |
CustomerId | ユーザーがアクセスまたは操作しているマネージャー アカウント (顧客) の識別子。 ユーザーは複数のマネージャー アカウントにアクセスできます。 この要素は、ほとんどのサービス操作に必要であり、ベスト プラクティスとして常に設定する必要があります。 詳細については、「 アカウントと顧客 ID を取得する」を参照してください。 |
string |
DeveloperToken | Bing Ads API へのアクセスに使用される開発者トークン。 詳細については、「 開発者トークンを取得する」を参照してください。 |
string |
Password | この要素は内部使用のために予約されており、今後のバージョンの API から削除されます。 ユーザー資格情報を設定するには、AuthenticationToken 要素を使用する必要があります。 | string |
UserName | この要素は内部使用のために予約されており、今後のバージョンの API から削除されます。 ユーザー資格情報を設定するには、AuthenticationToken 要素を使用する必要があります。 | string |
Response 要素
AddAdExtensionsResponse オブジェクトは、サービス操作応答の本文要素とヘッダー要素を定義します。 要素は、 応答 SOAP に示されている順序と同じ順序で返されます。
応答本文の要素
要素 | 説明 | データ型 |
---|---|---|
AdExtensionIdentities | 追加された拡張機能の ID。 リストは、要求で指定された拡張機能の一覧に直接対応します。 | AdExtensionIdentity 配列 |
NestedPartialErrors | 正常に追加されなかった広告拡張機能の詳細を含む BatchErrorCollection オブジェクトの配列。 各 BatchErrorCollection オブジェクト内の最上位エラーは、広告拡張機能エラーの可能性に対応しています。
BatchError オブジェクトの入れ子になったリストには、広告拡張機能内のリスト アイテムに固有のエラーが含まれます (該当する場合)。 エラーの一覧は、要求内の項目の一覧に直接対応していません。 エラーがない場合はリストを空にすることも、失敗したリスト 項目ごとに対応する 1 つ以上のエラー オブジェクトを要求に含めることもできます。 |
BatchErrorCollection 配列 |
応答ヘッダー要素
要素 | 説明 | データ型 |
---|---|---|
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">AddAdExtensions</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>
<AddAdExtensionsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<AccountId>ValueHere</AccountId>
<AdExtensions i:nil="false">
<AdExtension i:type="-- derived type specified here with the appropriate prefix --">
<DevicePreference i:nil="false">ValueHere</DevicePreference>
<ForwardCompatibilityMap xmlns:e183="http://schemas.datacontract.org/2004/07/System.Collections.Generic" i:nil="false">
<e183:KeyValuePairOfstringstring>
<e183:key i:nil="false">ValueHere</e183:key>
<e183:value i:nil="false">ValueHere</e183:value>
</e183:KeyValuePairOfstringstring>
</ForwardCompatibilityMap>
<Id i:nil="false">ValueHere</Id>
<Scheduling i:nil="false">
<DayTimeRanges i:nil="false">
<DayTime>
<Day>ValueHere</Day>
<EndHour>ValueHere</EndHour>
<EndMinute>ValueHere</EndMinute>
<StartHour>ValueHere</StartHour>
<StartMinute>ValueHere</StartMinute>
</DayTime>
</DayTimeRanges>
<EndDate i:nil="false">
<Day>ValueHere</Day>
<Month>ValueHere</Month>
<Year>ValueHere</Year>
</EndDate>
<StartDate i:nil="false">
<Day>ValueHere</Day>
<Month>ValueHere</Month>
<Year>ValueHere</Year>
</StartDate>
<UseSearcherTimeZone i:nil="false">ValueHere</UseSearcherTimeZone>
</Scheduling>
<Status i:nil="false">ValueHere</Status>
<Type i:nil="false">ValueHere</Type>
<Version i:nil="false">ValueHere</Version>
<!--These fields are applicable if the derived type attribute is set to LocationAdExtension-->
<Address i:nil="false">
<CityName i:nil="false">ValueHere</CityName>
<CountryCode i:nil="false">ValueHere</CountryCode>
<PostalCode i:nil="false">ValueHere</PostalCode>
<ProvinceCode i:nil="false">ValueHere</ProvinceCode>
<ProvinceName i:nil="false">ValueHere</ProvinceName>
<StreetAddress i:nil="false">ValueHere</StreetAddress>
<StreetAddress2 i:nil="false">ValueHere</StreetAddress2>
</Address>
<CompanyName i:nil="false">ValueHere</CompanyName>
<GeoCodeStatus i:nil="false">ValueHere</GeoCodeStatus>
<GeoPoint i:nil="false">
<LatitudeInMicroDegrees>ValueHere</LatitudeInMicroDegrees>
<LongitudeInMicroDegrees>ValueHere</LongitudeInMicroDegrees>
</GeoPoint>
<PhoneNumber i:nil="false">ValueHere</PhoneNumber>
<!--These fields are applicable if the derived type attribute is set to CallAdExtension-->
<CountryCode i:nil="false">ValueHere</CountryCode>
<IsCallOnly i:nil="false">ValueHere</IsCallOnly>
<IsCallTrackingEnabled i:nil="false">ValueHere</IsCallTrackingEnabled>
<PhoneNumber i:nil="false">ValueHere</PhoneNumber>
<RequireTollFreeTrackingNumber i:nil="false">ValueHere</RequireTollFreeTrackingNumber>
<!--These fields are applicable if the derived type attribute is set to ImageAdExtension-->
<AlternativeText i:nil="false">ValueHere</AlternativeText>
<Description i:nil="false">ValueHere</Description>
<DestinationUrl i:nil="false">ValueHere</DestinationUrl>
<DisplayText i:nil="false">ValueHere</DisplayText>
<FinalAppUrls i:nil="false">
<AppUrl>
<OsType i:nil="false">ValueHere</OsType>
<Url i:nil="false">ValueHere</Url>
</AppUrl>
</FinalAppUrls>
<FinalMobileUrls i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:string>ValueHere</a1:string>
</FinalMobileUrls>
<FinalUrlSuffix i:nil="false">ValueHere</FinalUrlSuffix>
<FinalUrls i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:string>ValueHere</a1:string>
</FinalUrls>
<ImageMediaIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:long>ValueHere</a1:long>
</ImageMediaIds>
<Images i:nil="false">
<AssetLink>
<Asset i:nil="false" i:type="-- derived type specified here with the appropriate prefix --">
<Id i:nil="false">ValueHere</Id>
<Name i:nil="false">ValueHere</Name>
<Type i:nil="false">ValueHere</Type>
<!--This field is applicable if the derived type attribute is set to TextAsset-->
<Text i:nil="false">ValueHere</Text>
<!--These fields are applicable if the derived type attribute is set to ImageAsset-->
<CropHeight i:nil="false">ValueHere</CropHeight>
<CropWidth i:nil="false">ValueHere</CropWidth>
<CropX i:nil="false">ValueHere</CropX>
<CropY i:nil="false">ValueHere</CropY>
<SubType i:nil="false">ValueHere</SubType>
<TargetHeight i:nil="false">ValueHere</TargetHeight>
<TargetWidth i:nil="false">ValueHere</TargetWidth>
<!--These fields are applicable if the derived type attribute is set to VideoAsset-->
<SubType i:nil="false">ValueHere</SubType>
<ThumbnailImage i:nil="false">
<CropHeight i:nil="false">ValueHere</CropHeight>
<CropWidth i:nil="false">ValueHere</CropWidth>
<CropX i:nil="false">ValueHere</CropX>
<CropY i:nil="false">ValueHere</CropY>
<SubType i:nil="false">ValueHere</SubType>
<TargetHeight i:nil="false">ValueHere</TargetHeight>
<TargetWidth i:nil="false">ValueHere</TargetWidth>
</ThumbnailImage>
</Asset>
<AssetPerformanceLabel i:nil="false">ValueHere</AssetPerformanceLabel>
<EditorialStatus i:nil="false">ValueHere</EditorialStatus>
<PinnedField i:nil="false">ValueHere</PinnedField>
</AssetLink>
</Images>
<Layouts i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:string>ValueHere</a1:string>
</Layouts>
<SourceType i:nil="false">ValueHere</SourceType>
<TrackingUrlTemplate i:nil="false">ValueHere</TrackingUrlTemplate>
<UrlCustomParameters i:nil="false">
<Parameters i:nil="false">
<CustomParameter>
<Key i:nil="false">ValueHere</Key>
<Value i:nil="false">ValueHere</Value>
</CustomParameter>
</Parameters>
</UrlCustomParameters>
<!--These fields are applicable if the derived type attribute is set to AppAdExtension-->
<AppPlatform i:nil="false">ValueHere</AppPlatform>
<AppStoreId i:nil="false">ValueHere</AppStoreId>
<DestinationUrl i:nil="false">ValueHere</DestinationUrl>
<DisplayText i:nil="false">ValueHere</DisplayText>
<FinalAppUrls i:nil="false">
<AppUrl>
<OsType i:nil="false">ValueHere</OsType>
<Url i:nil="false">ValueHere</Url>
</AppUrl>
</FinalAppUrls>
<FinalMobileUrls i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:string>ValueHere</a1:string>
</FinalMobileUrls>
<FinalUrlSuffix i:nil="false">ValueHere</FinalUrlSuffix>
<FinalUrls i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:string>ValueHere</a1:string>
</FinalUrls>
<TrackingUrlTemplate i:nil="false">ValueHere</TrackingUrlTemplate>
<UrlCustomParameters i:nil="false">
<Parameters i:nil="false">
<CustomParameter>
<Key i:nil="false">ValueHere</Key>
<Value i:nil="false">ValueHere</Value>
</CustomParameter>
</Parameters>
</UrlCustomParameters>
<!--These fields are applicable if the derived type attribute is set to ReviewAdExtension-->
<IsExact>ValueHere</IsExact>
<Source i:nil="false">ValueHere</Source>
<Text i:nil="false">ValueHere</Text>
<Url i:nil="false">ValueHere</Url>
<!--This field is applicable if the derived type attribute is set to CalloutAdExtension-->
<Text i:nil="false">ValueHere</Text>
<!--These fields are applicable if the derived type attribute is set to SitelinkAdExtension-->
<Description1 i:nil="false">ValueHere</Description1>
<Description2 i:nil="false">ValueHere</Description2>
<DestinationUrl i:nil="false">ValueHere</DestinationUrl>
<DisplayText i:nil="false">ValueHere</DisplayText>
<FinalAppUrls i:nil="false">
<AppUrl>
<OsType i:nil="false">ValueHere</OsType>
<Url i:nil="false">ValueHere</Url>
</AppUrl>
</FinalAppUrls>
<FinalMobileUrls i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:string>ValueHere</a1:string>
</FinalMobileUrls>
<FinalUrlSuffix i:nil="false">ValueHere</FinalUrlSuffix>
<FinalUrls i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:string>ValueHere</a1:string>
</FinalUrls>
<TrackingUrlTemplate i:nil="false">ValueHere</TrackingUrlTemplate>
<UrlCustomParameters i:nil="false">
<Parameters i:nil="false">
<CustomParameter>
<Key i:nil="false">ValueHere</Key>
<Value i:nil="false">ValueHere</Value>
</CustomParameter>
</Parameters>
</UrlCustomParameters>
<!--These fields are applicable if the derived type attribute is set to ActionAdExtension-->
<ActionType>ValueHere</ActionType>
<FinalMobileUrls i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:string>ValueHere</a1:string>
</FinalMobileUrls>
<FinalUrlSuffix i:nil="false">ValueHere</FinalUrlSuffix>
<FinalUrls i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:string>ValueHere</a1:string>
</FinalUrls>
<Language i:nil="false">ValueHere</Language>
<TrackingUrlTemplate i:nil="false">ValueHere</TrackingUrlTemplate>
<UrlCustomParameters i:nil="false">
<Parameters i:nil="false">
<CustomParameter>
<Key i:nil="false">ValueHere</Key>
<Value i:nil="false">ValueHere</Value>
</CustomParameter>
</Parameters>
</UrlCustomParameters>
<!--These fields are applicable if the derived type attribute is set to StructuredSnippetAdExtension-->
<Header i:nil="false">ValueHere</Header>
<Values i: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 i:nil="false">ValueHere</FinalUrlSuffix>
<Language i:nil="false">ValueHere</Language>
<PriceExtensionType>ValueHere</PriceExtensionType>
<TableRows i:nil="false">
<PriceTableRow>
<CurrencyCode i:nil="false">ValueHere</CurrencyCode>
<Description i:nil="false">ValueHere</Description>
<FinalMobileUrls i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:string>ValueHere</a1:string>
</FinalMobileUrls>
<FinalUrls i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:string>ValueHere</a1:string>
</FinalUrls>
<Header i:nil="false">ValueHere</Header>
<Price>ValueHere</Price>
<PriceQualifier>ValueHere</PriceQualifier>
<PriceUnit>ValueHere</PriceUnit>
<TermsAndConditions i:nil="false">ValueHere</TermsAndConditions>
<TermsAndConditionsUrl i:nil="false">ValueHere</TermsAndConditionsUrl>
</PriceTableRow>
</TableRows>
<TrackingUrlTemplate i:nil="false">ValueHere</TrackingUrlTemplate>
<UrlCustomParameters i:nil="false">
<Parameters i:nil="false">
<CustomParameter>
<Key i:nil="false">ValueHere</Key>
<Value i:nil="false">ValueHere</Value>
</CustomParameter>
</Parameters>
</UrlCustomParameters>
<!--These fields are applicable if the derived type attribute is set to PromotionAdExtension-->
<CurrencyCode i:nil="false">ValueHere</CurrencyCode>
<DiscountModifier i:nil="false">ValueHere</DiscountModifier>
<FinalAppUrls i:nil="false">
<AppUrl>
<OsType i:nil="false">ValueHere</OsType>
<Url i:nil="false">ValueHere</Url>
</AppUrl>
</FinalAppUrls>
<FinalMobileUrls i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:string>ValueHere</a1:string>
</FinalMobileUrls>
<FinalUrlSuffix i:nil="false">ValueHere</FinalUrlSuffix>
<FinalUrls i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:string>ValueHere</a1:string>
</FinalUrls>
<Language i:nil="false">ValueHere</Language>
<MoneyAmountOff i:nil="false">ValueHere</MoneyAmountOff>
<OrdersOverAmount i:nil="false">ValueHere</OrdersOverAmount>
<PercentOff i:nil="false">ValueHere</PercentOff>
<PromotionCode i:nil="false">ValueHere</PromotionCode>
<PromotionEndDate i:nil="false">
<Day>ValueHere</Day>
<Month>ValueHere</Month>
<Year>ValueHere</Year>
</PromotionEndDate>
<PromotionItem i:nil="false">ValueHere</PromotionItem>
<PromotionOccasion i:nil="false">ValueHere</PromotionOccasion>
<PromotionStartDate i:nil="false">
<Day>ValueHere</Day>
<Month>ValueHere</Month>
<Year>ValueHere</Year>
</PromotionStartDate>
<TrackingUrlTemplate i:nil="false">ValueHere</TrackingUrlTemplate>
<UrlCustomParameters i:nil="false">
<Parameters i:nil="false">
<CustomParameter>
<Key i:nil="false">ValueHere</Key>
<Value i:nil="false">ValueHere</Value>
</CustomParameter>
</Parameters>
</UrlCustomParameters>
<!--These fields are applicable if the derived type attribute is set to FilterLinkAdExtension-->
<AdExtensionHeaderType i:nil="false">ValueHere</AdExtensionHeaderType>
<FinalMobileUrls i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:string>ValueHere</a1:string>
</FinalMobileUrls>
<FinalUrlSuffix i:nil="false">ValueHere</FinalUrlSuffix>
<FinalUrls i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:string>ValueHere</a1:string>
</FinalUrls>
<Language i:nil="false">ValueHere</Language>
<Texts i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:string>ValueHere</a1:string>
</Texts>
<TrackingUrlTemplate i:nil="false">ValueHere</TrackingUrlTemplate>
<UrlCustomParameters i:nil="false">
<Parameters i:nil="false">
<CustomParameter>
<Key i:nil="false">ValueHere</Key>
<Value i:nil="false">ValueHere</Value>
</CustomParameter>
</Parameters>
</UrlCustomParameters>
<!--These fields are applicable if the derived type attribute is set to FlyerAdExtension-->
<Description i:nil="false">ValueHere</Description>
<FinalAppUrls i:nil="false">
<AppUrl>
<OsType i:nil="false">ValueHere</OsType>
<Url i:nil="false">ValueHere</Url>
</AppUrl>
</FinalAppUrls>
<FinalMobileUrls i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:string>ValueHere</a1:string>
</FinalMobileUrls>
<FinalUrlSuffix i:nil="false">ValueHere</FinalUrlSuffix>
<FinalUrls i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:string>ValueHere</a1:string>
</FinalUrls>
<FlyerName i:nil="false">ValueHere</FlyerName>
<ImageMediaIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:long>ValueHere</a1:long>
</ImageMediaIds>
<ImageMediaUrls i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:string>ValueHere</a1:string>
</ImageMediaUrls>
<StoreId i:nil="false">ValueHere</StoreId>
<TrackingUrlTemplate i:nil="false">ValueHere</TrackingUrlTemplate>
<UrlCustomParameters i:nil="false">
<Parameters i:nil="false">
<CustomParameter>
<Key i:nil="false">ValueHere</Key>
<Value i:nil="false">ValueHere</Value>
</CustomParameter>
</Parameters>
</UrlCustomParameters>
<!--These fields are applicable if the derived type attribute is set to VideoAdExtension-->
<ActionText i:nil="false">ValueHere</ActionText>
<AlternativeText i:nil="false">ValueHere</AlternativeText>
<DisplayText i:nil="false">ValueHere</DisplayText>
<FinalAppUrls i:nil="false">
<AppUrl>
<OsType i:nil="false">ValueHere</OsType>
<Url i:nil="false">ValueHere</Url>
</AppUrl>
</FinalAppUrls>
<FinalMobileUrls i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:string>ValueHere</a1:string>
</FinalMobileUrls>
<FinalUrlSuffix i:nil="false">ValueHere</FinalUrlSuffix>
<FinalUrls i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:string>ValueHere</a1:string>
</FinalUrls>
<Name i:nil="false">ValueHere</Name>
<ThumbnailId i:nil="false">ValueHere</ThumbnailId>
<ThumbnailUrl i:nil="false">ValueHere</ThumbnailUrl>
<TrackingUrlTemplate i:nil="false">ValueHere</TrackingUrlTemplate>
<UrlCustomParameters i:nil="false">
<Parameters i:nil="false">
<CustomParameter>
<Key i:nil="false">ValueHere</Key>
<Value i:nil="false">ValueHere</Value>
</CustomParameter>
</Parameters>
</UrlCustomParameters>
<VideoId i:nil="false">ValueHere</VideoId>
<!--These fields are applicable if the derived type attribute is set to DisclaimerAdExtension-->
<DisclaimerLayout i:nil="false">ValueHere</DisclaimerLayout>
<FinalAppUrls i:nil="false">
<AppUrl>
<OsType i:nil="false">ValueHere</OsType>
<Url i:nil="false">ValueHere</Url>
</AppUrl>
</FinalAppUrls>
<FinalMobileUrls i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:string>ValueHere</a1:string>
</FinalMobileUrls>
<FinalUrlSuffix i:nil="false">ValueHere</FinalUrlSuffix>
<FinalUrls i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:string>ValueHere</a1:string>
</FinalUrls>
<LineText i:nil="false">ValueHere</LineText>
<Name i:nil="false">ValueHere</Name>
<PopupText i:nil="false">ValueHere</PopupText>
<Title i:nil="false">ValueHere</Title>
<TrackingUrlTemplate i:nil="false">ValueHere</TrackingUrlTemplate>
<UrlCustomParameters i:nil="false">
<Parameters i:nil="false">
<CustomParameter>
<Key i:nil="false">ValueHere</Key>
<Value i:nil="false">ValueHere</Value>
</CustomParameter>
</Parameters>
</UrlCustomParameters>
<!--These fields are applicable if the derived type attribute is set to LogoAdExtension-->
<BusinessLogo i:nil="false">ValueHere</BusinessLogo>
<BusinessLogoUrl i:nil="false">ValueHere</BusinessLogoUrl>
<BusinessName i:nil="false">ValueHere</BusinessName>
<DomainName i:nil="false">ValueHere</DomainName>
</AdExtension>
</AdExtensions>
</AddAdExtensionsRequest>
</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>
<AddAdExtensionsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<AdExtensionIdentities d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<AdExtensionIdentity>
<Id>ValueHere</Id>
<Version d4p1:nil="false">ValueHere</Version>
</AdExtensionIdentity>
</AdExtensionIdentities>
<NestedPartialErrors d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<BatchErrorCollection d4p1:type="-- derived type specified here with the appropriate prefix --">
<BatchErrors d4p1:nil="false">
<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:e184="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
<e184:KeyValuePairOfstringstring>
<e184:key d4p1:nil="false">ValueHere</e184:key>
<e184:value d4p1:nil="false">ValueHere</e184:value>
</e184: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>
</BatchErrors>
<Code d4p1:nil="false">ValueHere</Code>
<Details d4p1:nil="false">ValueHere</Details>
<ErrorCode d4p1:nil="false">ValueHere</ErrorCode>
<FieldPath d4p1:nil="false">ValueHere</FieldPath>
<ForwardCompatibilityMap xmlns:e185="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
<e185:KeyValuePairOfstringstring>
<e185:key d4p1:nil="false">ValueHere</e185:key>
<e185:value d4p1:nil="false">ValueHere</e185:value>
</e185: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 EditorialErrorCollection-->
<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>
</BatchErrorCollection>
</NestedPartialErrors>
</AddAdExtensionsResponse>
</s:Body>
</s:Envelope>
コード構文
構文の例は、 Bing広告 SDK で使用できます。 その他 の例については、「Bing広告 API コードの例 」を参照してください。
public async Task<AddAdExtensionsResponse> AddAdExtensionsAsync(
long accountId,
IList<AdExtension> adExtensions)
{
var request = new AddAdExtensionsRequest
{
AccountId = accountId,
AdExtensions = adExtensions
};
return (await CampaignManagementService.CallAsync((s, r) => s.AddAdExtensionsAsync(r), request));
}
static AddAdExtensionsResponse addAdExtensions(
java.lang.Long accountId,
ArrayOfAdExtension adExtensions) throws RemoteException, Exception
{
AddAdExtensionsRequest request = new AddAdExtensionsRequest();
request.setAccountId(accountId);
request.setAdExtensions(adExtensions);
return CampaignManagementService.getService().addAdExtensions(request);
}
static function AddAdExtensions(
$accountId,
$adExtensions)
{
$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];
$request = new AddAdExtensionsRequest();
$request->AccountId = $accountId;
$request->AdExtensions = $adExtensions;
return $GLOBALS['CampaignManagementProxy']->GetService()->AddAdExtensions($request);
}
response=campaignmanagement_service.AddAdExtensions(
AccountId=AccountId,
AdExtensions=AdExtensions)
要件
サービス: CampaignManagementService.svc v13
Namespace: https://bingads.microsoft.com/CampaignManagement/v13
要求 URL
https://campaign.api.bingads.microsoft.com/CampaignManagement/v13/AdExtensions
Request 要素
AddAdExtensionsRequest オブジェクトは、サービス操作要求の本文要素とヘッダー要素を定義します。
注:
以下に特に記載がない限り、すべての要求要素が必要です。
要求本文要素
要素 | 説明 | データ型 |
---|---|---|
AccountId | 拡張機能を追加するアカウントの識別子。 | long |
AdExtensions | アカウントに追加する任意の種類の広告表示オプションの一覧。 呼び出しごとに最大 100 個の拡張機能を指定できます。 | AdExtension 配列 |
要求ヘッダー要素
要素 | 説明 | データ型 |
---|---|---|
Authorization | Microsoft Advertising アカウントへのアクセス許可を持つユーザーの資格情報を表す OAuth アクセス トークン。 トークンのプレフィックスに "Bearer" があることを確認してください。これは、適切な認証に必要です。 詳細については、「 OAuth による認証」を参照してください。 |
string |
CustomerAccountId | 要求のエンティティを所有または関連付けられている広告アカウントの識別子。 両方が必要な場合、このヘッダー要素の値は AccountId 本文要素と同じである必要があります。 この要素は、ほとんどのサービス操作に必要であり、ベスト プラクティスとして常に設定する必要があります。 詳細については、「 アカウントと顧客 ID を取得する」を参照してください。 |
string |
CustomerId | ユーザーがアクセスまたは操作しているマネージャー アカウント (顧客) の識別子。 ユーザーは複数のマネージャー アカウントにアクセスできます。 この要素は、ほとんどのサービス操作に必要であり、ベスト プラクティスとして常に設定する必要があります。 詳細については、「 アカウントと顧客 ID を取得する」を参照してください。 |
string |
DeveloperToken | Bing Ads API へのアクセスに使用される開発者トークン。 詳細については、「 開発者トークンを取得する」を参照してください。 |
string |
Password | この要素は内部使用のために予約されており、今後のバージョンの API から削除されます。 ユーザー資格情報を設定するには、AuthenticationToken 要素を使用する必要があります。 | string |
UserName | この要素は内部使用のために予約されており、今後のバージョンの API から削除されます。 ユーザー資格情報を設定するには、AuthenticationToken 要素を使用する必要があります。 | string |
Response 要素
AddAdExtensionsResponse オブジェクトは、サービス操作応答の本文要素とヘッダー要素を定義します。 要素は、 Response JSON に示されている順序と同じ順序で返されます。
応答本文の要素
要素 | 説明 | データ型 |
---|---|---|
AdExtensionIdentities | 追加された拡張機能の ID。 リストは、要求で指定された拡張機能の一覧に直接対応します。 | AdExtensionIdentity 配列 |
NestedPartialErrors | 正常に追加されなかった広告拡張機能の詳細を含む BatchErrorCollection オブジェクトの配列。 各 BatchErrorCollection オブジェクト内の最上位エラーは、広告拡張機能エラーの可能性に対応しています。
BatchError オブジェクトの入れ子になったリストには、広告拡張機能内のリスト アイテムに固有のエラーが含まれます (該当する場合)。 エラーの一覧は、要求内の項目の一覧に直接対応していません。 エラーがない場合はリストを空にすることも、失敗したリスト 項目ごとに対応する 1 つ以上のエラー オブジェクトを要求に含めることもできます。 |
BatchErrorCollection 配列 |
応答ヘッダー要素
要素 | 説明 | データ型 |
---|---|---|
TrackingId | API 呼び出しの詳細を含むログ エントリの識別子。 | string |
JSON を要求する
このテンプレートは、JSON 要求の 本文 と ヘッダー 要素を表示するツールによって生成されました。 このサービス操作で使用できるサポートされる型については、上記の 要求本文要素 のリファレンスを参照してください。
AdExtension の種類が ActionAdExtension の場合に適用可能な例を次に示します。
{
"AccountId": "LongValueHere",
"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"
}
]
}
}
]
}
応答 JSON
このテンプレートは、JSON 応答の 本文 と ヘッダー 要素を表示するツールによって生成されました。
BatchErrorCollection の種類が EditorialErrorCollection の場合に適用される例を次に示します。BatchError は EditorialError です。
{
"AdExtensionIdentities": [
{
"Id": "LongValueHere",
"Version": IntValueHere
}
],
"NestedPartialErrors": [
{
"BatchErrors": [
{
"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
}
],
"Code": IntValueHere,
"Details": "ValueHere",
"ErrorCode": "ValueHere",
"FieldPath": "ValueHere",
"ForwardCompatibilityMap": [
{
"key": "ValueHere",
"value": "ValueHere"
}
],
"Index": IntValueHere,
"Message": "ValueHere",
"Type": "EditorialErrorCollection",
"Appealable": "ValueHere",
"DisapprovedText": "ValueHere",
"Location": "ValueHere",
"PublisherCountry": "ValueHere",
"ReasonCode": IntValueHere
}
]
}
コード構文
SDK を使用して REST API を呼び出すには、SDK を特定のバージョンにアップグレードし、システム パラメーターを構成する必要があります。構文の例は、 Bing広告 SDK で使用できます。 その他 の例については、「Bing広告 API コードの例 」を参照してください。
public async Task<AddAdExtensionsResponse> AddAdExtensionsAsync(
long accountId,
IList<AdExtension> adExtensions)
{
var request = new AddAdExtensionsRequest
{
AccountId = accountId,
AdExtensions = adExtensions
};
return (await CampaignManagementService.CallAsync((s, r) => s.AddAdExtensionsAsync(r), request));
}
static AddAdExtensionsResponse addAdExtensions(
java.lang.Long accountId,
ArrayOfAdExtension adExtensions) throws RemoteException, Exception
{
AddAdExtensionsRequest request = new AddAdExtensionsRequest();
request.setAccountId(accountId);
request.setAdExtensions(adExtensions);
return CampaignManagementService.getService().addAdExtensions(request);
}
static function AddAdExtensions(
$accountId,
$adExtensions)
{
$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];
$request = new AddAdExtensionsRequest();
$request->AccountId = $accountId;
$request->AdExtensions = $adExtensions;
return $GLOBALS['CampaignManagementProxy']->GetService()->AddAdExtensions($request);
}
response=campaignmanagement_service.AddAdExtensions(
AccountId=AccountId,
AdExtensions=AdExtensions)