Cmdlets for Shopify

Build 24.0.9062

接続の確立

CData Cmdlets ユーザーは、データモジュールをインストールし、接続プロパティを設定してスクリプトを開始できます。このセクションでは、CSV インポートおよびエクスポートcmdlet などのネイティブPowerShell cmdlet でShopify Cmdlets を使用する例を示します。

インストールおよび接続

PSGet がある場合は、PowerShell Gallery から次のコマンドを使ってcmdlet をインストールできます。CData サイトからセットアップを取得することもできます。 

Install-Module ShopifyCmdlets

プロファイルに以下を追加すると、次のセッションでcmdlet がロードされます。 

Import-Module ShopifyCmdlets;

Connect-Shopify cmdlet を使って、別のcmdlet に渡すことができる接続オブジェクトを作成します。 

$conn = Connect-Shopify -InitiateOAuth 'GETANDREFRESH' -ShopURL 'https://yourshopname.myshopify.com' -OAuthClientId 'myoauthclientid' -OAuthClientSecret 'myoauthclientsecret'

Shopify への接続

このセクションでは、Web、デスクトップアプリケーション、ヘッドレスアプリケーションからShopify に接続する方法について説明します。

アクセストークンによる接続

アクセストークン経由の接続には、2つのステップが必要です。

  1. Shopify の管理画面でアクセストークンを作成
  2. アクセストークンを使用して認証

アクセストークンの作成

アプリを登録してアクセストークンを取得する方法は、次のとおりです。

  1. 管理画面からShopify にログインしApps -> Apps and sales channels に進みます。
  2. Develop apps をクリックしてCreate an app を選択します。
  3. Overview タブで、Configure Admin API scopes をクリックし、アプリに許可するストアのアクセス権を選択します。プロバイダーがすべてのテーブルとビューを使用するために必要な権限は次のとおりです。
    • read_assigned_fulfillment_orders, write_assigned_fulfillment_orders
    • read_content, write_content
    • read_customers, write_customers
    • read_draft_orders, write_draft_orders
    • read_fulfillments, write_fulfillments
    • read_gift_cards, write_gift_cards
    • read_inventory, write_inventory
    • read_marketing_events, write_marketing_events
    • read_orders, write_orders
    • read_price_rules, write_price_rules
    • read_product_listings, write_product_listings
    • read_products, write_products
    • read_reports, write_reports
    • read_script_tags, write_script_tags
    • read_shopify_payments_payouts
    • read_themes, write_themes
    • read_markets
    • read_shopify_payments_accounts
    • read_publications
    • unauthenticated_read_content (Storefront API)
  4. Save をクリックします。
  5. API Credentials を選択します。
  6. "Access tokens" の下でInstall app をクリックします。これでアクセストークンが作成されます。
  7. Admin API Access token のアクセストークンをコピーします。NOTE：トークンの公開およびコピーは1回のみ可能です。

アクセストークンによる認証

アクセストークンで認証するには、次を設定します。

  • AuthScheme：AccessToken に設定。
  • AccessToken：カスタムアプリからコピーしたアクセストークンの値に設定。

OAuth での接続

Shopify はOAuth 認証をサポートします。いかなる場合も、AuthScheme をOAuth に設定してカスタムOAuth アプリケーションを作成する必要があります。詳しくは、カスタムOAuth アプリケーションの作成 を参照してください。

デスクトップアプリケーション

下記の手順に従って、カスタムOAuth アプリケーションの資格情報を使用して認証します。

OAuth アクセストークンの取得およびリフレッシュ

以下を設定して、接続してください。

  • OAuthClientId：アプリケーションの登録時に割り当てられたクライアントId に設定。
  • OAuthClientSecret：アプリケーションの登録時に割り当てられたクライアントシークレットに設定。
  • CallbackURL：アプリケーションの登録時に定義されたリダイレクトURI に設定。
接続すると、本製品 はデフォルトブラウザでShopify のOAuth エンドポイントを開きます。ログインして、アプリケーションにアクセス許可を与えます。 本製品 はアクセストークンの期限が切れると自動的にリフレッシュします。

ヘッドレスマシン

ヘッドレスマシンのユーザーアカウントでOAuth を使用するようにドライバーを設定するには、インターネットブラウザに対応した別の端末で認証する必要があります。

  1. 以下のオプションから選択します。
    • オプション1：後述の「Verifier code を取得および交換」に従い、OAuthVerifier 値を取得します。
    • オプション2：インターネットブラウザに対応したマシンに本製品 をインストールし、後述の「OAuth 設定を転送」の説明に従い、通常のブラウザベースのフローで認証後にOAuth 認証値を転送します。
  2. 次に、ヘッドレスマシンからアクセストークンを自動的にリフレッシュするように本製品 を設定します。

オプション1：Verifier code を取得および交換

Verifier code を取得するには、OAuth Authorization URL で認証する必要があります。

次の手順に従います。

  1. はじめに、次のプロパティを設定します。
    • InitiateOAuth：OFF に設定。
    • OAuthClientId：アプリケーションの登録時に割り当てられたクライアントId に設定。
    • OAuthClientSecret：アプリケーションの登録時に割り当てられたクライアントシークレットに設定。
    次に、適切なCallbackURL を指定してGetOAuthAuthorizationURL ストアドプロシージャを呼び出します。ストアドプロシージャによって返されたURL をブラウザで開きます。
    • ログインして、本製品 にアクセス許可を与えます。すると、リダイレクトURI にリダイレクトされます。リダイレクトURI にはcode というパラメータが付加されます。このパラメータの値を控えておきます。後ほどこれをOAuthVerifier 接続プロパティに設定します。
次に、OAuth verifier code をOAuth リフレッシュトークンおよびアクセストークンと交換する必要があります。

ヘッドレスマシンでは、次の接続プロパティを設定してOAuth 認証値を取得します。

  • InitiateOAuth：REFRESH に設定。
  • OAuthVerifier：控えておいたverifier code（リダイレクトURI のcode パラメータの値）に設定。
  • OAuthClientId：カスタムOAuth アプリケーション設定のクライアントId に設定。
  • OAuthClientSecret：カスタムOAuth アプリケーション設定のクライアントシークレットに設定。
  • OAuthSettingsLocation：これを設定すると、暗号化されたOAuth 認証値が指定された場所に永続化されます。

接続をテストしてOAuth 設定ファイルを生成し、以下のプロパティを再設定して接続します。

  • InitiateOAuth：REFRESH に設定。
  • OAuthClientId：アプリケーションの登録時に割り当てられたクライアントId に設定。
  • OAuthClientSecret：アプリケーションの登録時に割り当てられたクライアントシークレットに設定。
  • OAuthSettingsLocation：暗号化されたOAuth 認証値を含む場所に設定。アクセストークンの自動リフレッシュを有効にするために、この場所が本製品 に読み書きのアクセス許可を与えることを確認してください。

オプション2：OAuth 設定を転送

ヘッドレスマシンでの接続に先立ち、インターネットブラウザに対応したデバイスでドライバーとの接続をインストールし、作成する必要があります。上述の「デスクトップアプリケーション」の説明に従って、接続プロパティを設定します。

「デスクトップアプリケーション」の手順が完了すると、生成された認証値は、OAuthSettingsLocation で指定された場所に暗号化されて書き込まれます。デフォルトのファイル名は"OAuthSettings.txt" です。

接続をテストしてOAuth 設定ファイルを生成し、OAuth 設定ファイルをヘッドレスマシンにコピーします。

ヘッドレスマシンで、次の接続プロパティを設定し、データに接続します。

  • InitiateOAuth：REFRESH に設定。
  • OAuthClientId：アプリケーションの登録時に割り当てられたクライアントId に設定。
  • OAuthClientSecret：アプリケーションの登録時に割り当てられたクライアントシークレットに設定。
  • OAuthSettingsLocation：ブラウザでマシンからコピーしたOAuth 設定ファイルの場所に設定。アクセストークンの自動リフレッシュを有効にするために、この場所が本製品 に読み書きのアクセス許可を与えることを確認してください。

データの取得

Select-Shopify cmdlet はデータを取得するためのネイティブなPowerShell インターフェースを提供します。 

$results = Select-Shopify -Connection $conn -Table "Customers" -Columns @("FirstName, Id") -Where "FirstName='jdoe1234'"
Invoke-Shopify cmdlet はSQL インターフェースを提供します。このcmdlet を使うと、Query パラメータを介してSQL クエリを実行できます。

cmdlet 出力のパイプ処理

cmdlet は行オブジェクトをパイプラインに一度に一行ずつ返します。以下は、結果をCSV ファイルにエクスポートします。 

Select-Shopify -Connection $conn -Table Customers -Where "FirstName = 'jdoe1234'" | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myCustomersData.csv -NoTypeInformation

Select-Shopify からの結果をSelect-Object cmdlet にパイプして、Export-CSV cmdlet にパイプする前にいくつかのプロパティを実行していることがわかるでしょう。これをする理由は、CData Cmdlets は接続、テーブル、およびカラムの情報を結果セットの各行オブジェクトに追加しますが、必ずしもその情報がCSV ファイルに必要ではないからです。

ただし、これによってcmdlet の出力を別のcmdlet にパイプすることが容易になります。以下に、結果セットをJSON に変換する例を示します。 

 
PS C:\> $conn  = Connect-Shopify -InitiateOAuth 'GETANDREFRESH' -ShopURL 'https://yourshopname.myshopify.com' -OAuthClientId 'myoauthclientid' -OAuthClientSecret 'myoauthclientsecret'
PS C:\> $row = Select-Shopify -Connection $conn -Table "Customers" -Columns (FirstName, Id) -Where "FirstName = 'jdoe1234'" | select -first 1
PS C:\> $row | ConvertTo-Json
{
  "Connection":  {

  },
  "Table":  "Customers",
  "Columns":  [

  ],
  "FirstName":  "MyFirstName",
  "Id":  "MyId"
}

データの削除

以下は、抽出条件に合うあらゆるレコードを削除します。 

Select-Shopify -Connection $conn -Table Customers -Where "FirstName = 'jdoe1234'" | Remove-Shopify

データの変更

cmdlet はデータクレンジング同様、データの変換を容易にします。次の例は、レコードがすでに存在するかどうか、挿入する前に更新が必要かどうかをチェックしてから、CSV ファイルのデータをShopify にロードします。 

Import-Csv -Path C:\MyCustomersUpdates.csv | %{
  $record = Select-Shopify -Connection $conn -Table Customers -Where ("Id = `'"+$_.Id+"`'")
  if($record){
    Update-Shopify -Connection $conn -Table Customers -Columns @("FirstName","Id") -Values @($_.FirstName, $_.Id) -Where "Id  = `'$_.Id`'"
  }else{
    Add-Shopify -Connection $conn -Table Customers -Columns @("FirstName","Id") -Values @($_.FirstName, $_.Id)
  }
}

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9062