Méthode : transferConfigs.create

Nom complet : projects.transferConfigs.create

Crée une configuration de transfert de données.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
parent

string

Obligatoire. ID du projet BigQuery dans lequel la configuration de transfert doit être créée. L'ID doit être au format suivant : projects/{projectId}/locations/{locationId} ou projects/{projectId}. Si l'emplacement spécifié et l'emplacement de l'ensemble de données BigQuery de destination ne correspondent pas, la requête échoue.

L'autorisation IAM suivante est requise pour la ressource parent indiquée :

  • bigquery.transfers.update

Paramètres de requête

Paramètres
authorizationCode

string

Code d'autorisation OAuth2 facultatif à utiliser avec cette configuration de transfert. Ce paramètre est obligatoire si de nouveaux identifiants sont nécessaires, comme indiqué par dataSources.checkValidCreds. Pour obtenir le code d'authorisation, envoyez une demande à https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?clientId=&scope=&redirect_uri=

  • clientId doit être l'ID client OAuth de l'API DTS BigQuery pour la source de données présentée, renvoyée par la méthode dataSources.list.
  • data_source_scopes correspond aux champs d'application renvoyés par la méthode dataSources.list.
  • redirect_uri est un paramètre facultatif. S'il n'est pas spécifié, le code d'autorisation est publié lors de l'ouverture de la fenêtre du flux d'autorisation. Sinon, il est envoyé à l'URI de redirection. Une valeur spéciale de urn:ietf:wg:oauth:2.0:oob signifie que le code d'autorisation doit être renvoyé dans la barre de titre du navigateur, avec le texte de la page invitant l'utilisateur à copier le code et à le coller dans l'application.
versionInfo

string

Informations facultatives sur la version. Si les utilisateurs souhaitent trouver un jeton d'accès très récent (c'est-à-dire, immédiatement après l'approbation de l'accès), ils doivent définir la revendication versionInfo dans la requête de jeton. Pour obtenir le paramètre versionInfo, les utilisateurs doivent utiliser le type de réponse "none+gsession". Le champ versionInfo est ainsi renvoyé dans la réponse d'autorisation qui doit être placée dans une revendication JWT au sein de la requête de jeton.

serviceAccountName

string

Nom du compte de service facultatif. Si ce champ est défini, la configuration de transfert est créée avec les identifiants du compte de service. Nécessite que les utilisateurs qui appellent cette API aient l'autorisation d'agir en tant que compte de service.

Corps de la requête

Le corps de la requête contient une instance de TransferConfig.

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient une nouvelle instance de TransferConfig.

Champs d'application des autorisations

Requiert le champ d'application OAuth suivant :

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

Pour plus d'informations, reportez-vous à la section Présentation de l'authentification.

Essayer