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

Latest commit

 

History

History
330 lines (299 loc) · 12.4 KB

LabelService.md

File metadata and controls

330 lines (299 loc) · 12.4 KB

LabelService

LabelServiceでは、ラベルに関する情報の取得および追加・更新・削除を行います。

WSDL

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

Namespace

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

サービス概要

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

操作

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

オブジェクト

Label

get

ラベルに関する情報を取得します。

リクエスト

パラメータ 必須 データ型 説明
selector ○ LabelSelector 操作の対象とするラベルの情報です。
＜リクエストサンプル＞
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
  <SOAP-ENV:Header>
    <RequestHeader xmlns="http://ss.yahooapis.jp/V201901/Label" 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>
    <get xmlns="http://ss.yahooapis.jp/V201901/Label" xmlns:ns2="http://ss.yahooapis.jp/V201901">
      <selector>
        <accountId>1234567890</accountId>
        <labelIds>10001</labelIds>
        <labelIds>10002</labelIds>
        <labelIds>10003</labelIds>
        <labelIds>10004</labelIds>
        <labelIds>10005</labelIds>
        <countLabeledEntity>TRUE</countLabeledEntity>
        <paging>
          <ns2:startIndex>1</ns2:startIndex>
          <ns2:numberResults>1000</ns2:numberResults>
        </paging>
      </selector>
    </get>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

レスポンス

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

フィールド データ型 説明
rval LabelPage 操作結果を含むラベルに関する情報のコンテナです。
＜レスポンスサンプル＞
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
  <SOAP-ENV:Header>
    <ResponseHeader xmlns="http://ss.yahooapis.jp/V201901/Label" xmlns:ns2="http://ss.yahooapis.jp/V201901">
      <ns2:service>Label</ns2:service>
      <ns2:requestTime>1547793090164</ns2:requestTime>
      <ns2:timeTakenSeconds>0.2671</ns2:timeTakenSeconds>
    </ResponseHeader>
  </SOAP-ENV:Header>
  <SOAP-ENV:Body>
    <ns2:getResponse xmlns="http://ss.yahooapis.jp/V201901" xmlns:ns2="http://ss.yahooapis.jp/V201901/Label">
      <ns2:rval>
        <totalNumEntries>1</totalNumEntries>
        <Page.Type>LabelPage</Page.Type>
        <ns2:values>
          <operationSucceeded>true</operationSucceeded>
          <ns2:label>
            <ns2:accountId>1234567890</ns2:accountId>
            <ns2:labelId>10001</ns2:labelId>
            <ns2:labelName>sample label.</ns2:labelName>
            <ns2:description>sample description.</ns2:description>
            <ns2:color>#FF0000</ns2:color>
            <ns2:labeledCampaign>0</ns2:labeledCampaign>
            <ns2:labeledAdGroup>0</ns2:labeledAdGroup>
            <ns2:labeledAdGroupAd>0</ns2:labeledAdGroupAd>
            <ns2:labeledAdGroupCriterion>0</ns2:labeledAdGroupCriterion>
          </ns2:label>
        </ns2:values>
      </ns2:rval>
    </ns2:getResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

mutate(ADD)

ラベルを追加します。

リクエスト

パラメータ 必須 データ型 説明
operations ○ LabelOperation 操作の対象となるラベルの情報および操作の内容を表します。
＜リクエストサンプル＞
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
  <SOAP-ENV:Header>
    <RequestHeader xmlns="http://ss.yahooapis.jp/V201901/Label" 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/Label">
      <operations>
        <operator>ADD</operator>
        <accountId>1234567890</accountId>
        <operand>
          <labelName>sample_20190118153130154</labelName>
          <description>add sample</description>
          <color>#000000</color>
        </operand>
      </operations>
    </mutate>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

レスポンス

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

フィールド データ型 説明
rval LabelReturnValue 操作結果を含むラベルに関する情報のコンテナです。
＜レスポンスサンプル＞
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
  <SOAP-ENV:Header>
    <ResponseHeader xmlns="http://ss.yahooapis.jp/V201901/Label" xmlns:ns2="http://ss.yahooapis.jp/V201901">
      <ns2:service>Label</ns2:service>
      <ns2:requestTime>1547793090185</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/Label">
      <ns2:rval>
        <ListReturnValue.Type>LabelReturnValue</ListReturnValue.Type>
        <Operation.Type>ADD</Operation.Type>
        <ns2:values>
          <operationSucceeded>true</operationSucceeded>
          <ns2:label>
            <ns2:accountId>1234567890</ns2:accountId>
            <ns2:labelId>10001</ns2:labelId>
            <ns2:labelName>sample_20190118153130154</ns2:labelName>
            <ns2:description>add sample</ns2:description>
            <ns2:color>#000000</ns2:color>
          </ns2:label>
        </ns2:values>
      </ns2:rval>
    </ns2:mutateResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

mutate(SET)

ラベルを更新します。

リクエスト

パラメータ 必須 データ型 説明
operations ○ LabelOperation 操作の対象となるラベルの情報および操作の内容を表します。
＜リクエストサンプル＞
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
  <SOAP-ENV:Header>
    <RequestHeader xmlns="http://ss.yahooapis.jp/V201901/Label" 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/Label">
      <operations>
        <operator>SET</operator>
        <accountId>1234567890</accountId>
        <operand>
          <labelId>10001</labelId>
          <labelName>set sample_20190118153130154</labelName>
          <description>set sample</description>
          <color>#ffffff</color>
        </operand>
      </operations>
    </mutate>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

レスポンス

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

フィールド データ型 説明
rval LabelReturnValue 操作結果を含むラベルに関する情報のコンテナです。
＜レスポンスサンプル＞
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
  <SOAP-ENV:Header>
    <ResponseHeader xmlns="http://ss.yahooapis.jp/V201901/Label" xmlns:ns2="http://ss.yahooapis.jp/V201901">
      <ns2:service>Label</ns2:service>
      <ns2:requestTime>1547793090201</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/Label">
      <ns2:rval>
        <ListReturnValue.Type>LabelReturnValue</ListReturnValue.Type>
        <Operation.Type>SET</Operation.Type>
        <ns2:values>
          <operationSucceeded>true</operationSucceeded>
          <ns2:label>
            <ns2:accountId>1234567890</ns2:accountId>
            <ns2:labelId>10001</ns2:labelId>
            <ns2:labelName>set sample_20190118153130154</ns2:labelName>
            <ns2:description>set sample</ns2:description>
            <ns2:color>#ffffff</ns2:color>
            <ns2:labeledCampaign>0</ns2:labeledCampaign>
            <ns2:labeledAdGroup>0</ns2:labeledAdGroup>
            <ns2:labeledAdGroupAd>0</ns2:labeledAdGroupAd>
            <ns2:labeledAdGroupCriterion>0</ns2:labeledAdGroupCriterion>
          </ns2:label>
        </ns2:values>
      </ns2:rval>
    </ns2:mutateResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

mutate(REMOVE)

ラベルを削除します。

リクエスト

パラメータ 必須 データ型 説明
operations ○ LabelOperation 操作の対象となるラベルの情報および操作の内容を表します。
＜リクエストサンプル＞
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
  <SOAP-ENV:Header>
    <RequestHeader xmlns="http://ss.yahooapis.jp/V201901/Label" 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/Label">
      <operations>
        <operator>REMOVE</operator>
        <accountId>1234567890</accountId>
        <operand>
          <labelId>10001</labelId>
        </operand>
      </operations>
    </mutate>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

レスポンス

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

フィールド データ型 説明
rval LabelReturnValue 操作結果を含むラベルに関する情報のコンテナです。
＜レスポンスサンプル＞
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
  <SOAP-ENV:Header>
    <ResponseHeader xmlns="http://ss.yahooapis.jp/V201901/Label" xmlns:ns2="http://ss.yahooapis.jp/V201901">
      <ns2:service>Label</ns2:service>
      <ns2:requestTime>1547793090219</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/Label">
      <ns2:rval>
        <ListReturnValue.Type>LabelReturnValue</ListReturnValue.Type>
        <Operation.Type>REMOVE</Operation.Type>
        <ns2:values>
          <operationSucceeded>true</operationSucceeded>
          <ns2:label>
            <ns2:accountId>1234567890</ns2:accountId>
            <ns2:labelId>10001</ns2:labelId>
            <ns2:labelName>set sample_20190118153130154</ns2:labelName>
            <ns2:description>set sample</ns2:description>
            <ns2:color>#ffffff</ns2:color>
            <ns2:labeledCampaign>0</ns2:labeledCampaign>
            <ns2:labeledAdGroup>0</ns2:labeledAdGroup>
            <ns2:labeledAdGroupAd>0</ns2:labeledAdGroupAd>
            <ns2:labeledAdGroupCriterion>0</ns2:labeledAdGroupCriterion>
          </ns2:label>
        </ns2:values>
      </ns2:rval>
    </ns2:mutateResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

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