OAuth2 scopes used by this API.
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"
)
AnalyticsAccountLink: A resource message representing the link between a Google Analytics account and a Google Marketing Platform organization.
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:"-"`
}
func (s *AnalyticsAccountLink) MarshalJSON() ([]byte, error)
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 Empty struct {
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
}
ListAnalyticsAccountLinksResponse: Response message for ListAnalyticsAccountLinks RPC.
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:"-"`
}
func (s *ListAnalyticsAccountLinksResponse) MarshalJSON() ([]byte, error)
Organization: A resource message representing a Google Marketing Platform organization.
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:"-"`
}
func (s *Organization) MarshalJSON() ([]byte, error)
type OrganizationsAnalyticsAccountLinksCreateCall struct {
// contains filtered or unexported fields
}
func (c *OrganizationsAnalyticsAccountLinksCreateCall) Context(ctx context.Context) *OrganizationsAnalyticsAccountLinksCreateCall
Context sets the context to be used in this call's Do method.
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 (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 (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 struct {
// contains filtered or unexported fields
}
func (c *OrganizationsAnalyticsAccountLinksDeleteCall) Context(ctx context.Context) *OrganizationsAnalyticsAccountLinksDeleteCall
Context sets the context to be used in this call's Do method.
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 (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 (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 struct {
// contains filtered or unexported fields
}
func (c *OrganizationsAnalyticsAccountLinksListCall) Context(ctx context.Context) *OrganizationsAnalyticsAccountLinksListCall
Context sets the context to be used in this call's Do method.
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 (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 (c *OrganizationsAnalyticsAccountLinksListCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
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 (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 (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 (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 struct {
// contains filtered or unexported fields
}
func NewOrganizationsAnalyticsAccountLinksService(s *Service) *OrganizationsAnalyticsAccountLinksService
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.
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.
func (r *OrganizationsAnalyticsAccountLinksService) List(parent string) *OrganizationsAnalyticsAccountLinksListCall
List: Lists the Google Analytics accounts link to the specified Google Marketing Platform organization.
func (r *OrganizationsAnalyticsAccountLinksService) SetPropertyServiceLevel(analyticsAccountLink string, setpropertyservicelevelrequest *SetPropertyServiceLevelRequest) *OrganizationsAnalyticsAccountLinksSetPropertyServiceLevelCall
SetPropertyServiceLevel: Updates the service level for an Analytics property.
type OrganizationsAnalyticsAccountLinksSetPropertyServiceLevelCall struct {
// contains filtered or unexported fields
}
func (c *OrganizationsAnalyticsAccountLinksSetPropertyServiceLevelCall) Context(ctx context.Context) *OrganizationsAnalyticsAccountLinksSetPropertyServiceLevelCall
Context sets the context to be used in this call's Do method.
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 (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 (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 struct {
// contains filtered or unexported fields
}
func (c *OrganizationsGetCall) Context(ctx context.Context) *OrganizationsGetCall
Context sets the context to be used in this call's Do method.
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 (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 (c *OrganizationsGetCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
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 struct {
AnalyticsAccountLinks *OrganizationsAnalyticsAccountLinksService
// contains filtered or unexported fields
}
func NewOrganizationsService(s *Service) *OrganizationsService
func (r *OrganizationsService) Get(name string) *OrganizationsGetCall
Get: Lookup for a single organization.
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(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(ctx context.Context, opts ...option.ClientOption) (*Service, error)
NewService creates a new Service.
SetPropertyServiceLevelRequest: Request message for SetPropertyServiceLevel RPC.
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:"-"`
}
func (s *SetPropertyServiceLevelRequest) MarshalJSON() ([]byte, error)
SetPropertyServiceLevelResponse: Response message for SetPropertyServiceLevel RPC.
type SetPropertyServiceLevelResponse struct {
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
}