@maxim_mazurok/gapi.client.marketingplatformadmin-v1alpha 0.1.20251028 → 0.1.20251029

package/index.d.ts

@@ -9,7 +9,7 @@
 // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
 // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
 // Generated from: https://marketingplatformadmin.googleapis.com/$discovery/rest?version=v1alpha
-// Revision: 20251028
+// Revision: 20251029
 
 /// <reference types="gapi.client" />
 
@@ -41,19 +41,93 @@ declare namespace gapi.client {
       /** Identifier. Resource name of this AnalyticsAccountLink. Note the resource ID is the same as the ID of the Analtyics account. Format: organizations/{org_id}/analyticsAccountLinks/{analytics_account_link_id} Example: "organizations/xyz/analyticsAccountLinks/1234" */
       name?: string;
     }
+    interface BillInfo {
+      /** The amount of the monthly base fee. */
+      baseFee?: Money;
+      /** The amount of the event fee. */
+      eventFee?: Money;
+      /** The amount of the price protection credit, this is only available for eligible customers. */
+      priceProtectionCredit?: Money;
+      /** The total amount of the bill. */
+      total?: Money;
+    }
+    interface ClientData {
+      /** The end date of the contract between the sales org and the end client. */
+      endDate?: Date;
+      /** The end client that has/had contract with the requested sales org. */
+      organization?: Organization;
+      /** The start date of the contract between the sales org and the end client. */
+      startDate?: Date;
+    }
+    interface Date {
+      /** 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. */
+      day?: number;
+      /** Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. */
+      month?: number;
+      /** Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. */
+      year?: number;
+    }
     interface Empty {}
+    interface FindSalesPartnerManagedClientsRequest {
+      /** Optional. If set, only active and just ended clients will be returned. */
+      isActive?: boolean;
+    }
+    interface FindSalesPartnerManagedClientsResponse {
+      /** The clients managed by the sales org. */
+      clientData?: ClientData[];
+    }
     interface ListAnalyticsAccountLinksResponse {
       /** Analytics account links in this organization. */
       analyticsAccountLinks?: AnalyticsAccountLink[];
       /** A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. */
       nextPageToken?: string;
     }
+    interface ListOrganizationsResponse {
+      /** A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. */
+      nextPageToken?: string;
+      /** The Organization resource that the user has access to, which includes the org id and display name. */
+      organizations?: Organization[];
+    }
+    interface Money {
+      /** The three-letter currency code defined in ISO 4217. */
+      currencyCode?: string;
+      /** 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. */
+      nanos?: number;
+      /** The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. */
+      units?: string;
+    }
     interface Organization {
       /** The human-readable name for the organization. */
       displayName?: string;
       /** Identifier. The resource name of the GMP organization. Format: organizations/{org_id} */
       name?: string;
     }
+    interface PropertyUsage {
+      /** The ID of the property's parent account. */
+      accountId?: string;
+      /** The number of events for which the property is billed in the requested month. */
+      billableEventCount?: string;
+      /** The display name of the property. */
+      displayName?: string;
+      /** The name of the Google Analytics Admin API property resource. Format: analyticsadmin.googleapis.com/properties/{property_id} */
+      property?: string;
+      /** The subtype of the analytics property. This affects the billable event count. */
+      propertyType?: string;
+      /** The service level of the property. */
+      serviceLevel?: string;
+      /** Total event count that the property received during the requested month. */
+      totalEventCount?: string;
+    }
+    interface ReportPropertyUsageRequest {
+      /** Required. The target month to list property usages. Format: YYYY-MM. For example, "2025-05" */
+      month?: string;
+    }
+    interface ReportPropertyUsageResponse {
+      /** Bill amount in the specified organization and month. Will be empty if user only has access to usage data. */
+      billInfo?: BillInfo;
+      /** Usage data for all properties in the specified organization and month. */
+      propertyUsages?: PropertyUsage[];
+    }
     interface SetPropertyServiceLevelRequest {
       /** Required. The Analytics property to change the ServiceLevel setting. This field is the name of the Google Analytics Admin API property resource. Format: analyticsadmin.googleapis.com/properties/{property_id} */
       analyticsProperty?: string;
@@ -238,6 +312,64 @@ declare namespace gapi.client {
       ): Request<{}>;
     }
     interface OrganizationsResource {
+      /** 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. */
+      findSalesPartnerManagedClients(request: {
+        /** V1 error format. */
+        '$.xgafv'?: string;
+        /** OAuth access token. */
+        access_token?: string;
+        /** Data format for response. */
+        alt?: string;
+        /** JSONP */
+        callback?: string;
+        /** Selector specifying which fields to include in a partial response. */
+        fields?: string;
+        /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+        key?: string;
+        /** OAuth 2.0 token for the current user. */
+        oauth_token?: string;
+        /** Required. The name of the sales partner organization. Format: organizations/{org_id} */
+        organization: string;
+        /** Returns response with indentations and line breaks. */
+        prettyPrint?: boolean;
+        /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
+        quotaUser?: string;
+        /** Upload protocol for media (e.g. "raw", "multipart"). */
+        upload_protocol?: string;
+        /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+        uploadType?: string;
+        /** Request body */
+        resource: FindSalesPartnerManagedClientsRequest;
+      }): Request<FindSalesPartnerManagedClientsResponse>;
+      findSalesPartnerManagedClients(
+        request: {
+          /** V1 error format. */
+          '$.xgafv'?: string;
+          /** OAuth access token. */
+          access_token?: string;
+          /** Data format for response. */
+          alt?: string;
+          /** JSONP */
+          callback?: string;
+          /** Selector specifying which fields to include in a partial response. */
+          fields?: string;
+          /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+          key?: string;
+          /** OAuth 2.0 token for the current user. */
+          oauth_token?: string;
+          /** Required. The name of the sales partner organization. Format: organizations/{org_id} */
+          organization: string;
+          /** Returns response with indentations and line breaks. */
+          prettyPrint?: boolean;
+          /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
+          quotaUser?: string;
+          /** Upload protocol for media (e.g. "raw", "multipart"). */
+          upload_protocol?: string;
+          /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+          uploadType?: string;
+        },
+        body: FindSalesPartnerManagedClientsRequest,
+      ): Request<FindSalesPartnerManagedClientsResponse>;
       /** Lookup for a single organization. */
       get(request?: {
         /** V1 error format. */
@@ -265,6 +397,93 @@ declare namespace gapi.client {
         /** Legacy upload protocol for media (e.g. "media", "multipart"). */
         uploadType?: string;
       }): Request<Organization>;
+      /** Returns a list of organizations that the user has access to. */
+      list(request?: {
+        /** V1 error format. */
+        '$.xgafv'?: string;
+        /** OAuth access token. */
+        access_token?: string;
+        /** Data format for response. */
+        alt?: string;
+        /** JSONP */
+        callback?: string;
+        /** Selector specifying which fields to include in a partial response. */
+        fields?: string;
+        /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+        key?: string;
+        /** OAuth 2.0 token for the current user. */
+        oauth_token?: string;
+        /** Optional. The maximum number of organizations to return in one call. The service may return fewer than this value. If unspecified, at most 50 organizations will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. */
+        pageSize?: number;
+        /** Optional. A page token, received from a previous ListOrganizations call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListOrganizations` must match the call that provided the page token. */
+        pageToken?: string;
+        /** Returns response with indentations and line breaks. */
+        prettyPrint?: boolean;
+        /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
+        quotaUser?: string;
+        /** Upload protocol for media (e.g. "raw", "multipart"). */
+        upload_protocol?: string;
+        /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+        uploadType?: string;
+      }): Request<ListOrganizationsResponse>;
+      /** Get 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. */
+      reportPropertyUsage(request: {
+        /** V1 error format. */
+        '$.xgafv'?: string;
+        /** OAuth access token. */
+        access_token?: string;
+        /** Data format for response. */
+        alt?: string;
+        /** JSONP */
+        callback?: string;
+        /** Selector specifying which fields to include in a partial response. */
+        fields?: string;
+        /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+        key?: string;
+        /** OAuth 2.0 token for the current user. */
+        oauth_token?: string;
+        /** Required. Specifies the organization whose property usage will be listed. Format: organizations/{org_id} */
+        organization: string;
+        /** Returns response with indentations and line breaks. */
+        prettyPrint?: boolean;
+        /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
+        quotaUser?: string;
+        /** Upload protocol for media (e.g. "raw", "multipart"). */
+        upload_protocol?: string;
+        /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+        uploadType?: string;
+        /** Request body */
+        resource: ReportPropertyUsageRequest;
+      }): Request<ReportPropertyUsageResponse>;
+      reportPropertyUsage(
+        request: {
+          /** V1 error format. */
+          '$.xgafv'?: string;
+          /** OAuth access token. */
+          access_token?: string;
+          /** Data format for response. */
+          alt?: string;
+          /** JSONP */
+          callback?: string;
+          /** Selector specifying which fields to include in a partial response. */
+          fields?: string;
+          /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+          key?: string;
+          /** OAuth 2.0 token for the current user. */
+          oauth_token?: string;
+          /** Required. Specifies the organization whose property usage will be listed. Format: organizations/{org_id} */
+          organization: string;
+          /** Returns response with indentations and line breaks. */
+          prettyPrint?: boolean;
+          /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
+          quotaUser?: string;
+          /** Upload protocol for media (e.g. "raw", "multipart"). */
+          upload_protocol?: string;
+          /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+          uploadType?: string;
+        },
+        body: ReportPropertyUsageRequest,
+      ): Request<ReportPropertyUsageResponse>;
       analyticsAccountLinks: AnalyticsAccountLinksResource;
     }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maxim_mazurok/gapi.client.marketingplatformadmin-v1alpha",
-  "version": "0.1.20251028",
+  "version": "0.1.20251029",
   "description": "TypeScript typings for Google Marketing Platform Admin API v1alpha",
   "repository": {
     "type": "git",

package/readme.md

@@ -72,10 +72,29 @@ gapi.auth.authorize(
 After that you can use Google Marketing Platform Admin API resources: <!-- TODO: make this work for multiple namespaces -->
 
 ```typescript
+/*
+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.
+*/
+await gapi.client.marketingplatformadmin.organizations.findSalesPartnerManagedClients(
+  {organization: 'organization'},
+);
+
 /*
 Lookup for a single organization.
 */
 await gapi.client.marketingplatformadmin.organizations.get({name: 'name'});
+
+/*
+Returns a list of organizations that the user has access to.
+*/
+await gapi.client.marketingplatformadmin.organizations.list({});
+
+/*
+Get 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.
+*/
+await gapi.client.marketingplatformadmin.organizations.reportPropertyUsage({
+  organization: 'organization',
+});
 ```
 
 For provenance information see [Provenance section on NPM](https://www.npmjs.com/package/@maxim_mazurok/gapi.client.marketingplatformadmin-v1alpha#Provenance:~:text=none-,Provenance,-Built%20and%20signed)