Google Marketing Platform Admin User Groups API

openapi: 3.2.0
info:
  title: Google Marketing Platform Admin API v1alpha User Groups API
  description: The Google Marketing Platform Admin API allows for programmatic access to the Google Marketing Platform configuration data. You can use the Google Marketing Platform Admin API to manage links between your Google Marketing Platform organization and Google Analytics accounts, and to set the service level of your GA4 properties.
  version: v1alpha
  contact:
    name: Google
    url: https://developers.google.com/analytics/devguides/config/gmp/v1
  license:
    name: Google APIs Terms of Service
    url: https://developers.google.com/terms
servers:
- url: https://marketingplatformadmin.googleapis.com
  description: Marketing Platform Admin API server
tags:
- name: User Groups
paths:
  /v1alpha/organizations/{organizationsId}/userGroups:
    post:
      operationId: createUserGroup
      summary: marketingplatformadmin.organizations.userGroups.create
      description: Creates a user group in the specified GMP organization.
      tags:
      - User Groups
      parameters:
      - name: organizationsId
        in: path
        required: true
        schema:
          type: string
        description: Path segment of `v1alpha/{+parent}/userGroups`.
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserGroup'
      security:
      - oauth2:
        - https://www.googleapis.com/auth/marketingplatformadmin.analytics.update
      x-discovery-id: marketingplatformadmin.organizations.userGroups.create
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserGroup'
    get:
      operationId: listUserGroups
      summary: marketingplatformadmin.organizations.userGroups.list
      description: Returns a list of user groups in the specified GMP organization.
      tags:
      - User Groups
      parameters:
      - name: organizationsId
        in: path
        required: true
        schema:
          type: string
        description: Path segment of `v1alpha/{+parent}/userGroups`.
      - name: pageToken
        in: query
        required: false
        description: Optional. A page token, received from a previous ListUserGroups call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListUserGroups` must match the call that provided the page token.
        schema:
          type: string
      - name: pageSize
        in: query
        required: false
        description: Optional. The maximum number of user groups to return in one call. The service may return fewer than this value. If unspecified, at most 50 user groups will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListUserGroupsResponse'
      security:
      - oauth2:
        - https://www.googleapis.com/auth/marketingplatformadmin.analytics.read
        - https://www.googleapis.com/auth/marketingplatformadmin.analytics.update
      x-discovery-id: marketingplatformadmin.organizations.userGroups.list
  /v1alpha/organizations/{organizationsId}/userGroups/{userGroupsId}:
    delete:
      operationId: deleteUserGroup
      summary: marketingplatformadmin.organizations.userGroups.delete
      description: Deletes a user group in the specified GMP organization.
      tags:
      - User Groups
      parameters:
      - name: organizationsId
        in: path
        required: true
        schema:
          type: string
        description: Path segment of `v1alpha/{+name}`.
      - name: userGroupsId
        in: path
        required: true
        schema:
          type: string
        description: Path segment of `v1alpha/{+name}`.
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Empty'
      security:
      - oauth2:
        - https://www.googleapis.com/auth/marketingplatformadmin.analytics.update
      x-discovery-id: marketingplatformadmin.organizations.userGroups.delete
    patch:
      operationId: patchUserGroup
      summary: marketingplatformadmin.organizations.userGroups.patch
      description: Updates a user group in the specified GMP organization.
      tags:
      - User Groups
      parameters:
      - name: organizationsId
        in: path
        required: true
        schema:
          type: string
        description: Path segment of `v1alpha/{+name}`.
      - name: userGroupsId
        in: path
        required: true
        schema:
          type: string
        description: Path segment of `v1alpha/{+name}`.
      - name: updateMask
        in: query
        required: false
        description: Required. The list of fields to update. Field names must be in snake case (for example, "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields.
        schema:
          type: string
          format: google-fieldmask
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserGroup'
      security:
      - oauth2:
        - https://www.googleapis.com/auth/marketingplatformadmin.analytics.update
      x-discovery-id: marketingplatformadmin.organizations.userGroups.patch
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserGroup'
    get:
      operationId: getUserGroup
      summary: marketingplatformadmin.organizations.userGroups.get
      description: Looks up a single user group.
      tags:
      - User Groups
      parameters:
      - name: organizationsId
        in: path
        required: true
        schema:
          type: string
        description: Path segment of `v1alpha/{+name}`.
      - name: userGroupsId
        in: path
        required: true
        schema:
          type: string
        description: Path segment of `v1alpha/{+name}`.
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserGroup'
      security:
      - oauth2:
        - https://www.googleapis.com/auth/marketingplatformadmin.analytics.read
        - https://www.googleapis.com/auth/marketingplatformadmin.analytics.update
      x-discovery-id: marketingplatformadmin.organizations.userGroups.get
components:
  schemas:
    ListUserGroupsResponse:
      type: object
      description: Response message for ListUserGroups RPC.
      properties:
        nextPageToken:
          type: string
          description: A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
        userGroups:
          type: array
          description: User groups in the organization.
          items:
            $ref: '#/components/schemas/UserGroup'
    Empty:
      type: object
      description: 'A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }'
      properties: {}
    UserGroup:
      type: object
      description: A resource message representing a user group in a GMP organization.
      properties:
        displayName:
          type: string
          description: Optional. The human-readable name for the user group.
        name:
          type: string
          description: 'Identifier. Resource name of this UserGroup. Format: organizations/{org_id}/userGroups/{user_group_id} Example: "organizations/123abc/userGroups/456def"'
        description:
          type: string
          description: Optional. The description of the user group.
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://accounts.google.com/o/oauth2/auth
          tokenUrl: https://oauth2.googleapis.com/token
          scopes:
            https://www.googleapis.com/auth/marketingplatformadmin.analytics.update: Manage your Google Analytics product account data in GMP home
            https://www.googleapis.com/auth/marketingplatformadmin.analytics.read: View your Google Analytics product account data in GMP home
x-generated-from: google-discovery-document
x-source: https://marketingplatformadmin.googleapis.com/$discovery/rest?version=v1alpha
x-discovery-revision: '20261103'