marketingplatformadmin

package
v0.210.0 Latest Latest
Warning

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

 Go to latest Published: Dec 4, 2024 License: BSD-3-Clause Imports: 16 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 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 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 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 

func (c *OrganizationsAnalyticsAccountLinksCreateCall) Context(ctx context.Context) *OrganizationsAnalyticsAccountLinksCreateCall

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

func (*OrganizationsAnalyticsAccountLinksCreateCall) Do 

func (c *OrganizationsAnalyticsAccountLinksCreateCall) Do(opts ...googleapi.CallOption) (*AnalyticsAccountLink, error)

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 

func (c *OrganizationsAnalyticsAccountLinksCreateCall) Fields(s ...googleapi.Field) *OrganizationsAnalyticsAccountLinksCreateCall

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

func (*OrganizationsAnalyticsAccountLinksCreateCall) Header 

func (c *OrganizationsAnalyticsAccountLinksCreateCall) Header() http.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 

func (c *OrganizationsAnalyticsAccountLinksDeleteCall) Context(ctx context.Context) *OrganizationsAnalyticsAccountLinksDeleteCall

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

func (*OrganizationsAnalyticsAccountLinksDeleteCall) Do 

func (c *OrganizationsAnalyticsAccountLinksDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)

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 

func (c *OrganizationsAnalyticsAccountLinksDeleteCall) Fields(s ...googleapi.Field) *OrganizationsAnalyticsAccountLinksDeleteCall

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

func (*OrganizationsAnalyticsAccountLinksDeleteCall) Header 

func (c *OrganizationsAnalyticsAccountLinksDeleteCall) Header() http.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 

func (c *OrganizationsAnalyticsAccountLinksListCall) Context(ctx context.Context) *OrganizationsAnalyticsAccountLinksListCall

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

func (*OrganizationsAnalyticsAccountLinksListCall) Do 

func (c *OrganizationsAnalyticsAccountLinksListCall) Do(opts ...googleapi.CallOption) (*ListAnalyticsAccountLinksResponse, error)

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 

func (c *OrganizationsAnalyticsAccountLinksListCall) Fields(s ...googleapi.Field) *OrganizationsAnalyticsAccountLinksListCall

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

func (*OrganizationsAnalyticsAccountLinksListCall) Header 

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

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

func (*OrganizationsAnalyticsAccountLinksListCall) IfNoneMatch 

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

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 

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

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 

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

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 

func (c *OrganizationsAnalyticsAccountLinksListCall) Pages(ctx context.Context, f func(*ListAnalyticsAccountLinksResponse) error) error

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 

func (r *OrganizationsAnalyticsAccountLinksService) Create(parent string, analyticsaccountlink *AnalyticsAccountLink) *OrganizationsAnalyticsAccountLinksCreateCall

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 

func (r *OrganizationsAnalyticsAccountLinksService) Delete(name string) *OrganizationsAnalyticsAccountLinksDeleteCall

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 

func (r *OrganizationsAnalyticsAccountLinksService) List(parent string) *OrganizationsAnalyticsAccountLinksListCall

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 

func (c *OrganizationsAnalyticsAccountLinksSetPropertyServiceLevelCall) Context(ctx context.Context) *OrganizationsAnalyticsAccountLinksSetPropertyServiceLevelCall

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

func (*OrganizationsAnalyticsAccountLinksSetPropertyServiceLevelCall) Do 

func (c *OrganizationsAnalyticsAccountLinksSetPropertyServiceLevelCall) Do(opts ...googleapi.CallOption) (*SetPropertyServiceLevelResponse, error)

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 

func (c *OrganizationsAnalyticsAccountLinksSetPropertyServiceLevelCall) Fields(s ...googleapi.Field) *OrganizationsAnalyticsAccountLinksSetPropertyServiceLevelCall

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

func (*OrganizationsAnalyticsAccountLinksSetPropertyServiceLevelCall) Header 

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

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 

func (c *OrganizationsGetCall) Context(ctx context.Context) *OrganizationsGetCall

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

func (*OrganizationsGetCall) Do added in v0.173.0 

func (c *OrganizationsGetCall) Do(opts ...googleapi.CallOption) (*Organization, error)

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 

func (c *OrganizationsGetCall) Fields(s ...googleapi.Field) *OrganizationsGetCall

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 OrganizationsService 

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

func NewOrganizationsService 

func NewOrganizationsService(s *Service) *OrganizationsService

func (*OrganizationsService) Get added in v0.173.0 

func (r *OrganizationsService) Get(name string) *OrganizationsGetCall

Get: Lookup for a single organization.

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

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.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.