接続の確立

コネクタ内で利用可能なオブジェクトは、"cdata.facebookads" モジュールからアクセスできます。モジュールのオブジェクトを直接使用するには：

モジュールを以下のようにインポートします。
```
import cdata.facebookads as mod
```
接続を確立するには、以下のような適切な接続文字列を使用してコネクタオブジェクトからconnect() メソッドを呼び出します。
```
mod.connect("InitiateOAuth=GETANDREFRESH;")
```

Facebook Ads への接続

以下はオプションの接続プロパティです。

Target：Facebook テーブルのいくつかはターゲットによりフィルタリング可能です。例えば、動画のコメントを取得するには、ターゲットとして動画のID を指定します。このプロパティは、クエリ結果を指定されたターゲットに合致するレコードに限定することを可能にします。Target カラムを使ってクエリ毎にこの制限をかけることができます。
AggregateFormat：本製品は、文字列集合としていくつかのカラムを返します。例えば、エンティティのいいねデータは集計されて返されます。デフォルトでは、本製品はJSON で集計カラムを返します。集計をXML で返すことも可能です。
RetryLevel：このプロパティを使用して、特定の広告インサイトのクエリとエラーに対するクエリの自動再試行を制御します。

Facebook Ads への認証

Facebook Ads はユーザー認証にOAuth 標準を使用しています。

OAuth

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

CData は、OAuth デスクトップ認証を簡略化する埋め込みOAuth アプリケーションを提供します。代わりに、カスタムOAuth アプリケーションを作成することも可能です。カスタムアプリケーションの作成およびその理由については、Azure AD アプリケーションの作成を参照してください。

認証に関する2つの方法の違いは、カスタムOAuth アプリケーションを使用する場合に、2つの接続プロパティを追加で設定する必要があることだけです。次の接続プロパティを設定して、接続してください。

InitiateOAuth：GETANDREFRESH に設定。InitiateOAuth を使うと、OAuth 交換の繰り返しや、手動でのOAuthAccessToken 設定を避けられます。
OAuthClientId：（カスタムアプリケーションのみ）アプリケーション設定のクライアントId に設定。
OAuthClientSecret：（カスタムアプリケーションのみ）アプリケーション設定のクライアントシークレットに設定。
CallbackURL：アプリケーション設定のリダイレクトURL に設定。
Scope（オプション）：ドライバーがリクエストするアクセス権をカスタマイズする必要がある場合は、これを設定します。
AuthenticateAsPage（オプション）：リクエストをページとして作成するには、これをページ名またはページID に設定します。ページは認証されたユーザーにより管理されている必要があります。

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

コールバックURL からアクセストークンを取得します。
古いトークンの期限が切れたときは、新しいアクセストークンを取得します。
OAuth 値をOAuthSettingsLocation に保存します。これらの値は接続間で永続化されます。

Web アプリケーション

Web アプリケーション経由で接続する場合は、Facebook Ads にカスタムOAuth アプリケーションを作成および登録する必要があります。カスタムアプリケーションについて詳しくは、カスタムOAuth アプリの作成を参照してください。それから本製品を使用してOAuth トークンの値を取得および管理します。

OAuth アクセストークンの取得

次の接続プロパティを設定し、OAuthAccessToken を取得します。

OAuthClientId：アプリケーション設定のクライアントId に設定。
OAuthClientSecret：アプリケーション設定のクライアントシークレットに設定。
Scope（オプション）：ドライバーがリクエストするアクセス権をカスタマイズする必要がある場合は、これを設定します。
AuthenticateAsPage（オプション）：リクエストをページとして作成するには、これをページ名またはページID に設定します。ページは認証されたユーザーにより管理されている必要があります。

続いてストアドプロシージャを呼び出し、OAuth 交換を完了します。

GetOAuthAuthorizationURL ストアドプロシージャを呼び出します。AuthMode インプットをWEB に、CallbackURL インプットをアプリケーション設定で指定したリダイレクトURI に設定します。必要に応じて、"Permissions" パラメータを設定してカスタム権限をリクエストします。
URL を開き、ログインして、アプリケーションを認可します。コールバックURL にリダイレクトされます。
GetOAuthAccessToken ストアドプロシージャを呼び出します。AuthMode インプットをWEB に設定します。Verifier インプットを、コールバックURL のクエリ文字列の"code" パラメータに設定します。必要に応じて、"Permissions" パラメータを設定してカスタム権限をリクエストします。

OAuthAccessToken 接続プロパティをストアドプロシージャで返されたアクセストークンに設定し、データに接続します。ExpiresIn 秒後に、アクセストークンの期限が切れたときは、GetOAuthAccessToken を呼び出し、新しいアクセストークンを取得します。 [

ヘッドレスマシン

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

ヘッドレスOAuth フローでは、カスタムOAuth アプリの作成は任意です。アプリの作成をスキップしたい場合は、ドライバーの埋め込みOAuth クレデンシャルで接続できます。しかしながら、カスタムOAuth アプリを作成すると、ユーザーがFacebook にログインしてドライバーにアクセス権を与えるときに表示される情報を変更することもできます。カスタムOAuth アプリケーションの作成については、カスタムOAuth アプリの作成を参照してください。

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

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

Verifier code を取得するには、OAuth Authorization URL で認証する必要があります。インターネットブラウザに対応したマシンから認証してOAuthVerifier 接続プロパティを取得する方法は次のとおりです。

埋め込みOAuth アプリケーションを使用する場合：
1. GetOAuthAuthorizationURL ストアドプロシージャを呼び出します。
2. Facebook Ads OAuth endpoint をクリックし、ブラウザでエンドポイントを開きます。
カスタムOAuth アプリケーションを使用するには、以下のプロパティを設定し、認証URL を作成します。
- InitiateOAuth：OFF に設定。
- OAuthClientId：アプリケーションの登録時に割り当てられたクライアントId に設定。
- OAuthClientSecret：アプリケーションの登録時に割り当てられたクライアントシークレットに設定。
CallbackURI 入力パラメータを、アプリケーション設定で指定した正確なリダイレクトURI に設定してGetOAuthAuthorizationURL ストアドプロシージャを呼び出します。
ストアドプロシージャによって返されたURL をブラウザで開きます。
ログインして、本製品にアクセス許可を与えます。すると、verifier code を含むコールバックURL にリダイレクトされます。
verifier code の値を保存します。後ほどこれをOAuthVerifier 接続プロパティに設定します。

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

OAuthClientId：OAuth 統合設定のクライアントID に設定。
OAuthClientSecret：OAuth 統合設定のクライアントシークレットに設定。
OAuthVerifier：verifier code に設定。
OAuthSettingsLocation：暗号化されたOAuth 認証値を指定された場所に永続化。
InitiateOAuth：REFRESH に設定。

データへの接続

OAuth 設定ファイルが生成されたら、次のプロパティを設定してデータに接続します。

OAuthSettingsLocation：暗号化されたOAuth 認証値が保存される場所に設定。アクセストークンの自動リフレッシュを有効にするために、この場所がプロバイダーに読み書きのアクセス許可を与えることを確認してください。
InitiateOAuth：REFRESH に設定。

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

別のマシンに本製品をインストールするには、認証してから、結果のOAuth 値を転送します。

セカンドマシンに、本製品をインストールして、次の接続プロパティセットで接続します。
- OAuthSettingsLocation：書き込み可能な場所に設定。
- InitiateOAuth：GETANDREFRESH に設定。
- OAuthClientId：アプリケーション設定のクライアントID に設定。
- OAuthClientSecret：アプリケーション設定のクライアントシークレットに設定。
- CallbackURL：アプリケーション設定のコールバックURL に設定。
認証する接続をテストします。生成された認証値は、OAuthSettingsLocation で指定されたパスに書き込まれて暗号化されます。接続テストに成功したら、OAuth 設定ファイルをヘッドレスマシンにコピーします。ヘッドレスマシンで、次の接続プロパティを設定し、データに接続します。
- InitiateOAuth：REFRESH に設定。
- OAuthSettingsLocation：OAuth 設定ファイルの場所に設定。アクセストークンの自動リフレッシュを有効にするために、この場所が本製品に読み書きのアクセス許可を与えることを確認してください。

追加認証のリクエスト

本製品の使用中に、指定のアクションを行う権限がアプリにありませんというエラーメッセージがFacebook から返されることがあります。このエラーを解消するには、必要な権限を持つ新しいOAuth アクセストークンを発行する必要があります。認証ステップでデスクトップアプリケーション用のScope プロパティを設定します。

Web アプリケーションは、リクエストしたいアクセス許可のインプットを持つGetOAuthAuthorizationURL およびGetOAuthAccessToken ストアドプロシージャを呼び出す必要があります。

これらはカンマで区切られたアクセス許可のリストで、一回の認可要求で複数を要求することができます。利用可能なFacebook アクセス許可のリストはこちらで確認できます。

http://developers.facebook.com/docs/authentication/permissions/

場合によっては、アクセス許可の制限は、リクエスト可能なFacebook Ads OAuth パーミッションが見つからないことが原因ではなく、Page Public Content Access やPage Public Metadata Access のようなOAuth アプリ機能が見つからないことが原因かもしれないことに注意してください。これらの機能はOAuth アプリ全体に紐づいており、ユーザーが要求した個々のOAuth アクセストークンに対して承認や拒否を行うことはできません。埋め込みOAuth アプリでは利用できないアプリ機能へのアクセスが必要な場合は、カスタムOAuth アプリの作成を検討してください。

AuthenticateAsPage プロパティ

単一ページとして投稿する場合は、AuthenticateAsPage 接続プロパティを使用します。ページのコレクションをクエリする場合は、AuthenticateAsPage を空のままにします。その場合、CData ツールはどのページトークンを使用するかを自動的に検出します。Alternatively, if you would like to disable this automatic detection and thus require usage of AuthenticateAsPage when querying a page, set AutoDetectPageTokens to "False".

次のセクションでは、2つのオプションについて比較します。

ページとして投稿

Facebook Ads に認証した後、あなたのユーザーアカウントで管理するページとして投稿をすることができます。AuthenticateAsPage プロパティを使用するページのID に設定します。Pages ビューをクエリして、あなたのアカウントでアクセスすることが可能なすべてのページのID を見ることができます。

自動ページ

Facebook Ads では、ページが所有するほとんどのリソースに対してページトークンを必要とする多くの変更を最近加えました。これは、複数のページを管理していてすべてのページで同じクエリを実行したい場合（例えばInsights を取得する場合など）に面倒です。CData のツールでこれをシームレスに処理するために、使用するページトークンを自動的に検出する方法を追加しました。これを機能させるには、AuthenticateAsPage を指定せず、AutoDetectPageTokens を"True" のままにします。正しいページトークンは、リクエストでターゲットの一部としてページID が指定されている場合にのみ解決できます。つまり、リクエストによっては手動でAuthenticateAsPage を指定する必要があります。

Setting AutoDetectPageTokens to "False" will disable automatic page token detection.

CData Python Connector for Facebook Ads