ideahub

package
v0.113.0 Latest Latest
Warning

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

 Go to latest Published: Mar 15, 2023 License: BSD-3-Clause Imports: 16 Imported by: 0

Documentation

Overview

Package ideahub provides access to the Idea Hub API.

For product documentation, see: https://console.cloud.google.com/apis/library/ideahub.googleapis.com

Creating a client

Usage example: 

import "google.golang.org/api/ideahub/v1alpha"
...
ctx := context.Background()
ideahubService, err := ideahub.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 option.WithAPIKey: 

ideahubService, err := ideahub.NewService(ctx, option.WithAPIKey("AIza..."))

To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow), use option.WithTokenSource: 

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

See https://godoc.org/google.golang.org/api/option/ for details on options.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type GoogleSearchIdeahubV1alphaAvailableLocale 

type GoogleSearchIdeahubV1alphaAvailableLocale struct {
	// Locale: A string in BCP 47 format, without a resource prefix.
	Locale string `json:"locale,omitempty"`

	// Name: A string in BCP 47 format, prefixed with the platform and
	// property name, and "locales/". Format:
	// platforms/{platform}/properties/{property}/locales/{locale}
	Name string `json:"name,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Locale") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Locale") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

GoogleSearchIdeahubV1alphaAvailableLocale: Represents locales that are available for a web property.

func (*GoogleSearchIdeahubV1alphaAvailableLocale) MarshalJSON 

func (s *GoogleSearchIdeahubV1alphaAvailableLocale) MarshalJSON() ([]byte, error)

type GoogleSearchIdeahubV1alphaIdea 

type GoogleSearchIdeahubV1alphaIdea struct {
	// Name: Unique identifier for the idea. Format: ideas/{ideaId}
	Name string `json:"name,omitempty"`

	// Text: The idea’s text.
	Text string `json:"text,omitempty"`

	// Topics: The Topics that match the idea.
	Topics []*GoogleSearchIdeahubV1alphaTopic `json:"topics,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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

GoogleSearchIdeahubV1alphaIdea: A single Idea that we want to show the end user.

func (*GoogleSearchIdeahubV1alphaIdea) MarshalJSON 

func (s *GoogleSearchIdeahubV1alphaIdea) MarshalJSON() ([]byte, error)

type GoogleSearchIdeahubV1alphaIdeaActivity added in v0.51.0 

type GoogleSearchIdeahubV1alphaIdeaActivity struct {
	// Ideas: The Idea IDs for this entry. If empty, topics should be set.
	Ideas []string `json:"ideas,omitempty"`

	// Name: Unique identifier for the idea activity. The name is ignored
	// when creating an idea activity. Format:
	// platforms/{platform}/properties/{property}/ideaActivities/{idea_activi
	// ty}
	Name string `json:"name,omitempty"`

	// Topics: The Topic IDs for this entry. If empty, ideas should be set.
	Topics []string `json:"topics,omitempty"`

	// Type: The type of activity performed.
	//
	// Possible values:
	//   "TYPE_UNSPECIFIED" - An unspecified, unknown type of idea activity.
	//   "POST_DRAFTED" - An idea activity type indicating a post has been
	// drafted.
	//   "POST_PUBLISHED" - An idea activity type indicating a post has been
	// published.
	//   "POST_DELETED" - An idea activity type indicating a post has been
	// deleted.
	//   "POST_UNPUBLISHED" - An idea activity type indicating a post has
	// been unpublished.
	Type string `json:"type,omitempty"`

	// Uri: The uri the activity relates to.
	Uri string `json:"uri,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Ideas") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Ideas") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

GoogleSearchIdeahubV1alphaIdeaActivity: An idea activity entry.

func (*GoogleSearchIdeahubV1alphaIdeaActivity) MarshalJSON added in v0.51.0 

func (s *GoogleSearchIdeahubV1alphaIdeaActivity) MarshalJSON() ([]byte, error)

type GoogleSearchIdeahubV1alphaIdeaState 

type GoogleSearchIdeahubV1alphaIdeaState struct {
	// Dismissed: Whether the idea is dismissed.
	Dismissed bool `json:"dismissed,omitempty"`

	// Name: Unique identifier for the idea state. Format:
	// platforms/{platform}/properties/{property}/ideaStates/{idea_state}
	Name string `json:"name,omitempty"`

	// Saved: Whether the idea is saved.
	Saved bool `json:"saved,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Dismissed") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Dismissed") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

GoogleSearchIdeahubV1alphaIdeaState: Represents idea state specific to a web property.

func (*GoogleSearchIdeahubV1alphaIdeaState) MarshalJSON 

func (s *GoogleSearchIdeahubV1alphaIdeaState) MarshalJSON() ([]byte, error)

type GoogleSearchIdeahubV1alphaListAvailableLocalesResponse 

type GoogleSearchIdeahubV1alphaListAvailableLocalesResponse struct {
	// AvailableLocales: Locales for which ideas are available for the given
	// Creator.
	AvailableLocales []*GoogleSearchIdeahubV1alphaAvailableLocale `json:"availableLocales,omitempty"`

	// NextPageToken: A token that 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. "AvailableLocales") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "AvailableLocales") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

GoogleSearchIdeahubV1alphaListAvailableLocalesResponse: Response for whether ideas are available for a given web property on a platform, for the currently logged-in user.

func (*GoogleSearchIdeahubV1alphaListAvailableLocalesResponse) MarshalJSON 

func (s *GoogleSearchIdeahubV1alphaListAvailableLocalesResponse) MarshalJSON() ([]byte, error)

type GoogleSearchIdeahubV1alphaListIdeasResponse 

type GoogleSearchIdeahubV1alphaListIdeasResponse struct {
	// Ideas: Results for the ListIdeasRequest.
	Ideas []*GoogleSearchIdeahubV1alphaIdea `json:"ideas,omitempty"`

	// NextPageToken: Used to fetch the next page in a subsequent request.
	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. "Ideas") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Ideas") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

func (*GoogleSearchIdeahubV1alphaListIdeasResponse) MarshalJSON 

func (s *GoogleSearchIdeahubV1alphaListIdeasResponse) MarshalJSON() ([]byte, error)

type GoogleSearchIdeahubV1alphaTopic 

type GoogleSearchIdeahubV1alphaTopic struct {
	// DisplayName: String displayed to the creator indicating the name of
	// the Topic.
	DisplayName string `json:"displayName,omitempty"`

	// Mid: The mID of the topic.
	Mid string `json:"mid,omitempty"`

	// Name: Unique identifier for the topic. Format: topics/{topic}
	Name string `json:"name,omitempty"`

	// 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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

GoogleSearchIdeahubV1alphaTopic: Represents a Topic umbrella for a list of questions that a Creator may want to respond to.

func (*GoogleSearchIdeahubV1alphaTopic) MarshalJSON 

func (s *GoogleSearchIdeahubV1alphaTopic) MarshalJSON() ([]byte, error)

type GoogleSearchIdeahubV1alphaTopicState added in v0.49.0 

type GoogleSearchIdeahubV1alphaTopicState struct {
	// Dismissed: Whether the topic is dismissed.
	Dismissed bool `json:"dismissed,omitempty"`

	// Name: Unique identifier for the topic state. Format:
	// platforms/{platform}/properties/{property}/topicStates/{topic_state}
	Name string `json:"name,omitempty"`

	// Saved: Whether the topic is saved.
	Saved bool `json:"saved,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Dismissed") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Dismissed") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

GoogleSearchIdeahubV1alphaTopicState: Represents topic state specific to a web property.

func (*GoogleSearchIdeahubV1alphaTopicState) MarshalJSON added in v0.49.0 

func (s *GoogleSearchIdeahubV1alphaTopicState) MarshalJSON() ([]byte, error)

type IdeasListCall 

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

func (*IdeasListCall) Context 

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

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*IdeasListCall) Do 

func (c *IdeasListCall) Do(opts ...googleapi.CallOption) (*GoogleSearchIdeahubV1alphaListIdeasResponse, error)

Do executes the "ideahub.ideas.list" call. Exactly one of *GoogleSearchIdeahubV1alphaListIdeasResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleSearchIdeahubV1alphaListIdeasResponse.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 (*IdeasListCall) Fields 

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

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

func (*IdeasListCall) Filter 

func (c *IdeasListCall) Filter(filter string) *IdeasListCall

Filter sets the optional parameter "filter": Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions are implicitly combined, as if the `AND` operator was always used. The `OR` operator is currently unsupported. * Supported functions: - `saved(bool)`: If set to true, fetches only saved ideas. If set to false, fetches all except saved ideas. Can't be simultaneously used with `dismissed(bool)`. - `dismissed(bool)`: If set to true, fetches only dismissed ideas. Can't be simultaneously used with `saved(bool)`. The `false` value is currently unsupported. Examples: * `saved(true)` * `saved(false)` * `dismissed(true)` The length of this field should be no more than 500 characters.

func (*IdeasListCall) Header 

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

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

func (*IdeasListCall) IfNoneMatch 

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

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*IdeasListCall) OrderBy 

func (c *IdeasListCall) OrderBy(orderBy string) *IdeasListCall

OrderBy sets the optional parameter "orderBy": Order semantics described below.

func (*IdeasListCall) PageSize 

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

PageSize sets the optional parameter "pageSize": The maximum number of ideas per page. If unspecified, at most 10 ideas will be returned. The maximum value is 2000; values above 2000 will be coerced to 2000.

func (*IdeasListCall) PageToken 

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

PageToken sets the optional parameter "pageToken": Used to fetch next page.

func (*IdeasListCall) Pages 

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

func (c *IdeasListCall) Parent(parent string) *IdeasListCall

Parent sets the optional parameter "parent": If defined, specifies the creator for which to filter by. Format: publishers/{publisher}/properties/{property}

type IdeasService 

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

func NewIdeasService 

func NewIdeasService(s *Service) *IdeasService

func (*IdeasService) List 

func (r *IdeasService) List() *IdeasListCall

List: List ideas for a given Creator and filter and sort options.

type PlatformsPropertiesIdeaActivitiesCreateCall added in v0.51.0 

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

func (*PlatformsPropertiesIdeaActivitiesCreateCall) Context added in v0.51.0 

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

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*PlatformsPropertiesIdeaActivitiesCreateCall) Do added in v0.51.0 

func (c *PlatformsPropertiesIdeaActivitiesCreateCall) Do(opts ...googleapi.CallOption) (*GoogleSearchIdeahubV1alphaIdeaActivity, error)

Do executes the "ideahub.platforms.properties.ideaActivities.create" call. Exactly one of *GoogleSearchIdeahubV1alphaIdeaActivity or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleSearchIdeahubV1alphaIdeaActivity.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 (*PlatformsPropertiesIdeaActivitiesCreateCall) Fields added in v0.51.0 

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

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

func (*PlatformsPropertiesIdeaActivitiesCreateCall) Header added in v0.51.0 

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

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

type PlatformsPropertiesIdeaActivitiesService added in v0.51.0 

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

func NewPlatformsPropertiesIdeaActivitiesService added in v0.51.0 

func NewPlatformsPropertiesIdeaActivitiesService(s *Service) *PlatformsPropertiesIdeaActivitiesService

func (*PlatformsPropertiesIdeaActivitiesService) Create added in v0.51.0 

func (r *PlatformsPropertiesIdeaActivitiesService) Create(parent string, googlesearchideahubv1alphaideaactivity *GoogleSearchIdeahubV1alphaIdeaActivity) *PlatformsPropertiesIdeaActivitiesCreateCall

Create: Creates an idea activity entry.

  • parent: The parent resource where this idea activity will be created. Format: platforms/{platform}/property/{property}.

type PlatformsPropertiesIdeaStatesPatchCall 

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

func (*PlatformsPropertiesIdeaStatesPatchCall) Context 

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

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*PlatformsPropertiesIdeaStatesPatchCall) Do 

func (c *PlatformsPropertiesIdeaStatesPatchCall) Do(opts ...googleapi.CallOption) (*GoogleSearchIdeahubV1alphaIdeaState, error)

Do executes the "ideahub.platforms.properties.ideaStates.patch" call. Exactly one of *GoogleSearchIdeahubV1alphaIdeaState or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleSearchIdeahubV1alphaIdeaState.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 (*PlatformsPropertiesIdeaStatesPatchCall) Fields 

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

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

func (*PlatformsPropertiesIdeaStatesPatchCall) Header 

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

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

func (*PlatformsPropertiesIdeaStatesPatchCall) UpdateMask 

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

UpdateMask sets the optional parameter "updateMask": The list of fields to be updated.

type PlatformsPropertiesIdeaStatesService 

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

func NewPlatformsPropertiesIdeaStatesService 

func NewPlatformsPropertiesIdeaStatesService(s *Service) *PlatformsPropertiesIdeaStatesService

func (*PlatformsPropertiesIdeaStatesService) Patch 

func (r *PlatformsPropertiesIdeaStatesService) Patch(nameid string, googlesearchideahubv1alphaideastate *GoogleSearchIdeahubV1alphaIdeaState) *PlatformsPropertiesIdeaStatesPatchCall

Patch: Update an idea state resource.

  • name: Unique identifier for the idea state. Format: platforms/{platform}/properties/{property}/ideaStates/{idea_state}.

type PlatformsPropertiesIdeasListCall 

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

func (*PlatformsPropertiesIdeasListCall) Context 

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

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*PlatformsPropertiesIdeasListCall) Do 

func (c *PlatformsPropertiesIdeasListCall) Do(opts ...googleapi.CallOption) (*GoogleSearchIdeahubV1alphaListIdeasResponse, error)

Do executes the "ideahub.platforms.properties.ideas.list" call. Exactly one of *GoogleSearchIdeahubV1alphaListIdeasResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleSearchIdeahubV1alphaListIdeasResponse.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 (*PlatformsPropertiesIdeasListCall) Fields 

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

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

func (*PlatformsPropertiesIdeasListCall) Filter 

func (c *PlatformsPropertiesIdeasListCall) Filter(filter string) *PlatformsPropertiesIdeasListCall

Filter sets the optional parameter "filter": Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions are implicitly combined, as if the `AND` operator was always used. The `OR` operator is currently unsupported. * Supported functions: - `saved(bool)`: If set to true, fetches only saved ideas. If set to false, fetches all except saved ideas. Can't be simultaneously used with `dismissed(bool)`. - `dismissed(bool)`: If set to true, fetches only dismissed ideas. Can't be simultaneously used with `saved(bool)`. The `false` value is currently unsupported. Examples: * `saved(true)` * `saved(false)` * `dismissed(true)` The length of this field should be no more than 500 characters.

func (*PlatformsPropertiesIdeasListCall) Header 

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

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

func (*PlatformsPropertiesIdeasListCall) IfNoneMatch 

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

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*PlatformsPropertiesIdeasListCall) OrderBy 

func (c *PlatformsPropertiesIdeasListCall) OrderBy(orderBy string) *PlatformsPropertiesIdeasListCall

OrderBy sets the optional parameter "orderBy": Order semantics described below.

func (*PlatformsPropertiesIdeasListCall) PageSize 

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

PageSize sets the optional parameter "pageSize": The maximum number of ideas per page. If unspecified, at most 10 ideas will be returned. The maximum value is 2000; values above 2000 will be coerced to 2000.

func (*PlatformsPropertiesIdeasListCall) PageToken 

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

PageToken sets the optional parameter "pageToken": Used to fetch next page.

func (*PlatformsPropertiesIdeasListCall) Pages 

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

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

func NewPlatformsPropertiesIdeasService 

func NewPlatformsPropertiesIdeasService(s *Service) *PlatformsPropertiesIdeasService

func (*PlatformsPropertiesIdeasService) List 

func (r *PlatformsPropertiesIdeasService) List(parent string) *PlatformsPropertiesIdeasListCall

List: List ideas for a given Creator and filter and sort options.

  • parent: If defined, specifies the creator for which to filter by. Format: publishers/{publisher}/properties/{property}.

type PlatformsPropertiesLocalesListCall 

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

func (*PlatformsPropertiesLocalesListCall) Context 

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

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*PlatformsPropertiesLocalesListCall) Do 

func (c *PlatformsPropertiesLocalesListCall) Do(opts ...googleapi.CallOption) (*GoogleSearchIdeahubV1alphaListAvailableLocalesResponse, error)

Do executes the "ideahub.platforms.properties.locales.list" call. Exactly one of *GoogleSearchIdeahubV1alphaListAvailableLocalesResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleSearchIdeahubV1alphaListAvailableLocalesResponse.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 (*PlatformsPropertiesLocalesListCall) Fields 

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

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

func (*PlatformsPropertiesLocalesListCall) Header 

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

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

func (*PlatformsPropertiesLocalesListCall) IfNoneMatch 

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

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*PlatformsPropertiesLocalesListCall) PageSize 

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

PageSize sets the optional parameter "pageSize": The maximum number of locales to return. The service may return fewer than this value. If unspecified, at most 100 locales will be returned. The maximum value is 100; values above 100 will be coerced to 100.

func (*PlatformsPropertiesLocalesListCall) PageToken 

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

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

func (*PlatformsPropertiesLocalesListCall) Pages 

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

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

func NewPlatformsPropertiesLocalesService 

func NewPlatformsPropertiesLocalesService(s *Service) *PlatformsPropertiesLocalesService

func (*PlatformsPropertiesLocalesService) List 

func (r *PlatformsPropertiesLocalesService) List(parent string) *PlatformsPropertiesLocalesListCall

List: Returns which locales ideas are available in for a given Creator.

  • parent: The web property to check idea availability for Format: platforms/{platform}/property/{property}.

type PlatformsPropertiesService 

type PlatformsPropertiesService struct {
	IdeaActivities *PlatformsPropertiesIdeaActivitiesService

	IdeaStates *PlatformsPropertiesIdeaStatesService

	Ideas *PlatformsPropertiesIdeasService

	Locales *PlatformsPropertiesLocalesService

	TopicStates *PlatformsPropertiesTopicStatesService
	// contains filtered or unexported fields
}

func NewPlatformsPropertiesService 

func NewPlatformsPropertiesService(s *Service) *PlatformsPropertiesService

type PlatformsPropertiesTopicStatesPatchCall added in v0.49.0 

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

func (*PlatformsPropertiesTopicStatesPatchCall) Context added in v0.49.0 

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

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*PlatformsPropertiesTopicStatesPatchCall) Do added in v0.49.0 

func (c *PlatformsPropertiesTopicStatesPatchCall) Do(opts ...googleapi.CallOption) (*GoogleSearchIdeahubV1alphaTopicState, error)

Do executes the "ideahub.platforms.properties.topicStates.patch" call. Exactly one of *GoogleSearchIdeahubV1alphaTopicState or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleSearchIdeahubV1alphaTopicState.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 (*PlatformsPropertiesTopicStatesPatchCall) Fields added in v0.49.0 

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

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

func (*PlatformsPropertiesTopicStatesPatchCall) Header added in v0.49.0 

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

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

func (*PlatformsPropertiesTopicStatesPatchCall) UpdateMask added in v0.49.0 

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

UpdateMask sets the optional parameter "updateMask": The list of fields to be updated.

type PlatformsPropertiesTopicStatesService added in v0.49.0 

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

func NewPlatformsPropertiesTopicStatesService added in v0.49.0 

func NewPlatformsPropertiesTopicStatesService(s *Service) *PlatformsPropertiesTopicStatesService

func (*PlatformsPropertiesTopicStatesService) Patch added in v0.49.0 

func (r *PlatformsPropertiesTopicStatesService) Patch(nameid string, googlesearchideahubv1alphatopicstate *GoogleSearchIdeahubV1alphaTopicState) *PlatformsPropertiesTopicStatesPatchCall

Patch: Update a topic state resource.

  • name: Unique identifier for the topic state. Format: platforms/{platform}/properties/{property}/topicStates/{topic_state}.

type PlatformsService 

type PlatformsService struct {
	Properties *PlatformsPropertiesService
	// contains filtered or unexported fields
}

func NewPlatformsService 

func NewPlatformsService(s *Service) *PlatformsService

type Service 

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

	Ideas *IdeasService

	Platforms *PlatformsService
	// 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.

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.