Google Marketing Platform Admin Organizations API

openapi: 3.2.0
info:
  title: Google Marketing Platform Admin API v1alpha … ……
  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: Organizations
paths:
  /v1alpha/organizations/{organizationsId}:reportPropertyUsage:
    post:
      operationId: reportPropertyUsage
      summary: marketingplatformadmin.organizations.reportPropertyUsage
      description: Gets the usage and billing data for properties within the organization for the specified month. Per direct client org, user needs to be OrgAdmin/BillingAdmin on the organization in order to view the billing and usage data. Per sales partner client org, user needs to be OrgAdmin/BillingAdmin on the sales partner org in order to view the billing and usage data, or OrgAdmin/BillingAdmin on the sales partner client org in order to view the usage data only.
      tags:
      - Organizations
      parameters:
      - name: organizationsId
        in: path
        required: true
        schema:
          type: string
        description: Path segment of `v1alpha/{+organization}:reportPropertyUsage`.
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportPropertyUsageResponse'
      security:
      - oauth2:
        - https://www.googleapis.com/auth/marketingplatformadmin.analytics.read
        - https://www.googleapis.com/auth/marketingplatformadmin.analytics.update
      x-discovery-id: marketingplatformadmin.organizations.reportPropertyUsage
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReportPropertyUsageRequest'
  /v1alpha/organizations/{organizationsId}:findSalesPartnerManagedClients:
    post:
      operationId: findSalesPartnerManagedClients
      summary: marketingplatformadmin.organizations.findSalesPartnerManagedClients
      description: Returns a list of clients managed by the sales partner organization. User needs to be an OrgAdmin/BillingAdmin on the sales partner organization in order to view the end clients.
      tags:
      - Organizations
      parameters:
      - name: organizationsId
        in: path
        required: true
        schema:
          type: string
        description: Path segment of `v1alpha/{+organization}:findSalesPartnerManagedClients`.
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FindSalesPartnerManagedClientsResponse'
      security:
      - oauth2:
        - https://www.googleapis.com/auth/marketingplatformadmin.analytics.read
        - https://www.googleapis.com/auth/marketingplatformadmin.analytics.update
      x-discovery-id: marketingplatformadmin.organizations.findSalesPartnerManagedClients
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FindSalesPartnerManagedClientsRequest'
  /v1alpha/organizations/{organizationsId}:
    get:
      operationId: getOrganization
      summary: marketingplatformadmin.organizations.get
      description: Looks up a single organization.
      tags:
      - Organizations
      parameters:
      - name: organizationsId
        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/Organization'
      security:
      - oauth2:
        - https://www.googleapis.com/auth/marketingplatformadmin.analytics.read
        - https://www.googleapis.com/auth/marketingplatformadmin.analytics.update
      x-discovery-id: marketingplatformadmin.organizations.get
components:
  schemas:
    ReportPropertyUsageRequest:
      type: object
      description: Request message for ReportPropertyUsage RPC.
      properties:
        month:
          type: string
          description: 'Required. The target month to list property usages. Format: YYYY-MM. For example, "2025-05"'
    ReportPropertyUsageResponse:
      type: object
      description: Response message for ReportPropertyUsage RPC.
      properties:
        billInfo:
          $ref: '#/components/schemas/BillInfo'
        propertyUsages:
          type: array
          description: Usage data for all properties in the specified organization and month.
          items:
            $ref: '#/components/schemas/PropertyUsage'
    Date:
      type: object
      description: 'Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp'
      properties:
        year:
          type: integer
          description: Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
          format: int32
        day:
          type: integer
          description: Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
          format: int32
        month:
          type: integer
          description: Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
          format: int32
    FindSalesPartnerManagedClientsRequest:
      type: object
      description: Request message for FindSalesPartnerManagedClients RPC.
      properties:
        isActive:
          type: boolean
          description: Optional. If set, only active and just ended clients will be returned.
    BillInfo:
      type: object
      description: Contains the bill amount.
      properties:
        eventFee:
          $ref: '#/components/schemas/Money'
        total:
          $ref: '#/components/schemas/Money'
        baseFee:
          $ref: '#/components/schemas/Money'
        priceProtectionCredit:
          $ref: '#/components/schemas/Money'
    Money:
      type: object
      description: Represents an amount of money with its currency type.
      properties:
        currencyCode:
          type: string
          description: The three-letter currency code defined in ISO 4217.
        units:
          type: string
          description: The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
          format: int64
        nanos:
          type: integer
          description: Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
          format: int32
    Organization:
      type: object
      description: A resource message representing a Google Marketing Platform organization.
      properties:
        name:
          type: string
          description: 'Identifier. The resource name of the GMP organization. Format: organizations/{org_id}'
        displayName:
          type: string
          description: The human-readable name for the organization.
    ClientData:
      type: object
      description: Contains the client data.
      properties:
        organization:
          $ref: '#/components/schemas/Organization'
        startDate:
          $ref: '#/components/schemas/Date'
        endDate:
          $ref: '#/components/schemas/Date'
    PropertyUsage:
      type: object
      description: Contains the count of events received by the property, along with metadata that influences the volume of `billable` events.
      properties:
        billableEventCount:
          type: string
          description: The number of events for which the property is billed in the requested month.
          format: int64
        serviceLevel:
          type: string
          description: The service level of the property.
          enum:
          - ANALYTICS_SERVICE_LEVEL_UNSPECIFIED
          - ANALYTICS_SERVICE_LEVEL_STANDARD
          - ANALYTICS_SERVICE_LEVEL_360
          x-enum-descriptions:
          - Service level unspecified.
          - The standard version of Google Analytics.
          - The premium version of Google Analytics.
        property:
          type: string
          description: 'The name of the Google Analytics Admin API property resource. Format: analyticsadmin.googleapis.com/properties/{property_id}'
        totalEventCount:
          type: string
          description: Total event count that the property received during the requested month.
          format: int64
        accountId:
          type: string
          description: The ID of the property's parent account.
          format: int64
        displayName:
          type: string
          description: The display name of the property.
        propertyType:
          type: string
          description: The subtype of the analytics property. This affects the billable event count.
          enum:
          - ANALYTICS_PROPERTY_TYPE_UNSPECIFIED
          - ANALYTICS_PROPERTY_TYPE_ORDINARY
          - ANALYTICS_PROPERTY_TYPE_SUBPROPERTY
          - ANALYTICS_PROPERTY_TYPE_ROLLUP
          x-enum-descriptions:
          - Unknown or unspecified property type
          - Ordinary Google Analytics property
          - Google Analytics subproperty
          - Google Analytics rollup property
    FindSalesPartnerManagedClientsResponse:
      type: object
      description: Response message for FindSalesPartnerManagedClients RPC.
      properties:
        clientData:
          type: array
          description: The clients managed by the sales org.
          items:
            $ref: '#/components/schemas/ClientData'
  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'