メソッド: transferConfigs.create

完全名: projects.transferConfigs.create

新しいデータ転送の構成を作成します。

HTTP リクエスト

POST https://bigquerydatatransfer.googleapis.com/v1/{parent=projects/*}/transferConfigs

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
parent

string

必須。転送構成が作成される BigQuery プロジェクト ID。projects/{projectId}/locations/{locationId} または projects/{projectId} の形式にする必要があります。指定したロケーションと宛先 BigQuery データセットのロケーションが一致しない場合、リクエストが失敗します。

認証には、指定されたリソース parent に対する次の IAM の権限が必要です。

  • bigquery.transfers.update

クエリ パラメータ

パラメータ
authorizationCode

string

（省略可）この転送構成で使用される OAuth2 認証コード。dataSources.checkValidCreds で指定されているように、新しい認証情報が必要な場合は必須です。authorizationCode を取得するには、https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?clientId=&scope=&redirect_uri= に対してリクエストを発行します。

  • clientId は、dataSources.list メソッドから返される特定のデータソースの BigQuery DTS API の OAuth clientId である必要があります。
  • data_source_scopes は、dataSources.list メソッドから返されるスコープです。
  • redirect_uri は、オプション パラメータです。指定されなかった場合は、認証コードが認証フロー ウィンドウのオープナーに送信されます。そうでない場合は、リダイレクト URI に送信されます。urn:ietf:wg:oauth:2.0:oob の特殊な値は、ユーザーにコードをコピーしてアプリケーションに貼り付けるように要求するページテキストとともに、認証コードがブラウザのタイトルバーに返されることを意味します。
versionInfo

string

バージョン情報。これは省略可能です。直近、つまりアクセス承認直後のアクセス トークンを検索する場合は、トークン リクエストに versionInfo クレームを設定する必要があります。versionInfo を取得するには、レスポンス タイプに none+gsession を使用する必要があります。これにより、認証レスポンスで versionInfo が返されます。これはトークン リクエストの JWT クレームに格納されます。
serviceAccountName

string

サービス アカウント名。これは省略可能です。このフィールドが設定されている場合、このサービス アカウントの認証情報を使用して転送構成が作成されます。この API を呼び出すユーザーには、このサービス アカウントとして機能するための権限が必要です。

リクエストの本文

リクエストの本文には TransferConfig のインスタンスが含まれます。

レスポンスの本文

成功した場合、レスポンスの本文には、新しく作成された TransferConfig のインスタンスが含まれます。

認証スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。

試してみる