Yahoo Shopping への接続を追加

Yahoo Shopping への接続を追加するには：

1. アプリケーションコンソールで、接続ページに移動します。
2. 接続の追加パネルで、追加したい接続のアイコンを選択します。
3. Yahoo Shopping アイコンが利用できない場合は、Add More アイコンをクリックしてCData サイトからYahoo Shopping コネクタをダウンロードおよびインストールします。

必須プロパティについては、設定タブを参照してください。

通常必須ではない接続プロパティについては、高度な設定タブを参照してください。

Yahoo Shopping への接続

Yahoo Shopping は埋め込みOAuth クレデンシャルを提供しており、デスクトップアプリケーションまたはヘッドレスマシンからの接続を簡単にします。Web アプリケーションから接続するには、カスタムOAuth アプリケーションの作成 で説明するようにカスタムOAuth アプリケーションを作成する必要があります。

すべての認証フローで、OAuth 経由で接続するにはAuthScheme をOAuth に設定する必要があります。

以下のサブセクションでは、Yahoo Shopping への認証について詳しく説明します。

• デスクトップ：ユーザーのローカルマシン上でのサーバーへの接続で、テストやプロトタイピングによく使用されます。埋め込みOAuth またはカスタムOAuth で認証されます。
• Web：共有ウェブサイト経由でデータにアクセスします。カスタムOAuth でのみ認証されます。
• ヘッドレスサーバー：他のコンピュータやそのユーザーにサービスを提供する専用コンピュータで、モニタやキーボードなしで動作するように構成されています。埋め込みOAuth またはカスタムOAuth で認証されます。

カスタムOAuth アプリケーションの作成についての情報と、すでに埋め込みOAuth 認証情報を持つ認証フローでもカスタムOAuth アプリケーションを作成したほうがよい場合の説明については、カスタムOAuth アプリケーションの作成 を参照してください。

Yahoo Shopping で利用可能な接続文字列プロパティの全リストは、Connection を参照してください。

アクセストークンの期限が切れたときは、Sync App は自動でアクセストークンをリフレッシュします。

OAuth アクセストークンの自動リフレッシュ：

Sync App がOAuth アクセストークンを自動的にリフレッシュするようにするには、次のように設定します。

1. はじめてデータに接続する際、次の接続プロパティを設定します。
   • InitiateOAuth： REFRESH。
   • OAuthClientId：カスタムOAuth アプリケーション設定のクライアントId。
   • OAuthClientSecret：カスタムOAuth アプリケーション設定のクライアントシークレット。
   • OAuthAccessToken：GetOAuthAccessToken によって返されたアクセストークン。
   • OAuthSettingsLocation：Sync App がOAuth 値を保存する場所のパス。これは接続間で維持されます。
2. その後のデータ接続では、以下を設定します。
   • InitiateOAuth
   • OAuthSettingsLocation

OAuth アクセストークンの手動リフレッシュ：

OAuth アクセストークンを手動でリフレッシュするために必要な唯一の値は、OAuth リフレッシュトークンです。

1. ExpiresIn 期間（GetOAuthAccessToken が返す）が経過した後にOAuthAccessToken を手動でリフレッシュするには、RefreshOAuthAccessToken ストアドプロシージャを呼び出します。
2. 次の接続プロパティを設定します。
   • OAuthClientId：カスタムOAuth アプリケーション設定のクライアントId。
   • OAuthClientSecret：カスタムOAuth アプリケーション設定のクライアントシークレット。

3. RefreshOAuthAccessToken を呼び出し、OAuthRefreshToken にGetOAuthAccessToken によって返されたOAuth リフレッシュトークンを設定します。
4. 新しいトークンが取得できたら、OAuthAccessToken プロパティにRefreshOAuthAccessToken によって返された値を設定します。これで新規接続が開かれます。

OAuth リフレッシュトークンを保存し、OAuth アクセストークンの有効期限が切れた後に手動でリフレッシュできるようにします。

このセクションでは、Yahoo Shopping Sync App の高度な機能を厳選して説明します。

ユーザー定義ビュー

Sync App はユーザー定義ビューの使用をサポートします。これは事前設定されたユーザー定義クエリによって内容が決定される仮想テーブルです。 このビューは、ドライバーに発行されるクエリを直接制御できない場合に有効です。 カスタムビューの作成と設定の概要については、ユーザー定義ビュー を参照してください。

SSL の設定

SSL の設定 を使用して、Sync App が証明書のネゴシエーションをどのように扱うかを調整します。さまざまな証明書形式を選択できます。詳しくは、「接続文字列オプション」にあるSSLServerCert プロパティを参照してください。

ファイアウォールとプロキシ

Windows プロキシとHTTP プロキシを含むファイアウォールとプロキシ に合致するようSync App を設定します。トンネル接続を設定することもできます。

クエリ処理

Sync App は、Yahoo Shopping にできるだけ多くのSELECT ステートメント処理をオフロードし、残りのクエリをクライアント側のインメモリで処理します。

詳しくは、クエリ処理 を参照してください。

ログ

CData ログを調整するために使用可能な設定の概要については、ログ を参照してください。基本的なロギングに必要なのは2つの接続プロパティだけですが、より詳細なロギングをサポートする多くの機能があり、LogModules 接続プロパティを使用してロギングする情報のサブセットを指定することができます。

SSL 設定のカスタマイズ

デフォルトでは、Sync App はサーバーとのTLS のネゴシエーションを試みます。サーバー証明書は、デフォルトのシステム信頼済み証明書ストアで検証されます。SSLServerCert 接続プロパティを使用して、証明書の検証方法をオーバーライドできます。

別の証明書を指定するには、SSLServerCert 接続プロパティを参照してください。

クライアントSSL 証明書

Yahoo Shopping Sync App はクライアント証明書の設定もサポートしています。次を設定すれば、クライアント証明書を使って接続できます。

• SSLClientCert：クライアント証明書のための証明書ストア名。
• SSLClientCertType：TLS / SSL クライアント証明書を格納するキーストアの種類。
• SSLClientCertPassword：TLS / SSL クライアント証明書のパスワード。
• SSLClientCertSubject：TLS / SSL クライアント証明書のサブジェクト。

Firewall またはProxy 経由の接続

HTTP プロキシ

HTTP プロキシへの認証には、以下のように設定します。

• ProxyServer：HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。
• ProxyPort：プロキシサーバーが起動しているTCP ポート。
• ProxyAuthScheme：プロキシサーバーに対して認証する際にSync App が使用する認証方法。
• ProxyUser：プロキシサーバーに登録されているユーザーアカウントのユーザー名。
• ProxyPassword：ProxyUser に紐付けられたパスワード。

その他のプロキシ

次のプロパティを設定します。

• プロキシベースのファイヤーウォールを使用するには、FirewallType、FirewallServer、およびFirewallPort を設定します。
• 接続をトンネルするには、FirewallType をTUNNEL に設定します。
• 認証するには、FirewallUser とFirewallPassword を設定します。
• SOCKS プロキシへの認証には、さらにFirewallType をSOCKS5 に設定します。

CData Sync App は、Yahoo Shopping オブジェクトをリレーショナルテーブルおよびビューとしてモデル化します。 Yahoo Shopping オブジェクトは他のオブジェクトとリレーションを持ちます。テーブルでは、これらのリレーションは外部キーを使用して表されます。 次のセクションでは、利用可能なAPI オブジェクトを示し、Yahoo Shopping API へのSQL の実行について詳しく説明します。

ほとんどのデータベースオブジェクトのスキーマは、シンプルなテキストベースのコンフィギュレーションファイルで定義されます。

SellerId カラムは、すべてのテーブル、ビュー、およびプロシージャにあります。これはSellerId 接続プロパティに接続されています。クエリで指定されていない場合、リクエストには接続プロパティに設定されている値が含まれます。

Sync App はYahoo Shopping のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。

Yahoo Shopping Connector for CData Sync テーブル

Name	Description
Inventory	Stock database of inventory data in Yahoo! Shopping.
OrderDetails	Returns data from a sample table.
OrderLineItems	Returns data from a sample table.
OrderPayments	Returns data from a sample table.
Orders	Returns data from a sample table.
OrderShippings	Returns data from a sample table.
ProductOptions	Return the list of options for the specified product.
Products	Return the list of registered products of your store.
ProductSubCodes	Return the list of options for the specified product.

Stock database of inventory data in Yahoo! Shopping.

Select

The Sync App will use the Yahoo Shopping API to process WHERE clause conditions built with the following columns and operators, ItemCode is required. The rest of the filter is executed client side within the Sync App.

• ItemCode and SellerId support the = operator.

For example, the following queries are processed server side:

SELECT * FROM Inventory WHERE ItemCode = 'CD001' 

Insert

Insert is not supported by Inventory

Update

Yahoo Shopping allows updates for the AllowOverdraft, Quantity and StockClose columns.

UPDATE Inventory SET AllowOverdraft = 1, Quantity = '15', StockClose = 0 WHERE ItemCode = 'CD001' 

Batch Update

Yahoo Shopping allows updates for the same columns.

INSERT INTO Inventory#TEMP (AllowOverdraft, ItemCode, Quantity, StockClose)  VALUES (1, 'CD0001', '12', 0)

INSERT INTO Inventory#TEMP (AllowOverdraft, ItemCode, Quantity, StockClose)  VALUES (1, 'CD0002', '32', 0)

UPDATE Inventory SET (AllowOverdraft, ItemCode, Quantity, StockClose) SELECT AllowOverdraft, ItemCode, Quantity, StockClose FROM [Inventory#TEMP]

Delete

Delete is not supported by Inventory

Columns

Name	Type	ReadOnly	References	Description
ItemCode [KEY]	String	False	Products.ItemCode	Product code. In INSERT or UPDATE: For products that do not have individual product codes, please specify only the product code. For products with individual item codes, please connect the product code and individual product code with a colon ':'.
SellerId	String	False		Id of the store account. In UPDATE: If the number has a plus sign '+', the value will be added and it will be subtracted if minus sign '-' is attached. If only numeric value is written, the field will be updated with that value.
SubCode	String	True		Individual product code. If the product does not have individual product code, this will be empty.
Status	Integer	True		Stock acquisition status. 0: No stock information, 1: Stock information available. 使用できる値は次のとおりです。0, 1
Quantity	String	False		Quantity of inventory. If this value is empty, this means that the number of stock is infinite.
AllowOverdraft	Integer	False		The excess purchase setting. 0: Excessive purchase impossible, 1: Excess purchase possible. 使用できる値は次のとおりです。0, 1
IsPublished	Integer	True		The product reflection flag. 0: Product not reflected, 1: Product reflected. 使用できる値は次のとおりです。0, 1
UpdateTime	Datetime	True		Last update date.
StockClose	Integer	False		Stock Close Flag. 0: Normal State, 1: Stock Closed State 使用できる値は次のとおりです。0, 1

Returns data from a sample table.

Select

The Sync App will use the Yahoo Shopping API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

• OrderId AND SellerId support the = operator.

For example, the following queries are processed server side:

SELECT * FROM OrderDetails WHERE OrderId = 'store_000001'

SELECT * FROM OrderDetails WHERE OrderId = 'store_000001' AND SellerId = 'store' 

Insert

Insert is not supported by OrderDetails

Update

Yahoo Shopping allows UPDATEs for the OrderStatus, IsPointFix, CancelReason, CancelReasonDetail, OperationUser, PrintSlipTime, PrintDeliveryTime, PrintBillTime, BuyerComments, SellerComments, Notes, PayCharge, ShipCharge, GiftWrapCharge, Discount columns.

UPDATE OrderDetails SET OrderStatus = 2, IsPointFix = 'true', CancelReason = 110, CancelReasonDetail = ' detail for canceling here ', OperationUser = 'API', PrintSlipTime = '2018-05-27T10:51:18.000+02:00', PrintDeliveryTime = '2018-06-27T10:51:18.000+02:00', PrintBillTime = '2018-07-27T10:51:18.000+02:00', BuyerComments = 'comments here', SellerComments = 'seller comments', Notes = 'some notes ', PayCharge = 1, ShipCharge = 2, GiftWrapCharge = 0, Discount = 4 WHERE OrderId = 'store-10000003'

Delete

Delete is not supported by OrderDetails

Columns

Name	Type	ReadOnly	References	Description
OrderId [KEY]	String	False	Orders.OrderId	Order Id.
SellerId	String	False		Store account.
OrderTime	Datetime	True		The date and time when the order was made.
OrderStatus	Integer	False		Status of the order. 1: During reservation, 2: In process, 3: Hold, 4: Cancel, 5: Completed. 使用できる値は次のとおりです。0, 1, 2, 3, 4, 5, 8
CancelReason	Integer	False		Cancellation reason: Order Cancellation - 100: Cancel, 110: Returned Item, 120: Not Received, 130: Address Unknown, 140: Receiving Refused, 150: No Connection, 160: Duplicate Order, 170: Payment Unavailable, 180: Other, 300: Mistakenly Ordered, 310: Customer Using Points They Forgot to Use, 320: Customer Using Coupon They Forgot to Use, 330: Customer Found Cheaper Price, 340: Shipping Cost Too High, 350: Change of Shipping Destination, 360: Change of Shipping Method, 370: Change of Payment Method, 380: Credit Card Not Available, | Store convenience - 200: Settlement Method Convenience, 210: Missing Item, 220: Discontinued, 230: Other | Other - 0: Cancel reason n/a System cancellation | blank: Order not canceled.
CancelReasonDetail	String	False		The reason why the store has entered a cancellation reason when the reason is Store Convenience 230 (Other)
IsPointFix	Boolean	False		Required on an Update. True: Points are finalized. False: The point is not fixed.
OperationUser	String	False		The registered name of Yahoo! JAPAN business ID who carried out update work.
ParentOrderId	String	True		The splitting order ID when an order is split.
ChildOrderId	String	True		The second splitting order ID when an order is split.
MobileCarrierName	String	True		The type of mobile carrier.
NeedSnl	Boolean	True		Store newsletter opt-in flag.
LastUpdateTime	Datetime	True		The last modification date of order information.
SuspectMessage	String	True		A message when an order is judged as mischievous.0: Non-naughty order, 1: Mischievous order, 2: Mischievious canceled order.
SendConfirmTime	Datetime	True		The date and time of sending the order confirmation email sent when the order is newly entered.
SendPayTime	Datetime	True		The mail transmission date sent at the time of settlement.
PrintSlipTime	Datetime	False		The date and time when the order slip was output.
PrintDeliveryTime	Datetime	False		The date and time when we output the invoice.
PrintBillTime	Datetime	False		The date and time when the invoice was output.
BuyerComments	String	False		The comment string displayed by the buyer.
SellerComments	String	False		The comment string displayed by the store in the store.
Notes	String	False		A memo in the store when the store is entered with the order management tool.
Referer	String	True		Referrer information covering domain, search keywords, etc.
EntryPoint	String	True		The URL of the store page where the buyer entered the target store.
HistoryId	String	True		An ID that manages the update history of orders.
UsageId	String	True		The coupon usage ID.
UseCouponData	String	True		Detailed information on the coupon information.
TotalCouponDiscount	Integer	True		Of the amount discounted by the store coupon of all the products associated with one order, this becomes the discount total value other than the shipping fee.
ShippingCouponFlg	Integer	True		Free shipping availability. 0: None, 1: Present.
ShippingCouponDiscount	Integer	True		It is the discount amount of the carriage when applying free shipping coupons.
CampaignPoints	String	True		Comma separated list of breakdown points.
IsMultiShip	Boolean	True		Indicates if there is a multiple shipping order.
MultiShipId	String	True		ID that identifies multiple delivery orders.
PayCharge	Integer	False		The fee set by the store (cash on delivery commission etc.). The settlement fee of Yahoo! settlement is different.
ShipCharge	Integer	False		Shipping fee (postage free coupon discount after deduction).
GiftWrapCharge	Integer	False		Gift wrapping fee.
Discount	Integer	False		Discount. The value entered in the price discount column on the store creator Pro after the store side is entered.
Adjustments	Integer	False		Adjustment amount.
SettleAmount	Integer	True		The same value as the total amount (TotalPrice).
UsePoint	Integer	True		Number of points used.
TotalPrice	Integer	True		Subtotal - usage point + gift wrapping fee + fee - discount + postage + adjustment amount - mall coupon discount amount.
IsGetPointFixAll	Boolean	True		Indicates whether or not the process of finalizing the grant points of all lines (goods) has been completed.
TotalMallCouponDiscount	Integer	True		Indicates the total value of the amount discounted at the mall coupon.
SettlePayAmount	Integer	True		When the order is split, this will not reflect the split amount. The total amount will reflect this.
IsLogin	Boolean	True		Login order.
FspLicenseCode	String	True		For details on the star club, please see the following page. http://starclub.yahoo.co.jp/.
FspLicenseName	String	True		For details on the star club, please see the following page. http://starclub.yahoo.co.jp/.
GuestAuthId	String	True		Guest authorization Id for guest orders only.
YamatoCoopStatus	Integer	True		使用できる値は次のとおりです。0, 1, 2, 3, 4
FraudHoldStatus	Integer	True		0 or null: Low risk of fraud, 1: Rule pending review, 2: Release rule hold, 3: Rule abuse confirmed. 使用できる値は次のとおりです。0, 1, 2, 3
PublicationTime	Datetime	True		The time that can be obtained from the orderList, such as when the illegal hold is released, is set.
UseGiftCardData	String	True		Gift Card Data.
GiftCardDiscount	Integer	True		Amount of gift voucher used
SocialGiftType	String	True		This column indicates whether the delivery address information for social gift orders is entered by sharing the URL or entered by the purchaser. For orders before the feature is released, it will be empty (null).
IsVip	Boolean	True		This column indicates whether the order is eligible for VIP benefits or not.
InsuranceStatus	Integer	True		Insurance enrollment status null or 0: No application 1: Application in process 2: Application successful 3: Application unsuccessful 4: Coverage started 5: Insurance canceled 6: Insurance ordered
ShipCompanyMethodCode	String	True		The name of the shipping method used by the shipping company. The code determined by the shipping company.
ShipCompanyReceivedDatetime	Datetime	True		The date and time the delivery company received the shipment
ShipContactlessDeliveryCode	String	True		Delivery company drop-off location code null: Item not eligible for drop-off delivery OR Drop-off delivery not selected 00: Item to be dropped off and picked up in person 01: Item to be dropped off and picked up without meeting the customer
ChannelGoodsPlanId	String	True		ID when signing up for PayPay Insurance via SHP
ChannelGoodsPlanName	String	True		PayPay Insurance Name via SHP

Returns data from a sample table.

Select

The Sync App will use the Yahoo Shopping API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

• OrderId AND SellerId support the = operator.

For example, the following queries are processed server side:

SELECT * FROM OrderLineItems WHERE OrderId = 'store_000001'

SELECT * FROM OrderLineItems WHERE OrderId = 'store_000001' AND SellerId = 'store' 

Insert

To add a OrderLineItem specify the OrderId, IsQuotation, ItemId, LineId, Quantity, Title, UnitPrice columns.

INSERT INTO OrderLineItems (OrderId, IsQuotation, ItemId, LineId, Quantity, Title, UnitPrice) VALUES ('store-10000004', 'false', 'CD0012345', 22, 10, 'some new title test', 150) 

Batch Insert

Yahoo Shopping allows batch inserts for the same columns. OrderId should be the same in all batch records.

INSERT INTO OrderLineItems (OrderId, IsQuotation, ItemId, LineId, Quantity, Title, UnitPrice) VALUES ('store-10000004', 'false', 'CD0012345', 22, 10, 'some new title test 1', 150) 

INSERT INTO OrderLineItems (OrderId, IsQuotation, ItemId, LineId, Quantity, Title, UnitPrice) VALUES ('store-10000004', 'false', 'CD0012346', 22, 10, 'some new title test 2', 150) 

INSERT INTO OrderLineItems (OrderId, IsQuotation, ItemId, LineId, Quantity, Title, UnitPrice) SELECT OrderId, IsQuotation, ItemId, LineId, Quantity, Title, UnitPrice FROM OrderLineItems#TEMP

Update

UPDATE is not supported by OrderDetails

Delete

Delete is not supported by OrderDetails

Columns

Name	Type	ReadOnly	References	Description
OrderId [KEY]	String	False	Orders.OrderId	Order ID.
LineId [KEY]	Integer	False		Product line ID.
OrderTime	Datetime	True		The date and time when the order was made.
SellerId	String	False		Store account ID.
ItemId	String	False		Product ID.
Title	String	False		Product title.
SubCode	String	False		The subcode of the product when this value has been set.
SubCodeOption	String	True		The subcode option when this value has been set. Both key & value.
IsUsed	Boolean	True		Indicates whether it is a used item.
ImageId	String	True		The product image ID.
IsTaxable	Boolean	True		Tax object flag.
Jan	String	True		Japanese Article Number code.
ProductId	String	True		The product code (product number/model number).
CategoryId	Integer	True		Category code.
AffiliateRatio	String	True		Store burden rate.
UnitPrice	Integer	False		Unit price of each item (amount after discount of store coupons) .
ItemTaxRatio	Integer	True		Unit price of each item (amount after discount of store coupons) .
Quantity	Integer	False		The quantity of each item.
PointAvailQuantity	Integer	True		Points to be granted quantity.
ReleaseDate	Date	True		Release date. This is only when there is input of release date. For release date bigger than order date, treat it as a pre-order.
HaveReview	Boolean	True		Product review absence flag.
PointFspCode	String	True		Point code by item. 10001 to 10015, 2001 to 20010.
PointRatioY	Integer	True		Granted Point Magnification (Yahoo! JAPAN Burden).
PointRatioSeller	Integer	True		Granted Point Magnification (Store Burden).
UnitGetPoint	Integer	True		Number of credit points granted.
IsGetPointFix	Boolean	True		Granted point determination flag.
GetPointFixDate	Date	True		Granulation point determination date. After 14 days of order date, we will set the pre-order to 14 days after release date.
CouponDiscount	Integer	True		Coupon discount amount.
CouponUseNum	Integer	True		Number of applicable coupons.
OriginalPrice	Integer	True		Unit price before discount.
OriginalNum	Integer	True		Quantity before line splitting.
LeadTimeStart	Date	True		Start of shipment date.
LeadTimeEnd	Date	True		Shipment day end.
LeadTimeText	String	True		Shipping date text.
CouponData	String	True		Store coupons.
IsQuotation	Boolean	False		Used only on UPDATE.
OperationUser	String	False		It is the registered name of Yahoo! JAPAN business ID who carried out update work.
YamatoCoopStatus	Integer	True		It is a status that shows the current status of the link to Yamato Transport. 使用できる値は次のとおりです。0, 1, 2, 3, 4
PickAndDeliveryCode	String	True		The bar code information required for delivery.
PickAndDeliveryTransportRuleType	Integer	True		It is an information on cargo handling. 使用できる値は次のとおりです。0, 1, 2, 3, 4, 5
YamatoUndeliverableReason	String	True		The reason why Yamato delivery is not possible.

Returns data from a sample table.

Select

The Sync App will use the Yahoo Shopping API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

• OrderId AND SellerId support the = operator.

For example, the following queries are processed server side:

SELECT * FROM OrderPayments WHERE OrderId = 'store_000001'

SELECT * FROM OrderPayments WHERE OrderId = 'store_000001' AND SellerId = 'store' 

Insert

Insert is not supported by OrderPayments

Update

Yahoo Shopping allows UPDATEs for the PayStatus, PayDate, OperationUser, PayType, PayKind, PayMethod, PayMethodName, PayNotes, NeedBillSlip, NeedDetailedSlip, NeedReceipt, BillAddressFrom, BillFirstName, BillFirstNameKana, BillLastName, BillLastNameKana, BillZipCode, BillPrefecture, BillPrefectureKana, BillCity, BillCityKana, BillAddress1, BillAddress1Kana, BillAddress2, BillAddress2Kana, BillPhoneNumber, BillEmgPhoneNumber, BillMailAddress, BillSection1Field, BillSection1Value, BillSection2Field, BillSection2Value columns.

UPDATE OrderPayments SET PayStatus = 0, PayDate = '2108-10-10', OperationUser = 'system', PayType = 0, PayKind = 7, PayMethod = 'payment_c1', PayMethodName = 'testname', PayNotes = ' payment notes here..', NeedBillSlip = 'false', NeedDetailedSlip = 'false', NeedReceipt = 'true', BillAddressFrom = 'from address', BillFirstName = 'first name', BillFirstNameKana = 'first name phonetic', BillLastName = 'last name', BillLastNameKana = 'last name phonetic', BillZipCode = '1423', BillPrefecture = 'prefecture ', BillPrefectureKana = 'prefecture phonetic', BillCity = 'city', BillCityKana = ' city phonetic', BillAddress1 = 'address 1', BillAddress1Kana = 'address 1 phonetic', BillAddress2 = 'address 2', BillAddress2Kana = 'address 2 phonetic', BillPhoneNumber = '050-5578-7397', BillEmgPhoneNumber = '050-5578-7397', BillMailAddress = 'mail address', BillSection1Field = 'field 1', BillSection1Value = 'value 1', BillSection2Field = 'field 2', BillSection2Value = 'value 2' WHERE OrderId = 'store-10000002'

Delete

Delete is not supported by OrderPayments

Columns

Name	Type	ReadOnly	References	Description
OrderId [KEY]	String	False	Orders.OrderId	Order ID.
SellerId	String	False		Store account ID.
OrderTime	Datetime	True		The date and time when the order was made.
PayStatus	Integer	False		Deposit status. 0: Waiting for payment, 1: Payment already made 使用できる値は次のとおりです。0, 1
SettleStatus	Integer	True		Settlement status. 1: Settlement application, 2: Waiting for payment, 3: Payment completion, 4: Waiting for payment, 5: Completion of settlement, 6: Cancel, 7: Refund, 8: Expired, 9: Payment application, 10: Authorization error, 11: Sales cancelled, 12: Suica address error. 使用できる値は次のとおりです。1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12
PayType	Integer	False		Payment classification. 0: Postpay, 1: Prepay. 使用できる値は次のとおりです。0, 1
PayKind	Integer	False		Payment type. 0: Card, 1: Internet banking, 2: Carrier settlement, 3: Transfer, 4: Cash on delivery, 5: Convenience store, 6: Electronic money 7: Other. 使用できる値は次のとおりです。0, 1, 2, 3, 4, 5, 6, 7
PayMethod	String	False		Payment method number. payment_a 1: Credit card payment, payment_a 6: Convenience store payment (7-Eleven), payment_a 7: Convenience store payment (Others), payment_a 8: Mobile Suica payment, payment_a 9: Docomo Mobile payment, payment_a 10: au Easy settlement, payment_a 11: Soft bank collectively payment, payment_a 15: Payee, payment_a 16: Yahoo Money / deposit payment, payment_b [1-6]: bank transfer (name is free setting of store), payment_c1: Japan Post Bank (prepayment), payment_c2: Japan Post Bank (postpay), payment_c3: registered mail, payment_d1: cash on delivery goods, payment_e [1-15 ]: Free payment method name of the store, payment_z1: Full payment of points.
PayMethodName	String	False		Payment method name.
SellerHandlingCharge	Integer	True		A settlement fee for the store's burden.
PayActionTime	Datetime	True		Purchase history detail screen It contains the payment update date and time.
PayDate	Date	False		The deposit date entered in the order management tool.
PayNotes	String	False		The contents of the remarks column of the deposit entered by the order management tool.
SettleId	String	True		Settlement ID.
CardBrand	String	True		In case of credit card it is the card brand name (VISA etc).
CardNumber	String	True		Only store of original merchant store contract is available. Encrypted character string information can be acquired.
CardNumberLast4	String	True		The last four digits of the credit card.
CardExpireYear	String	True		The expiration year of the card.
CardExpireMonth	String	True		The expiration month of the card.
CardPayType	Integer	True		Card payment classification. 1: Lump sum payment, 2: Bonus lump sum payment, 3: Ribbon payment, 4: Installment payment 使用できる値は次のとおりです。1, 2, 3, 4
CardHolderName	String	True		The name of the cardholder
CardPayCount	Integer	True		The number of payments in installments.
CardBirthDay	String	True		Card date of birth.
UseYahooCard	Boolean	True		Yahoo! JAPAN JCB Card Availability.
UseWallet	Boolean	True		Wallet availability.
NeedBillSlip	Boolean	False		Whether or not you wish to have an invoice when ordering entered by the purchaser.
NeedDetailedSlip	Boolean	False		The presence or absence of the requested statement when ordering entered by the purchaser.
NeedReceipt	Boolean	False		Whether there is a receipt at the time of ordering entered by the purchaser.
AgeConfirmField	String	True		The field name set by the store in the age confirmation field.
AgeConfirmValue	Integer	True		Age confirmation field numeric input.
AgeConfirmCheck	Boolean	True		If the box has been checked when there is an age check check box.
BillAddressFrom	String	False		Billing address. P: UDB home address, B: UDB work address, ship: same as the addressee, O1: others, O2: other, O3: other 3 O4: other 4 O: other input.
BillFirstName	String	False		Billing Name.
BillFirstNameKana	String	False		Billing name (phonetic).
BillLastName	String	False		Billing surname.
BillLastNameKana	String	False		Billing last name (phonetic).
BillZipCode	String	False		Billing Postal Code.
BillPrefecture	String	False		Billing address Prefecture In case of overseas 'Other' is entered.
BillPrefectureKana	String	False		Billing prefecture phonetic.
BillCity	String	False		Billing city / county.
BillCityKana	String	False		Billing County District Phonetic.
BillAddress1	String	False		Billing address 1.
BillAddress1Kana	String	False		Billing address 1 phonetic.
BillAddress2	String	False		Billing address 2.
BillAddress2Kana	String	False		Billing address 2 phonetic.
BillPhoneNumber	String	False		Billing telephone number.
BillEmgPhoneNumber	String	False		Billing telephone number (urgent).
BillMailAddress	String	False		Billing E-mail address.
BillSection1Field	String	False		Billing address Affiliation 1 Field name.
BillSection1Value	String	False		Billing address Affiliation 1 Input information.
BillSection2Field	String	False		Billing address Affiliation 2 Field name.
BillSection2Value	String	False		Billing address Affiliation 2 Input information.
CombinedPayType	Integer	False		Billing address Affiliation 2 Input information.
CombinedPayKind	Integer	False		Billing address Affiliation 2 Input information.
CombinedPayMethod	String	False		Billing address Affiliation 2 Input information.
PayMethodAmount	Decimal	False		Billing address Affiliation 2 Input information.
CombinedPayMethodName	String	False		Billing address Affiliation 2 Input information.
CombinedPayMethodAmount	Decimal	False		Billing address Affiliation 2 Input information.
PayNo	String	True		Payment number.
PayNoIssueDate	Datetime	True		Payment number issue date / time.
ConfirmNumber	String	True		Authorization number.
PaymentTerm	Datetime	True		Payment due date for convenience store payment, mobile Suica settlement, and payment settlement.
IsApplePay	Boolean	True		Availability of ApplePay.
OperationUser	String	False		It is the registered name of Yahoo! JAPAN business ID who carried out update work.

Returns data from a sample table.

Select

The Sync App will use the Yahoo Shopping API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

• OrderId support the = operator.
• SellerId DeviceType IsSeen IsSplit IsRoyalty IsAffiliate Suspect OrderStatus and StoreStatus support the = operator.
• OrderTime supports the following operators: =,<,<=,> AND >=.

For example, the following queries are processed server side:

SELECT * FROM Orders WHERE ReadOnlyMode = 2

SELECT * FROM Orders WHERE OrderId = 'store_000001'

SELECT * FROM Orders WHERE OrderId = 'store_000001' AND SellerId = 'store' 

SELECT * FROM Orders WHERE OrderTime > '2010-07-07 00:00:00+01:00' AND OrderTime <= '2018-07-07 00:00:00+01:00' AND DeviceType = 1 AND IsSeen = 'true' AND IsSplit = 'false' AND IsRoyalty = 'true' AND IsAffiliate = 'false' AND Suspect = 0 AND OrderStatus = 2

Insert

Insert is not supported by Orders

Update

Yahoo Shopping allows updates for the IsSeen, Suspect and StoreStatus columns.

UPDATE Orders SET IsSeen = 'true', Suspect = 0, StoreStatus = '3' WHERE OrderId = 'store-10000001'

Delete

Delete is not supported by Orders

Columns

Name	Type	ReadOnly	References	Description
OrderId [KEY]	String	False		Order Id.
SellerId	String	False		Store account.
OrderTime	Datetime	True		The date and time when the order was made.
Version	Integer	True		Shopping cart and IF specification version of order API.
OriginalOrderId	String	True		It is the order ID when we processed the order.
ParentOrderId	String	True		This is the splitting order ID when order is split.
DeviceType	Integer	True		Device information 1: PC 2: Galaxy 3: Smartphone 4: Tablet. 使用できる値は次のとおりです。1, 2, 3, 4
IsSeen	Boolean	False		Viewed flag.
IsSplit	Boolean	True		Split flag.
IsRoyalty	Boolean	True		It judges whether it is a charge target or not. For example, for a test order, specify false.
IsSeller	Boolean	True		Administrator order flag. The seller ordered by Yahoo! ID registered. It displays in order management.
IsAffiliate	Boolean	True		It is judging whether it is an order via an affiliate.
IsRatingB2s	Boolean	True		Seller It is judged whether it has been evaluated or not.
ExistMultiReleaseDate	Boolean	True		Multiple release date available.
LastUpdateTime	Datetime	True		It is the last modification date of order information.
Suspect	Integer	False		Flag to judge mischief target, non target, and canceled. 0: non-mischievous order 1: mischievous order 2: mischievous canceled order. 使用できる値は次のとおりです。0, 1, 2
OrderStatus	Integer	True		0: Not entered 1: Reserved 2: In process 3: Hold 4: Cancel 5: Complete 8: Wait for consent. 使用できる値は次のとおりです。0, 1, 2, 3, 4, 5, 8
StoreStatus	String	False		It is a status that the store can set independently.
RoyaltyFixTime	Datetime	True		Charging decision date and time.
IsYahooAuctionOrder	Boolean	True		IsYahooAuctionOrder
YahooAuctionMerchantId	String	True		YahooAuctionMerchantId
YahooAuctionId	String	True		YahooAuctionId
IsReadOnly	Integer	True		Read only flag. 1: Read only (cancel acceptance order) 0: Readable / writable. 使用できる値は次のとおりです。0, 1
YamatoCoopStatus	Integer	True		This is a status that shows the current status of the link to Yamato Transport. 使用できる値は次のとおりです。0, 1, 2, 3, 4
ReadOnlyMode	Integer	True		Property to get data that the user can be able to cancel. Supports only value 2 使用できる値は次のとおりです。0, 1, 2 デフォルト値は2です。
TotalCount	Integer	True		Total number of records available.
FraudHoldStatus	Integer	False		This is a status that shows the risk of Fraud.
PublicationTime	Datetime	False		Time that can be obtained from the Order List.
IsEazy	Boolean	True		It is an Order Flag.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name	Type	Description
Start	Integer	Search index where to start seraching records from.
FraudHoldDisplayType	Integer	A flag that determines whether to include fraudulently held orders. 使用できる値は次のとおりです。0, 1
PayStatus	Integer	Deposit status. 0: Waiting for payment, 1: Payment already made. 使用できる値は次のとおりです。0, 1

Returns data from a sample table.

Select

The Sync App will use the Yahoo Shopping API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

• OrderId AND SellerId support the = operator.

For example, the following queries are processed server side:

SELECT * FROM OrderShippings WHERE OrderId = 'store_000001'

SELECT * FROM OrderShippings WHERE OrderId = 'store_000001' AND SellerId = 'store' 

Insert

Insert is not supported by OrderShippings

Update

Yahoo Shopping allows updates for the IsPointFix, ShipStatus, ShipMethod, ShipMethodName, ShipRequestDate, ShipRequestTime, ShipNotes, ShipCompanyCode, ShipInvoiceNumber1, ShipInvoiceNumber2, ShipInvoiceNumberEmptyReason, ShipUrl, ArriveType, ShipDate, ArrivalDate, NeedGiftWrap, GiftWrapType, GiftWrapMessage, NeedGiftWrapPaper, GiftWrapPaperType, GiftWrapName, ShipFirstName, ShipFirstNameKana, ShipLastName, ShipLastNameKana, ShipPrefecture, ShipPrefectureKana, ShipZipCode, ShipCity, ShipCityKana, ShipAddress1, ShipAddress1Kana, ShipAddress2, ShipAddress2Kana, ShipPhoneNumber, ShipEmgPhoneNumber, ShipSection1Field, ShipSection1Value, ShipSection2Field, ShipSection2Value, OperationUser columns.

UPDATE OrderShippings SET IsPointFix = 'true', ShipStatus = 3, ShipMethod = '1', ShipMethodName = ' the ship method name', ShipRequestDate = '2017-04-04', ShipRequestTime = '01:01:01', ShipNotes = ' shipping notes', ShipCompanyCode = '1001', ShipInvoiceNumber1 = 'number 1', ShipInvoiceNumber2 = 'number 2', ShipInvoiceNumberEmptyReason = ' reason', ShipUrl = 'domain.com', ArriveType = 0, ShipDate = '2017-04-04', ArrivalDate = '2017-04-04', NeedGiftWrap = 'false', GiftWrapType = '', GiftWrapMessage = '', NeedGiftWrapPaper = 'false', GiftWrapPaperType = '4', GiftWrapName = 'wrap name', ShipFirstName = 'ship name', ShipFirstNameKana = ' ship name phonetic', ShipLastName = 'last name', ShipLastNameKana = 'last name phonetic', ShipPrefecture = 'prefecture', ShipPrefectureKana = ' prefecture phonetic', ShipZipCode = '980-0021', ShipCity = 'NJ', ShipCityKana = 'NJ phonetic', ShipAddress1 = ' the address', ShipAddress1Kana = 'the address phonetic', ShipAddress2 = ' address 2', ShipAddress2Kana = 'address 2 phonetic', ShipPhoneNumber = '050-5578-7397', ShipEmgPhoneNumber = '050-5578-7390', ShipSection1Field = 'test field 1', ShipSection1Value = 'test value 1', ShipSection2Field = 'test field 2', ShipSection2Value = 'test value 2', OperationUser = 'API' WHERE OrderId = 'store-10000002'

Delete

Delete is not supported by OrderShippings

Columns

Name	Type	ReadOnly	References	Description
OrderId [KEY]	String	False	Orders.OrderId	Order Id.
SellerId	String	False		Store account.
OrderTime	Datetime	True		The date and time when the order was made.
IsPointFix	Boolean	False		Used only on update.
ShipStatus	Integer	False		Delivery status 0: Can not be shipped 1: Can be shipped 2: Shipping in progress 3: Shipped completed 4: Receiving completed. 使用できる値は次のとおりです。0, 1, 2, 3, 4
ShipMethod	String	False		Delivery method number: any one of postage 1 - 14, 16.
ShipMethodName	String	False		Delivery method name.
ShipRequestDate	Date	False		Desired delivery day.
ShipRequestTime	String	False		Delivery time desired.
ShipNotes	String	False		Delivery note.
ShipCompanyCode	String	False		Delivery company code 1000: Other 1001: Yamato Transport 1002: Sagawa Express 1003: Japan Post 1004: Seino Transportation.
ShipInvoiceNumber1	String	False		Delivery slip number information of the shipping company that the store set with the tool or API.
ShipInvoiceNumber2	String	False		Delivery slip number information of the shipping company that the store set with the tool or API.
ShipInvoiceNumberEmptyReason	String	False		NULL: (Unregistered state) 101: For direct item from manufacturer's inventory 102: For goods that do not need shipping 103: For overseas receipt items 104: For direct contact from the delivery company 105: Document number Because it is not issued (can not be tracked) because of the delivery method.
ShipUrl	String	False		Tracking URL of the shipping company that the store set with tools and APIs.
ArriveType	Integer	False		Drinking 0: Normal 1 : School order 2: Matsutake order 使用できる値は次のとおりです。0, 1, 2
ShipDate	Date	False		Shipment date entered.
ArrivalDate	Date	False		It is the arrival date entered.
NeedGiftWrap	Boolean	False		Presence or absence of gift wrapping.
GiftWrapType	String	False		Gift wrapping type.
GiftWrapMessage	String	False		Gift message.
NeedGiftWrapPaper	Boolean	False		Whether or not.
GiftWrapPaperType	String	False		Works type.
GiftWrapName	String	False		Enter name (message).
Option1Field	String	True		Option field Key information (field name).
Option1Type	Integer	True		Option field Key information (setting).
Option1Value	String	True		Option field Input contents.
Option2Field	String	True		Option field Key information (field name).
Option2Type	Integer	True		Option field Key information (setting).
Option2Value	String	True		Option field Input contents.
ShipFirstName	String	False		Destination name.
ShipFirstNameKana	String	False		Destination name phonetic.
ShipLastName	String	False		Destination surname.
ShipLastNameKana	String	False		Destination surname phonetic.
ShipPrefecture	String	False		Delivery destination Prefecture In case of overseas 'Other' is entered.
ShipPrefectureKana	String	False		Destination prefecture phonetic.
ShipZipCode	String	False		Delivery addressee postal code.
ShipCity	String	False		Destination city / county.
ShipCityKana	String	False		Destination city / county phonetic.
ShipAddress1	String	False		Destination address 1.
ShipAddress1Kana	String	False		Destination address 1 phonetic.
ShipAddress2	String	False		Destination address 2.
ShipAddress2Kana	String	False		Destination address 2 phonetic.
ShipPhoneNumber	String	False		Destination telephone number.
ShipEmgPhoneNumber	String	False		Destination telephone number (urgent).
ShipSection1Field	String	False		Addressee affiliation 1 Field name.
ShipSection1Value	String	False		Addressee affiliation 1 input information.
ShipSection2Field	String	False		Addressee affiliation 2 Field name.
ShipSection2Value	String	False		Addressee affiliation 2 input information.
OperationUser	String	False		It is the registered name of Yahoo! JAPAN business ID who carried out update work.
YamatoCoopStatus	Integer	True		It is a status that shows the current status of the link to Yamato Transport. 使用できる値は次のとおりです。0, 1, 2, 3, 4
CollectionDate	Date	True		The date when Yamato Transport collected the cargo.
CashOnDeliveryTax	Integer	False		The tax amount for the delivery payments.
NumberUnitsShipped	Integer	True		The number of packages sent by Yamato Transport.
ShipRequestTimeZoneCode	Integer	True		Preferred delivery time zone number. Blank if not specified, 101: Morning (8:00 to 12:00), 102: 14:00 to 16:00, 103: 16:00 to 18:00, 104: 18:00 to 20:00, 105: 19:00 to 21:00. 使用できる値は次のとおりです。101, 102, 103, 104, 105
ShipInstructType	Integer	True		The used delivery service category. 1: Direct cooperation, 2: Via couriers, 101: Yamato P & D. 使用できる値は次のとおりです。1, 2, 101
ShipInstructStatus	Integer	True		The status of orders in Yamatopic & Delivery. 0: Not applicable, 100: Shipping instruction not yet accepted, 101: Waiting for shipping instruction, 102: Cancelled shipping, 103: Shipping instruction completed. 104: Shipping completed, 105: Delivery completed, 106: Undeliverable. 使用できる値は次のとおりです。0, 101, 102, 103, 104, 105, 106
IsEazy	Boolean	True		It is an Order Flag.

Return the list of options for the specified product.

Select

The Sync App will use the Yahoo Shopping API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

• ItemCode and/or SellerId support the = operator.

For example, the following queries are processed server side:

SELECT * FROM ProductOptions WHERE ItemCode = 'CD001'

SELECT * FROM ProductOptions WHERE ItemCode = 'CD001' AND SellerId = 'store' 

Insert

ItemCode, Name, SpecName are required for an Insert

INSERT INTO ProductOptions (Name, SpecId, SpecName, SpecValue, ItemCode) VALUES ('optionName', '1234', 'optionSpecificationName', '3456', 'CD000001') 

Update

Yahoo Shopping allows updates for the Name, SpecId, SpecValue, SpecName columns. OptionValueId is required. This is a composite key containing the option name and the option specification value.

UPDATE [ProductOptions] SET Name = 'SizeRename', SpecId = '123', SpecName = 'Medium', SpecValue = '234' WHERE OptionValueId = 'Size|Small' AND ItemCode = 'CD000001'

Delete

A product option can be deleted by providing the ItemCode and OptionValueId and issuing a DELETE statement

DELETE FROM ProductOptions WHERE ItemCode = 'CD000001' AND OptionValueId = 'SizeRename|Medium' 

Columns

Name	Type	ReadOnly	References	Description
ItemCode [KEY]	String	False		Product code
SellerId	String	False		Id of the seller.
OptionValueId [KEY]	String	True		Id of the option value.
Type	Integer	True		Option type 1: Normal option (with inventory setting), 2: Normal option (no inventory setting). 使用できる値は次のとおりです。1, 2
Name	String	False		Option name.
SpecId	String	False		Option spec ID.
Length	String	True		Option length.
SpecValue	String	False		Specification value of option value.
SpecName	String	False		Specification name of option value.

Return the list of registered products of your store.

Select

The Sync App will use the Yahoo Shopping API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

• StoreCategoryKey and/or SellerId support the = operator.
• ItemCode supports the =, LIKE operator.
• Name supports the LIKE operator.

For example, the following queries are processed server side:

SELECT * FROM Products WHERE StoreCategoryKey = 'category_key'

SELECT * FROM Products WHERE ItemCode = 'CD001' AND SellerId = 'store' 

SELECT * FROM Products WHERE Name LIKE '%prod_name%'

Insert

To add a product you specify the ItemCode (required), Name, Path, ProductCategory, Price, SalePrice, OriginalPrice, MemberPrice, ReleaseDate, display, Headline, Caption ,Abstract, Explanation, Additional1, Additional2, Additional3, SpAdditional, ShipWeight, Taxable, PointCode, MetaDesc, HiddenPageFlag, TemplateName, SaleLimit, BrandCode, ProductCode, JanCode, Delivery, Condition, Options, Subcodes, PostageSet columns.

INSERT INTO Products (Name, ItemCode, Price, SalePrice, MemberPrice, SalePeriodEnd, SalePeriodStart, Display )  VALUES ('productName1', 'CD0001', 5000, 4000, 3000, '2018-06-25T03:00:00.000+02:00', '2018-05-25T03:00:00.000+02:00', 0)

Update

Yahoo Shopping allows updates for the Name, Path, ProductCategory, Price, SalePrice, OriginalPrice, MemberPrice, ReleaseDate, display, Headline, Caption ,Abstract, Explanation, Additional1, Additional2, Additional3, SpAdditional, ShipWeight, Taxable, PointCode, MetaDesc, HiddenPageFlag, TemplateName, SaleLimit, BrandCode, ProductCode, JanCode, Delivery, Condition, Options, Subcodes, PostageSet columns.

Update Products SET Name = 'ProductName', Path = 'CategoryPage:SubCategory', ProductCategory = '12345', Price = 110 , SalePrice = 109, OiginalPrice = 111 , MemberPrice = 108 , ReleaseDate = '2013-06-25T03:00:00.000+02:00', display = 1 ,Headline = ' headline text', Caption = 'tset caption', Abstract = 'sample Abstract', Explanation = 'sample Explanation', Additional1 = 'sample Additional1', Additional2 = 'sample Additional2' , Additional3 = 'sample Additional3', SpAdditional = 'sample SpAdditional', ShipWeight = 234, Taxable = 0, PointCode = 'D05' , MetaDesc = 'sample MetaDesc', HiddenPageFlag = '0' , TemplateName = 'IT02', SaleLimit = 100, BrandCode = '12312', ProductCode ='04-7282' , JanCode = '4971275472819' , Delivery = 3, Condition= 0, PostageSet = 0 WHERE ItemCode = 'CD001' 

Update Products SET Options = '<Options><Option type = \"2\" name = \"Color\" specId = \"123\"> <Value specValue = \"23\" name = \"Red\"/> <Value specValue = \"34\" name = \"Blue\"/> </Option><Option type = \"1\" name = \"Size\" specId = \"24181\"> <Value specValue = \"210764\" name = \"Large\"/> </Option></Options>', SubCodes = ' <SubCodes> <SubCode code = \"21342\" quantity = \"\" stockClose = \"0\"> <Option name = \"Size\" value = \"Large\"/> <Option name = \"Color\" value = \"Blue\"/> <LeadTimeInStock>4000</LeadTimeInStock> <LeadTimeOutStock>2000</LeadTimeOutStock> </SubCode> <SubCode code = \"211342\" quantity = \"\" stockClose = \"0\"> <Option name = \"Size\" value = \"Large\"/> <Option name = \"Color\" value = \"Red\"/> <LeadTimeInStock></LeadTimeInStock> <LeadTimeOutStock></LeadTimeOutStock> </SubCode> </SubCodes>' WHERE ItemCode = 'CD001' 

Upsert

Yahoo Shopping allows upsert for the Name, Path, Price, SalePrice, OriginalPrice, MemberPrice, ReleaseDate, display, Headline, Caption ,Abstract, Explanation, Additional1, Additional2, Additional3, SpAdditional, ShipWeight, Taxable, PointCode, MetaDesc, HiddenPageFlag, TemplateName, SaleLimit, BrandCode, ProductCode, JanCode, Delivery, Condition columns.

UPSERT INTO Products (Name, ItemCode, Path, Price) VALUES ('someName', 'CD0001', 'CategoryPage:SubCategory', 110)

Batch Update

Yahoo Shopping allows batch updates for Name, OriginalPrice, Price, SalePrice, MemberPrice, SalePeriodEnd, SalePeriodStart and Display columns.

INSERT INTO Products#TEMP (Name, ItemCode, Price, SalePrice, MemberPrice, SalePeriodEnd, SalePeriodStart, Display ) VALUES ('productName1', 'CD0001', 5000, 4000, 3000, '2018-06-25T03:00:00.000+02:00', '2018-05-25T03:00:00.000+02:00', 0)

INSERT INTO Products#TEMP (Name, ItemCode, Price, SalePrice, MemberPrice, SalePeriodEnd, SalePeriodStart, Display ) VALUES ('productName2', 'CD0002', 6000, 5000, 2000, '2018-07-25T03:00:00.000+02:00', '2018-06-25T03:00:00.000+02:00', 1)

UPDATE Products SET (Name, ItemCode, Price, SalePrice, MemberPrice, SalePeriodEnd, SalePeriodStart, Display ) SELECT Name, ItemCode, Price, SalePrice, MemberPrice, SalePeriodEnd, SalePeriodStart, Display  FROM [Products#TEMP]

Delete

A product be deleted by providing the ItemCode and issuing a DELETE statement

DELETE FROM Products WHERE ItemCode = 'CD000001'

Batch Delete

Several products be deleted by providing the ItemCodes and issuing a DELETE statement

INSERT INTO DeleteProducts#TEMP (ItemCode) VALUES ('CD000001')

INSERT INTO DeleteProducts#TEMP (ItemCode) VALUES ('CD000002')

DELETE FROM Products WHERE EXISTS (SELECT ItemCode FROM DeleteProducts#TEMP)

Columns

Name	Type	ReadOnly	References	Description
ItemCode [KEY]	String	False		Product code.
HasSubcode	Integer	True		With subcode. 1: With subcode, 0: No subcode code 使用できる値は次のとおりです。0, 1
SellerId	String	False		ID of the store account.
Name	String	False		The name of the product.
ProductCategory	String	False		Product category ID.
StoreCategoryName	String	True		The page name of the store category.
Path	String	False		The path of the store category. (Category names separated by colon).
Price	Integer	False		Regular selling price.
SalePrice	Integer	False		Special price.
OriginalPrice	Integer	False		List price.
OriginalPriceEvidence	String	True		Evidence URL.
MemberPrice	Integer	False		Price for members.
SalePeriodStart	Datetime	False		Sales start date and time.
SalePeriodEnd	Datetime	False		End of sale date.
SortOrder	Integer	True		Product display order under store category.
SortPriority	Integer	True		Product display priority order under store category.
Quantity	Integer	True		Inventory (There are items only when stock = true request is specified.).
Display	Integer	False		Page release. 1: Public, 0: Not Disclosed. 使用できる値は次のとおりです。0, 1
EditingFlag	Integer	True		Edit flag. 1: A state that has not been reflected at the front since being edited, 0: Reflected. 使用できる値は次のとおりです。0, 1
Headline	String	False		Catch copy.
Caption	String	False		Product Description.
Abstract	String	False		One word comment.
Explanation	String	False		Product information.
Additional1	String	False		Free space 1.
Additional2	String	False		Free space 2.
Additional3	String	False		Free space 3.
SpAdditional	String	False		Free space for smartphone.
RelevantLinks	String	False		Recommended product information.
CartRelatedItems	String	False		Recommended related item information.
TaxRateType	Decimal	False		Recommended related item information. 使用できる値は次のとおりです。0.1, 0.8
ShipWeight	Integer	False		Product weight.
Taxable	Integer	False		Tax object. 1: Taxation , 0: Tax exemption. 使用できる値は次のとおりです。0, 1
TaxrateType	Decimal	False		Tax rate object. 使用できる値は次のとおりです。0.1, 0.08
ReleaseDate	Date	False		Release date.
PointCode	String	False		Point magnification code.
MetaKey	String	True		META keywords.
MetaDesc	String	False		META description .
HiddenPage	String	True		Hidden page information.
HiddenPageFlag	String	False		Hidden page flag. 0: Normal, 1: Hidden page. 使用できる値は次のとおりです。0, 1
HiddenPageId	String	True		Hidden page ID.
HiddenPagePassword	String	True		Password for hidden pages.
TemplateId	String	True		Design template ID.
TemplateName	String	False		Design template name.
SaleLimit	Integer	False		Purchase limit.
SpCode	String	False		Promotional code.
BrandCode	String	False		Brand code.
ProductCode	String	False		Product Code.
JanCode	String	False		Japanese Article Number Code.
Delivery	Integer	False		Free shipping set. 0: None, 1: Free shipping, 2: Including shipping fee ( Because shipping costs are treated as free shipping, it will be saved as 1 if 2 is specified), 3: Conditional shipping free. 使用できる値は次のとおりです。0, 1, 2, 3
Image	String	True		URL of product preview image.
LibImage1	String	True		Product details URL of preview image 1.
LibImage2	String	True		Product details URL of preview image 2.
LibImage3	String	True		Product details URL of preview image 3.
LibImage4	String	True		Product details URL of preview image 4.
LibImage5	String	True		Product details URL of preview image 5.
LibImage6	String	True		Product details URL of preview image 6.
LibImage7	String	True		Product details URL of preview image 7.
LibImage8	String	True		Product details URL of preview image 8.
LibImage9	String	True		Product details URL of preview image 9.
LibImage10	String	True		Product details URL of preview image 10.
LibImage11	String	True		Product details URL of preview image 11.
LibImage12	String	True		Product details URL of preview image 12.
LibImage13	String	True		Product details URL of preview image 13.
LibImage14	String	True		Product details URL of preview image 14.
LibImage15	String	True		Product details URL of preview image 15.
LibImage16	String	True		Product details URL of preview image 16.
LibImage17	String	True		Product details URL of preview image 17.
LibImage18	String	True		Product details URL of preview image 18.
LibImage19	String	True		Product details URL of preview image 19.
LibImage20	String	True		Product details URL of preview image 20.
AstkCode	Integer	False		Chiku/Misuzu code. 0: Non-compliant, 1: Matsuku, 2: Kokutsuku. 使用できる値は次のとおりです。0, 1, 2
Condition	Integer	False		State of goods. 0: New article, 1: Used. 使用できる値は次のとおりです。0, 1
Spec1Id	Integer	True		Specification 1: Spec ID.
Spec1Name	String	True		Specification 1: Display name of spec.
Spec1Value	String	True		Specification 1: Specification value ID.
Spec1ValueName	String	True		Specification 1: Display name of spec value.
Spec2Id	Integer	True		Specification 2: Spec ID.
Spec2Name	String	True		Specification 2: Display name of spec.
Spec2Value	String	True		Specification 2: Specification value ID.
Spec2ValueName	String	True		Specification 2: Display name of spec value.
Spec3Id	Integer	True		Specification 3: Spec ID.
Spec3Name	String	True		Specification 3: Display name of spec.
Spec3Value	String	True		Specification 3: Specification value ID.
Spec3ValueName	String	True		Specification 3: Display name of spec value.
Spec4Id	Integer	True		Specification 4: Spec ID.
Spec4Name	String	True		Specification 4: Display name of spec.
Spec4Value	String	True		Specification 4: Specification value ID.
Spec4ValueName	String	True		Specification 4: Display name of spec value.
Spec5Id	Integer	True		Specification 5: Spec ID.
Spec5Name	String	True		Specification 5: Display name of spec.
Spec5Value	String	True		Specification 5: Specification value ID.
Spec5ValueName	String	True		Specification 5: Display name of spec value.
Spec6Id	Integer	True		Specification 6: Spec ID.
Spec6Name	String	True		Specification 6: Display name of spec.
Spec6Value	String	True		Specification 6: Specification value ID.
Spec6ValueName	String	True		Specification 6: Display name of spec value.
Spec7Id	Integer	True		Specification 7: Spec ID.
Spec7Name	String	True		Specification 7: Display name of spec.
Spec7Value	String	True		Specification 7: Specification value ID.
Spec7ValueName	String	True		Specification 7: Display name of spec value.
Spec8Id	Integer	True		Specification 8: Spec ID.
Spec8Name	String	True		Specification 8: Display name of spec.
Spec8Value	String	True		Specification 8: Specification value ID.
Spec8ValueName	String	True		Specification 8: Display name of spec value.
Spec9Id	Integer	True		Specification 9: Spec ID.
Spec9Name	String	True		Specification 9: Display name of spec.
Spec9Value	String	True		Specification 9: Specification value ID.
Spec9ValueName	String	True		Specification 9: Display name of spec value.
Spec10Id	Integer	True		Specification 10: Spec ID.
Spec10Name	String	True		Specification 10: Display name of spec.
Spec10Value	String	True		Specification 10: Specification value ID.
Spec10ValueName	String	True		Specification 10: Display name of spec value.
Options	String	False		Option information .
Inscriptions	String	False		Inclusion information .
SubCodes	String	False		Individual product code information.
ShowStock	Integer	True		Inventory display setting (product individual setting). 1: Stock number display, 2: Stock display.
UpdateTime	Datetime	True		Update date.
LeadTimeInStock	Datetime	False		Shipping date information management number when stocked.
LeadTimeOutStock	Datetime	False		Shipment date information management number when out of stock.
KeepStock	Integer	False		Set at the time of cancellation from the orderer, set the stock back. 0: Do not take, stock at the time of cancellation, 1: Return stock at the time of cancellation (Initial value).
StockClose	Integer	True		Stock Close Flag. 0: Normal State, 1: Stock Closed State, Empty: Subcode Exists. 使用できる値は次のとおりです。0, 1
StoreCategoryKey	String	True	Categories.PageKey	The page key of the store category.
PostageSet	Integer	False		Delivery group management number tied to the product, values 1-20. 使用できる値は次のとおりです。1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20
PickAndDeliveryCode	String	False		Barcode information.
PickAndDeliveryTransportRuleType	Integer	False		使用できる値は次のとおりです。0, 1, 2, 3, 4, 5
EcoSettingId	String	False		This column indicates the environmental label name (1 to 100) or the eco keyword name (101 and above).
EcoSettingEvidenceUrl	String	False		This column indicates the environmental label/eco keyword evidence URL.

Return the list of options for the specified product.

Select

The Sync App will use the Yahoo Shopping API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

• ItemCode and/or SellerId support the = operator.

For example, the following queries are processed server side:

SELECT * FROM ProductSubcodes WHERE ItemCode = 'CD001'

SELECT * FROM ProductSubcodes WHERE ItemCode = 'CD001' AND SellerId = 'store' 

Insert

ItemCode, Code, OptionName, OptionValue are required for an Insert

INSERT INTO ProductSubcodes (Code, LeadTimeInStock, LeadTimeOutStock, OptionName, OptionValue, ItemCode) VALUES ('001', '1000', '4000', 'Color', 'Red', 'CD000001') 

Update

Yahoo Shopping allows updates for the Code, OptionName, OptionValue, LeadTimeInStock, LeadTimeOutStock columns. CodeOptionId is required. This is a composite key containing the subcode code and the option name.

UPDATE [ProductSubcodes] SET Code = '002', LeadTimeInStock = '2000', LeadTimeOutStock = '4000', OptionName = 'Size', OptionValue = 'Small' WHERE CodeOptionId = '001|Color' AND ItemCode = 'CD000001'

Delete

A product subcode can be deleted by providing the ItemCode and CodeOptionId and issuing a DELETE statement

DELETE FROM ProductSubcodes WHERE ItemCode = 'CD000001' AND CodeOptionId = '002|Color' 

Columns

Name	Type	ReadOnly	References	Description
ItemCode [KEY]	String	True		Product code
SellerId	String	True		Id of the seller.
CodeOptionId [KEY]	String	True		Id of the subcode option.
Code	String	False		Individual product code.
Quantity	Integer	True		Subcode quantity.
StockClose	Integer	True		Subcode stock close indicator.
OptionName	String	False		Option name.
OptionValue	String	False		Option value.
LeadTimeInStock	String	False		Inventory ship date value.
LeadTimeOutStock	String	False		Out of stock value of shipment date.

ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。

クエリは、ビューに対して通常のテーブルと同様に実行することができます。

Yahoo Shopping Connector for CData Sync ビュー

Name	Description
Categories	Retrieve the list of store categories.
ItemImageList	List of the uploaded product images.
OrderChangeHistory	Provides update history information for a single order.
OrderCount	Acquire the number of new orders and new pre-order orders.
OrderLineItemDetails	Returns detailed data for each Order Line Item.
OrderLineItemInscriptions	Returns data from a sample table.
OrderLineItemOptions	Returns data from a sample table.

Retrieve the list of store categories.

Select

The Sync App will use the Yahoo Shopping API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

• PageKey and SellerId support the = operator.

For example, the following queries are processed server side:

SELECT * FROM Categories WHERE PageKey = 'key' 

Columns

Name	Type	References	Description
PageKey [KEY]	String		Product code.
SellerId	String		Seller ID.
Name	String		The name of the product.
HiddenPageFlag	Integer		Hidden page flag. 0: normal page, 1: hidden page.
SortOrder	String		Child store category display order within designated store category.
EditingFlag	Integer		Edit flag. 0: Reflected, 1: State not reflected at the front after being edited.
UpdateTime	Datetime		Update date.

List of the uploaded product images.

Select

The Sync App will use the Yahoo Shopping API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

• SearchTerm, StoreCategoryKey and SellerId support the = operator.

For example, the following queries are processed server side:

SELECT * FROM ItemImageList WHERE SearchTerm = 'img' 

SELECT * FROM ItemImageList WHERE StoreCategoryKey = 'store_category' 

Columns

Name	Type	References	Description
Id [KEY]	String		Product image identifier.
SellerId	String		Seller Id.
SearchTerm	String		Specify search word when performing character search on image name (Partial Match).If you specify more than one space, it will be an AND search.
StoreCategoryKey	String	Categories.PageKey	When acquiring the image list by store category unit, specify the page key of the store category.
Name	String		Image ID (store account _ character string excluding extension of image name)
UrlModeA	String		URL for A image display mode.
UrlModeB	String		URL for B image display mode.
UrlModeC	String		URL for C image display mode.
UrlModeD	String		URL for D image display mode.
UrlModeE	String		URL for E image display mode.
UrlModeF	String		URL for F image display mode.
UrlModeG	String		URL for G image display mode.
UrlModeH	String		URL for H image display mode.
UrlModeI	String		URL for I image display mode.
UrlModeJ	String		URL for J image display mode.
UrlModeK	String		URL for K image display mode.
UrlModeL	String		URL for L image display mode.
Size	String		Horizontal size of original image.
FileSize	Long		File size of original image (bytes).
UploadDate	Datetime		Update date.
PublishDate	Datetime		Reflection date.
EditingFlag	Integer		Edit flag 0: Reflected 1: State not reflected at the front after being edited.

Provides update history information for a single order.

Select

The Sync App will use the Yahoo Shopping API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

• OrderID and SellerId support the = operator.

For example, the following queries are processed server side:

SELECT * FROM OrderChangeHistory WHERE OrderID = 'store_00001' 

Columns

Name	Type	References	Description
OrderId [KEY]	String	Orders.OrderId	Order ID.
SellerId	String		Store account
UpdateTime	Datetime		Update date and time.
UpdatePerson	String		Updater (one of the following will be included): Name of worker associated with Yahoo! JAPAN business ID, Yahoo! JAPAN Business ID, Yahoo! JAPAN ID, system.
ChangeField	String		Changed field.
ChangeValue	String		Changed value.
ChangeItemLineId	String		Changed Line Id.

Acquire the number of new orders and new pre-order orders.

Select

The Sync App will use the Yahoo Shopping API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

• SellerId supports the = operator.

For example, the following queries are processed server side:

SELECT * FROM OrderCount WHERE SellerId = 'store' 

Columns

Name	Type	References	Description
SellerId [KEY]	String		Specify the store account.
NewOrder	Integer		New order number (order details unread number).
NewReserve	Integer		Number of new reservations.
WaitPayment	Integer		Number of queue waiting.
WaitShipping	Integer		Number of items waiting for shipment.
Shipping	Integer		Number of shipping processes.
Reserve	Integer		Number of reservations.
Holding	Integer		Number of holds.
WaitDone	Integer		Order completion wait count.
Suspect	Integer		Number of mischievous orders.
SettleError	Integer		Number of settlement errors.
Refund	Integer		Number of refundable items.
AutoDone	Integer		Auto orders completed.
AutoWorking	Integer		Automatic order hold cancel count.
Release	Integer		Number of scheduled release orders.
NoPayNumber	Integer		Payment number not issued.
StoreStatus1	Integer		Store status 1 number.
StoreStatus2	Integer		Store status 2 number.
StoreStatus3	Integer		Store status 3 number.
StoreStatus4	Integer		Store status 4 number.
StoreStatus5	Integer		Store status 5 number.
StoreStatus6	Integer		Store status 6 number.
StoreStatus7	Integer		Store status 7 number.
StoreStatus8	Integer		Store status 8 number.
StoreStatus9	Integer		Store status 9 number.
StoreStatus10	Integer		Store status 10 number.

Returns detailed data for each Order Line Item.

Columns

Name	Type	References	Description
OrderId [KEY]	String	Orders.OrderId	Order ID.
Line_LineId [KEY]	Integer		Product line ID.
ItemId	String		Product ID.
SellerId	String		Store account ID.
OrderTime	Datetime		The date and time when the order was made.
OperationUser	String		It is the registered name of Yahoo! JAPAN business ID who carried out update work.
OrderStatus	Integer		Status of the order. 1: During reservation, 2: In process, 3: Hold, 4: Cancel, 5: Completed. 使用できる値は次のとおりです。0, 1, 2, 3, 4, 5, 8
CancelReason	Integer		Cancellation reason: Order Cancellation - 100: Cancel, 110: Returned Item, 120: Not Received, 130: Address Unknown, 140: Receiving Refused, 150: No Connection, 160: Duplicate Order, 170: Payment Unavailable, 180: Other, 300: Mistakenly Ordered, 310: Customer Using Points They Forgot to Use, 320: Customer Using Coupon They Forgot to Use, 330: Customer Found Cheaper Price, 340: Shipping Cost Too High, 350: Change of Shipping Destination, 360: Change of Shipping Method, 370: Change of Payment Method, 380: Credit Card Not Available, | Store convenience - 200: Settlement Method Convenience, 210: Missing Item, 220: Discontinued, 230: Other | Other - 0: Cancel reason n/a System cancellation | blank: Order not canceled.
CancelReasonDetail	String		The reason why the store has entered a cancellation reason when the reason is Store Convenience 230 (Other)
ParentOrderId	String		The splitting order ID when an order is split.
ChildOrderId	String		The second splitting order ID when an order is split.
MobileCarrierName	String		The type of mobile carrier.
NeedSnl	Boolean		Store newsletter opt-in flag.
LastUpdateTime	Datetime		The last modification date of order information.
SuspectMessage	String		A message when an order is judged as mischievous.0: Non-naughty order, 1: Mischievous order, 2: Mischievious canceled order.
SendConfirmTime	Datetime		The date and time of sending the order confirmation email sent when the order is newly entered.
SendPayTime	Datetime		The mail transmission date sent at the time of settlement.
PrintSlipTime	Datetime		The date and time when the order slip was output.
PrintDeliveryTime	Datetime		The date and time when we output the invoice.
PrintBillTime	Datetime		The date and time when the invoice was output.
BuyerComments	String		The comment string displayed by the buyer.
SellerComments	String		The comment string displayed by the store in the store.
Notes	String		A memo in the store when the store is entered with the order management tool.
Referer	String		Referrer information covering domain, search keywords, etc.
EntryPoint	String		The URL of the store page where the buyer entered the target store.
HistoryId	String		An ID that manages the update history of orders.
UsageId	String		The coupon usage ID.
UseCouponData	String		Detailed information on the coupon information.
TotalCouponDiscount	Integer		Of the amount discounted by the store coupon of all the products associated with one order, this becomes the discount total value other than the shipping fee.
ShippingCouponFlg	Integer		Free shipping availability. 0: None, 1: Present.
ShippingCouponDiscount	Integer		It is the discount amount of the carriage when applying free shipping coupons.
CampaignPoints	String		Comma separated list of breakdown points.
IsMultiShip	Boolean		Indicates if there is a multiple shipping order.
MultiShipId	String		ID that identifies multiple delivery orders.
YamatoCoopStatus	Integer		Caution: Yamato Topic and Delivery Dedicated Item This status indicates the current state of cooperation with Yamato Transport. Only [3: Linked] will be the status that linked. 使用できる値は次のとおりです。0, 1, 2, 3, 4
FraudHoldStatus	Integer		0 or null: Low risk of fraud, 1: Rule pending review, 2: Release rule hold, 3: Rule abuse confirmed. 使用できる値は次のとおりです。0, 1, 2, 3
PublicationTime	Datetime		The time that can be obtained from the orderList, such as when the illegal hold is released, is set.
Shipping_CollectionDate	Date		The date when Yamato Transport collected the cargo.
Shipping_CashOnDeliveryTax	Integer		The tax amount for the delivery payments.
Shipping_NumberUnitsShipped	Integer		The number of packages sent by Yamato Transport.
Shipping_IsEazy	Boolean		It is an Order Flag.
Shipping_ShipRequestTimeZoneCode	Integer		Preferred delivery time zone number. Blank if not specified, 101: Morning (8:00 to 12:00), 102: 14:00 to 16:00, 103: 16:00 to 18:00, 104: 18:00 to 20:00, 105: 19:00 to 21:00. 使用できる値は次のとおりです。101, 102, 103, 104, 105
Shipping_ShipInstructType	Integer		The used delivery service category. 1: Direct cooperation, 2: Via couriers, 101: Yamato P & D. 使用できる値は次のとおりです。1, 2, 101
Shipping_ShipInstructStatus	Integer		The status of orders in Yamatopic & Delivery. 0: Not applicable, 100: Shipping instruction not yet accepted, 101: Waiting for shipping instruction, 102: Cancelled shipping, 103: Shipping instruction completed. 104: Shipping completed, 105: Delivery completed, 106: Undeliverable. 使用できる値は次のとおりです。0, 101, 102, 103, 104, 105, 106
Line_PickAndDeliveryCode	String		The bar code information required for delivery.
Line_PickAndDeliveryTransportRuleType	Integer		使用できる値は次のとおりです。0, 1, 2, 3, 4, 5
Line_YamatoUndeliverableReason	String		The reason why Yamato delivery is not possible.
Detail_PayCharge	Integer		The fee set by the store (cash on delivery commission etc.). The settlement fee of Yahoo! settlement is different.
Detail_ShipCharge	Integer		Shipping fee (postage free coupon discount after deduction).
Detail_GiftWrapCharge	Integer		Gift wrapping fee.
Detail_Discount	Integer		Discount. The value entered in the price discount column on the store creator Pro after the store side is entered.
Detail_Adjustments	Integer		Adjustment amount.
Detail_SettleAmount	Integer		The same value as the total amount (TotalPrice).
Detail_UsePoint	Integer		Number of points used.
Detail_TotalPrice	Integer		Subtotal - usage point + gift wrapping fee + fee - discount + postage + adjustment amount - mall coupon discount amount.
Detail_IsGetPointFixAll	Boolean		Indicates whether or not the process of finalizing the grant points of all lines (goods) has been completed.
Detail_TotalMallCouponDiscount	Integer		Indicates the total value of the amount discounted at the mall coupon.
Detail_SettlePayAmount	Integer		When the order is split, this will not reflect the split amount. The total amount will reflect this.
Detail_PayMethodAmount	Decimal		Billing address Affiliation 2 Input information.
Detail_CombinedPayMethodAmount	Decimal		Billing address Affiliation 2 Input information.
Detail_IsLogin	Boolean		Login order.
Detail_FspLicenseCode	String		For details on the star club, please see the following page. http://starclub.yahoo.co.jp/.
Detail_FspLicenseName	String		For details on the star club, please see the following page. http://starclub.yahoo.co.jp/.
Detail_GuestAuthId	String		Guest authorization Id for guest orders only.
Payment_PayStatus	Integer		Deposit status. 0: Waiting for payment, 1: Payment already made 使用できる値は次のとおりです。0, 1
Payment_SettleStatus	Integer		Settlement status. 1: Settlement application, 2: Waiting for payment, 3: Payment completion, 4: Waiting for payment, 5: Completion of settlement, 6: Cancel, 7: Refund, 8: Expired, 9: Payment application, 10: Authorization error, 11: Sales cancelled, 12: Suica address error. 使用できる値は次のとおりです。1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12
Payment_PayType	Integer		Payment classification. 0: Postpay, 1: Prepay. 使用できる値は次のとおりです。0, 1
Payment_PayKind	Integer		Payment type. 0: Card, 1: Internet banking, 2: Carrier settlement, 3: Transfer, 4: Cash on delivery, 5: Convenience store, 6: Electronic money 7: Other. 使用できる値は次のとおりです。0, 1, 2, 3, 4, 5, 6, 7
Payment_PayMethod	String		Payment method number. payment_a 1: Credit card payment, payment_a 6: Convenience store payment (7-Eleven), payment_a 7: Convenience store payment (Others), payment_a 8: Mobile Suica payment, payment_a 9: Docomo Mobile payment, payment_a 10: au Easy settlement, payment_a 11: Soft bank collectively payment, payment_a 15: Payee, payment_a 16: Yahoo Money / deposit payment, payment_b [1-6]: bank transfer (name is free setting of store), payment_c1: Japan Post Bank (prepayment), payment_c2: Japan Post Bank (postpay), payment_c3: registered mail, payment_d1: cash on delivery goods, payment_e [1-15 ]: Free payment method name of the store, payment_z1: Full payment of points.
Payment_PayMethodName	String		Payment method name.
Payment_SellerHandlingCharge	Integer		A settlement fee for the store's burden.
Payment_PayActionTime	Datetime		Purchase history detail screen It contains the payment update date and time.
Payment_PayDate	Date		The deposit date entered in the order management tool.
Payment_PayNotes	String		The contents of the remarks column of the deposit entered by the order management tool.
Payment_SettleId	String		Settlement ID.
Payment_CardBrand	String		In case of credit card it is the card brand name (VISA etc).
Payment_CardNumber	String		Only store of original merchant store contract is available. Encrypted character string information can be acquired.
Payment_CardNumberLast4	String		The last four digits of the credit card.
Payment_CardExpireYear	String		The expiration year of the card.
Payment_CardExpireMonth	String		The expiration month of the card.
Payment_CardPayType	Integer		Card payment classification. 1: Lump sum payment, 2: Bonus lump sum payment, 3: Ribbon payment, 4: Installment payment 使用できる値は次のとおりです。1, 2, 3, 4
Payment_CardHolderName	String		The name of the cardholder
Payment_CardPayCount	Integer		The number of payments in installments.
Payment_CardBirthDay	String		Card date of birth.
Payment_UseYahooCard	Boolean		Yahoo! JAPAN JCB Card Availability.
Payment_UseWallet	Boolean		Wallet availability.
Payment_NeedBillSlip	Boolean		Whether or not you wish to have an invoice when ordering entered by the purchaser.
Payment_NeedDetailedSlip	Boolean		The presence or absence of the requested statement when ordering entered by the purchaser.
Payment_NeedReceipt	Boolean		Whether there is a receipt at the time of ordering entered by the purchaser.
Payment_AgeConfirmField	String		The field name set by the store in the age confirmation field.
Payment_AgeConfirmValue	Integer		Age confirmation field numeric input.
Payment_AgeConfirmCheck	Boolean		If the box has been checked when there is an age check check box.
Payment_BillAddressFrom	String		Billing address. P: UDB home address, B: UDB work address, ship: same as the addressee, O1: others, O2: other, O3: other 3 O4: other 4 O: other input.
Payment_BillFirstName	String		Billing Name.
Payment_BillFirstNameKana	String		Billing name (phonetic).
Payment_BillLastName	String		Billing surname.
Payment_BillLastNameKana	String		Billing last name (phonetic).
Payment_BillZipCode	String		Billing Postal Code.
Payment_BillPrefecture	String		Billing address Prefecture In case of overseas 'Other' is entered.
Payment_BillPrefectureKana	String		Billing prefecture phonetic.
Payment_BillCity	String		Billing city / county.
Payment_BillCityKana	String		Billing County District Phonetic.
Payment_BillAddress1	String		Billing address 1.
Payment_BillAddress1Kana	String		Billing address 1 phonetic.
Payment_BillAddress2	String		Billing address 2.
Payment_BillAddress2Kana	String		Billing address 2 phonetic.
Payment_BillPhoneNumber	String		Billing telephone number.
Payment_BillEmgPhoneNumber	String		Billing telephone number (urgent).
Payment_BillMailAddress	String		Billing E-mail address.
Payment_BillSection1Field	String		Billing address Affiliation 1 Field name.
Payment_BillSection1Value	String		Billing address Affiliation 1 Input information.
Payment_BillSection2Field	String		Billing address Affiliation 2 Field name.
Payment_BillSection2Value	String		Billing address Affiliation 2 Input information.
Payment_CombinedPayType	Integer		Billing address Affiliation 2 Input information.
Payment_CombinedPayKind	Integer		Billing address Affiliation 2 Input information.
Payment_CombinedPayMethod	String		Billing address Affiliation 2 Input information.
Payment_CombinedPayMethodName	String		Billing address Affiliation 2 Input information.
Payment_PayNo	String		Payment number.
Payment_PayNoIssueDate	Datetime		Payment number issue date / time.
Payment_ConfirmNumber	String		Authorization number.
Payment_PaymentTerm	Datetime		Payment due date for convenience store payment, mobile Suica settlement, and payment settlement.
Payment_IsApplePay	Boolean		Availability of ApplePay.
Shipping_ShipStatus	Integer		Delivery status 0: Can not be shipped 1: Can be shipped 2: Shipping in progress 3: Shipped completed 4: Receiving completed. 使用できる値は次のとおりです。0, 1, 2, 3, 4
Shipping_ShipMethod	String		Delivery method number: any one of postage 1 - 14, 16.
Shipping_ShipMethodName	String		Delivery method name.
Shipping_ShipRequestDate	Date		Desired delivery day.
Shipping_ShipRequestTime	String		Delivery time desired.
Shipping_ShipNotes	String		Delivery note.
Shipping_ShipCompanyCode	String		Delivery company code 1000: Other 1001: Yamato Transport 1002: Sagawa Express 1003: Japan Post 1004: Seino Transportation.
Shipping_ShipInvoiceNumber1	String		Delivery slip number information of the shipping company that the store set with the tool or API.
Shipping_ShipInvoiceNumber2	String		Delivery slip number information of the shipping company that the store set with the tool or API.
Shipping_ShipInvoiceNumberEmptyReason	String		NULL: (Unregistered state) 101: For direct item from manufacturer's inventory 102: For goods that do not need shipping 103: For overseas receipt items 104: For direct contact from the delivery company 105: Document number Because it is not issued (can not be tracked) because of the delivery method.
Shipping_ShipUrl	String		Tracking URL of the shipping company that the store set with tools and APIs.
Shipping_ArriveType	Integer		Drinking 0: Normal 1 : School order 2: Matsutake order 使用できる値は次のとおりです。0, 1, 2
Shipping_ShipDate	Date		Shipment date entered.
Shipping_ArrivalDate	Date		It is the arrival date entered.
Shipping_NeedGiftWrap	Boolean		Presence or absence of gift wrapping.
Shipping_GiftWrapType	String		Gift wrapping type.
Shipping_GiftWrapMessage	String		Gift message.
Shipping_NeedGiftWrapPaper	Boolean		Whether or not.
Shipping_GiftWrapPaperType	String		Works type.
Shipping_GiftWrapName	String		Enter name (message).
Shipping_Option1Field	String		Option field Key information (field name).
Shipping_Option1Type	Integer		Option field Key information (setting).
Shipping_Option1Value	String		Option field Input contents.
Shipping_Option2Field	String		Option field Key information (field name).
Shipping_Option2Type	Integer		Option field Key information (setting).
Shipping_Option2Value	String		Option field Input contents.
Shipping_ShipFirstName	String		Destination name.
Shipping_ShipFirstNameKana	String		Destination name phonetic.
Shipping_ShipLastName	String		Destination surname.
Shipping_ShipLastNameKana	String		Destination surname phonetic.
Shipping_ShipPrefecture	String		Delivery destination Prefecture In case of overseas 'Other' is entered.
Shipping_ShipPrefectureKana	String		Destination prefecture phonetic.
Shipping_ShipZipCode	String		Delivery addressee postal code.
Shipping_ShipCity	String		Destination city / county.
Shipping_ShipCityKana	String		Destination city / county phonetic.
Shipping_ShipAddress1	String		Destination address 1.
Shipping_ShipAddress1Kana	String		Destination address 1 phonetic.
Shipping_ShipAddress2	String		Destination address 2.
Shipping_ShipAddress2Kana	String		Destination address 2 phonetic.
Shipping_ShipPhoneNumber	String		Destination telephone number.
Shipping_ShipEmgPhoneNumber	String		Destination telephone number (urgent).
Shipping_ShipSection1Field	String		Addressee affiliation 1 Field name.
Shipping_ShipSection1Value	String		Addressee affiliation 1 input information.
Shipping_ShipSection2Field	String		Addressee affiliation 2 Field name.
Shipping_ShipSection2Value	String		Addressee affiliation 2 input information.
Line_Title	String		Product title.
Line_SubCode	String		The subcode of the product when this value has been set.
Line_SubCodeOption	String		The subcode option when this value has been set. Both key & value.
Line_IsUsed	Boolean		Indicates whether it is a used item.
Line_ImageId	String		The product image ID.
Line_IsTaxable	Boolean		Tax object flag.
Line_Jan	String		Japanese Article Number code.
Line_ProductId	String		The product code (product number/model number).
Line_CategoryId	Integer		Category code.
Line_AffiliateRatio	String		Store burden rate.
Line_UnitPrice	Integer		Unit price of each item (amount after discount of store coupons) .
Line_ItemTaxRatio	Integer		Unit price of each item (amount after discount of store coupons) .
Line_Quantity	Integer		The quantity of each item.
Line_PointAvailQuantity	Integer		Points to be granted quantity.
Line_ReleaseDate	Date		Release date. This is only when there is input of release date. For release date bigger than order date, treat it as a pre-order.
Line_HaveReview	Boolean		Product review absence flag.
Line_PointFspCode	String		Point code by item. 10001 to 10015, 2001 to 20010.
Line_PointRatioY	Integer		Granted Point Magnification (Yahoo! JAPAN Burden).
Line_PointRatioSeller	Integer		Granted Point Magnification (Store Burden).
Line_UnitGetPoint	Integer		Number of credit points granted.
Line_IsGetPointFix	Boolean		Granted point determination flag.
Line_GetPointFixDate	Date		Granulation point determination date. After 14 days of order date, we will set the pre-order to 14 days after release date.
Line_CouponDiscount	Integer		Coupon discount amount.
Line_CouponUseNum	Integer		Number of applicable coupons.
Line_OriginalPrice	Integer		Unit price before discount.
Line_OriginalNum	Integer		Quantity before line splitting.
Line_LeadTimeStart	Date		Start of shipment date.
Line_LeadTimeEnd	Date		Shipment day end.
Line_LeadTimeText	String		Shipping date text.
Line_CouponData	String		Store coupons.
Line_ItemOption	String		Product options.
Line_Inscription	String		Inspections.
UseGiftCardData	String		Gift Card Data.
Detail_GiftCardDiscount	Integer		Amount of gift voucher used

Returns data from a sample table.

Columns

Name	Type	References	Description
OrderId [KEY]	String	Orders.OrderId	Order ID.
LineId [KEY]	Integer		Product line ID.
OrderTime	Datetime		The date and time when the order was made.
SellerId	String		Store account ID.
ItemId	String		Product ID.
InscriptionIndex	Integer		It is only when an item is set up for the item. Item Inscription Index.
InscriptionName	String		It is only when an item is set up for the item. Item Inscription Name.
InscriptionValue	String		It is only when an item is set up for the item. Item Inscription Value.

Returns data from a sample table.

Columns

Name	Type	References	Description
OrderId [KEY]	String	Orders.OrderId	Order ID.
LineId [KEY]	Integer		Product line ID.
OrderTime	Datetime		The date and time when the order was made.
SellerId	String		Store account ID.
ItemId	String		Product ID.
ItemOptionIndex	Integer		Item Option Index. This is only shown when product option is set.
ItemOptionName	String		Item Option Name. This is only shown when product option is set.
ItemOptionValue	String		Item Option Value. This is only shown when product option is set.

接続文字列プロパティは、接続を確立するために使用できるさまざまなオプションです。このセクションでは、本プロバイダーの接続文字列で設定できるオプションの一覧を示します。詳細については各リンクをクリックしてください。

接続を確立する方法について詳しくは、接続の確立を参照してください。

OAuth

---

プロパティ	説明
OAuthClientId	カスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。（コンシューマーキーとも呼ばれます。）このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。
OAuthClientSecret	カスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。（ コンシューマーシークレット とも呼ばれます。）このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。
SellerId	Store account ID.
UseSandbox	Specify if you are connecting to a test environment or a production account. Defaults to FALSE.
PublicKey	Set this to the public key shared by Yahoo Shopping.
PublicKeyVersion	Specify the version of the obtained public key from Yahoo Shopping.
PublicKeyType	The type of certificate store for this certificate.

SSL

---

プロパティ	説明
SSLClientCert	SSL クライアント認証（2-way SSL）のためのTLS/SSL クライアント証明書ストアを指定します。このプロパティは、他のSSL 関連プロパティと連動して、セキュアな接続を確立します。
SSLClientCertType	SSL クライアント認証用のTLS/SSL クライアント証明書を格納するキーストアの種類を指定します。プラットフォームや証明書のソースに応じて、さまざまなキーストア形式から選択できます。
SSLClientCertPassword	TLS/SSL クライアント証明書ストアにアクセスするために必要なパスワードを指定します。選択した証明書ストアの種類がアクセスにパスワードを必要とする場合、このプロパティを使用します。
SSLClientCertSubject	TLS/SSL クライアント証明書のサブジェクトを指定し、証明書ストアで場所を検索します。 CN=www.server.com, C=US のように、識別名フィールドのカンマ区切りのリストを使用します。ワイルドカード * は、ストアの先頭の証明書を選択します。
SSLServerCert	TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。

Firewall

---

プロパティ	説明
FirewallType	provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。
FirewallServer	ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。
FirewallPort	プロキシベースのファイアウォールで使用するTCP ポートを指定します。
FirewallUser	プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。
FirewallPassword	プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。

Proxy

---

プロパティ	説明
ProxyAutoDetect	provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。
ProxyServer	HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。
ProxyPort	クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバー（ProxyServer 接続プロパティで設定）のTCP ポート。
ProxyAuthScheme	ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。
ProxyUser	ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名。
ProxyPassword	ProxyUser 接続プロパティで指定されたユーザーに紐付けられたパスワード。
ProxySSLType	ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプ。
ProxyExceptions	ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

Logging

---

プロパティ	説明
LogModules	ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。

Schema

---

プロパティ	説明
Location	テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。
BrowsableSchemas	レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
Tables	レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。
Views	レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。

Miscellaneous

---

プロパティ	説明
MaxRows	集計やGROUP BY を使用しないクエリで返される最大行数を指定します。
Other	特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。
PageSize	The number of results to return per page of data retrieved from the server.
PseudoColumns	テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。
Timeout	provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。
UserDefinedViews	カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。

このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。

---

プロパティ	説明
OAuthClientId	カスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。（コンシューマーキーとも呼ばれます。）このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。
OAuthClientSecret	カスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。（ コンシューマーシークレット とも呼ばれます。）このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。
SellerId	Store account ID.
UseSandbox	Specify if you are connecting to a test environment or a production account. Defaults to FALSE.
PublicKey	Set this to the public key shared by Yahoo Shopping.
PublicKeyVersion	Specify the version of the obtained public key from Yahoo Shopping.
PublicKeyType	The type of certificate store for this certificate.

カスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。（コンシューマーキーとも呼ばれます。）このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。

解説

OAuthClientId は、ユーザーがOAuth 経由で認証を行う前に設定する必要があるいくつかの接続パラメータの1つです。詳細は接続の確立を参照してください。

カスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。（ コンシューマーシークレット とも呼ばれます。）このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。

解説

OAuthClientSecret は、ユーザーがOAuth 経由で認証を行う前に設定する必要があるいくつかの接続パラメータの1つです。詳細は接続の確立を参照してください。

Store account ID.

解説

Store account ID.

Specify if you are connecting to a test environment or a production account. Defaults to FALSE.

解説

The property will default to FALSE, in case you are connection to a test environment, set this to TRUE.

Set this to the public key shared by Yahoo Shopping.

解説

Either BLOB or key file can be set and the type of the key should be set in PublicKeyType. Please check the following page for the pubblic key details. Store Creator Pro > Settings > Encryption Key Management

Specify the version of the obtained public key from Yahoo Shopping.

解説

Specify the version of the obtained public key from Yahoo Shopping.

The type of certificate store for this certificate.

解説

This property can take one of the following values:

PUBLIC_KEY_FILE	The Public Key is the name of a file that contains a PEM- or DER-encoded public key certificate.
PUBLIC_KEY_BLOB	The Public Key is a string (base-64-encoded) that contains a PEM- or DER-encoded public key certificate.

このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。

---

プロパティ	説明
SSLClientCert	SSL クライアント認証（2-way SSL）のためのTLS/SSL クライアント証明書ストアを指定します。このプロパティは、他のSSL 関連プロパティと連動して、セキュアな接続を確立します。
SSLClientCertType	SSL クライアント認証用のTLS/SSL クライアント証明書を格納するキーストアの種類を指定します。プラットフォームや証明書のソースに応じて、さまざまなキーストア形式から選択できます。
SSLClientCertPassword	TLS/SSL クライアント証明書ストアにアクセスするために必要なパスワードを指定します。選択した証明書ストアの種類がアクセスにパスワードを必要とする場合、このプロパティを使用します。
SSLClientCertSubject	TLS/SSL クライアント証明書のサブジェクトを指定し、証明書ストアで場所を検索します。 CN=www.server.com, C=US のように、識別名フィールドのカンマ区切りのリストを使用します。ワイルドカード * は、ストアの先頭の証明書を選択します。
SSLServerCert	TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。

SSL クライアント認証（2-way SSL）のためのTLS/SSL クライアント証明書ストアを指定します。このプロパティは、他のSSL 関連プロパティと連動して、セキュアな接続を確立します。

解説

このプロパティは、SSL クライアント認証のためのクライアント証明書ストアを指定します。 このプロパティは、証明書ストアの種類を定義するSSLClientCertType、およびパスワードで保護されたストア用のパスワードを指定するSSLClientCertPassword と一緒に使用します。 SSLClientCert が設定され、SSLClientCertSubject が設定されている場合、ドライバーは指定されたサブジェクトに一致する証明書を検索します。

証明書ストアの指定はプラットフォームによって異なります。 Windowsでは、証明書ストアはMY（個人証明書）などの名前で識別されますが、Java では、証明書ストアは通常、証明書とオプションの秘密キーを含むファイルです。

Windows の共通のユーザとシステム証明書ストアの指定は以下のとおりです。

MY	個人証明書と関連付けられた秘密キーを格納している証明書ストア。
CA	証明機関の証明書。
ROOT	ルート証明書。
SPC	ソフトウェア発行元証明書。

PFXFile タイプの場合、このプロパティをファイル名に設定します。PFXBlob タイプの場合は、このプロパティをPKCS12 形式のファイルのバイナリコンテンツに設定します。

SSL クライアント認証用のTLS/SSL クライアント証明書を格納するキーストアの種類を指定します。プラットフォームや証明書のソースに応じて、さまざまなキーストア形式から選択できます。

解説

このプロパティは、クライアント証明書を指定するために使用されるキーストアの形式と場所を決定します。 サポートされている値には、プラットフォーム固有およびユニバーサルなキーストア形式があります。 有効な値と使用方法は以下のとおりです。

USER - デフォルト	Windows の場合、現在のユーザーにより所有された証明書ストアであることを指定します。この種類はJava では利用できませんので注意してください。
MACHINE	Windows の場合、この証明書ストアがシステムストアであることを指定します。この種類はJava では利用できませんので注意してください。
PFXFILE	この証明書ストアは、証明書を含むPFX（PKCS12）ファイルの名前です。
PFXBLOB	この証明書ストアは、PFX（PKCS12）形式の証明書ストアを表すBase-64でエンコードされた文字列です。
JKSFILE	この証明書ストアは、証明書を含むJava key store（JKS）ファイルの名前です。この種類はJava でのみ利用できますので注意してください。
JKSBLOB	この証明書ストアは、Java key store（JKS）形式の証明書ストアを表すBase-64でエンコードされた文字列です。この種類はJava でのみ利用できますので注意してください。
PEMKEY_FILE	この証明書ストアは、秘密キーと任意の証明書を含むPEM でエンコードされたファイルの名前です。
PEMKEY_BLOB	この証明書ストアは、秘密キーと任意の証明書を含むBase-64でエンコードされた文字列です。
PUBLIC_KEY_FILE	この証明書ストアは、PEM またはDER でエンコードされた公開キーの証明書を含むファイルの名前です。
PUBLIC_KEY_BLOB	この証明書ストアは、PEM またはDER でエンコードされた公開キーの証明書を含むBase-64でエンコードされた文字列です。
SSHPUBLIC_KEY_FILE	この証明書ストアは、SSH 公開キーを含むファイルの名前です。
SSHPUBLIC_KEY_BLOB	この証明書ストアは、SSH 公開キーを含むBase-64でエンコードされた文字列です。
P7BFILE	この証明書ストアは、証明書を含むPKCS7 ファイルの名前です。
PPKFILE	この証明書ストアは、PuTTY 秘密キー（PPK）を含むファイルの名前です。
XMLFILE	この証明書ストアは、XML 形式の証明書を含むファイルの名前です。
XMLBLOB	この証明書ストアは、XML 形式の証明書を含む文字列の名前です。
BCFKSFILE	この証明書ストアは、Bouncy Castle キーストアを含むファイルの名前です。
BCFKSBLOB	この証明書ストアは、Bouncy Castle キーストアを含む文字列（Base-64エンコード）です。

TLS/SSL クライアント証明書ストアにアクセスするために必要なパスワードを指定します。選択した証明書ストアの種類がアクセスにパスワードを必要とする場合、このプロパティを使用します。

解説

このプロパティは、パスワードで保護された証明書ストアを開くために必要なパスワードを指定します。 このプロパティは、PFX やJKS タイプのストアによく推奨されるように、復号化のためにパスワードを必要とする証明書ストアを使用する場合に必要です。

証明書ストアの種類がパスワードを必要としない場合（Windows のUSER やMACHINE など）、このプロパティは空白のままにできます。 認証エラーを回避するため、パスワードが指定された証明書ストアに関連付けられたものと一致していることを確認してください。

TLS/SSL クライアント証明書のサブジェクトを指定し、証明書ストアで場所を検索します。 CN=www.server.com, C=US のように、識別名フィールドのカンマ区切りのリストを使用します。ワイルドカード * は、ストアの先頭の証明書を選択します。

解説

このプロパティは、サブジェクトに基づいてロードするクライアント証明書を決定します。Sync App は、指定されたサブジェクトに完全に一致する証明書を検索します。 完全に一致するものが見つからない場合、Sync App はサブジェクトの値を含む証明書を検索します。 一致する証明書がない場合、証明書は選択されません。

サブジェクトは、識別名フィールドと値のカンマ区切りリストという標準の形式に従うべきです。 例えば、CN=www.server.com, OU=Test, C=US です。一般的なフィールドには以下のものが含まれます。

フィールド	説明
CN	共通名。一般的には、www.server.com のようなホスト名です。
O	法人名
OU	法人の部署名
L	法人の住所（市町村名）
S	法人の住所（都道府県）
C	国名
E	E メールアドレス

Note： フィールドにカンマなどの特殊文字が含まれている場合は、値を引用符で囲む必要があります。例：CN="Example, Inc.", C=US。

TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。

解説

TLS/SSL 接続を使用する場合は、このプロパティを使用して、サーバーが受け入れるTLS/SSL 証明書を指定できます。コンピュータによって信頼されていない他の証明書はすべて拒否されます。

このプロパティは、次のフォームを取ります：

説明	例
フルPEM 証明書（例では省略されています）	-----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
証明書を保有するローカルファイルへのパス。	C:\cert.cer
公開鍵（例では省略されています）	-----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
MD5 Thumbprint （hex 値はスペースおよびコロン区切り）	ecadbdda5a1529c58a1e9e09828d70e4
SHA1 Thumbprint （hex 値はスペースおよびコロン区切り）	34a929226ae0819f2ec14b4a3d904f801cbb150d

これを指定しない場合は、マシンが信用するすべての証明書が受け入れられます。

すべての証明書の受け入れを示すには、'*'を使用します。セキュリティ上の理由から、これはお勧めできません。

このセクションでは、本プロバイダーの接続文字列で設定可能なFirewall プロパティの全リストを提供します。

---

プロパティ	説明
FirewallType	provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。
FirewallServer	ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。
FirewallPort	プロキシベースのファイアウォールで使用するTCP ポートを指定します。
FirewallUser	プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。
FirewallPassword	プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。

provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。

解説

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

Note：デフォルトでは、Sync App はシステムプロキシに接続します。この動作を無効化し、次のプロキシタイプのいずれかに接続するには、ProxyAutoDetect をfalse に設定します。

次の表は、サポートされている各プロトコルのポート番号情報です。

プロトコル	デフォルトポート	説明
TUNNEL	80	Sync App がYahoo Shopping への接続を開くポート。トラフィックはこの場所のプロキシを経由して行き来します。
SOCKS4	1080	Sync App がYahoo Shopping への接続を開くポート。SOCKS 4 は次にFirewallUser 値をプロキシに渡し、接続リクエストが許容されるかどうかを決定します。
SOCKS5	1080	Sync App がYahoo Shopping にデータを送信するポート。SOCKS 5 プロキシに認証が必要な場合には、FirewallUser およびFirewallPassword をプロキシが認識する認証情報に設定します。

HTTP プロキシへの接続には、ProxyServer およびProxyPort ポートを使ってください。HTTP プロキシへの認証には、ProxyAuthScheme、ProxyUser、およびProxyPassword を使ってください。

ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。

解説

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

プロキシベースのファイアウォールで使用するTCP ポートを指定します。

解説

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。

解説

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。

解説

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

このセクションでは、本プロバイダーの接続文字列で設定可能なProxy プロパティの全リストを提供します。

---

プロパティ	説明
ProxyAutoDetect	provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。
ProxyServer	HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。
ProxyPort	クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバー（ProxyServer 接続プロパティで設定）のTCP ポート。
ProxyAuthScheme	ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。
ProxyUser	ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名。
ProxyPassword	ProxyUser 接続プロパティで指定されたユーザーに紐付けられたパスワード。
ProxySSLType	ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプ。
ProxyExceptions	ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。

解説

この接続プロパティをTrue に設定すると、Sync App は既存のプロキシサーバー構成についてシステムプロキシ設定をチェックします（プロキシサーバーの詳細を手動で入力する必要はありません）。

この接続プロパティは他のプロキシ設定より優先されます。特定のプロキシサーバーに接続するためにSync App を手動で構成する場合は、False に設定します。

HTTP プロキシへの接続には、ProxyServer を参照してください。SOCKS やトンネリングなどの他のプロキシには、FirewallType を参照してください。

HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。

解説

ProxyAutoDetect がFalse に設定されている場合、Sync App はこの接続プロパティで指定されたプロキシサーバーを通じてのみHTTP トラフィックをルーティングします。ProxyAutoDetect がTrue に設定されている場合（デフォルト）、Sync App は代わりにシステムプロキシ設定で指定されたプロキシサーバーを介してHTTP トラフィックをルーティングします。

クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバー（ProxyServer 接続プロパティで設定）のTCP ポート。

解説

ProxyAutoDetect がFalse に設定されている場合、Sync App はこの接続プロパティで指定されたプロキシサーバーポートを通じてのみHTTP トラフィックをルーティングします。ProxyAutoDetect がTrue に設定されている場合（デフォルト）、Sync App は代わりにシステムプロキシ設定で指定されたプロキシサーバーポートを介してHTTP トラフィックをルーティングします。

その他のプロキシタイプについては、FirewallType を参照してください。

ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。

解説

認証タイプは次のいずれかです。

• BASIC：Sync App はHTTP BASIC 認証を行います。
• DIGEST：Sync App はHTTP DIGEST 認証を行います。
• NTLM：Sync App はNTLM トークンを取得します。
• NEGOTIATE：Sync App は認証において有効なプロトコルに応じて、NTLM もしくはKerberos トークンを取得します。
• NONE：ProxyServer が認証を必要としない場合に設定します。

"NONE" 以外のすべての値については、ProxyUser およびProxyPassword 接続プロパティも設定する必要があります。

SOCKS 5 認証のような他の認証タイプを使用するには、FirewallType を参照してください。

ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名。

解説

ProxyUser および ProxyPassword 接続プロパティは、ProxyServer で指定されたHTTP プロキシに対して接続よび認証するために使用されます。

ProxyAuthScheme で利用可能な認証タイプを1つ選択した後、このプロパティを以下のように設定します。

ProxyAuthScheme の値	ProxyUser に設定する値
BASIC	プロキシサーバーに登録されているユーザーのユーザー名。
DIGEST	プロキシサーバーに登録されているユーザーのユーザー名。
NEGOTIATE	プロキシサーバーが属するドメインまたは信頼されたドメイン内の有効なユーザーであるWindows ユーザーのユーザー名。user@domain またはdomain\user の形式で指定。
NTLM	プロキシサーバーが属するドメインまたは信頼されたドメイン内の有効なユーザーであるWindows ユーザーのユーザー名。user@domain またはdomain\user の形式で指定。
NONE	ProxyPassword 接続プロパティは設定しないでください。

Sync App は、ProxyAutoDetect がFalse に設定されている場合にのみ、このユーザー名を使用します。ProxyAutoDetect がTrue に設定されている場合（デフォルト）、Sync App は代わりにシステムのプロキシ設定で指定されているユーザー名を使用します。

ProxyUser 接続プロパティで指定されたユーザーに紐付けられたパスワード。

解説

ProxyUser および ProxyPassword 接続プロパティは、ProxyServer で指定されたHTTP プロキシに対して接続よび認証するために使用されます。

ProxyAuthScheme で利用可能な認証タイプを1つ選択した後、このプロパティを以下のように設定します。

ProxyAuthScheme の値	ProxyPassword に設定する値
BASIC	ProxyUser で指定したプロキシサーバーユーザーに紐付けられたパスワード。
DIGEST	ProxyUser で指定したプロキシサーバーユーザーに紐付けられたパスワード。
NEGOTIATE	ProxyUser で指定したWindows ユーザーアカウントに紐付けられたパスワード。
NTLM	ProxyUser で指定したWindows ユーザーアカウントに紐付けられたパスワード。
NONE	ProxyPassword 接続プロパティは設定しないでください。

SOCKS 5 認証もしくは、トンネリングは、FirewallType を参照してください。

Sync App は、ProxyAutoDetect がFalse に設定されている場合にのみ、このパスワードを使用します。ProxyAutoDetect がTrue に設定されている場合（デフォルト）、Sync App は代わりにシステムのプロキシ設定で指定されているパスワードを使用します。

ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプ。

解説

このプロパティは、ProxyServer で指定されたHTTP プロキシへの接続にSSL を使用するかどうかを決定します。この接続プロパティには、以下の値を設定できます。

AUTO	デフォルト設定。ProxyServer がHTTPS URL に設定されている場合、Sync App は、TUNNEL オプションを使用します。ProxyServer がHTTP URL に設定されている場合、コンポーネントはNEVER オプションを使用します。
ALWAYS	接続は、常にSSL 有効となります。
NEVER	接続は、SSL 有効になりません。
TUNNEL	接続はトンネリングプロキシ経由で行われます。プロキシサーバーがリモートホストへの接続を開き、プロキシを経由して通信が行われます。

ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

解説

ProxyServer は、このプロパティで定義されたアドレスを除くすべてのアドレスに使用されます。セミコロンを使用してエントリを区切ります。

Sync App はデフォルトでシステムプロキシ設定を使用するため、それ以上の設定は必要ありません。この接続にプロキシ例外を明示的に設定する場合は、ProxyAutoDetect をFalse に設定します。

このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。

---

プロパティ	説明
LogModules	ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。

ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。

解説

このプロパティは、含めるログモジュールを指定することでログファイルの内容をカスタマイズすることができます。 ログモジュールは、クエリ実行、メタデータ、SSL 通信などの異なる領域にログ情報を分類します。 各モジュールは4文字のコードで表され、文字の名前の場合は末尾にスペースが必要なものもあります。

例えば、EXEC はクエリ実行をログに記録し、INFO は一般的なプロバイダーメッセージをログに記録します。 複数のモジュールを含めるには、次のように名前をセミコロンで区切ります：INFO;EXEC;SSL。

Verbosity 接続プロパティは、このプロパティで指定されたモジュールベースのフィルタリングよりも優先されます。 Verbosity レベルを満たし、指定されたモジュールに属するログエントリのみが記録されます。 利用可能なすべてのモジュールをログファイルに含めるには、このプロパティを空白のままにします。

利用可能なモジュールの完全なリストとログの設定に関する詳細な手引きについては、ログ の「高度なログの記録」セクションを参照してください。

このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。

---

プロパティ	説明
Location	テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。
BrowsableSchemas	レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
Tables	レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。
Views	レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。

テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。

解説

Location プロパティは、定義をカスタマイズしたり（例えば、カラム名を変更する、カラムを無視するなど）、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。

指定しない場合、デフォルトの場所は%APPDATA%\\CData\\YahooShopping Data Provider\\Schema となり、%APPDATA%はユーザーのコンフィギュレーションディレクトリに設定されます：

プラットフォーム	%APPDATA%
Windows	APPDATA 環境変数の値
Linux	~/.config

レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

解説

利用可能なデータベーススキーマをすべてリストすると余分な時間がかかり、パフォーマンスが低下します。 接続文字列にスキーマのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。

レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。

解説

データベースによっては、利用可能なすべてのテーブルをリストするのに時間がかかり、パフォーマンスが低下する場合があります。 接続文字列にテーブルのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。

利用可能なテーブルがたくさんあり、すでに作業したいテーブルが決まっている場合、このプロパティを使用して対象のテーブルのみに表示を制限することができます。これを行うには、カンマ区切りのリストで使用したいテーブルを指定します。各テーブルは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space` です。

Note：複数のスキーマまたはカタログを持つデータソースに接続する場合は、表示する各テーブルを完全修飾名で指定する必要があります。これにより、複数のカタログやスキーマに存在するテーブルが混同されることを防ぎます。

レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。

解説

データベースによっては、利用可能なすべてのビューをリストするのに時間がかかり、パフォーマンスが低下する場合があります。 接続文字列にビューのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。

利用可能なビューがたくさんあり、すでに作業したいビューが決まっている場合、このプロパティを使用して対象のビューのみに表示を制限することができます。これを行うには、カンマ区切りのリストで使用したいビューを指定します。各ビューは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space` です。

Note：複数のスキーマまたはカタログを持つデータソースに接続する場合は、確認する各ビューを完全修飾名で指定する必要があります。これにより、複数のカタログやスキーマに存在するビューが混同されることを防ぎます。

このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。

---

プロパティ	説明
MaxRows	集計やGROUP BY を使用しないクエリで返される最大行数を指定します。
Other	特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。
PageSize	The number of results to return per page of data retrieved from the server.
PseudoColumns	テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。
Timeout	provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。
UserDefinedViews	カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。

集計やGROUP BY を使用しないクエリで返される最大行数を指定します。

解説

このプロパティは、集計やGROUP BY 句を含まないクエリに対してSync App が返す行数の上限を設定します。 この制限により、クエリがデフォルトで過度に大きな結果セットを返さないようにします。

クエリにLIMIT 句が含まれている場合、クエリで指定された値がMaxRows 設定よりも優先されます。 MaxRows が"-1" に設定されている場合、LIMIT 句が明示的にクエリに含まれていない限り、行の制限は行われません。

このプロパティは、非常に大きなデータセットを返す可能性のあるクエリを実行する際に、パフォーマンスを最適化し過剰なリソース消費を防ぐのに役立ちます。

特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。

解説

このプロパティは、シニアユーザーが特定のシナリオに対して隠しプロパティを設定できるようにします。 これらの設定は通常のユースケースには必要ありませんが、特定の要件に対応したり、追加の機能を提供したりすることができます。 複数のプロパティをセミコロン区切りのリストで定義できます。

Note： 特定のシナリオや問題に対処するためにサポートチームから助言があった場合にのみ、これらのプロパティを設定することを強く推奨します。

複数のプロパティをセミコロン区切りリストで指定します。

統合およびフォーマット

DefaultColumnSize	データソースがメタデータにカラムの長さを提供しない場合に、文字列フィールドのデフォルトの長さを設定します。デフォルト値は2000です。
ConvertDateTimeToGMT	日時の値を、マシンのローカルタイムではなくGMT グリニッジ標準時に変換するかどうかを決定します。
RecordToFile=filename	基底のソケットデータ転送を指定のファイルに記録します。

The number of results to return per page of data retrieved from the server.

解説

The number of results to return per page of data retrieved from the server.

テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。

解説

このプロパティを使用すると、Sync App がテーブルカラムとして公開する擬似カラムを定義できます。

個々の擬似カラムを指定するには、以下の形式を使用します。"Table1=Column1;Table1=Column2;Table2=Column3"

すべてのテーブルのすべての擬似カラムを含めるには、次のようにします："*=*"

provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。

解説

このプロパティは、Sync App が操作をキャンセルする前に操作の完了を待機する最大時間を秒単位で制御します。 操作の完了前にタイムアウト時間が経過すると、Sync App は操作をキャンセルして例外をスローします。

タイムアウトは、クエリや操作全体ではなくサーバーとの個々の通信に適用されます。 例えば、各ページング呼び出しがタイムアウト制限内に完了する場合、クエリは60秒を超えて実行を続けることができます。

このプロパティを0に設定するとタイムアウトが無効になり、操作が成功するか、サーバー側のタイムアウト、ネットワークの中断、またはサーバーのリソース制限などの他の条件で失敗するまで無期限に実行されます。 このプロパティは慎重に使用してください。長時間実行される操作がパフォーマンスを低下させたり、応答しなくなる可能性があるためです。

カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。

解説

このプロパティを使用すると、UserDefinedViews.json というJSON 形式の構成ファイルを通じてカスタムビューを定義および管理できます。 これらのビューはSync App によって自動的に認識され、標準のデータベースビューのようにカスタムSQL クエリを実行できるようになります。 JSON ファイルは、各ビューをルート要素として定義し、その子要素として"query" を持ちます。この"query" にはビューのSQL クエリが含まれています。次に例を示します。

{
	"MyView": {
		"query": "SELECT * FROM SampleTable_1 WHERE MyColumn = 'value'"
	},
	"MyView2": {
		"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
	}
}

このプロパティを使用して、1つのファイルに複数のビューを定義し、ファイルパスを指定できます。 例：UserDefinedViews=C:\Path\To\UserDefinedViews.json。 このプロパティを使用すると、指定されたビューのみがSync App によって検知されます。

詳しくは、ユーザー定義ビュー を参照してください。