Google Marketing Platform Admin Admin Access Bindings API

openapi: 3.2.0
info:
  title: Google Marketing Platform Admin API v1alpha Admin Access………
  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: AdminAccessBindings
paths:
  /v1alpha/organizations/{organizationsId}/adminAccessBindings:
    post:
      operationId: createAdminAccessBinding
      summary: marketingplatformadmin.organizations.adminAccessBindings.create
      description: Creates an admin access binding in the specified GMP organization.
      tags:
      - AdminAccessBindings
      parameters:
      - name: organizationsId
        in: path
        required: true
        schema:
          type: string
        description: Path segment of `v1alpha/{+parent}/adminAccessBindings`.
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdminAccessBinding'
      security:
      - oauth2:
        - https://www.googleapis.com/auth/marketingplatformadmin.analytics.update
      x-discovery-id: marketingplatformadmin.organizations.adminAccessBindings.create
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AdminAccessBinding'
    get:
      operationId: listAdminAccessBindings
      summary: marketingplatformadmin.organizations.adminAccessBindings.list
      description: Returns a list of admin access bindings in the specified GMP organization.
      tags:
      - AdminAccessBindings
      parameters:
      - name: organizationsId
        in: path
        required: true
        schema:
          type: string
        description: Path segment of `v1alpha/{+parent}/adminAccessBindings`.
      - name: pageToken
        in: query
        required: false
        description: Optional. A page token, received from a previous ListAdminAccessBindings call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAdminAccessBindings` must match the call that provided the page token.
        schema:
          type: string
      - name: pageSize
        in: query
        required: false
        description: Optional. The maximum number of Admin Access Bindings to return in one call. The service may return fewer than this value. If unspecified, at most 50 Admin Access Bindings 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/ListAdminAccessBindingsResponse'
      security:
      - oauth2:
        - https://www.googleapis.com/auth/marketingplatformadmin.analytics.read
        - https://www.googleapis.com/auth/marketingplatformadmin.analytics.update
      x-discovery-id: marketingplatformadmin.organizations.adminAccessBindings.list
  /v1alpha/organizations/{organizationsId}/adminAccessBindings/{adminAccessBindingsId}:
    patch:
      operationId: patchAdminAccessBinding
      summary: marketingplatformadmin.organizations.adminAccessBindings.patch
      description: Updates an admin access binding in the specified GMP organization.
      tags:
      - AdminAccessBindings
      parameters:
      - name: organizationsId
        in: path
        required: true
        schema:
          type: string
        description: Path segment of `v1alpha/{+name}`.
      - name: adminAccessBindingsId
        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/AdminAccessBinding'
      security:
      - oauth2:
        - https://www.googleapis.com/auth/marketingplatformadmin.analytics.update
      x-discovery-id: marketingplatformadmin.organizations.adminAccessBindings.patch
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AdminAccessBinding'
    get:
      operationId: getAdminAccessBinding
      summary: marketingplatformadmin.organizations.adminAccessBindings.get
      description: Looks up a single admin access binding.
      tags:
      - AdminAccessBindings
      parameters:
      - name: organizationsId
        in: path
        required: true
        schema:
          type: string
        description: Path segment of `v1alpha/{+name}`.
      - name: adminAccessBindingsId
        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/AdminAccessBinding'
      security:
      - oauth2:
        - https://www.googleapis.com/auth/marketingplatformadmin.analytics.read
        - https://www.googleapis.com/auth/marketingplatformadmin.analytics.update
      x-discovery-id: marketingplatformadmin.organizations.adminAccessBindings.get
components:
  schemas:
    ListAdminAccessBindingsResponse:
      type: object
      description: Response message for ListAdminAccessBindings 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.
        adminAccessBindings:
          type: array
          description: Admin Access Bindings in the organization.
          items:
            $ref: '#/components/schemas/AdminAccessBinding'
    AdminAccessBinding:
      type: object
      description: A resource message representing a binding to a set of roles.
      properties:
        organizationRoles:
          type: array
          description: Optional. A list of roles granted to the parent organization. USER_ADMIN_ROLE and BILLING_ADMIN_ROLE will be automatically added if ORG_ADMIN_ROLE is assigned. No roles will be assigned if no roles are specified.
          items:
            type: string
            enum:
            - ORGANIZATION_ROLE_UNSPECIFIED
            - ORG_ADMIN_ROLE
            - USER_ADMIN_ROLE
            - BILLING_ADMIN_ROLE
            x-enum-descriptions:
            - Unknown or unspecified organization role.
            - Organization admin role that grants all administrative privileges.
            - User admin role that grants access to the Users section to perform various user management functions.
            - Billing admin role that grants access to the Billing section to perform various billing-related functions.
        name:
          type: string
          description: 'Identifier. The resource name of this AdminAccessBinding. Format: organizations/{org_id}/adminAccessBindings/{admin_access_binding_id} Example: "organizations/123abc/adminAccessBindings/456def"'
        userEmail:
          type: string
          description: Email address of the user.
        userGroup:
          type: string
          description: Resource name 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'