カスタムクレデンシャル
カスタムOAuth アプリを使用するタイミング
Web フローではカスタムOAuth アプリの作成が必須です。デスクトップ およびヘッドレス アプリケーションでは、カスタムOAuth アプリの作成は任意です。本製品 はすでにSnapchat Ads に登録されており、埋め込みクレデンシャルで接続できるからです。 カスタムOAuth アプリの作成は、本製品 がすでにSnapchat Ads に登録されていて埋め込みクレデンシャルで接続できるため任意です。カスタムOAuth アプリを作成して、ユーザーがSnapchat Ads にログインして本製品 にアクセス権を与えるときに表示される情報を変更することもできます。
カスタムOAuth アプリでのデスクトップ認証
カスタムOAuth アプリの作成 後、下記の手順に従って、カスタムOAuth アプリの資格情報を使用して認証します。OAuth アクセストークンの取得およびリフレッシュ
次を設定して、接続してください。
- OAuthClientId：アプリの登録時に割り当てられたクライアントId に設定。
- OAuthClientSecret：アプリの登録時に割り当てられたクライアントシークレットに設定。
- CallbackURL：アプリの登録時に定義されたリダイレクトURI に設定。
- InitiateOAuth：GETANDREFRESH に設定。InitiateOAuth を使うと、OAuth 交換の繰り返しや、手動でのOAuthAccessToken 設定を避けられます。
- コールバックURL からアクセストークンを取得し、リクエストを認証します。
- 期限が切れた際に、アクセストークンをリフレッシュします。
- OAuthSettingsLocation にOAuth 値を保存し、接続の間に維持されるようにします。
カスタムOAuth アプリでのWeb 認証
Web アプリケーション経由で接続する場合は、Snapchat Ads にカスタムOAuth アプリを登録する必要があります。カスタムOAuth アプリの作成 を参照してください。それから本製品 を使用してOAuth トークンの値を取得および管理します。
OAuth アクセストークンの取得
次の接続プロパティを設定し、OAuthAccessToken を取得します。
- OAuthClientId：アプリケーション設定のクライアントId に設定。
- OAuthClientSecret：アプリケーション設定のクライアントシークレットに設定。
続いてストアドプロシージャを呼び出し、OAuth 交換を完了します。
-
GetOAuthAuthorizationURL ストアドプロシージャを呼び出します。AuthMode インプットをWEB に、CallbackURL インプットをアプリケーション設定で指定したリダイレクトURI に設定します。
ストアドプロシージャがOAuth エンドポイントのURL を返します。
- URL を開き、ログインして、アプリケーションを認可します。コールバックURL にリダイレクトされます。
- GetOAuthAccessToken ストアドプロシージャを呼び出します。AuthMode インプットをWEB に設定します。Verifier インプットを、コールバックURL のクエリ文字列の"code" パラメータに設定します。
OAuth アクセストークンのリフレッシュ
InitiateOAuth をREFRESH に設定してOAuth アクセストークンの期限が切れたときに自動的にリフレッシュするか、RefreshOAuthAccessToken ストアドプロシージャを呼び出してトークンを手動でリフレッシュできます。
自動リフレッシュ
InitiateOAuth でトークンをリフレッシュするには、最初のデータ接続で次のように設定します。
- OAuthAccessToken：GetOAuthAccessToken によって返されたアクセストークンに設定。
- InitiateOAuth：REFRESH に設定。InitiateOAuth を使うと、OAuth 交換の繰り返しや、手動でのOAuthAccessToken 設定を避けられます。
- OAuthSettingsLocation：接続間で維持されるようにするには、本製品 がOAuth 値を保存する場所のパスを設定。
- OAuthClientId：アプリケーション設定のクライアントId に設定。
- OAuthClientSecret：アプリケーション設定のクライアントシークレットに設定。
- OAuthRefreshToken：GetOAuthAccessToken によって返されたリフレッシュトークンに設定。
その後のデータ接続では、次を設定します。
- InitiateOAuth
- OAuthSettingsLocation
手動でリフレッシュ
RefreshOAuthAccessToken ストアドプロシージャを使用してOAuthAccessToken を手動でリフレッシュできます。GetOAuthAccessToken によって返されたExpiresIn パラメータ値が経過した後にストアドプロシージャを呼び出します。以下の接続プロパティが設定されている必要があります。
- OAuthClientId：アプリケーション設定のクライアントId に設定。
- OAuthClientSecret：アプリケーション設定のクライアントシークレットに設定。
次のパラメータセットを使用してRefreshOAuthAccessToken を呼び出すことができます。
- OAuthRefreshToken：これをGetOAuthAccessToken によって返されたOAuthRefreshToken に設定します。