marketingplatformadmin

package
v0.257.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 2, 2025 License: BSD-3-Clause Imports: 18 Imported by: 0

Documentation

Overview

Package marketingplatformadmin provides access to the Google Marketing Platform Admin API.

For product documentation, see: https://developers.google.com/analytics/devguides/config/gmp/v1

Library status

These client libraries are officially supported by Google. However, this library is considered complete and is in maintenance mode. This means that we will address critical bugs and security issues but will not add any new features.

When possible, we recommend using our newer [Cloud Client Libraries for Go](https://pkg.go.dev/cloud.google.com/go) that are still actively being worked and iterated on.

Creating a client

Usage example:

import "google.golang.org/api/marketingplatformadmin/v1alpha"
...
ctx := context.Background()
marketingplatformadminService, err := marketingplatformadmin.NewService(ctx)

In this example, Google Application Default Credentials are used for authentication. For information on how to create and obtain Application Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.

Other authentication options

By default, all available scopes (see "Constants") are used to authenticate. To restrict scopes, use google.golang.org/api/option.WithScopes:

marketingplatformadminService, err := marketingplatformadmin.NewService(ctx, option.WithScopes(marketingplatformadmin.MarketingplatformadminAnalyticsUpdateScope))

To use an API key for authentication (note: some APIs do not support API keys), use google.golang.org/api/option.WithAPIKey:

marketingplatformadminService, err := marketingplatformadmin.NewService(ctx, option.WithAPIKey("AIza..."))

To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow, use google.golang.org/api/option.WithTokenSource:

config := &oauth2.Config{...}
// ...
token, err := config.Exchange(ctx, ...)
marketingplatformadminService, err := marketingplatformadmin.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))

See google.golang.org/api/option.ClientOption for details on options.

Index

Constants

View Source
const (
	// View your Google Analytics product account data in GMP home
	MarketingplatformadminAnalyticsReadScope = "https://www.googleapis.com/auth/marketingplatformadmin.analytics.read"

	// Manage your Google Analytics product account data in GMP home
	MarketingplatformadminAnalyticsUpdateScope = "https://www.googleapis.com/auth/marketingplatformadmin.analytics.update"
)

OAuth2 scopes used by this API.

Variables

This section is empty.

Functions

This section is empty.

Types

type AnalyticsAccountLink struct {
	// AnalyticsAccount: Required. Immutable. The resource name of the
	// AnalyticsAdmin API account. The account ID will be used as the ID of this
	// AnalyticsAccountLink resource, which will become the final component of the
	// resource name. Format: analyticsadmin.googleapis.com/accounts/{account_id}
	AnalyticsAccount string `json:"analyticsAccount,omitempty"`
	// DisplayName: Output only. The human-readable name for the Analytics account.
	DisplayName string `json:"displayName,omitempty"`
	// LinkVerificationState: Output only. The verification state of the link
	// between the Analytics account and the parent organization.
	//
	// Possible values:
	//   "LINK_VERIFICATION_STATE_UNSPECIFIED" - The link state is unknown.
	//   "LINK_VERIFICATION_STATE_VERIFIED" - The link is established.
	//   "LINK_VERIFICATION_STATE_NOT_VERIFIED" - The link is requested, but hasn't
	// been approved by the product account admin.
	LinkVerificationState string `json:"linkVerificationState,omitempty"`
	// Name: 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 `json:"name,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "AnalyticsAccount") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AnalyticsAccount") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

AnalyticsAccountLink: A resource message representing the link between a Google Analytics account and a Google Marketing Platform organization.

func (AnalyticsAccountLink) MarshalJSON

func (s AnalyticsAccountLink) MarshalJSON() ([]byte, error)

type BillInfo added in v0.255.0

type BillInfo struct {
	// BaseFee: The amount of the monthly base fee.
	BaseFee *Money `json:"baseFee,omitempty"`
	// EventFee: The amount of the event fee.
	EventFee *Money `json:"eventFee,omitempty"`
	// PriceProtectionCredit: The amount of the price protection credit, this is
	// only available for eligible customers.
	PriceProtectionCredit *Money `json:"priceProtectionCredit,omitempty"`
	// Total: The total amount of the bill.
	Total *Money `json:"total,omitempty"`
	// ForceSendFields is a list of field names (e.g. "BaseFee") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "BaseFee") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

BillInfo: Contains the bill amount.

func (BillInfo) MarshalJSON added in v0.255.0

func (s BillInfo) MarshalJSON() ([]byte, error)

type ClientData added in v0.255.0

type ClientData struct {
	// EndDate: The end date of the contract between the sales org and the end
	// client.
	EndDate *Date `json:"endDate,omitempty"`
	// Organization: The end client that has/had contract with the requested sales
	// org.
	Organization *Organization `json:"organization,omitempty"`
	// StartDate: The start date of the contract between the sales org and the end
	// client.
	StartDate *Date `json:"startDate,omitempty"`
	// ForceSendFields is a list of field names (e.g. "EndDate") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "EndDate") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ClientData: Contains the client data.

func (ClientData) MarshalJSON added in v0.255.0

func (s ClientData) MarshalJSON() ([]byte, error)

type Date added in v0.255.0

type Date struct {
	// Day: 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 int64 `json:"day,omitempty"`
	// Month: Month of a year. Must be from 1 to 12, or 0 to specify a year without
	// a month and day.
	Month int64 `json:"month,omitempty"`
	// Year: Year of the date. Must be from 1 to 9999, or 0 to specify a date
	// without a year.
	Year int64 `json:"year,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Day") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Day") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Date: 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

func (Date) MarshalJSON added in v0.255.0

func (s Date) MarshalJSON() ([]byte, error)

type Empty

type Empty struct {
	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
}

Empty: 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); }

type FindSalesPartnerManagedClientsRequest added in v0.255.0

type FindSalesPartnerManagedClientsRequest struct {
	// IsActive: Optional. If set, only active and just ended clients will be
	// returned.
	IsActive bool `json:"isActive,omitempty"`
	// ForceSendFields is a list of field names (e.g. "IsActive") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "IsActive") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

FindSalesPartnerManagedClientsRequest: Request message for FindSalesPartnerManagedClients RPC.

func (FindSalesPartnerManagedClientsRequest) MarshalJSON added in v0.255.0

func (s FindSalesPartnerManagedClientsRequest) MarshalJSON() ([]byte, error)

type FindSalesPartnerManagedClientsResponse added in v0.255.0

type FindSalesPartnerManagedClientsResponse struct {
	// ClientData: The clients managed by the sales org.
	ClientData []*ClientData `json:"clientData,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "ClientData") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ClientData") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

FindSalesPartnerManagedClientsResponse: Response message for FindSalesPartnerManagedClients RPC.

func (FindSalesPartnerManagedClientsResponse) MarshalJSON added in v0.255.0

func (s FindSalesPartnerManagedClientsResponse) MarshalJSON() ([]byte, error)

type ListAnalyticsAccountLinksResponse

type ListAnalyticsAccountLinksResponse struct {
	// AnalyticsAccountLinks: Analytics account links in this organization.
	AnalyticsAccountLinks []*AnalyticsAccountLink `json:"analyticsAccountLinks,omitempty"`
	// NextPageToken: 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 `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "AnalyticsAccountLinks") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AnalyticsAccountLinks") to
	// include in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ListAnalyticsAccountLinksResponse: Response message for ListAnalyticsAccountLinks RPC.

func (ListAnalyticsAccountLinksResponse) MarshalJSON

func (s ListAnalyticsAccountLinksResponse) MarshalJSON() ([]byte, error)

type ListOrganizationsResponse added in v0.255.0

type ListOrganizationsResponse struct {
	// NextPageToken: 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 `json:"nextPageToken,omitempty"`
	// Organizations: The Organization resource that the user has access to, which
	// includes the org id and display name.
	Organizations []*Organization `json:"organizations,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "NextPageToken") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "NextPageToken") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ListOrganizationsResponse: Response message for ListOrganizations RPC.

func (ListOrganizationsResponse) MarshalJSON added in v0.255.0

func (s ListOrganizationsResponse) MarshalJSON() ([]byte, error)

type Money added in v0.255.0

type Money struct {
	// CurrencyCode: The three-letter currency code defined in ISO 4217.
	CurrencyCode string `json:"currencyCode,omitempty"`
	// Nanos: 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 int64 `json:"nanos,omitempty"`
	// Units: The whole units of the amount. For example if `currencyCode` is
	// "USD", then 1 unit is one US dollar.
	Units int64 `json:"units,omitempty,string"`
	// ForceSendFields is a list of field names (e.g. "CurrencyCode") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "CurrencyCode") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Money: Represents an amount of money with its currency type.

func (Money) MarshalJSON added in v0.255.0

func (s Money) MarshalJSON() ([]byte, error)

type Organization added in v0.173.0

type Organization struct {
	// DisplayName: The human-readable name for the organization.
	DisplayName string `json:"displayName,omitempty"`
	// Name: Identifier. The resource name of the GMP organization. Format:
	// organizations/{org_id}
	Name string `json:"name,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "DisplayName") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "DisplayName") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Organization: A resource message representing a Google Marketing Platform organization.

func (Organization) MarshalJSON added in v0.173.0

func (s Organization) MarshalJSON() ([]byte, error)

type OrganizationsAnalyticsAccountLinksCreateCall

type OrganizationsAnalyticsAccountLinksCreateCall struct {
	// contains filtered or unexported fields
}

func (*OrganizationsAnalyticsAccountLinksCreateCall) Context

Context sets the context to be used in this call's Do method.

func (*OrganizationsAnalyticsAccountLinksCreateCall) Do

Do executes the "marketingplatformadmin.organizations.analyticsAccountLinks.create" call. Any non-2xx status code is an error. Response headers are in either *AnalyticsAccountLink.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*OrganizationsAnalyticsAccountLinksCreateCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*OrganizationsAnalyticsAccountLinksCreateCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type OrganizationsAnalyticsAccountLinksDeleteCall

type OrganizationsAnalyticsAccountLinksDeleteCall struct {
	// contains filtered or unexported fields
}

func (*OrganizationsAnalyticsAccountLinksDeleteCall) Context

Context sets the context to be used in this call's Do method.

func (*OrganizationsAnalyticsAccountLinksDeleteCall) Do

Do executes the "marketingplatformadmin.organizations.analyticsAccountLinks.delete" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*OrganizationsAnalyticsAccountLinksDeleteCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*OrganizationsAnalyticsAccountLinksDeleteCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type OrganizationsAnalyticsAccountLinksListCall

type OrganizationsAnalyticsAccountLinksListCall struct {
	// contains filtered or unexported fields
}

func (*OrganizationsAnalyticsAccountLinksListCall) Context

Context sets the context to be used in this call's Do method.

func (*OrganizationsAnalyticsAccountLinksListCall) Do

Do executes the "marketingplatformadmin.organizations.analyticsAccountLinks.list" call. Any non-2xx status code is an error. Response headers are in either *ListAnalyticsAccountLinksResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*OrganizationsAnalyticsAccountLinksListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*OrganizationsAnalyticsAccountLinksListCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*OrganizationsAnalyticsAccountLinksListCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*OrganizationsAnalyticsAccountLinksListCall) PageSize

PageSize sets the optional parameter "pageSize": The maximum number of Analytics account links to return in one call. The service may return fewer than this value. If unspecified, at most 50 Analytics account links will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

func (*OrganizationsAnalyticsAccountLinksListCall) PageToken

PageToken sets the optional parameter "pageToken": A page token, received from a previous ListAnalyticsAccountLinks call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAnalyticsAccountLinks` must match the call that provided the page token.

func (*OrganizationsAnalyticsAccountLinksListCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type OrganizationsAnalyticsAccountLinksService

type OrganizationsAnalyticsAccountLinksService struct {
	// contains filtered or unexported fields
}

func NewOrganizationsAnalyticsAccountLinksService

func NewOrganizationsAnalyticsAccountLinksService(s *Service) *OrganizationsAnalyticsAccountLinksService

func (*OrganizationsAnalyticsAccountLinksService) Create

Create: Creates the link between the Analytics account and the Google Marketing Platform organization. User needs to be an org user, and admin on the Analytics account to create the link. If the account is already linked to an organization, user needs to unlink the account from the current organization, then try link again.

  • parent: The parent resource where this Analytics account link will be created. Format: organizations/{org_id}.

func (*OrganizationsAnalyticsAccountLinksService) Delete

Delete: Deletes the AnalyticsAccountLink, which detaches the Analytics account from the Google Marketing Platform organization. User needs to be an org user, and admin on the Analytics account in order to delete the link.

  • name: The name of the Analytics account link to delete. Format: organizations/{org_id}/analyticsAccountLinks/{analytics_account_link_id}.

func (*OrganizationsAnalyticsAccountLinksService) List

List: Lists the Google Analytics accounts link to the specified Google Marketing Platform organization.

  • parent: The parent organization, which owns this collection of Analytics account links. Format: organizations/{org_id}.

func (*OrganizationsAnalyticsAccountLinksService) SetPropertyServiceLevel

func (r *OrganizationsAnalyticsAccountLinksService) SetPropertyServiceLevel(analyticsAccountLink string, setpropertyservicelevelrequest *SetPropertyServiceLevelRequest) *OrganizationsAnalyticsAccountLinksSetPropertyServiceLevelCall

SetPropertyServiceLevel: Updates the service level for an Analytics property.

  • analyticsAccountLink: The parent AnalyticsAccountLink scope where this property is in. Format: organizations/{org_id}/analyticsAccountLinks/{analytics_account_link_id}.

type OrganizationsAnalyticsAccountLinksSetPropertyServiceLevelCall

type OrganizationsAnalyticsAccountLinksSetPropertyServiceLevelCall struct {
	// contains filtered or unexported fields
}

func (*OrganizationsAnalyticsAccountLinksSetPropertyServiceLevelCall) Context

Context sets the context to be used in this call's Do method.

func (*OrganizationsAnalyticsAccountLinksSetPropertyServiceLevelCall) Do

Do executes the "marketingplatformadmin.organizations.analyticsAccountLinks.setPropertyServiceLevel" call. Any non-2xx status code is an error. Response headers are in either *SetPropertyServiceLevelResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*OrganizationsAnalyticsAccountLinksSetPropertyServiceLevelCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*OrganizationsAnalyticsAccountLinksSetPropertyServiceLevelCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type OrganizationsFindSalesPartnerManagedClientsCall added in v0.255.0

type OrganizationsFindSalesPartnerManagedClientsCall struct {
	// contains filtered or unexported fields
}

func (*OrganizationsFindSalesPartnerManagedClientsCall) Context added in v0.255.0

Context sets the context to be used in this call's Do method.

func (*OrganizationsFindSalesPartnerManagedClientsCall) Do added in v0.255.0

Do executes the "marketingplatformadmin.organizations.findSalesPartnerManagedClients" call. Any non-2xx status code is an error. Response headers are in either *FindSalesPartnerManagedClientsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*OrganizationsFindSalesPartnerManagedClientsCall) Fields added in v0.255.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*OrganizationsFindSalesPartnerManagedClientsCall) Header added in v0.255.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type OrganizationsGetCall added in v0.173.0

type OrganizationsGetCall struct {
	// contains filtered or unexported fields
}

func (*OrganizationsGetCall) Context added in v0.173.0

Context sets the context to be used in this call's Do method.

func (*OrganizationsGetCall) Do added in v0.173.0

Do executes the "marketingplatformadmin.organizations.get" call. Any non-2xx status code is an error. Response headers are in either *Organization.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*OrganizationsGetCall) Fields added in v0.173.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*OrganizationsGetCall) Header added in v0.173.0

func (c *OrganizationsGetCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*OrganizationsGetCall) IfNoneMatch added in v0.173.0

func (c *OrganizationsGetCall) IfNoneMatch(entityTag string) *OrganizationsGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type OrganizationsListCall added in v0.255.0

type OrganizationsListCall struct {
	// contains filtered or unexported fields
}

func (*OrganizationsListCall) Context added in v0.255.0

Context sets the context to be used in this call's Do method.

func (*OrganizationsListCall) Do added in v0.255.0

Do executes the "marketingplatformadmin.organizations.list" call. Any non-2xx status code is an error. Response headers are in either *ListOrganizationsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*OrganizationsListCall) Fields added in v0.255.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*OrganizationsListCall) Header added in v0.255.0

func (c *OrganizationsListCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*OrganizationsListCall) IfNoneMatch added in v0.255.0

func (c *OrganizationsListCall) IfNoneMatch(entityTag string) *OrganizationsListCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*OrganizationsListCall) PageSize added in v0.255.0

func (c *OrganizationsListCall) PageSize(pageSize int64) *OrganizationsListCall

PageSize sets the optional parameter "pageSize": 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.

func (*OrganizationsListCall) PageToken added in v0.255.0

func (c *OrganizationsListCall) PageToken(pageToken string) *OrganizationsListCall

PageToken sets the optional parameter "pageToken": 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.

func (*OrganizationsListCall) Pages added in v0.255.0

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type OrganizationsReportPropertyUsageCall added in v0.255.0

type OrganizationsReportPropertyUsageCall struct {
	// contains filtered or unexported fields
}

func (*OrganizationsReportPropertyUsageCall) Context added in v0.255.0

Context sets the context to be used in this call's Do method.

func (*OrganizationsReportPropertyUsageCall) Do added in v0.255.0

Do executes the "marketingplatformadmin.organizations.reportPropertyUsage" call. Any non-2xx status code is an error. Response headers are in either *ReportPropertyUsageResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*OrganizationsReportPropertyUsageCall) Fields added in v0.255.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*OrganizationsReportPropertyUsageCall) Header added in v0.255.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type OrganizationsService

type OrganizationsService struct {
	AnalyticsAccountLinks *OrganizationsAnalyticsAccountLinksService
	// contains filtered or unexported fields
}

func NewOrganizationsService

func NewOrganizationsService(s *Service) *OrganizationsService

func (*OrganizationsService) FindSalesPartnerManagedClients added in v0.255.0

func (r *OrganizationsService) FindSalesPartnerManagedClients(organization string, findsalespartnermanagedclientsrequest *FindSalesPartnerManagedClientsRequest) *OrganizationsFindSalesPartnerManagedClientsCall

FindSalesPartnerManagedClients: 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.

  • organization: The name of the sales partner organization. Format: organizations/{org_id}.

func (*OrganizationsService) Get added in v0.173.0

Get: Lookup for a single organization.

  • name: The name of the Organization to retrieve. Format: organizations/{org_id}.

func (*OrganizationsService) List added in v0.255.0

List: Returns a list of organizations that the user has access to.

func (*OrganizationsService) ReportPropertyUsage added in v0.255.0

func (r *OrganizationsService) ReportPropertyUsage(organization string, reportpropertyusagerequest *ReportPropertyUsageRequest) *OrganizationsReportPropertyUsageCall

ReportPropertyUsage: 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.

  • organization: Specifies the organization whose property usage will be listed. Format: organizations/{org_id}.

type PropertyUsage added in v0.255.0

type PropertyUsage struct {
	// AccountId: The ID of the property's parent account.
	AccountId int64 `json:"accountId,omitempty,string"`
	// BillableEventCount: The number of events for which the property is billed in
	// the requested month.
	BillableEventCount int64 `json:"billableEventCount,omitempty,string"`
	// DisplayName: The display name of the property.
	DisplayName string `json:"displayName,omitempty"`
	// Property: The name of the Google Analytics Admin API property resource.
	// Format: analyticsadmin.googleapis.com/properties/{property_id}
	Property string `json:"property,omitempty"`
	// PropertyType: The subtype of the analytics property. This affects the
	// billable event count.
	//
	// Possible values:
	//   "ANALYTICS_PROPERTY_TYPE_UNSPECIFIED" - Unknown or unspecified property
	// type
	//   "ANALYTICS_PROPERTY_TYPE_ORDINARY" - Ordinary Google Analytics property
	//   "ANALYTICS_PROPERTY_TYPE_SUBPROPERTY" - Google Analytics subproperty
	//   "ANALYTICS_PROPERTY_TYPE_ROLLUP" - Google Analytics rollup property
	PropertyType string `json:"propertyType,omitempty"`
	// ServiceLevel: The service level of the property.
	//
	// Possible values:
	//   "ANALYTICS_SERVICE_LEVEL_UNSPECIFIED" - Service level unspecified.
	//   "ANALYTICS_SERVICE_LEVEL_STANDARD" - The standard version of Google
	// Analytics.
	//   "ANALYTICS_SERVICE_LEVEL_360" - The premium version of Google Analytics.
	ServiceLevel string `json:"serviceLevel,omitempty"`
	// TotalEventCount: Total event count that the property received during the
	// requested month.
	TotalEventCount int64 `json:"totalEventCount,omitempty,string"`
	// ForceSendFields is a list of field names (e.g. "AccountId") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AccountId") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

PropertyUsage: Contains the count of events received by the property, along with metadata that influences the volume of `billable` events.

func (PropertyUsage) MarshalJSON added in v0.255.0

func (s PropertyUsage) MarshalJSON() ([]byte, error)

type ReportPropertyUsageRequest added in v0.255.0

type ReportPropertyUsageRequest struct {
	// Month: Required. The target month to list property usages. Format: YYYY-MM.
	// For example, "2025-05"
	Month string `json:"month,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Month") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Month") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ReportPropertyUsageRequest: Request message for ReportPropertyUsage RPC.

func (ReportPropertyUsageRequest) MarshalJSON added in v0.255.0

func (s ReportPropertyUsageRequest) MarshalJSON() ([]byte, error)

type ReportPropertyUsageResponse added in v0.255.0

type ReportPropertyUsageResponse struct {
	// BillInfo: Bill amount in the specified organization and month. Will be empty
	// if user only has access to usage data.
	BillInfo *BillInfo `json:"billInfo,omitempty"`
	// PropertyUsages: Usage data for all properties in the specified organization
	// and month.
	PropertyUsages []*PropertyUsage `json:"propertyUsages,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "BillInfo") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "BillInfo") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ReportPropertyUsageResponse: Response message for ReportPropertyUsage RPC.

func (ReportPropertyUsageResponse) MarshalJSON added in v0.255.0

func (s ReportPropertyUsageResponse) MarshalJSON() ([]byte, error)

type Service

type Service struct {
	BasePath  string // API endpoint base URL
	UserAgent string // optional additional User-Agent fragment

	Organizations *OrganizationsService
	// contains filtered or unexported fields
}

func New deprecated

func New(client *http.Client) (*Service, error)

New creates a new Service. It uses the provided http.Client for requests.

Deprecated: please use NewService instead. To provide a custom HTTP client, use option.WithHTTPClient. If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.

func NewService

func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error)

NewService creates a new Service.

type SetPropertyServiceLevelRequest

type SetPropertyServiceLevelRequest struct {
	// AnalyticsProperty: 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 `json:"analyticsProperty,omitempty"`
	// ServiceLevel: Required. The service level to set for this property.
	//
	// Possible values:
	//   "ANALYTICS_SERVICE_LEVEL_UNSPECIFIED" - Service level unspecified.
	//   "ANALYTICS_SERVICE_LEVEL_STANDARD" - The standard version of Google
	// Analytics.
	//   "ANALYTICS_SERVICE_LEVEL_360" - The premium version of Google Analytics.
	ServiceLevel string `json:"serviceLevel,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AnalyticsProperty") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AnalyticsProperty") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

SetPropertyServiceLevelRequest: Request message for SetPropertyServiceLevel RPC.

func (SetPropertyServiceLevelRequest) MarshalJSON

func (s SetPropertyServiceLevelRequest) MarshalJSON() ([]byte, error)

type SetPropertyServiceLevelResponse

type SetPropertyServiceLevelResponse struct {
	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
}

SetPropertyServiceLevelResponse: Response message for SetPropertyServiceLevel RPC.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL