merchantapi

package
v0.214.0 Latest Latest
Warning

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

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

Documentation

Overview

Package merchantapi provides access to the Merchant API.

For product documentation, see: https://developers.devsite.corp.google.com/merchant/api

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/merchantapi/conversions_v1beta"
...
ctx := context.Background()
merchantapiService, err := merchantapi.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

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

merchantapiService, err := merchantapi.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, ...)
merchantapiService, err := merchantapi.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))

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

Index

Constants

View Source 
const (
	// Manage your product listings and accounts for Google Shopping
	ContentScope = "https://www.googleapis.com/auth/content"
)

OAuth2 scopes used by this API.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccountsConversionSourcesCreateCall 

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

func (*AccountsConversionSourcesCreateCall) Context 

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

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

func (*AccountsConversionSourcesCreateCall) Do 

func (c *AccountsConversionSourcesCreateCall) Do(opts ...googleapi.CallOption) (*ConversionSource, error)

Do executes the "merchantapi.accounts.conversionSources.create" call. Any non-2xx status code is an error. Response headers are in either *ConversionSource.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 (*AccountsConversionSourcesCreateCall) Fields 

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

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

func (*AccountsConversionSourcesCreateCall) Header 

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

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

type AccountsConversionSourcesDeleteCall 

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

func (*AccountsConversionSourcesDeleteCall) Context 

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

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

func (*AccountsConversionSourcesDeleteCall) Do 

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

Do executes the "merchantapi.accounts.conversionSources.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 (*AccountsConversionSourcesDeleteCall) Fields 

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

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

func (*AccountsConversionSourcesDeleteCall) Header 

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

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

type AccountsConversionSourcesGetCall 

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

func (*AccountsConversionSourcesGetCall) Context 

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

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

func (*AccountsConversionSourcesGetCall) Do 

func (c *AccountsConversionSourcesGetCall) Do(opts ...googleapi.CallOption) (*ConversionSource, error)

Do executes the "merchantapi.accounts.conversionSources.get" call. Any non-2xx status code is an error. Response headers are in either *ConversionSource.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 (*AccountsConversionSourcesGetCall) Fields 

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

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

func (*AccountsConversionSourcesGetCall) Header 

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

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

func (*AccountsConversionSourcesGetCall) IfNoneMatch 

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

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 AccountsConversionSourcesListCall 

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

func (*AccountsConversionSourcesListCall) Context 

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

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

func (*AccountsConversionSourcesListCall) Do 

func (c *AccountsConversionSourcesListCall) Do(opts ...googleapi.CallOption) (*ListConversionSourcesResponse, error)

Do executes the "merchantapi.accounts.conversionSources.list" call. Any non-2xx status code is an error. Response headers are in either *ListConversionSourcesResponse.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 (*AccountsConversionSourcesListCall) Fields 

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

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

func (*AccountsConversionSourcesListCall) Header 

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

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

func (*AccountsConversionSourcesListCall) IfNoneMatch 

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

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 (*AccountsConversionSourcesListCall) PageSize 

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

PageSize sets the optional parameter "pageSize": The maximum number of conversion sources to return in a page. If no `page_size` is specified, `100` is used as the default value. The maximum value is `200`. Values above `200` will be coerced to `200`. Regardless of pagination, at most `200` conversion sources are returned in total.

func (*AccountsConversionSourcesListCall) PageToken 

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

PageToken sets the optional parameter "pageToken": Page token.

func (*AccountsConversionSourcesListCall) Pages 

func (c *AccountsConversionSourcesListCall) Pages(ctx context.Context, f func(*ListConversionSourcesResponse) 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.

func (*AccountsConversionSourcesListCall) ShowDeleted 

func (c *AccountsConversionSourcesListCall) ShowDeleted(showDeleted bool) *AccountsConversionSourcesListCall

ShowDeleted sets the optional parameter "showDeleted": Show deleted (archived) option.

type AccountsConversionSourcesPatchCall 

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

func (*AccountsConversionSourcesPatchCall) Context 

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

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

func (*AccountsConversionSourcesPatchCall) Do 

func (c *AccountsConversionSourcesPatchCall) Do(opts ...googleapi.CallOption) (*ConversionSource, error)

Do executes the "merchantapi.accounts.conversionSources.patch" call. Any non-2xx status code is an error. Response headers are in either *ConversionSource.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 (*AccountsConversionSourcesPatchCall) Fields 

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

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

func (*AccountsConversionSourcesPatchCall) Header 

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

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

func (*AccountsConversionSourcesPatchCall) UpdateMask 

func (c *AccountsConversionSourcesPatchCall) UpdateMask(updateMask string) *AccountsConversionSourcesPatchCall

UpdateMask sets the optional parameter "updateMask": List of fields being updated.

type AccountsConversionSourcesService 

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

func NewAccountsConversionSourcesService 

func NewAccountsConversionSourcesService(s *Service) *AccountsConversionSourcesService

func (*AccountsConversionSourcesService) Create 

func (r *AccountsConversionSourcesService) Create(parent string, conversionsource *ConversionSource) *AccountsConversionSourcesCreateCall

Create: Creates a new conversion source.

  • parent: The merchant account that will own the new conversion source. Format: accounts/{account}.

func (*AccountsConversionSourcesService) Delete 

func (r *AccountsConversionSourcesService) Delete(name string) *AccountsConversionSourcesDeleteCall

Delete: Archives an existing conversion source. If the conversion source is a Merchant Center Destination, it will be recoverable for 30 days. If the conversion source is a Google Analytics Link, it will be deleted immediately and can be restored by creating a new one.

  • name: The name of the conversion source to be deleted. Format: accounts/{account}/conversionSources/{conversion_source}.

func (*AccountsConversionSourcesService) Get 

func (r *AccountsConversionSourcesService) Get(name string) *AccountsConversionSourcesGetCall

Get: Fetches a conversion source.

  • name: The name of the conversion source to be fetched. Format: accounts/{account}/conversionSources/{conversion_source}.

func (*AccountsConversionSourcesService) List 

func (r *AccountsConversionSourcesService) List(parent string) *AccountsConversionSourcesListCall

List: Retrieves the list of conversion sources the caller has access to.

  • parent: The merchant account who owns the collection of conversion sources. Format: accounts/{account}.

func (*AccountsConversionSourcesService) Patch 

func (r *AccountsConversionSourcesService) Patch(name string, conversionsource *ConversionSource) *AccountsConversionSourcesPatchCall

Patch: Updates information of an existing conversion source. Available only for Merchant Center Destination conversion sources.

  • name: Output only. Identifier. Generated by the Content API upon creation of a new `ConversionSource`. Format: [a-z]{4}:.+ The four characters before the colon represent the type of conversio source. Content after the colon represents the ID of the conversion source within that type. The ID of two different conversion sources might be the same across different types. The following type prefixes are supported: - galk: For GoogleAnalyticsLink sources. - mcdn: For MerchantCenterDestination sources.

func (*AccountsConversionSourcesService) Undelete 

func (r *AccountsConversionSourcesService) Undelete(name string, undeleteconversionsourcerequest *UndeleteConversionSourceRequest) *AccountsConversionSourcesUndeleteCall

Undelete: Re-enables an archived conversion source. Only Available for Merchant Center Destination conversion sources.

  • name: The name of the conversion source to be undeleted. Format: accounts/{account}/conversionSources/{conversion_source}.

type AccountsConversionSourcesUndeleteCall 

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

func (*AccountsConversionSourcesUndeleteCall) Context 

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

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

func (*AccountsConversionSourcesUndeleteCall) Do 

func (c *AccountsConversionSourcesUndeleteCall) Do(opts ...googleapi.CallOption) (*ConversionSource, error)

Do executes the "merchantapi.accounts.conversionSources.undelete" call. Any non-2xx status code is an error. Response headers are in either *ConversionSource.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 (*AccountsConversionSourcesUndeleteCall) Fields 

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

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

func (*AccountsConversionSourcesUndeleteCall) Header 

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

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

type AccountsService 

type AccountsService struct {
	ConversionSources *AccountsConversionSourcesService
	// contains filtered or unexported fields
}

func NewAccountsService 

func NewAccountsService(s *Service) *AccountsService

type AttributionSettings 

type AttributionSettings struct {
	// AttributionLookbackWindowDays: Required. Lookback windows (in days) used for
	// attribution in this source. Supported values are 7, 30, 40.
	AttributionLookbackWindowDays int64 `json:"attributionLookbackWindowDays,omitempty"`
	// AttributionModel: Required. Attribution model.
	//
	// Possible values:
	//   "ATTRIBUTION_MODEL_UNSPECIFIED" - Unspecified model.
	//   "CROSS_CHANNEL_LAST_CLICK" - Cross-channel Last Click model.
	//   "ADS_PREFERRED_LAST_CLICK" - Ads-preferred Last Click model.
	//   "CROSS_CHANNEL_DATA_DRIVEN" - Cross-channel Data Driven model.
	//   "CROSS_CHANNEL_FIRST_CLICK" - Cross-channel First Click model.
	//   "CROSS_CHANNEL_LINEAR" - Cross-channel Linear model.
	//   "CROSS_CHANNEL_POSITION_BASED" - Cross-channel Position Based model.
	//   "CROSS_CHANNEL_TIME_DECAY" - Cross-channel Time Decay model.
	AttributionModel string `json:"attributionModel,omitempty"`
	// ConversionType: Immutable. Unordered list. List of different conversion
	// types a conversion event can be classified as. A standard "purchase" type
	// will be automatically created if this list is empty at creation time.
	ConversionType []*ConversionType `json:"conversionType,omitempty"`
	// ForceSendFields is a list of field names (e.g.
	// "AttributionLookbackWindowDays") 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. "AttributionLookbackWindowDays")
	// 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:"-"`
}

AttributionSettings: Represents attribution settings for conversion sources receiving pre-attribution data.

func (AttributionSettings) MarshalJSON 

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

type ConversionSource 

type ConversionSource struct {
	// Controller: Output only. Controller of the conversion source.
	//
	// Possible values:
	//   "CONTROLLER_UNSPECIFIED" - Default value. This value is unused.
	//   "MERCHANT" - Controlled by the Merchant who owns the Conversion Source.
	//   "YOUTUBE_AFFILIATES" - Controlled by the YT Affiliates program.
	Controller string `json:"controller,omitempty"`
	// ExpireTime: Output only. The time when an archived conversion source becomes
	// permanently deleted and is no longer available to undelete.
	ExpireTime string `json:"expireTime,omitempty"`
	// GoogleAnalyticsLink: Immutable. Conversion Source of type "Link to Google
	// Analytics Property".
	GoogleAnalyticsLink *GoogleAnalyticsLink `json:"googleAnalyticsLink,omitempty"`
	// MerchantCenterDestination: Conversion Source of type "Merchant Center Tag
	// Destination".
	MerchantCenterDestination *MerchantCenterDestination `json:"merchantCenterDestination,omitempty"`
	// Name: Output only. Identifier. Generated by the Content API upon creation of
	// a new `ConversionSource`. Format: [a-z]{4}:.+ The four characters before the
	// colon represent the type of conversio source. Content after the colon
	// represents the ID of the conversion source within that type. The ID of two
	// different conversion sources might be the same across different types. The
	// following type prefixes are supported: - galk: For GoogleAnalyticsLink
	// sources. - mcdn: For MerchantCenterDestination sources.
	Name string `json:"name,omitempty"`
	// State: Output only. Current state of this conversion source. Can't be edited
	// through the API.
	//
	// Possible values:
	//   "STATE_UNSPECIFIED" - Conversion source has unspecified state.
	//   "ACTIVE" - Conversion source is fully functional.
	//   "ARCHIVED" - Conversion source has been archived in the last 30 days and
	// not currently functional. Can be restored using the undelete method.
	//   "PENDING" - Conversion source creation has started but not fully finished
	// yet.
	State string `json:"state,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Controller") 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. "Controller") 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:"-"`
}

ConversionSource: Represents a conversion source owned by a Merchant account. A merchant account can have up to 200 conversion sources.

func (ConversionSource) MarshalJSON 

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

type ConversionType 

type ConversionType struct {
	// Name: Output only. Conversion event name, as it'll be reported by the
	// client.
	Name string `json:"name,omitempty"`
	// Report: Output only. Option indicating if the type should be included in
	// Merchant Center reporting.
	Report bool `json:"report,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Name") 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. "Name") 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:"-"`
}

ConversionType: Message representing a types of conversion events

func (ConversionType) MarshalJSON 

func (s ConversionType) 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 GoogleAnalyticsLink struct {
	// AttributionSettings: Output only. Attribution settings for the linked Google
	// Analytics property.
	AttributionSettings *AttributionSettings `json:"attributionSettings,omitempty"`
	// Property: Output only. Name of the Google Analytics property the merchant is
	// linked to.
	Property string `json:"property,omitempty"`
	// PropertyId: Required. Immutable. ID of the Google Analytics property the
	// merchant is linked to.
	PropertyId int64 `json:"propertyId,omitempty,string"`
	// ForceSendFields is a list of field names (e.g. "AttributionSettings") 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. "AttributionSettings") 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:"-"`
}

GoogleAnalyticsLink: "Google Analytics Link" sources can be used to get conversion data from an existing Google Analytics property into the linked Merchant Center account.

func (GoogleAnalyticsLink) MarshalJSON 

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

type ListConversionSourcesResponse 

type ListConversionSourcesResponse struct {
	// ConversionSources: List of conversion sources.
	ConversionSources []*ConversionSource `json:"conversionSources,omitempty"`
	// NextPageToken: Token to be used to fetch the next results page.
	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. "ConversionSources") 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. "ConversionSources") 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:"-"`
}

ListConversionSourcesResponse: Response message for the ListConversionSources method.

func (ListConversionSourcesResponse) MarshalJSON 

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

type MerchantCenterDestination 

type MerchantCenterDestination struct {
	// AttributionSettings: Required. Attribution settings being used for the
	// Merchant Center Destination.
	AttributionSettings *AttributionSettings `json:"attributionSettings,omitempty"`
	// CurrencyCode: Required. Three-letter currency code (ISO 4217). The currency
	// code defines in which currency the conversions sent to this destination will
	// be reported in Merchant Center.
	CurrencyCode string `json:"currencyCode,omitempty"`
	// Destination: Output only. Merchant Center Destination ID.
	Destination string `json:"destination,omitempty"`
	// DisplayName: Required. Merchant-specified display name for the destination.
	// This is the name that identifies the conversion source within the Merchant
	// Center UI. Limited to 64 characters.
	DisplayName string `json:"displayName,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AttributionSettings") 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. "AttributionSettings") 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:"-"`
}

MerchantCenterDestination: "Merchant Center Destination" sources can be used to send conversion events from an online store using a Google tag directly to a Merchant Center account where the source is created.

func (MerchantCenterDestination) MarshalJSON 

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

type ProductChange 

type ProductChange struct {
	// NewValue: The new value of the changed resource or attribute.
	NewValue string `json:"newValue,omitempty"`
	// OldValue: The old value of the changed resource or attribute.
	OldValue string `json:"oldValue,omitempty"`
	// RegionCode: Countries that have the change (if applicable)
	RegionCode string `json:"regionCode,omitempty"`
	// ReportingContext: Reporting contexts that have the change (if applicable)
	//
	// Possible values:
	//   "REPORTING_CONTEXT_ENUM_UNSPECIFIED" - Not specified.
	//   "SHOPPING_ADS" - [Shopping
	// ads](https://support.google.com/merchants/answer/6149970).
	//   "DISCOVERY_ADS" - Deprecated: Use `DEMAND_GEN_ADS` instead. [Discovery and
	// Demand Gen ads](https://support.google.com/merchants/answer/13389785).
	//   "DEMAND_GEN_ADS" - [Demand Gen
	// ads](https://support.google.com/merchants/answer/13389785).
	//   "DEMAND_GEN_ADS_DISCOVER_SURFACE" - [Demand Gen ads on Discover
	// surface](https://support.google.com/merchants/answer/13389785).
	//   "VIDEO_ADS" - [Video
	// ads](https://support.google.com/google-ads/answer/6340491).
	//   "DISPLAY_ADS" - [Display
	// ads](https://support.google.com/merchants/answer/6069387).
	//   "LOCAL_INVENTORY_ADS" - [Local inventory
	// ads](https://support.google.com/merchants/answer/3271956).
	//   "VEHICLE_INVENTORY_ADS" - [Vehicle inventory
	// ads](https://support.google.com/merchants/answer/11544533).
	//   "FREE_LISTINGS" - [Free product
	// listings](https://support.google.com/merchants/answer/9199328).
	//   "FREE_LOCAL_LISTINGS" - [Free local product
	// listings](https://support.google.com/merchants/answer/9825611).
	//   "FREE_LOCAL_VEHICLE_LISTINGS" - [Free local vehicle
	// listings](https://support.google.com/merchants/answer/11544533).
	//   "YOUTUBE_SHOPPING" - [YouTube
	// Shopping](https://support.google.com/merchants/answer/13478370).
	//   "CLOUD_RETAIL" - [Cloud
	// retail](https://cloud.google.com/solutions/retail).
	//   "LOCAL_CLOUD_RETAIL" - [Local cloud
	// retail](https://cloud.google.com/solutions/retail).
	//   "PRODUCT_REVIEWS" - [Product
	// Reviews](https://support.google.com/merchants/answer/14620732).
	//   "MERCHANT_REVIEWS" - [Merchant
	// Reviews](https://developers.google.com/merchant-review-feeds).
	//   "YOUTUBE_CHECKOUT" - [YouTube Checkout](
	ReportingContext string `json:"reportingContext,omitempty"`
	// ForceSendFields is a list of field names (e.g. "NewValue") 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. "NewValue") 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:"-"`
}

ProductChange: The change that happened to the product including old value, new value, country code as the region code and reporting context.

func (ProductChange) MarshalJSON 

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

type ProductStatusChangeMessage 

type ProductStatusChangeMessage struct {
	// Account: The target account that owns the entity that changed. Format :
	// `accounts/{merchant_id}`
	Account string `json:"account,omitempty"`
	// Attribute: The attribute in the resource that changed, in this case it will
	// be always `Status`.
	//
	// Possible values:
	//   "ATTRIBUTE_UNSPECIFIED" - Unspecified attribute
	//   "STATUS" - Status of the changed entity
	Attribute string `json:"attribute,omitempty"`
	// Changes: A message to describe the change that happened to the product
	Changes []*ProductChange `json:"changes,omitempty"`
	// ExpirationTime: The product expiration time. This field will not bet set if
	// the notification is sent for a product deletion event.
	ExpirationTime string `json:"expirationTime,omitempty"`
	// ManagingAccount: The account that manages the merchant's account. can be the
	// same as merchant id if it is standalone account. Format :
	// `accounts/{service_provider_id}`
	ManagingAccount string `json:"managingAccount,omitempty"`
	// Resource: The product name. Format:
	// `{product.name=accounts/{account}/products/{product}}`
	Resource string `json:"resource,omitempty"`
	// ResourceId: The product id.
	ResourceId string `json:"resourceId,omitempty"`
	// ResourceType: The resource that changed, in this case it will always be
	// `Product`.
	//
	// Possible values:
	//   "RESOURCE_UNSPECIFIED" - Unspecified resource
	//   "PRODUCT" - Resource type : product
	ResourceType string `json:"resourceType,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Account") 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. "Account") 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:"-"`
}

ProductStatusChangeMessage: The message that the merchant will receive to notify about product status change event

func (ProductStatusChangeMessage) MarshalJSON 

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

type Service 

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

	Accounts *AccountsService
	// 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 UndeleteConversionSourceRequest 

type UndeleteConversionSourceRequest struct {
}

UndeleteConversionSourceRequest: Request message for the UndeleteConversionSource method.

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.