Method: accounts.userLinks.batchCreate

アカウントまたはプロパティへの複数のユーザーのリンクに関する情報を作成します。

このメソッドはトランザクションです。UserLink を作成できない場合、UserLink は作成されません。

HTTP リクエスト

POST https://analyticsadmin.googleapis.com/v1alpha/{parent=accounts/*}/userLinks:batchCreate

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

パスパラメータ

パラメータ
parent

string

必須。リクエスト内のすべてのユーザーリンクが対象とするアカウントまたはプロパティ。このフィールドは必須です。CreateUserLinkRequest メッセージの親フィールドは空にするか、このフィールドと一致させる必要があります。形式の例: accounts/1234

リクエスト本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現 
{
  "notifyNewUsers": boolean,
  "requests": [
    {
      object (CreateUserLinkRequest)
    }
  ]
}
フィールド
notifyNewUsers

boolean

省略可。設定されている場合は、新しいユーザーにメールを送信して、リソースに対する権限が付与されたことを通知します。これが設定されているかどうかにかかわらず、個々のリクエスト内の notificationNewUser フィールドは無視されます。
requests[]

object (CreateUserLinkRequest)

必須。作成するユーザーリンクを指定するリクエスト。1 つのバッチで作成できるユーザーリンクは 1,000 個までです。

レスポンスの本文

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

承認スコープ

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

  • https://www.googleapis.com/auth/analytics.manage.users

CreateUserLinkRequest

userLinks.create RPC に対するリクエスト メッセージ。

ユーザーは複数のメールアドレスを Google アカウントに関連付けることができ、そのうちの 1 つが「メイン」のメールアドレスになります。Google アカウントに関連付けられている任意のメールアドレスを新しいユーザーリンクに使用できますが、返される UserLink には常に「メイン」のメールアドレスが含まれます。そのため、このリクエストの入力と出力のメールアドレスが異なる場合があります。

JSON 表現 
{
  "parent": string,
  "notifyNewUser": boolean,
  "userLink": {
    object (UserLink)
  }
}
フィールド
parent

string

必須。形式の例: accounts/1234
notifyNewUser

boolean

省略可。設定されている場合は、リソースへの権限が付与されたことを新規ユーザーにメールで通知します。