次の方法で共有

AddAds サービス操作 - キャンペーン管理

  • [アーティクル]

広告グループに 1 つ以上の広告を追加します。

注:

  • 拡張テキスト広告を、2023 年 2 月 1 日までにレスポンシブ検索広告にアップグレードします。 この日付を過ぎると、新しいテキスト広告を作成したり、既存の拡張テキスト広告を編集したりできなくなります。 詳細については、「 レスポンシブ検索広告について」を参照してください。
  • 既存の拡張テキスト広告は引き続き配信され、そのパフォーマンスに関するレポートを表示できます。
  • 拡張テキスト広告は引き続き一時停止、有効化、または削除できます。 そうしないと、拡張テキスト広告を追加または更新しようとすると、 CampaignServiceAdTypeInvalid エラーが発生します。
  • この変更の詳細については、こちらをご覧ください。

Request 要素

AddAdsRequest オブジェクトは、サービス操作要求の本文要素とヘッダー要素を定義します。 要素は、 要求 SOAP に示されている順序と同じ順序である必要があります。

注:

以下に特に記載がない限り、すべての要求要素が必要です。

要求本文要素

要素 説明 データ型
AdGroupId 広告を追加する広告グループの識別子。 long
広告 広告グループに追加する最大 50 個の広告の配列。 広告 配列

要求ヘッダー要素

要素 説明 データ型
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 要素

AddAdsResponse オブジェクトは、サービス操作応答の本文要素とヘッダー要素を定義します。 要素は、 応答 SOAP に示されている順序と同じ順序で返されます。

応答本文の要素

要素 説明 データ型
AdIds 追加された広告に対応する一意のシステム識別子の一覧。

識別子の一覧は、要求内の広告の一覧に直接対応します。 リストの項目は null として返される場合があります。 広告が追加されなかったリスト インデックスごとに、対応する要素は null になります。		 long 配列
PartialErrors 成功しなかった要求項目の詳細を含む BatchError オブジェクトの配列。

エラーの一覧は、要求内の項目の一覧に直接対応していません。 エラーがない場合はリストを空にすることも、失敗したリスト 項目ごとに対応する 1 つ以上のエラー オブジェクトを要求に含めることもできます。		 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">AddAds</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>
    <AddAdsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <AdGroupId>ValueHere</AdGroupId>
      <Ads i:nil="false">
        <Ad i:type="-- derived type specified here with the appropriate prefix --">
          <AdFormatPreference i:nil="false">ValueHere</AdFormatPreference>
          <DevicePreference i:nil="false">ValueHere</DevicePreference>
          <EditorialStatus i:nil="false">ValueHere</EditorialStatus>
          <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>
          <ForwardCompatibilityMap xmlns:e201="http://schemas.datacontract.org/2004/07/System.Collections.Generic" i:nil="false">
            <e201:KeyValuePairOfstringstring>
              <e201:key i:nil="false">ValueHere</e201:key>
              <e201:value i:nil="false">ValueHere</e201:value>
            </e201:KeyValuePairOfstringstring>
          </ForwardCompatibilityMap>
          <Id i:nil="false">ValueHere</Id>
          <Status i:nil="false">ValueHere</Status>
          <TrackingUrlTemplate i:nil="false">ValueHere</TrackingUrlTemplate>
          <Type i:nil="false">ValueHere</Type>
          <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 TextAd-->
          <DestinationUrl i:nil="false">ValueHere</DestinationUrl>
          <DisplayUrl i:nil="false">ValueHere</DisplayUrl>
          <Text i:nil="false">ValueHere</Text>
          <Title i:nil="false">ValueHere</Title>
          <!--This field is applicable if the derived type attribute is set to ProductAd-->
          <PromotionalText i: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 i:nil="false">ValueHere</AppPlatform>
          <AppStoreId i:nil="false">ValueHere</AppStoreId>
          <Text i:nil="false">ValueHere</Text>
          <Title i:nil="false">ValueHere</Title>
          <!--These fields are applicable if the derived type attribute is set to ExpandedTextAd-->
          <Domain i:nil="false">ValueHere</Domain>
          <Path1 i:nil="false">ValueHere</Path1>
          <Path2 i:nil="false">ValueHere</Path2>
          <Text i:nil="false">ValueHere</Text>
          <TextPart2 i:nil="false">ValueHere</TextPart2>
          <TitlePart1 i:nil="false">ValueHere</TitlePart1>
          <TitlePart2 i:nil="false">ValueHere</TitlePart2>
          <TitlePart3 i:nil="false">ValueHere</TitlePart3>
          <!--These fields are applicable if the derived type attribute is set to DynamicSearchAd-->
          <Path1 i:nil="false">ValueHere</Path1>
          <Path2 i:nil="false">ValueHere</Path2>
          <Text i:nil="false">ValueHere</Text>
          <TextPart2 i:nil="false">ValueHere</TextPart2>
          <!--These fields are applicable if the derived type attribute is set to ResponsiveAd-->
          <AdSubType i:nil="false">ValueHere</AdSubType>
          <BusinessName i:nil="false">ValueHere</BusinessName>
          <CallToAction i:nil="false">ValueHere</CallToAction>
          <CallToActionLanguage i:nil="false">ValueHere</CallToActionLanguage>
          <Descriptions 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 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>
          </Descriptions>
          <Headline i:nil="false">ValueHere</Headline>
          <Headlines 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 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>
          </Headlines>
          <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>
                <!--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>
          <ImpressionTrackingUrls i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <a1:string>ValueHere</a1:string>
          </ImpressionTrackingUrls>
          <LongHeadline i:nil="false">
            <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 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>
          </LongHeadline>
          <LongHeadlineString i:nil="false">ValueHere</LongHeadlineString>
          <LongHeadlines 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>
          </LongHeadlines>
          <Text i:nil="false">ValueHere</Text>
          <VerifiedTrackingSettings i:nil="false">
            <Details xmlns:e202="http://schemas.datacontract.org/2004/07/System.Collections.Generic" i:nil="false">
              <e202:ArrayOfKeyValuePairOfstringstring>
                <e202:KeyValuePairOfstringstring>
                  <e202:key i:nil="false">ValueHere</e202:key>
                  <e202:value i:nil="false">ValueHere</e202:value>
                </e202:KeyValuePairOfstringstring>
              </e202:ArrayOfKeyValuePairOfstringstring>
            </Details>
          </VerifiedTrackingSettings>
          <Videos 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>
          </Videos>
          <!--These fields are applicable if the derived type attribute is set to ResponsiveSearchAd-->
          <Descriptions 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 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>
          </Descriptions>
          <Domain i:nil="false">ValueHere</Domain>
          <Headlines 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 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>
          </Headlines>
          <Path1 i:nil="false">ValueHere</Path1>
          <Path2 i:nil="false">ValueHere</Path2>
        </Ad>
      </Ads>
    </AddAdsRequest>
  </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>
    <AddAdsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <AdIds d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <a1:long>ValueHere</a1:long>
      </AdIds>
      <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:e203="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
            <e203:KeyValuePairOfstringstring>
              <e203:key d4p1:nil="false">ValueHere</e203:key>
              <e203:value d4p1:nil="false">ValueHere</e203:value>
            </e203: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>
    </AddAdsResponse>
  </s:Body>
</s:Envelope>

コード構文

構文の例は、 Bing広告 SDK で使用できます。 その他 の例については、「Bing広告 API コードの例 」を参照してください。

public async Task<AddAdsResponse> AddAdsAsync(
	long adGroupId,
	IList<Ad> ads)
{
	var request = new AddAdsRequest
	{
		AdGroupId = adGroupId,
		Ads = ads
	};

	return (await CampaignManagementService.CallAsync((s, r) => s.AddAdsAsync(r), request));
}

static AddAdsResponse addAds(
	java.lang.Long adGroupId,
	ArrayOfAd ads) throws RemoteException, Exception
{
	AddAdsRequest request = new AddAdsRequest();

	request.setAdGroupId(adGroupId);
	request.setAds(ads);

	return CampaignManagementService.getService().addAds(request);
}

static function AddAds(
	$adGroupId,
	$ads)
{

	$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];

	$request = new AddAdsRequest();

	$request->AdGroupId = $adGroupId;
	$request->Ads = $ads;

	return $GLOBALS['CampaignManagementProxy']->GetService()->AddAds($request);
}

response=campaignmanagement_service.AddAds(
	AdGroupId=AdGroupId,
	Ads=Ads)

要件

サービス: CampaignManagementService.svc v13
Namespace: https://bingads.microsoft.com/CampaignManagement/v13

要求 URL

https://campaign.api.bingads.microsoft.com/CampaignManagement/v13/Ads

Request 要素

AddAdsRequest オブジェクトは、サービス操作要求の本文要素とヘッダー要素を定義します。

注:

以下に特に記載がない限り、すべての要求要素が必要です。

要求本文要素

要素 説明 データ型
AdGroupId 広告を追加する広告グループの識別子。 long
広告 広告グループに追加する最大 50 個の広告の配列。 広告 配列

要求ヘッダー要素

要素 説明 データ型
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 要素

AddAdsResponse オブジェクトは、サービス操作応答の本文要素とヘッダー要素を定義します。 要素は、 Response JSON に示されている順序と同じ順序で返されます。

応答本文の要素

要素 説明 データ型
AdIds 追加された広告に対応する一意のシステム識別子の一覧。

識別子の一覧は、要求内の広告の一覧に直接対応します。 リストの項目は null として返される場合があります。 広告が追加されなかったリスト インデックスごとに、対応する要素は null になります。		 long 配列
PartialErrors 成功しなかった要求項目の詳細を含む BatchError オブジェクトの配列。

エラーの一覧は、要求内の項目の一覧に直接対応していません。 エラーがない場合はリストを空にすることも、失敗したリスト 項目ごとに対応する 1 つ以上のエラー オブジェクトを要求に含めることもできます。		 BatchError 配列

応答ヘッダー要素

要素 説明 データ型
TrackingId API 呼び出しの詳細を含むログ エントリの識別子。 string

JSON を要求する

このテンプレートは、JSON 要求の 本文 と ヘッダー 要素を表示するツールによって生成されました。 このサービス操作で使用できるサポートされる型については、上記の 要求本文要素 のリファレンスを参照してください。

広告の種類が AppInstallAd の場合に適用される例を次に示します。

{
  "AdGroupId": "LongValueHere",
  "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"
    }
  ]
}

応答 JSON

このテンプレートは、JSON 応答の 本文 と ヘッダー 要素を表示するツールによって生成されました。

BatchError の種類が EditorialError の場合に適用される例を次に示します。

{
  "AdIds": [
    "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<AddAdsResponse> AddAdsAsync(
	long adGroupId,
	IList<Ad> ads)
{
	var request = new AddAdsRequest
	{
		AdGroupId = adGroupId,
		Ads = ads
	};

	return (await CampaignManagementService.CallAsync((s, r) => s.AddAdsAsync(r), request));
}

static AddAdsResponse addAds(
	java.lang.Long adGroupId,
	ArrayOfAd ads) throws RemoteException, Exception
{
	AddAdsRequest request = new AddAdsRequest();

	request.setAdGroupId(adGroupId);
	request.setAds(ads);

	return CampaignManagementService.getService().addAds(request);
}

static function AddAds(
	$adGroupId,
	$ads)
{

	$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];

	$request = new AddAdsRequest();

	$request->AdGroupId = $adGroupId;
	$request->Ads = $ads;

	return $GLOBALS['CampaignManagementProxy']->GetService()->AddAds($request);
}

response=campaignmanagement_service.AddAds(
	AdGroupId=AdGroupId,
	Ads=Ads)