AdGroupAdLabelService.md

AdGroupAdLabelService

AdGroupAdLabelServiceでは、ラベルと広告の紐付けの登録・削除を行います。

WSDL

environment	url
production	https://ss.yahooapis.jp/services/V201901/AdGroupAdLabelService?wsdl
sandbox	https://sandbox.ss.yahooapis.jp/services/V201901/AdGroupAdLabelService?wsdl

Namespace

http://ss.yahooapis.jp/V201901/AdGroupAdLabel

サービス概要

ラベルと広告の紐付けの登録・削除を行います。

操作

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

• mutate(ADD)
• mutate(REMOVE)

オブジェクト

AdGroupAdLabel

mutate(ADD)

ラベルと広告の紐付けを登録します。

リクエスト

パラメータ	必須	データ型	説明
operations	○	AdGroupAdLabelOperation	操作の対象となるラベル、広告の情報および操作の内容を表します。

＜リクエストサンプル＞

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
  <SOAP-ENV:Header>
    <RequestHeader xmlns="http://ss.yahooapis.jp/V201901/AdGroupAdLabel" xmlns:ns2="http://ss.yahooapis.jp/V201901">
      <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/V201901/AdGroupAdLabel">
      <operations>
        <operator>ADD</operator>
        <accountId>1234567890</accountId>
        <operand>
          <campaignId>10001</campaignId>
          <adGroupId>20001</adGroupId>
          <adId>30001</adId>
          <labelId>40001</labelId>
        </operand>
      </operations>
    </mutate>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

レスポンス

正常時のレスポンスフィールド

フィールド	データ型	説明
rval	AdGroupAdLabelReturnValue	操作結果を含むラベル、広告に関する情報のコンテナです。

＜レスポンスサンプル＞

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
  <SOAP-ENV:Header>
    <ResponseHeader xmlns="http://ss.yahooapis.jp/V201901/AdGroupAdLabel" xmlns:ns2="http://ss.yahooapis.jp/V201901">
      <ns2:service>AdGroupAdLabel</ns2:service>
      <ns2:requestTime>1547793791870</ns2:requestTime>
      <ns2:timeTakenSeconds>0.2671</ns2:timeTakenSeconds>
    </ResponseHeader>
  </SOAP-ENV:Header>
  <SOAP-ENV:Body>
    <ns2:mutateResponse xmlns="http://ss.yahooapis.jp/V201901" xmlns:ns2="http://ss.yahooapis.jp/V201901/AdGroupAdLabel">
      <ns2:rval>
        <ListReturnValue.Type>AdGroupAdLabelReturnValue</ListReturnValue.Type>
        <Operation.Type>ADD</Operation.Type>
        <ns2:values>
          <operationSucceeded>true</operationSucceeded>
          <ns2:adGroupAdLabel>
            <ns2:accountId>1234567890</ns2:accountId>
            <ns2:campaignId>10001</ns2:campaignId>
            <ns2:adGroupId>20001</ns2:adGroupId>
            <ns2:adId>30001</ns2:adId>
            <ns2:labelId>40001</ns2:labelId>
          </ns2:adGroupAdLabel>
        </ns2:values>
      </ns2:rval>
    </ns2:mutateResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

mutate(REMOVE)

ラベルと広告グループの紐付けを削除します。

リクエスト

パラメータ	必須	データ型	説明
operations	○	AdGroupAdLabelOperation	操作の対象となるラベル、広告の情報および操作の内容を表します。

＜リクエストサンプル＞

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
  <SOAP-ENV:Header>
    <RequestHeader xmlns="http://ss.yahooapis.jp/V201901/AdGroupAdLabel" xmlns:ns2="http://ss.yahooapis.jp/V201901">
      <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/V201901/AdGroupAdLabel">
      <operations>
        <operator>REMOVE</operator>
        <accountId>1234567890</accountId>
        <operand>
          <campaignId>10001</campaignId>
          <adGroupId>20001</adGroupId>
          <adId>30001</adId>
          <labelId>40001</labelId>
        </operand>
      </operations>
    </mutate>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

レスポンス

正常時のレスポンスフィールド

フィールド	データ型	説明
rval	AdGroupAdLabelReturnValue	操作結果を含むラベル、広告に関する情報のコンテナです。

＜レスポンスサンプル＞

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
  <SOAP-ENV:Header>
    <ResponseHeader xmlns="http://ss.yahooapis.jp/V201901/AdGroupAdLabel" xmlns:ns2="http://ss.yahooapis.jp/V201901">
      <ns2:service>AdGroupAdLabel</ns2:service>
      <ns2:requestTime>1547793791882</ns2:requestTime>
      <ns2:timeTakenSeconds>0.2671</ns2:timeTakenSeconds>
    </ResponseHeader>
  </SOAP-ENV:Header>
  <SOAP-ENV:Body>
    <ns2:mutateResponse xmlns="http://ss.yahooapis.jp/V201901" xmlns:ns2="http://ss.yahooapis.jp/V201901/AdGroupAdLabel">
      <ns2:rval>
        <ListReturnValue.Type>AdGroupAdLabelReturnValue</ListReturnValue.Type>
        <Operation.Type>REMOVE</Operation.Type>
        <ns2:values>
          <operationSucceeded>true</operationSucceeded>
          <ns2:adGroupAdLabel>
            <ns2:accountId>1234567890</ns2:accountId>
            <ns2:campaignId>10001</ns2:campaignId>
            <ns2:adGroupId>20001</ns2:adGroupId>
            <ns2:adId>30001</ns2:adId>
            <ns2:labelId>40001</ns2:labelId>
          </ns2:adGroupAdLabel>
        </ns2:values>
      </ns2:rval>
    </ns2:mutateResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

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