CData Python Connector for Yahoo! Ads

Build 22.0.8479

カスタムOAuth アプリの作成

ユーザー名やパスワードへのアクセスを保有していない場合や、それらを使いたくない場合にはOAuth 認証が使用できます。Yahoo! Ads はOAuth 認証標準を使用しています。これには認証ユーザーがブラウザ経由でYahoo! Ads と通信する必要があります。このセクションで説明するとおり、本製品 はさまざまな方法でOAuth 交換をサポートします。

接続アプリケーションの作成

OAuth クライアントクレデンシャル、クライアントID、およびクライアントシークレットを取得するには:

  1. Yahoo! JAPAN広告API 管理ツールを表示します。ログインを求められた場合は、Yahoo! JAPAN 広告API の申請に使用したYahoo! JAPANビジネスID でログインしてください。
  2. アプリケーション一覧画面で[登録アプリケーション]をクリックします。
  3. 登録アプリケーションの画面で[登録]ボタンをクリックします。
  4. 必須項目をすべて入力し、リダイレクトURI ボックスに値を入力します。デスクトップアプリケーションを作成する場合は、コールバックURL を http://localhost:33333 か任意の別のポート番号に設定してください。Web アプリケーションを作成する場合は、コールバックURL をユーザーがアプリケーションを認可した後に表示したいWeb アプリケーションのページに設定してください。
  5. 入力が終わったら、[確認]ボタンをクリックします。確認画面で内容に問題がなければ、[登録]ボタンをクリックします。
  6. 入力したアプリケーションが一覧に表示され、登録が完了します。上記手順で入力した情報に加えて、クライアントID とクライアントシークレットが表示されます。

デスクトップアプリケーションからYahoo! Ads へ認証

次の接続プロパティを設定して、接続してください。

  • OAuthClientId:アプリケーション設定のクライアントID に設定。
  • OAuthClientSecret:アプリケーション設定のクライアントシークレットに設定。
  • CallbackURL:アプリケーション設定のコールバックURL に設定。
  • InitiateOAuthGETANDREFRESH に設定。InitiateOAuth を使って、OAuth 交換や、手動でのOAuthAccessToken 接続プロパティの設定の繰り返しを避けられます。

接続すると、本製品 はデフォルトブラウザでOAuth エンドポイントを開きます。ログインして、アプリケーションにアクセス許可を与えます。本製品 が以下のOAuth プロセスを完了します。

  1. コールバックURL を取得して、アクセストークンを設定します。
  2. OAuthSettingsLocation にOAuth 値を保存し、接続間で永続化されるようにします。
  3. 返されたリフレッシュトークンと有効なアクセストークンとを交換します。

Web アプリケーションからYahoo! Ads へ認証

次の接続プロパティを設定し、アクセストークンを取得します。

  • OAuthClientId:アプリケーション設定のクライアントID に設定。
  • OAuthClientSecret:アプリケーション設定のクライアントシークレットに設定。
  • CallbackURL:アプリケーション設定のコールバックURL に設定。

Web アプリケーションから接続する場合、または本製品 にブラウザウィンドウを開く権限がない場合は、temporary verification value とアクセストークンを交換する必要があります。

  1. GetOAuthAuthorizationURL を呼び出します。ストアドプロシージャがOAuth エンドポイントのURL を返します。
  2. ログインして、アプリケーションを認可します。コールバックURL にリダイレクトされます。GrantType パラメータをImplicit に設定した場合、クエリ string パラメータにおいて、コールバックURL はOAuthAccessToken を保持します。GrantType パラメータを"code に設定した場合、クエリ string パラメータ "code" において、コールバックURL はverifier code を保持します。verifier code を取り出し、 を呼び出します。

次の接続プロパティを設定し、データに接続します。

  • OAuthAccessToken

アクセストークンの期限が切れたときに自動でリフレッシュするには、InitiateOAuthREFRESH に設定しOAuthRefreshToken を設定してください。あるいは、アクセストークンの期限が切れたときにRefreshOAuthAccessToken ストアドプロシージャを呼び出します。リフレッシュトークンが入力されると、プロシージャは有効なOAuth アクセストークンを返します。

Copyright (c) 2023 CData Software, Inc. - All rights reserved.
Build 22.0.8479