メソッド: transferConfigs.patch

完全名: projects.transferConfigs.patch

データ転送の構成を更新します。更新しない場合でも、すべてのフィールドを設定する必要があります。

HTTP リクエスト

PATCH https://bigquerydatatransfer.googleapis.com/v1/{transferConfig.name=projects/*/transferConfigs/*}

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

パスパラメータ

パラメータ
transferConfig.name

string

転送構成のリソース名。転送構成名の形式は projects/{projectId}/locations/{region}/transferConfigs/{configId} です。名前は、CreateTransferConfigRequest に指定された configId、projectId、リージョンに基づいて自動的に生成されます。configId が指定されていない場合、通常は configId に uuid が生成されます。ただし uuid は生成されない場合や不要な場合もあります。

クエリ パラメータ

パラメータ
authorizationCode

string

（省略可）この転送設定で使用される OAuth2 認証コード。指定された場合は、転送構成が承認するユーザーに関連付けられます。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 の特殊な値は、ユーザーにコードをコピーしてアプリケーションに貼り付けるように要求するページテキストとともに、認証コードがブラウザのタイトルバーに返されることを意味します。
updateMask

string (FieldMask format)

必須。このリクエストで更新が必要なフィールドのリスト。

完全修飾されたフィールド名のカンマ区切りリスト。例: "user.displayName,photo"。
versionInfo

string

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

string

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

リクエストの本文

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

レスポンスの本文

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

認証スコープ

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

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

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

試してみる