Skip to content
This repository has been archived by the owner on Nov 30, 2021. It is now read-only.

Latest commit

 

History

History
1227 lines (1171 loc) · 55.9 KB

AdGroupAdService.md

File metadata and controls

1227 lines (1171 loc) · 55.9 KB

AdGroupAdService

AdGroupAdServiceでは、広告に関する情報の取得および追加・更新・削除を行います。

WSDL

environment url
production https://ss.yahooapis.jp/services/V201909/AdGroupAdService?wsdl
sandbox https://sandbox.ss.yahooapis.jp/services/V201909/AdGroupAdService?wsdl

Namespace

http://ss.yahooapis.jp/V201909/AdGroupAd

Service Overview

広告に関する情報の取得および追加・更新・削除を行います。

Operation

AdGroupAdServiceで提供される操作を説明します。

get

リクエスト

広告に関する情報を取得します。

パラメータ 必須 データ型
selector Yes AdGroupAdSelector
＜リクエストサンプル＞
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
  <SOAP-ENV:Header>
    <RequestHeader xmlns="http://ss.yahooapis.jp/V201909/AdGroupAd" xmlns:ns2="http://ss.yahooapis.jp/V201909">
      <ns2:license>1111-1111-1111-1111</ns2:license>
      <ns2:apiAccountId>2222-2222-2222-2222</ns2:apiAccountId>
      <ns2:apiAccountPassword>password</ns2:apiAccountPassword>
    </RequestHeader>
  </SOAP-ENV:Header>
  <SOAP-ENV:Body>
    <get xmlns="http://ss.yahooapis.jp/V201909/AdGroupAd" xmlns:ns2="http://ss.yahooapis.jp/V201909">
      <selector>
        <accountId>1234567890</accountId>
        <campaignIds>20001</campaignIds>
        <campaignIds>20002</campaignIds>
        <campaignIds>20003</campaignIds>
        <campaignIds>20004</campaignIds>
        <campaignIds>20005</campaignIds>
        <adGroupIds>30001</adGroupIds>
        <adGroupIds>30002</adGroupIds>
        <adGroupIds>30003</adGroupIds>
        <adGroupIds>30004</adGroupIds>
        <adGroupIds>30005</adGroupIds>
        <adIds>40001</adIds>
        <adIds>40002</adIds>
        <adIds>40003</adIds>
        <adIds>40004</adIds>
        <adIds>40005</adIds>
        <adTypes>TEXT_AD2</adTypes>
        <adTypes>APP_AD</adTypes>
        <adTypes>EXTENDED_TEXT_AD</adTypes>
        <adTypes>DYNAMIC_SEARCH_LINKED_AD</adTypes>
        <userStatuses>ACTIVE</userStatuses>
        <userStatuses>PAUSED</userStatuses>
        <approvalStatuses>APPROVED</approvalStatuses>
        <approvalStatuses>APPROVED_WITH_REVIEW</approvalStatuses>
        <approvalStatuses>REVIEW</approvalStatuses>
        <approvalStatuses>PRE_DISAPPROVED</approvalStatuses>
        <approvalStatuses>POST_DISAPPROVED</approvalStatuses>
        <labelIds>50001</labelIds>
        <labelIds>50002</labelIds>
        <labelIds>50003</labelIds>
        <labelIds>50004</labelIds>
        <labelIds>50005</labelIds>
        <containsLabelId>TRUE</containsLabelId>
        <paging>
          <ns2:startIndex>1</ns2:startIndex>
          <ns2:numberResults>1000</ns2:numberResults>
        </paging>
      </selector>
    </get>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

レスポンス

広告に関する情報を取得します。

パラメータ データ型
rval AdGroupAdPage
＜レスポンスサンプル＞
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
  <SOAP-ENV:Header>
    <ResponseHeader xmlns="http://ss.yahooapis.jp/V201909/AdGroupAd" xmlns:ns2="http://ss.yahooapis.jp/V201909">
      <ns2:service>AdGroupAd</ns2:service>
      <ns2:requestTime>1567167321898</ns2:requestTime>
      <ns2:timeTakenSeconds>0.2671</ns2:timeTakenSeconds>
    </ResponseHeader>
  </SOAP-ENV:Header>
  <SOAP-ENV:Body>
    <ns2:getResponse xmlns="http://ss.yahooapis.jp/V201909" xmlns:ns2="http://ss.yahooapis.jp/V201909/AdGroupAd">
      <ns2:rval>
        <totalNumEntries>5</totalNumEntries>
        <Page.Type>AdGroupAdPage</Page.Type>
        <ns2:values>
          <operationSucceeded>true</operationSucceeded>
          <ns2:adGroupAd>
            <ns2:accountId>1234567890</ns2:accountId>
            <ns2:campaignId>20001</ns2:campaignId>
            <ns2:campaignTrackId>200000001</ns2:campaignTrackId>
            <ns2:campaignName>sample campaign.</ns2:campaignName>
            <ns2:adGroupId>30001</ns2:adGroupId>
            <ns2:adGroupTrackId>300000001</ns2:adGroupTrackId>
            <ns2:adGroupName>sample adGroup.</ns2:adGroupName>
            <ns2:adId>40001</ns2:adId>
            <ns2:adTrackId>400000001</ns2:adTrackId>
            <ns2:adName>sample text ad.</ns2:adName>
            <ns2:userStatus>ACTIVE</ns2:userStatus>
            <ns2:trademarkStatus>NO_RESTRICTION</ns2:trademarkStatus>
            <ns2:approvalStatus>APPROVED</ns2:approvalStatus>
            <ns2:ad xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ns2:TextAd2">
              <ns2:type>TEXT_AD2</ns2:type>
              <ns2:advancedUrl>http://yahoo.co.jp</ns2:advancedUrl>
              <ns2:additionalAdvancedUrls>
                <ns2:advancedUrl>http://yahoo.co.jp/url1</ns2:advancedUrl>
              </ns2:additionalAdvancedUrls>
              <ns2:advancedMobileUrl>http://mobile.yahoo.co.jp</ns2:advancedMobileUrl>
              <ns2:additionalAdvancedMobileUrls>
                <ns2:advancedMobileUrl>http://mobile.yahoo.co.jp/url1</ns2:advancedMobileUrl>
              </ns2:additionalAdvancedMobileUrls>
              <ns2:trackingUrl>http://yahoo.co.jp?url={lpurl}&amp;c={campaignid}&amp;g={adgroupid}&amp;a={creative}&amp;type={_site}&amp;pid={_id1}&amp;vid={_id2}</ns2:trackingUrl>
              <ns2:customParameters>
                <ns2:parameters>
                  <ns2:key>site</ns2:key>
                  <ns2:value>yahoo</ns2:value>
                </ns2:parameters>
                <ns2:parameters>
                  <ns2:key>id1</ns2:key>
                  <ns2:value>1234</ns2:value>
                </ns2:parameters>
                <ns2:parameters>
                  <ns2:key>id2</ns2:key>
                  <ns2:value>a7h59A98yu</ns2:value>
                </ns2:parameters>
              </ns2:customParameters>
              <ns2:displayUrl>yahoo.co.jp</ns2:displayUrl>
              <ns2:headline>sample ad title.</ns2:headline>
              <ns2:description>sample ad description.</ns2:description>
              <ns2:devicePreference>SMART_PHONE</ns2:devicePreference>
              <ns2:description2>{=COUNTDOWN("2016/01/01 00:00:00","ja")}</ns2:description2>
            </ns2:ad>
            <ns2:labels>
              <ns2:labelId>50001</ns2:labelId>
              <ns2:labelName>sample label 1</ns2:labelName>
              <ns2:description>sample description 1</ns2:description>
              <ns2:color>#FFFFFF</ns2:color>
            </ns2:labels>
          </ns2:adGroupAd>
        </ns2:values>
        <ns2:values>
          <operationSucceeded>true</operationSucceeded>
          <ns2:adGroupAd>
            <ns2:accountId>1234567890</ns2:accountId>
            <ns2:campaignId>20002</ns2:campaignId>
            <ns2:campaignTrackId>200000002</ns2:campaignTrackId>
            <ns2:campaignName>sample campaign.</ns2:campaignName>
            <ns2:adGroupId>30002</ns2:adGroupId>
            <ns2:adGroupTrackId>300000002</ns2:adGroupTrackId>
            <ns2:adGroupName>sample adGroup.</ns2:adGroupName>
            <ns2:adId>40002</ns2:adId>
            <ns2:adTrackId>400000002</ns2:adTrackId>
            <ns2:adName>sample app ad for ios.</ns2:adName>
            <ns2:userStatus>ACTIVE</ns2:userStatus>
            <ns2:trademarkStatus>NO_RESTRICTION</ns2:trademarkStatus>
            <ns2:approvalStatus>APPROVED</ns2:approvalStatus>
            <ns2:ad xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ns2:AppAd">
              <ns2:type>APP_AD</ns2:type>
              <ns2:advancedUrl>http://www.apple.com/jp/itunes/app/appname/appid1234567890</ns2:advancedUrl>
              <ns2:displayUrl>itunes.apple.com</ns2:displayUrl>
              <ns2:headline>sample ad title.</ns2:headline>
              <ns2:description>sample ad description.</ns2:description>
              <ns2:description2>sample ad description2.</ns2:description2>
              <ns2:appStore>IOS</ns2:appStore>
              <ns2:appId>appid1234567890</ns2:appId>
            </ns2:ad>
            <ns2:labels>
              <ns2:labelId>50002</ns2:labelId>
              <ns2:labelName>sample label 2</ns2:labelName>
              <ns2:description>sample description 2</ns2:description>
              <ns2:color>#000000</ns2:color>
            </ns2:labels>
          </ns2:adGroupAd>
        </ns2:values>
        <ns2:values>
          <operationSucceeded>true</operationSucceeded>
          <ns2:adGroupAd>
            <ns2:accountId>1234567890</ns2:accountId>
            <ns2:campaignId>20003</ns2:campaignId>
            <ns2:campaignTrackId>200000003</ns2:campaignTrackId>
            <ns2:campaignName>sample campaign.</ns2:campaignName>
            <ns2:adGroupId>30003</ns2:adGroupId>
            <ns2:adGroupTrackId>300000003</ns2:adGroupTrackId>
            <ns2:adGroupName>sample adGroup.</ns2:adGroupName>
            <ns2:adId>40003</ns2:adId>
            <ns2:adTrackId>400000003</ns2:adTrackId>
            <ns2:adName>sample app ad for android.</ns2:adName>
            <ns2:userStatus>ACTIVE</ns2:userStatus>
            <ns2:trademarkStatus>NO_RESTRICTION</ns2:trademarkStatus>
            <ns2:approvalStatus>APPROVED</ns2:approvalStatus>
            <ns2:ad xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ns2:AppAd">
              <ns2:type>APP_AD</ns2:type>
              <ns2:advancedUrl>https://play.google.com/store/apps/details?id=appid1234567890</ns2:advancedUrl>
              <ns2:displayUrl>play.google.com/store</ns2:displayUrl>
              <ns2:headline>sample ad title.</ns2:headline>
              <ns2:description>sample ad description.</ns2:description>
              <ns2:description2>sample ad description2.</ns2:description2>
              <ns2:appStore>ANDROID</ns2:appStore>
              <ns2:appId>appid1234567890</ns2:appId>
            </ns2:ad>
            <ns2:labels>
              <ns2:labelId>50003</ns2:labelId>
              <ns2:labelName>sample label 3</ns2:labelName>
              <ns2:description>sample description 3</ns2:description>
              <ns2:color>#FF0000</ns2:color>
            </ns2:labels>
          </ns2:adGroupAd>
        </ns2:values>
        <ns2:values>
          <operationSucceeded>true</operationSucceeded>
          <ns2:adGroupAd>
            <ns2:accountId>1234567890</ns2:accountId>
            <ns2:campaignId>20004</ns2:campaignId>
            <ns2:campaignTrackId>200000004</ns2:campaignTrackId>
            <ns2:campaignName>sample campaign.</ns2:campaignName>
            <ns2:adGroupId>30004</ns2:adGroupId>
            <ns2:adGroupTrackId>300000004</ns2:adGroupTrackId>
            <ns2:adGroupName>sample adGroup.</ns2:adGroupName>
            <ns2:adId>40004</ns2:adId>
            <ns2:adTrackId>400000004</ns2:adTrackId>
            <ns2:adName>sample extended text ad.</ns2:adName>
            <ns2:userStatus>ACTIVE</ns2:userStatus>
            <ns2:trademarkStatus>NO_RESTRICTION</ns2:trademarkStatus>
            <ns2:approvalStatus>APPROVED</ns2:approvalStatus>
            <ns2:ad xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ns2:ExtendedTextAd">
              <ns2:type>EXTENDED_TEXT_AD</ns2:type>
              <ns2:advancedUrl>http://yahoo.co.jp</ns2:advancedUrl>
              <ns2:displayUrl>yahoo.co.jp/path1/path2</ns2:displayUrl>
              <ns2:headline>sample ad title.</ns2:headline>
              <ns2:description>sample ad description.</ns2:description>
              <ns2:devicePreference>SMART_PHONE</ns2:devicePreference>
              <ns2:headline2>sample ad title2.</ns2:headline2>
              <ns2:path1>path1</ns2:path1>
              <ns2:path2>path2</ns2:path2>
            </ns2:ad>
            <ns2:labels>
              <ns2:labelId>50004</ns2:labelId>
              <ns2:labelName>sample label 4</ns2:labelName>
              <ns2:description>sample description 4</ns2:description>
              <ns2:color>#00FF00</ns2:color>
            </ns2:labels>
          </ns2:adGroupAd>
        </ns2:values>
        <ns2:values>
          <operationSucceeded>true</operationSucceeded>
          <ns2:adGroupAd>
            <ns2:accountId>1234567890</ns2:accountId>
            <ns2:campaignId>20005</ns2:campaignId>
            <ns2:campaignTrackId>200000005</ns2:campaignTrackId>
            <ns2:campaignName>sample campaign.</ns2:campaignName>
            <ns2:adGroupId>30005</ns2:adGroupId>
            <ns2:adGroupTrackId>300000005</ns2:adGroupTrackId>
            <ns2:adGroupName>sample adGroup.</ns2:adGroupName>
            <ns2:adId>40005</ns2:adId>
            <ns2:adTrackId>400000005</ns2:adTrackId>
            <ns2:adName>sample dynamic search linked ad.</ns2:adName>
            <ns2:userStatus>ACTIVE</ns2:userStatus>
            <ns2:trademarkStatus>NO_RESTRICTION</ns2:trademarkStatus>
            <ns2:approvalStatus>APPROVED</ns2:approvalStatus>
            <ns2:ad xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ns2:DynamicSearchLinkedAd">
              <ns2:type>DYNAMIC_SEARCH_LINKED_AD</ns2:type>
              <ns2:description>sample ad description.</ns2:description>
            </ns2:ad>
            <ns2:labels>
              <ns2:labelId>50005</ns2:labelId>
              <ns2:labelName>sample label 5</ns2:labelName>
              <ns2:description>sample description 5</ns2:description>
              <ns2:color>#0000FF</ns2:color>
            </ns2:labels>
          </ns2:adGroupAd>
        </ns2:values>
      </ns2:rval>
    </ns2:getResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

mutate(ADD)

リクエスト

広告に関する情報を追加します。

パラメータ 必須 データ型
operations Yes AdGroupAdOperation
＜リクエストサンプル＞
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
  <SOAP-ENV:Header>
    <RequestHeader xmlns="http://ss.yahooapis.jp/V201909/AdGroupAd" xmlns:ns2="http://ss.yahooapis.jp/V201909">
      <ns2:license>1111-1111-1111-1111</ns2:license>
      <ns2:apiAccountId>2222-2222-2222-2222</ns2:apiAccountId>
      <ns2:apiAccountPassword>password</ns2:apiAccountPassword>
    </RequestHeader>
  </SOAP-ENV:Header>
  <SOAP-ENV:Body>
    <mutate xmlns="http://ss.yahooapis.jp/V201909/AdGroupAd">
      <operations>
        <operator>ADD</operator>
        <accountId>1234567890</accountId>
        <operand>
          <campaignId>20001</campaignId>
          <adGroupId>30001</adGroupId>
          <adName>sample text ad.</adName>
          <userStatus>ACTIVE</userStatus>
          <ad xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="TextAd2">
            <type>TEXT_AD2</type>
            <advancedUrl>http://yahoo.co.jp</advancedUrl>
            <additionalAdvancedUrls>
              <advancedUrl>http://yahoo.co.jp/url1</advancedUrl>
            </additionalAdvancedUrls>
            <advancedMobileUrl>http://mobile.yahoo.co.jp</advancedMobileUrl>
            <additionalAdvancedMobileUrls>
              <advancedMobileUrl>http://mobile.yahoo.co.jp/url1</advancedMobileUrl>
            </additionalAdvancedMobileUrls>
            <trackingUrl>http://yahoo.co.jp?url={lpurl}&amp;c={campaignid}&amp;g={adgroupid}&amp;a={creative}&amp;type={_site}&amp;pid={_id1}&amp;vid={_id2}</trackingUrl>
            <customParameters>
              <parameters>
                <key>site</key>
                <value>yahoo</value>
              </parameters>
              <parameters>
                <key>id1</key>
                <value>1234</value>
              </parameters>
              <parameters>
                <key>id2</key>
                <value>a7h59A98yu</value>
              </parameters>
            </customParameters>
            <displayUrl>yahoo.co.jp</displayUrl>
            <headline>sample ad title.</headline>
            <description>sample ad description.</description>
            <devicePreference>SMART_PHONE</devicePreference>
            <description2>{=COUNTDOWN("2016/01/01 00:00:00","ja")}</description2>
          </ad>
        </operand>
        <operand>
          <campaignId>20002</campaignId>
          <adGroupId>30002</adGroupId>
          <adName>sample app ad for ios.</adName>
          <userStatus>ACTIVE</userStatus>
          <ad xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="AppAd">
            <type>APP_AD</type>
            <advancedUrl>http://www.apple.com/jp/itunes/app/appname/appid1234567890</advancedUrl>
            <displayUrl>itunes.apple.com</displayUrl>
            <headline>sample ad title.</headline>
            <description>sample ad description.</description>
            <description2>sample ad description2.</description2>
            <appStore>IOS</appStore>
            <appId>appid1234567890</appId>
          </ad>
        </operand>
        <operand>
          <campaignId>20003</campaignId>
          <adGroupId>30003</adGroupId>
          <adName>sample app ad for android.</adName>
          <userStatus>ACTIVE</userStatus>
          <ad xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="AppAd">
            <type>APP_AD</type>
            <advancedUrl>https://play.google.com/store/apps/details?id=appid1234567890</advancedUrl>
            <displayUrl>play.google.com/store</displayUrl>
            <headline>sample ad title.</headline>
            <description>sample ad description.</description>
            <description2>sample ad description2.</description2>
            <appStore>ANDROID</appStore>
            <appId>appid1234567890</appId>
          </ad>
        </operand>
        <operand>
          <campaignId>20004</campaignId>
          <adGroupId>30004</adGroupId>
          <adName>sample extended text ad.</adName>
          <userStatus>ACTIVE</userStatus>
          <ad xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ExtendedTextAd">
            <type>EXTENDED_TEXT_AD</type>
            <advancedUrl>http://yahoo.co.jp</advancedUrl>
            <displayUrl>yahoo.co.jp/path1/path2</displayUrl>
            <headline>sample ad title.</headline>
            <description>sample ad description.</description>
            <devicePreference>SMART_PHONE</devicePreference>
            <headline2>sample ad title2.</headline2>
            <path1>path1</path1>
            <path2>path2</path2>
          </ad>
        </operand>
        <operand>
          <campaignId>20005</campaignId>
          <adGroupId>30005</adGroupId>
          <adName>sample dynamic search linked ad.</adName>
          <userStatus>ACTIVE</userStatus>
          <ad xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ExtendedTextAd">
            <type>DYNAMIC_SEARCH_LINKED_AD</type>
            <description>sample ad description.</description>
          </ad>
        </operand>
      </operations>
    </mutate>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

レスポンス

広告に関する情報を追加します。

パラメータ データ型
rval AdGroupAdReturnValue
＜レスポンスサンプル＞
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
  <SOAP-ENV:Header>
    <ResponseHeader xmlns="http://ss.yahooapis.jp/V201909/AdGroupAd" xmlns:ns2="http://ss.yahooapis.jp/V201909">
      <ns2:service>AdGroupAd</ns2:service>
      <ns2:requestTime>1567167321937</ns2:requestTime>
      <ns2:timeTakenSeconds>0.2671</ns2:timeTakenSeconds>
    </ResponseHeader>
  </SOAP-ENV:Header>
  <SOAP-ENV:Body>
    <ns2:mutateResponse xmlns="http://ss.yahooapis.jp/V201909" xmlns:ns2="http://ss.yahooapis.jp/V201909/AdGroupAd">
      <ns2:rval>
        <ListReturnValue.Type>AdGroupAdReturnValue</ListReturnValue.Type>
        <Operation.Type>ADD</Operation.Type>
        <ns2:values>
          <operationSucceeded>true</operationSucceeded>
          <ns2:adGroupAd>
            <ns2:accountId>1234567890</ns2:accountId>
            <ns2:campaignId>20001</ns2:campaignId>
            <ns2:campaignTrackId>200000001</ns2:campaignTrackId>
            <ns2:campaignName>sample campaign.</ns2:campaignName>
            <ns2:adGroupId>30001</ns2:adGroupId>
            <ns2:adGroupTrackId>300000001</ns2:adGroupTrackId>
            <ns2:adGroupName>sample adGroup.</ns2:adGroupName>
            <ns2:adId>40001</ns2:adId>
            <ns2:adTrackId>400000001</ns2:adTrackId>
            <ns2:adName>sample text ad.</ns2:adName>
            <ns2:userStatus>ACTIVE</ns2:userStatus>
            <ns2:trademarkStatus>NO_RESTRICTION</ns2:trademarkStatus>
            <ns2:approvalStatus>APPROVED</ns2:approvalStatus>
            <ns2:ad xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ns2:TextAd2">
              <ns2:type>TEXT_AD2</ns2:type>
              <ns2:advancedUrl>http://yahoo.co.jp</ns2:advancedUrl>
              <ns2:additionalAdvancedUrls>
                <ns2:advancedUrl>http://yahoo.co.jp/url1</ns2:advancedUrl>
              </ns2:additionalAdvancedUrls>
              <ns2:advancedMobileUrl>http://mobile.yahoo.co.jp</ns2:advancedMobileUrl>
              <ns2:additionalAdvancedMobileUrls>
                <ns2:advancedMobileUrl>http://mobile.yahoo.co.jp/url1</ns2:advancedMobileUrl>
              </ns2:additionalAdvancedMobileUrls>
              <ns2:trackingUrl>http://yahoo.co.jp?url={lpurl}&amp;c={campaignid}&amp;g={adgroupid}&amp;a={creative}&amp;type={_site}&amp;pid={_id1}&amp;vid={_id2}</ns2:trackingUrl>
              <ns2:customParameters>
                <ns2:parameters>
                  <ns2:key>site</ns2:key>
                  <ns2:value>yahoo</ns2:value>
                </ns2:parameters>
                <ns2:parameters>
                  <ns2:key>id1</ns2:key>
                  <ns2:value>1234</ns2:value>
                </ns2:parameters>
                <ns2:parameters>
                  <ns2:key>id2</ns2:key>
                  <ns2:value>a7h59A98yu</ns2:value>
                </ns2:parameters>
              </ns2:customParameters>
              <ns2:displayUrl>yahoo.co.jp</ns2:displayUrl>
              <ns2:headline>sample ad title.</ns2:headline>
              <ns2:description>sample ad description.</ns2:description>
              <ns2:devicePreference>SMART_PHONE</ns2:devicePreference>
              <ns2:description2>{=COUNTDOWN("2016/01/01 00:00:00","ja")}</ns2:description2>
            </ns2:ad>
          </ns2:adGroupAd>
        </ns2:values>
        <ns2:values>
          <operationSucceeded>true</operationSucceeded>
          <ns2:adGroupAd>
            <ns2:accountId>1234567890</ns2:accountId>
            <ns2:campaignId>20002</ns2:campaignId>
            <ns2:campaignTrackId>200000002</ns2:campaignTrackId>
            <ns2:campaignName>sample campaign.</ns2:campaignName>
            <ns2:adGroupId>30002</ns2:adGroupId>
            <ns2:adGroupTrackId>300000002</ns2:adGroupTrackId>
            <ns2:adGroupName>sample adGroup.</ns2:adGroupName>
            <ns2:adId>40002</ns2:adId>
            <ns2:adTrackId>400000002</ns2:adTrackId>
            <ns2:adName>sample app ad for ios.</ns2:adName>
            <ns2:userStatus>ACTIVE</ns2:userStatus>
            <ns2:trademarkStatus>NO_RESTRICTION</ns2:trademarkStatus>
            <ns2:approvalStatus>APPROVED</ns2:approvalStatus>
            <ns2:ad xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ns2:AppAd">
              <ns2:type>APP_AD</ns2:type>
              <ns2:advancedUrl>http://www.apple.com/jp/itunes/app/appname/appid1234567890</ns2:advancedUrl>
              <ns2:displayUrl>itunes.apple.com</ns2:displayUrl>
              <ns2:headline>sample ad title.</ns2:headline>
              <ns2:description>sample ad description.</ns2:description>
              <ns2:description2>sample ad description2.</ns2:description2>
              <ns2:appStore>IOS</ns2:appStore>
              <ns2:appId>appid1234567890</ns2:appId>
            </ns2:ad>
          </ns2:adGroupAd>
        </ns2:values>
        <ns2:values>
          <operationSucceeded>true</operationSucceeded>
          <ns2:adGroupAd>
            <ns2:accountId>1234567890</ns2:accountId>
            <ns2:campaignId>20003</ns2:campaignId>
            <ns2:campaignTrackId>200000003</ns2:campaignTrackId>
            <ns2:campaignName>sample campaign.</ns2:campaignName>
            <ns2:adGroupId>30003</ns2:adGroupId>
            <ns2:adGroupTrackId>300000003</ns2:adGroupTrackId>
            <ns2:adGroupName>sample adGroup.</ns2:adGroupName>
            <ns2:adId>40003</ns2:adId>
            <ns2:adTrackId>400000003</ns2:adTrackId>
            <ns2:adName>sample app ad for android.</ns2:adName>
            <ns2:userStatus>ACTIVE</ns2:userStatus>
            <ns2:trademarkStatus>NO_RESTRICTION</ns2:trademarkStatus>
            <ns2:approvalStatus>APPROVED</ns2:approvalStatus>
            <ns2:ad xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ns2:AppAd">
              <ns2:type>APP_AD</ns2:type>
              <ns2:advancedUrl>https://play.google.com/store/apps/details?id=appid1234567890</ns2:advancedUrl>
              <ns2:displayUrl>play.google.com/store</ns2:displayUrl>
              <ns2:headline>sample ad title.</ns2:headline>
              <ns2:description>sample ad description.</ns2:description>
              <ns2:description2>sample ad description2.</ns2:description2>
              <ns2:appStore>ANDROID</ns2:appStore>
              <ns2:appId>appid1234567890</ns2:appId>
            </ns2:ad>
          </ns2:adGroupAd>
        </ns2:values>
        <ns2:values>
          <operationSucceeded>true</operationSucceeded>
          <ns2:adGroupAd>
            <ns2:accountId>1234567890</ns2:accountId>
            <ns2:campaignId>20004</ns2:campaignId>
            <ns2:campaignTrackId>200000004</ns2:campaignTrackId>
            <ns2:campaignName>sample campaign.</ns2:campaignName>
            <ns2:adGroupId>30004</ns2:adGroupId>
            <ns2:adGroupTrackId>300000004</ns2:adGroupTrackId>
            <ns2:adGroupName>sample adGroup.</ns2:adGroupName>
            <ns2:adId>40004</ns2:adId>
            <ns2:adTrackId>400000004</ns2:adTrackId>
            <ns2:adName>sample extended text ad.</ns2:adName>
            <ns2:userStatus>ACTIVE</ns2:userStatus>
            <ns2:trademarkStatus>NO_RESTRICTION</ns2:trademarkStatus>
            <ns2:approvalStatus>APPROVED</ns2:approvalStatus>
            <ns2:ad xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ns2:ExtendedTextAd">
              <ns2:type>EXTENDED_TEXT_AD</ns2:type>
              <ns2:advancedUrl>http://yahoo.co.jp</ns2:advancedUrl>
              <ns2:displayUrl>yahoo.co.jp/path1/path2</ns2:displayUrl>
              <ns2:headline>sample ad title.</ns2:headline>
              <ns2:description>sample ad description.</ns2:description>
              <ns2:devicePreference>SMART_PHONE</ns2:devicePreference>
              <ns2:headline2>sample ad title2.</ns2:headline2>
              <ns2:path1>path1</ns2:path1>
              <ns2:path2>path2</ns2:path2>
            </ns2:ad>
          </ns2:adGroupAd>
        </ns2:values>
        <ns2:values>
          <operationSucceeded>true</operationSucceeded>
          <ns2:adGroupAd>
            <ns2:accountId>1234567890</ns2:accountId>
            <ns2:campaignId>20005</ns2:campaignId>
            <ns2:campaignTrackId>200000005</ns2:campaignTrackId>
            <ns2:campaignName>sample campaign.</ns2:campaignName>
            <ns2:adGroupId>30005</ns2:adGroupId>
            <ns2:adGroupTrackId>300000005</ns2:adGroupTrackId>
            <ns2:adGroupName>sample adGroup.</ns2:adGroupName>
            <ns2:adId>40005</ns2:adId>
            <ns2:adTrackId>400000005</ns2:adTrackId>
            <ns2:adName>sample dynamic search linked ad.</ns2:adName>
            <ns2:userStatus>ACTIVE</ns2:userStatus>
            <ns2:trademarkStatus>NO_RESTRICTION</ns2:trademarkStatus>
            <ns2:approvalStatus>APPROVED</ns2:approvalStatus>
            <ns2:ad xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ns2:DynamicSearchLinkedAd">
              <ns2:type>DYNAMIC_SEARCH_LINKED_AD</ns2:type>
              <ns2:description>sample ad description.</ns2:description>
            </ns2:ad>
          </ns2:adGroupAd>
        </ns2:values>
      </ns2:rval>
    </ns2:mutateResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

mutate(SET)

リクエスト

広告に関する情報を更新します。

パラメータ 必須 データ型
operations Yes AdGroupAdOperation
＜リクエストサンプル＞
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
  <SOAP-ENV:Header>
    <RequestHeader xmlns="http://ss.yahooapis.jp/V201909/AdGroupAd" xmlns:ns2="http://ss.yahooapis.jp/V201909">
      <ns2:license>1111-1111-1111-1111</ns2:license>
      <ns2:apiAccountId>2222-2222-2222-2222</ns2:apiAccountId>
      <ns2:apiAccountPassword>password</ns2:apiAccountPassword>
    </RequestHeader>
  </SOAP-ENV:Header>
  <SOAP-ENV:Body>
    <mutate xmlns="http://ss.yahooapis.jp/V201909/AdGroupAd">
      <operations>
        <operator>SET</operator>
        <accountId>1234567890</accountId>
        <operand>
          <campaignId>20001</campaignId>
          <adGroupId>30001</adGroupId>
          <adGroupName>sample text ad.</adGroupName>
          <adId>40001</adId>
          <userStatus>ACTIVE</userStatus>
        </operand>
        <operand>
          <campaignId>20002</campaignId>
          <adGroupId>30002</adGroupId>
          <adId>40002</adId>
          <adName>sample app ad for ios.</adName>
          <userStatus>ACTIVE</userStatus>
        </operand>
        <operand>
          <campaignId>20003</campaignId>
          <adGroupId>30003</adGroupId>
          <adId>40003</adId>
          <adName>sample app ad for android.</adName>
          <userStatus>ACTIVE</userStatus>
        </operand>
        <operand>
          <campaignId>20004</campaignId>
          <adGroupId>30004</adGroupId>
          <adId>40004</adId>
          <adName>sample extended text ad.</adName>
          <userStatus>ACTIVE</userStatus>
        </operand>
        <operand>
          <campaignId>20005</campaignId>
          <adGroupId>30005</adGroupId>
          <adId>40005</adId>
          <adName>sample dynamic search linked ad.</adName>
          <userStatus>ACTIVE</userStatus>
        </operand>
      </operations>
    </mutate>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

レスポンス

広告に関する情報を更新します。

パラメータ データ型
rval AdGroupAdReturnValue
＜レスポンスサンプル＞
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
  <SOAP-ENV:Header>
    <ResponseHeader xmlns="http://ss.yahooapis.jp/V201909/AdGroupAd" xmlns:ns2="http://ss.yahooapis.jp/V201909">
      <ns2:service>AdGroupAd</ns2:service>
      <ns2:requestTime>1567167321964</ns2:requestTime>
      <ns2:timeTakenSeconds>0.2671</ns2:timeTakenSeconds>
    </ResponseHeader>
  </SOAP-ENV:Header>
  <SOAP-ENV:Body>
    <ns2:mutateResponse xmlns="http://ss.yahooapis.jp/V201909" xmlns:ns2="http://ss.yahooapis.jp/V201909/AdGroupAd">
      <ns2:rval>
        <ListReturnValue.Type>AdGroupAdReturnValue</ListReturnValue.Type>
        <Operation.Type>SET</Operation.Type>
        <ns2:values>
          <operationSucceeded>true</operationSucceeded>
          <ns2:adGroupAd>
            <ns2:accountId>1234567890</ns2:accountId>
            <ns2:campaignId>20001</ns2:campaignId>
            <ns2:campaignTrackId>200000001</ns2:campaignTrackId>
            <ns2:campaignName>sample campaign.</ns2:campaignName>
            <ns2:adGroupId>30001</ns2:adGroupId>
            <ns2:adGroupTrackId>300000001</ns2:adGroupTrackId>
            <ns2:adGroupName>sample adGroup.</ns2:adGroupName>
            <ns2:adId>40001</ns2:adId>
            <ns2:adTrackId>400000001</ns2:adTrackId>
            <ns2:adName>sample text ad.</ns2:adName>
            <ns2:userStatus>ACTIVE</ns2:userStatus>
            <ns2:trademarkStatus>NO_RESTRICTION</ns2:trademarkStatus>
            <ns2:approvalStatus>APPROVED</ns2:approvalStatus>
            <ns2:ad xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ns2:TextAd2">
              <ns2:type>TEXT_AD2</ns2:type>
              <ns2:advancedUrl>http://yahoo.co.jp</ns2:advancedUrl>
              <ns2:additionalAdvancedUrls>
                <ns2:advancedUrl>http://yahoo.co.jp/url1</ns2:advancedUrl>
              </ns2:additionalAdvancedUrls>
              <ns2:advancedMobileUrl>http://mobile.yahoo.co.jp</ns2:advancedMobileUrl>
              <ns2:additionalAdvancedMobileUrls>
                <ns2:advancedMobileUrl>http://mobile.yahoo.co.jp/url1</ns2:advancedMobileUrl>
              </ns2:additionalAdvancedMobileUrls>
              <ns2:trackingUrl>http://yahoo.co.jp?url={lpurl}&amp;c={campaignid}&amp;g={adgroupid}&amp;a={creative}&amp;type={_site}&amp;pid={_id1}&amp;vid={_id2}</ns2:trackingUrl>
              <ns2:customParameters>
                <ns2:parameters>
                  <ns2:key>site</ns2:key>
                  <ns2:value>yahoo</ns2:value>
                </ns2:parameters>
                <ns2:parameters>
                  <ns2:key>id1</ns2:key>
                  <ns2:value>1234</ns2:value>
                </ns2:parameters>
                <ns2:parameters>
                  <ns2:key>id2</ns2:key>
                  <ns2:value>a7h59A98yu</ns2:value>
                </ns2:parameters>
              </ns2:customParameters>
              <ns2:displayUrl>yahoo.co.jp</ns2:displayUrl>
              <ns2:headline>sample ad title.</ns2:headline>
              <ns2:description>sample ad description.</ns2:description>
              <ns2:devicePreference>SMART_PHONE</ns2:devicePreference>
              <ns2:description2>{=COUNTDOWN("2016/01/01 00:00:00","ja")}</ns2:description2>
            </ns2:ad>
          </ns2:adGroupAd>
        </ns2:values>
        <ns2:values>
          <operationSucceeded>true</operationSucceeded>
          <ns2:adGroupAd>
            <ns2:accountId>1234567890</ns2:accountId>
            <ns2:campaignId>20002</ns2:campaignId>
            <ns2:campaignTrackId>200000002</ns2:campaignTrackId>
            <ns2:campaignName>sample campaign.</ns2:campaignName>
            <ns2:adGroupId>30002</ns2:adGroupId>
            <ns2:adGroupTrackId>300000002</ns2:adGroupTrackId>
            <ns2:adGroupName>sample adGroup.</ns2:adGroupName>
            <ns2:adId>40002</ns2:adId>
            <ns2:adTrackId>400000002</ns2:adTrackId>
            <ns2:adName>sample app ad for ios.</ns2:adName>
            <ns2:userStatus>ACTIVE</ns2:userStatus>
            <ns2:trademarkStatus>NO_RESTRICTION</ns2:trademarkStatus>
            <ns2:approvalStatus>APPROVED</ns2:approvalStatus>
            <ns2:ad xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ns2:AppAd">
              <ns2:type>APP_AD</ns2:type>
              <ns2:advancedUrl>http://www.apple.com/jp/itunes/app/appname/appid1234567890</ns2:advancedUrl>
              <ns2:displayUrl>itunes.apple.com</ns2:displayUrl>
              <ns2:headline>sample ad title.</ns2:headline>
              <ns2:description>sample ad description.</ns2:description>
              <ns2:description2>sample ad description2.</ns2:description2>
              <ns2:appStore>IOS</ns2:appStore>
              <ns2:appId>appid1234567890</ns2:appId>
            </ns2:ad>
          </ns2:adGroupAd>
        </ns2:values>
        <ns2:values>
          <operationSucceeded>true</operationSucceeded>
          <ns2:adGroupAd>
            <ns2:accountId>1234567890</ns2:accountId>
            <ns2:campaignId>20003</ns2:campaignId>
            <ns2:campaignTrackId>200000003</ns2:campaignTrackId>
            <ns2:campaignName>sample campaign.</ns2:campaignName>
            <ns2:adGroupId>30003</ns2:adGroupId>
            <ns2:adGroupTrackId>300000003</ns2:adGroupTrackId>
            <ns2:adGroupName>sample adGroup.</ns2:adGroupName>
            <ns2:adId>40003</ns2:adId>
            <ns2:adTrackId>400000003</ns2:adTrackId>
            <ns2:adName>sample app ad for android.</ns2:adName>
            <ns2:userStatus>ACTIVE</ns2:userStatus>
            <ns2:trademarkStatus>NO_RESTRICTION</ns2:trademarkStatus>
            <ns2:approvalStatus>APPROVED</ns2:approvalStatus>
            <ns2:ad xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ns2:AppAd">
              <ns2:type>APP_AD</ns2:type>
              <ns2:advancedUrl>https://play.google.com/store/apps/details?id=appid1234567890</ns2:advancedUrl>
              <ns2:displayUrl>play.google.com/store</ns2:displayUrl>
              <ns2:headline>sample ad title.</ns2:headline>
              <ns2:description>sample ad description.</ns2:description>
              <ns2:description2>sample ad description2.</ns2:description2>
              <ns2:appStore>ANDROID</ns2:appStore>
              <ns2:appId>appid1234567890</ns2:appId>
            </ns2:ad>
          </ns2:adGroupAd>
        </ns2:values>
        <ns2:values>
          <operationSucceeded>true</operationSucceeded>
          <ns2:adGroupAd>
            <ns2:accountId>1234567890</ns2:accountId>
            <ns2:campaignId>20004</ns2:campaignId>
            <ns2:campaignTrackId>200000004</ns2:campaignTrackId>
            <ns2:campaignName>sample campaign.</ns2:campaignName>
            <ns2:adGroupId>30004</ns2:adGroupId>
            <ns2:adGroupTrackId>300000004</ns2:adGroupTrackId>
            <ns2:adGroupName>sample adGroup.</ns2:adGroupName>
            <ns2:adId>40004</ns2:adId>
            <ns2:adTrackId>400000004</ns2:adTrackId>
            <ns2:adName>sample extended text ad.</ns2:adName>
            <ns2:userStatus>ACTIVE</ns2:userStatus>
            <ns2:trademarkStatus>NO_RESTRICTION</ns2:trademarkStatus>
            <ns2:approvalStatus>APPROVED</ns2:approvalStatus>
            <ns2:ad xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ns2:ExtendedTextAd">
              <ns2:type>EXTENDED_TEXT_AD</ns2:type>
              <ns2:advancedUrl>http://yahoo.co.jp</ns2:advancedUrl>
              <ns2:displayUrl>yahoo.co.jp/path1/path2</ns2:displayUrl>
              <ns2:headline>sample ad title.</ns2:headline>
              <ns2:description>sample ad description.</ns2:description>
              <ns2:devicePreference>SMART_PHONE</ns2:devicePreference>
              <ns2:headline2>sample ad title2.</ns2:headline2>
              <ns2:path1>path1</ns2:path1>
              <ns2:path2>path2</ns2:path2>
            </ns2:ad>
          </ns2:adGroupAd>
        </ns2:values>
        <ns2:values>
          <operationSucceeded>true</operationSucceeded>
          <ns2:adGroupAd>
            <ns2:accountId>1234567890</ns2:accountId>
            <ns2:campaignId>20005</ns2:campaignId>
            <ns2:campaignTrackId>200000005</ns2:campaignTrackId>
            <ns2:campaignName>sample campaign.</ns2:campaignName>
            <ns2:adGroupId>30005</ns2:adGroupId>
            <ns2:adGroupTrackId>300000005</ns2:adGroupTrackId>
            <ns2:adGroupName>sample adGroup.</ns2:adGroupName>
            <ns2:adId>40005</ns2:adId>
            <ns2:adTrackId>400000005</ns2:adTrackId>
            <ns2:adName>sample dynamic search linked ad.</ns2:adName>
            <ns2:userStatus>ACTIVE</ns2:userStatus>
            <ns2:trademarkStatus>NO_RESTRICTION</ns2:trademarkStatus>
            <ns2:approvalStatus>APPROVED</ns2:approvalStatus>
            <ns2:ad xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ns2:DynamicSearchLinkedAd">
              <ns2:type>DYNAMIC_SEARCH_LINKED_AD</ns2:type>
              <ns2:description>sample ad description.</ns2:description>
            </ns2:ad>
          </ns2:adGroupAd>
        </ns2:values>
      </ns2:rval>
    </ns2:mutateResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

mutate(REMOVE)

リクエスト

広告に関する情報を削除します。

パラメータ 必須 データ型
operations Yes AdGroupAdOperation
＜リクエストサンプル＞
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
  <SOAP-ENV:Header>
    <RequestHeader xmlns="http://ss.yahooapis.jp/V201909/AdGroupAd" xmlns:ns2="http://ss.yahooapis.jp/V201909">
      <ns2:license>1111-1111-1111-1111</ns2:license>
      <ns2:apiAccountId>2222-2222-2222-2222</ns2:apiAccountId>
      <ns2:apiAccountPassword>password</ns2:apiAccountPassword>
    </RequestHeader>
  </SOAP-ENV:Header>
  <SOAP-ENV:Body>
    <mutate xmlns="http://ss.yahooapis.jp/V201909/AdGroupAd">
      <operations>
        <operator>REMOVE</operator>
        <accountId>1234567890</accountId>
        <operand>
          <campaignId>20001</campaignId>
          <adGroupId>30001</adGroupId>
          <adId>40001</adId>
        </operand>
        <operand>
          <campaignId>20002</campaignId>
          <adGroupId>30002</adGroupId>
          <adId>40002</adId>
        </operand>
        <operand>
          <campaignId>20003</campaignId>
          <adGroupId>30003</adGroupId>
          <adId>40003</adId>
        </operand>
        <operand>
          <campaignId>20004</campaignId>
          <adGroupId>30004</adGroupId>
          <adId>40004</adId>
        </operand>
        <operand>
          <campaignId>20005</campaignId>
          <adGroupId>30005</adGroupId>
          <adId>40005</adId>
        </operand>
      </operations>
    </mutate>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

レスポンス

広告に関する情報を削除します。

パラメータ データ型
rval AdGroupAdReturnValue
＜レスポンスサンプル＞
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
  <SOAP-ENV:Header>
    <ResponseHeader xmlns="http://ss.yahooapis.jp/V201909/AdGroupAd" xmlns:ns2="http://ss.yahooapis.jp/V201909">
      <ns2:service>AdGroupAd</ns2:service>
      <ns2:requestTime>1567167321987</ns2:requestTime>
      <ns2:timeTakenSeconds>0.2671</ns2:timeTakenSeconds>
    </ResponseHeader>
  </SOAP-ENV:Header>
  <SOAP-ENV:Body>
    <ns2:mutateResponse xmlns="http://ss.yahooapis.jp/V201909" xmlns:ns2="http://ss.yahooapis.jp/V201909/AdGroupAd">
      <ns2:rval>
        <ListReturnValue.Type>AdGroupAdReturnValue</ListReturnValue.Type>
        <Operation.Type>REMOVE</Operation.Type>
        <ns2:values>
          <operationSucceeded>true</operationSucceeded>
          <ns2:adGroupAd>
            <ns2:accountId>1234567890</ns2:accountId>
            <ns2:campaignId>20001</ns2:campaignId>
            <ns2:campaignTrackId>200000001</ns2:campaignTrackId>
            <ns2:campaignName>sample campaign.</ns2:campaignName>
            <ns2:adGroupId>30001</ns2:adGroupId>
            <ns2:adGroupTrackId>300000001</ns2:adGroupTrackId>
            <ns2:adGroupName>sample adGroup.</ns2:adGroupName>
            <ns2:adId>40001</ns2:adId>
            <ns2:adTrackId>400000001</ns2:adTrackId>
            <ns2:adName>sample text ad.</ns2:adName>
            <ns2:userStatus>ACTIVE</ns2:userStatus>
            <ns2:trademarkStatus>NO_RESTRICTION</ns2:trademarkStatus>
            <ns2:approvalStatus>APPROVED</ns2:approvalStatus>
            <ns2:ad xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ns2:TextAd2">
              <ns2:type>TEXT_AD2</ns2:type>
              <ns2:advancedUrl>http://yahoo.co.jp</ns2:advancedUrl>
              <ns2:additionalAdvancedUrls>
                <ns2:advancedUrl>http://yahoo.co.jp/url1</ns2:advancedUrl>
              </ns2:additionalAdvancedUrls>
              <ns2:advancedMobileUrl>http://mobile.yahoo.co.jp</ns2:advancedMobileUrl>
              <ns2:additionalAdvancedMobileUrls>
                <ns2:advancedMobileUrl>http://mobile.yahoo.co.jp/url1</ns2:advancedMobileUrl>
              </ns2:additionalAdvancedMobileUrls>
              <ns2:trackingUrl>http://yahoo.co.jp?url={lpurl}&amp;c={campaignid}&amp;g={adgroupid}&amp;a={creative}&amp;type={_site}&amp;pid={_id1}&amp;vid={_id2}</ns2:trackingUrl>
              <ns2:customParameters>
                <ns2:parameters>
                  <ns2:key>site</ns2:key>
                  <ns2:value>yahoo</ns2:value>
                </ns2:parameters>
                <ns2:parameters>
                  <ns2:key>id1</ns2:key>
                  <ns2:value>1234</ns2:value>
                </ns2:parameters>
                <ns2:parameters>
                  <ns2:key>id2</ns2:key>
                  <ns2:value>a7h59A98yu</ns2:value>
                </ns2:parameters>
              </ns2:customParameters>
              <ns2:displayUrl>yahoo.co.jp</ns2:displayUrl>
              <ns2:headline>sample ad title.</ns2:headline>
              <ns2:description>sample ad description.</ns2:description>
              <ns2:devicePreference>SMART_PHONE</ns2:devicePreference>
              <ns2:description2>{=COUNTDOWN("2016/01/01 00:00:00","ja")}</ns2:description2>
            </ns2:ad>
          </ns2:adGroupAd>
        </ns2:values>
        <ns2:values>
          <operationSucceeded>true</operationSucceeded>
          <ns2:adGroupAd>
            <ns2:accountId>1234567890</ns2:accountId>
            <ns2:campaignId>20002</ns2:campaignId>
            <ns2:campaignTrackId>200000002</ns2:campaignTrackId>
            <ns2:campaignName>sample campaign.</ns2:campaignName>
            <ns2:adGroupId>30002</ns2:adGroupId>
            <ns2:adGroupTrackId>300000002</ns2:adGroupTrackId>
            <ns2:adGroupName>sample adGroup.</ns2:adGroupName>
            <ns2:adId>40002</ns2:adId>
            <ns2:adTrackId>400000002</ns2:adTrackId>
            <ns2:adName>sample app ad for ios.</ns2:adName>
            <ns2:userStatus>ACTIVE</ns2:userStatus>
            <ns2:trademarkStatus>NO_RESTRICTION</ns2:trademarkStatus>
            <ns2:approvalStatus>APPROVED</ns2:approvalStatus>
            <ns2:ad xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ns2:AppAd">
              <ns2:type>APP_AD</ns2:type>
              <ns2:advancedUrl>http://www.apple.com/jp/itunes/app/appname/appid1234567890</ns2:advancedUrl>
              <ns2:displayUrl>itunes.apple.com</ns2:displayUrl>
              <ns2:headline>sample ad title.</ns2:headline>
              <ns2:description>sample ad description.</ns2:description>
              <ns2:description2>sample ad description2.</ns2:description2>
              <ns2:appStore>IOS</ns2:appStore>
              <ns2:appId>appid1234567890</ns2:appId>
            </ns2:ad>
          </ns2:adGroupAd>
        </ns2:values>
        <ns2:values>
          <operationSucceeded>true</operationSucceeded>
          <ns2:adGroupAd>
            <ns2:accountId>1234567890</ns2:accountId>
            <ns2:campaignId>20003</ns2:campaignId>
            <ns2:campaignTrackId>200000003</ns2:campaignTrackId>
            <ns2:campaignName>sample campaign.</ns2:campaignName>
            <ns2:adGroupId>30003</ns2:adGroupId>
            <ns2:adGroupTrackId>300000003</ns2:adGroupTrackId>
            <ns2:adGroupName>sample adGroup.</ns2:adGroupName>
            <ns2:adId>40003</ns2:adId>
            <ns2:adTrackId>400000003</ns2:adTrackId>
            <ns2:adName>sample app ad for android.</ns2:adName>
            <ns2:userStatus>ACTIVE</ns2:userStatus>
            <ns2:trademarkStatus>NO_RESTRICTION</ns2:trademarkStatus>
            <ns2:approvalStatus>APPROVED</ns2:approvalStatus>
            <ns2:ad xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ns2:AppAd">
              <ns2:type>APP_AD</ns2:type>
              <ns2:advancedUrl>https://play.google.com/store/apps/details?id=appid1234567890</ns2:advancedUrl>
              <ns2:displayUrl>play.google.com/store</ns2:displayUrl>
              <ns2:headline>sample ad title.</ns2:headline>
              <ns2:description>sample ad description.</ns2:description>
              <ns2:description2>sample ad description2.</ns2:description2>
              <ns2:appStore>ANDROID</ns2:appStore>
              <ns2:appId>appid1234567890</ns2:appId>
            </ns2:ad>
          </ns2:adGroupAd>
        </ns2:values>
        <ns2:values>
          <operationSucceeded>true</operationSucceeded>
          <ns2:adGroupAd>
            <ns2:accountId>1234567890</ns2:accountId>
            <ns2:campaignId>20004</ns2:campaignId>
            <ns2:campaignTrackId>200000004</ns2:campaignTrackId>
            <ns2:campaignName>sample campaign.</ns2:campaignName>
            <ns2:adGroupId>30004</ns2:adGroupId>
            <ns2:adGroupTrackId>300000004</ns2:adGroupTrackId>
            <ns2:adGroupName>sample adGroup.</ns2:adGroupName>
            <ns2:adId>40004</ns2:adId>
            <ns2:adTrackId>400000004</ns2:adTrackId>
            <ns2:adName>sample extended text ad.</ns2:adName>
            <ns2:userStatus>ACTIVE</ns2:userStatus>
            <ns2:trademarkStatus>NO_RESTRICTION</ns2:trademarkStatus>
            <ns2:approvalStatus>APPROVED</ns2:approvalStatus>
            <ns2:ad xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ns2:ExtendedTextAd">
              <ns2:type>EXTENDED_TEXT_AD</ns2:type>
              <ns2:advancedUrl>http://yahoo.co.jp</ns2:advancedUrl>
              <ns2:displayUrl>yahoo.co.jp/path1/path2</ns2:displayUrl>
              <ns2:headline>sample ad title.</ns2:headline>
              <ns2:description>sample ad description.</ns2:description>
              <ns2:devicePreference>SMART_PHONE</ns2:devicePreference>
              <ns2:headline2>sample ad title2.</ns2:headline2>
              <ns2:path1>path1</ns2:path1>
              <ns2:path2>path2</ns2:path2>
            </ns2:ad>
          </ns2:adGroupAd>
        </ns2:values>
        <ns2:values>
          <operationSucceeded>true</operationSucceeded>
          <ns2:adGroupAd>
            <ns2:accountId>1234567890</ns2:accountId>
            <ns2:campaignId>20005</ns2:campaignId>
            <ns2:campaignTrackId>200000005</ns2:campaignTrackId>
            <ns2:campaignName>sample campaign.</ns2:campaignName>
            <ns2:adGroupId>30005</ns2:adGroupId>
            <ns2:adGroupTrackId>300000005</ns2:adGroupTrackId>
            <ns2:adGroupName>sample adGroup.</ns2:adGroupName>
            <ns2:adId>40005</ns2:adId>
            <ns2:adTrackId>400000005</ns2:adTrackId>
            <ns2:adName>sample dynamic search linked ad.</ns2:adName>
            <ns2:userStatus>ACTIVE</ns2:userStatus>
            <ns2:trademarkStatus>NO_RESTRICTION</ns2:trademarkStatus>
            <ns2:approvalStatus>APPROVED</ns2:approvalStatus>
            <ns2:ad xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ns2:DynamicSearchLinkedAd">
              <ns2:type>DYNAMIC_SEARCH_LINKED_AD</ns2:type>
              <ns2:description>sample ad description.</ns2:description>
            </ns2:ad>
          </ns2:adGroupAd>
        </ns2:values>
      </ns2:rval>
    </ns2:mutateResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

setTrademarkStatus

リクエスト

商標の使用制限解除を確認します。

パラメータ 必須 データ型
operations Yes AdGroupAdSetTrademarkStatusOperation
＜リクエストサンプル＞
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
  <SOAP-ENV:Header>
    <RequestHeader xmlns="http://ss.yahooapis.jp/V201909/AdGroupAd" xmlns:ns2="http://ss.yahooapis.jp/V201909">
      <ns2:license>1111-1111-1111-1111</ns2:license>
      <ns2:apiAccountId>2222-2222-2222-2222</ns2:apiAccountId>
      <ns2:apiAccountPassword>password</ns2:apiAccountPassword>
    </RequestHeader>
  </SOAP-ENV:Header>
  <SOAP-ENV:Body>
    <setTrademarkStatus xmlns="http://ss.yahooapis.jp/V201909/AdGroupAd">
      <operations>
        <accountId>1234567890</accountId>
        <operand>
          <campaignId>20001</campaignId>
          <adGroupId>30001</adGroupId>
          <adId>40001</adId>
        </operand>
      </operations>
    </setTrademarkStatus>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

レスポンス

商標の使用制限解除を確認します。

パラメータ データ型
rval AdGroupAdReturnValue
＜レスポンスサンプル＞
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
  <SOAP-ENV:Header>
    <ResponseHeader xmlns="http://ss.yahooapis.jp/V201909/AdGroupAd" xmlns:ns2="http://ss.yahooapis.jp/V201909">
      <ns2:service>AdGroupAd</ns2:service>
      <ns2:requestTime>1567167322011</ns2:requestTime>
      <ns2:timeTakenSeconds>0.2671</ns2:timeTakenSeconds>
    </ResponseHeader>
  </SOAP-ENV:Header>
  <SOAP-ENV:Body>
    <ns2:setTrademarkStatusResponse xmlns="http://ss.yahooapis.jp/V201909" xmlns:ns2="http://ss.yahooapis.jp/V201909/AdGroupAd">
      <ns2:rval>
        <ListReturnValue.Type>AdGroupAdReturnValue</ListReturnValue.Type>
        <ns2:values>
          <operationSucceeded>true</operationSucceeded>
          <ns2:adGroupAd>
            <ns2:accountId>1234567890</ns2:accountId>
            <ns2:campaignId>20001</ns2:campaignId>
            <ns2:campaignTrackId>200000001</ns2:campaignTrackId>
            <ns2:campaignName>sample campaign.</ns2:campaignName>
            <ns2:adGroupId>30001</ns2:adGroupId>
            <ns2:adGroupTrackId>300000001</ns2:adGroupTrackId>
            <ns2:adGroupName>sample adGroup.</ns2:adGroupName>
            <ns2:adId>40001</ns2:adId>
            <ns2:adTrackId>400000001</ns2:adTrackId>
            <ns2:adName>sample text ad.</ns2:adName>
            <ns2:userStatus>ACTIVE</ns2:userStatus>
            <ns2:trademarkStatus>NO_RESTRICTION</ns2:trademarkStatus>
            <ns2:approvalStatus>APPROVED</ns2:approvalStatus>
            <ns2:ad xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ns2:TextAd2">
              <ns2:type>TEXT_AD2</ns2:type>
              <ns2:advancedUrl>http://yahoo.co.jp</ns2:advancedUrl>
              <ns2:additionalAdvancedUrls>
                <ns2:advancedUrl>http://yahoo.co.jp/url1</ns2:advancedUrl>
              </ns2:additionalAdvancedUrls>
              <ns2:advancedMobileUrl>http://mobile.yahoo.co.jp</ns2:advancedMobileUrl>
              <ns2:additionalAdvancedMobileUrls>
                <ns2:advancedMobileUrl>http://mobile.yahoo.co.jp/url1</ns2:advancedMobileUrl>
              </ns2:additionalAdvancedMobileUrls>
              <ns2:trackingUrl>http://yahoo.co.jp?url={lpurl}&amp;c={campaignid}&amp;g={adgroupid}&amp;a={creative}&amp;type={_site}&amp;pid={_id1}&amp;vid={_id2}</ns2:trackingUrl>
              <ns2:customParameters>
                <ns2:parameters>
                  <ns2:key>site</ns2:key>
                  <ns2:value>yahoo</ns2:value>
                </ns2:parameters>
                <ns2:parameters>
                  <ns2:key>id1</ns2:key>
                  <ns2:value>1234</ns2:value>
                </ns2:parameters>
                <ns2:parameters>
                  <ns2:key>id2</ns2:key>
                  <ns2:value>a7h59A98yu</ns2:value>
                </ns2:parameters>
              </ns2:customParameters>
              <ns2:displayUrl>yahoo.co.jp</ns2:displayUrl>
              <ns2:headline>sample ad title.</ns2:headline>
              <ns2:description>sample ad description.</ns2:description>
              <ns2:devicePreference>SMART_PHONE</ns2:devicePreference>
              <ns2:description2>{=COUNTDOWN("2016/01/01 00:00:00","ja")}</ns2:description2>
            </ns2:ad>
          </ns2:adGroupAd>
        </ns2:values>
      </ns2:rval>
    </ns2:setTrademarkStatusResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

クリエイティブ・コモンズ・ライセンス
この 作品 は クリエイティブ・コモンズ 表示 - 改変禁止 2.1 日本 ライセンスの下に提供されています。