youtubeanalytics

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

Documentation

Overview

Package youtubeanalytics provides access to the YouTube Analytics API.

For product documentation, see: https://developers.google.com/youtube/analytics

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/youtubeanalytics/v2"
...
ctx := context.Background()
youtubeanalyticsService, err := youtubeanalytics.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: 

youtubeanalyticsService, err := youtubeanalytics.NewService(ctx, option.WithScopes(youtubeanalytics.YtAnalyticsReadonlyScope))

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

youtubeanalyticsService, err := youtubeanalytics.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, ...)
youtubeanalyticsService, err := youtubeanalytics.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 YouTube account
	YoutubeScope = "https://www.googleapis.com/auth/youtube"

	// View your YouTube account
	YoutubeReadonlyScope = "https://www.googleapis.com/auth/youtube.readonly"

	// View and manage your assets and associated content on YouTube
	YoutubepartnerScope = "https://www.googleapis.com/auth/youtubepartner"

	// View monetary and non-monetary YouTube Analytics reports for your YouTube
	// content
	YtAnalyticsMonetaryReadonlyScope = "https://www.googleapis.com/auth/yt-analytics-monetary.readonly"

	// View YouTube Analytics reports for your YouTube content
	YtAnalyticsReadonlyScope = "https://www.googleapis.com/auth/yt-analytics.readonly"
)

OAuth2 scopes used by this API.

Variables

This section is empty.

Functions

This section is empty.

Types

type EmptyResponse 

type EmptyResponse struct {
	// Errors: Apiary error details
	Errors *Errors `json:"errors,omitempty"`

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

EmptyResponse: Empty response.

func (EmptyResponse) MarshalJSON 

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

type ErrorProto 

type ErrorProto struct {
	// Argument: Error arguments, to be used when building user-friendly error
	// messages given the error domain and code. Different error codes require
	// different arguments.
	Argument []string `json:"argument,omitempty"`
	// Code: Error code in the error domain. This should correspond to a value of
	// the enum type whose name is in domain. See the core error domain in
	// error_domain.proto.
	Code string `json:"code,omitempty"`
	// DebugInfo: Debugging information, which should not be shared externally.
	DebugInfo string `json:"debugInfo,omitempty"`
	// Domain: Error domain. RoSy services can define their own domain and error
	// codes. This should normally be the name of an enum type, such as:
	// gdata.CoreErrorDomain
	Domain string `json:"domain,omitempty"`
	// ExternalErrorMessage: A short explanation for the error, which can be shared
	// outside Google. Please set domain, code and arguments whenever possible
	// instead of this error message so that external APIs can build safe error
	// messages themselves. External messages built in a RoSy interface will most
	// likely refer to information and concepts that are not available externally
	// and should not be exposed. It is safer if external APIs can understand the
	// errors and decide what the error message should look like.
	ExternalErrorMessage string `json:"externalErrorMessage,omitempty"`
	// Location: Location of the error, as specified by the location type. If
	// location_type is PATH, this should be a path to a field that's relative to
	// the request, using FieldPath notation (net/proto2/util/public/field_path.h).
	// Examples: authenticated_user.gaia_id resource.address[2].country
	Location string `json:"location,omitempty"`
	// Possible values:
	//   "PATH" - location is an xpath-like path pointing to the request field that
	// caused the error.
	//   "OTHER" - other location type which can safely be shared externally.
	//   "PARAMETER" - Location is request parameter. This maps to the {@link
	// PARAMETERS} in {@link MessageLocation}.
	LocationType string `json:"locationType,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Argument") 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. "Argument") 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:"-"`
}

ErrorProto: Describes one specific error.

func (ErrorProto) MarshalJSON 

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

type Errors 

type Errors struct {
	// Code: Global error code. Deprecated and ignored. Set custom error codes in
	// ErrorProto.domain and ErrorProto.code instead.
	//
	// Possible values:
	//   "BAD_REQUEST"
	//   "FORBIDDEN"
	//   "NOT_FOUND"
	//   "CONFLICT"
	//   "GONE"
	//   "PRECONDITION_FAILED"
	//   "INTERNAL_ERROR"
	//   "SERVICE_UNAVAILABLE"
	Code string `json:"code,omitempty"`
	// Error: Specific error description and codes
	Error []*ErrorProto `json:"error,omitempty"`
	// RequestId: Request identifier generated by the service, which can be used to
	// identify the error in the logs
	RequestId string `json:"requestId,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Code") 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. "Code") 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:"-"`
}

Errors: Request Error information. The presence of an error field signals that the operation has failed.

func (Errors) MarshalJSON 

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

type Group 

type Group struct {
	// ContentDetails: The `contentDetails` object contains additional information
	// about the group, such as the number and type of items that it contains.
	ContentDetails *GroupContentDetails `json:"contentDetails,omitempty"`
	// Errors: Apiary error details
	Errors *Errors `json:"errors,omitempty"`
	// Etag: The Etag of this resource.
	Etag string `json:"etag,omitempty"`
	// Id: The ID that YouTube uses to uniquely identify the group.
	Id string `json:"id,omitempty"`
	// Kind: Identifies the API resource's type. The value will be `youtube#group`.
	Kind string `json:"kind,omitempty"`
	// Snippet: The `snippet` object contains basic information about the group,
	// including its creation date and name.
	Snippet *GroupSnippet `json:"snippet,omitempty"`

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

Group: A group.

func (Group) MarshalJSON 

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

type GroupContentDetails 

type GroupContentDetails struct {
	// ItemCount: The number of items in the group.
	ItemCount uint64 `json:"itemCount,omitempty,string"`
	// ItemType: The type of resources that the group contains. Valid values for
	// this property are: * `youtube#channel` * `youtube#playlist` *
	// `youtube#video` * `youtubePartner#asset`
	ItemType string `json:"itemType,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ItemCount") 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. "ItemCount") 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:"-"`
}

GroupContentDetails: A group's content details.

func (GroupContentDetails) MarshalJSON 

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

type GroupItem 

type GroupItem struct {
	// Errors: Apiary error details
	Errors *Errors `json:"errors,omitempty"`
	// Etag: The Etag of this resource.
	Etag string `json:"etag,omitempty"`
	// GroupId: The ID that YouTube uses to uniquely identify the group that
	// contains the item.
	GroupId string `json:"groupId,omitempty"`
	// Id: The ID that YouTube uses to uniquely identify the `channel`, `video`,
	// `playlist`, or `asset` resource that is included in the group. Note that
	// this ID refers specifically to the inclusion of that resource in a
	// particular group and is different than the channel ID, video ID, playlist
	// ID, or asset ID that uniquely identifies the resource itself. The
	// `resource.id` property's value specifies the unique channel, video,
	// playlist, or asset ID.
	Id string `json:"id,omitempty"`
	// Kind: Identifies the API resource's type. The value will be
	// `youtube#groupItem`.
	Kind string `json:"kind,omitempty"`
	// Resource: The `resource` object contains information that identifies the
	// item being added to the group.
	Resource *GroupItemResource `json:"resource,omitempty"`

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

GroupItem: A group item.

func (GroupItem) MarshalJSON 

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

type GroupItemResource 

type GroupItemResource struct {
	// Id: The channel, video, playlist, or asset ID that YouTube uses to uniquely
	// identify the item that is being added to the group.
	Id string `json:"id,omitempty"`
	// Kind: Identifies the type of resource being added to the group. Valid values
	// for this property are: * `youtube#channel` * `youtube#playlist` *
	// `youtube#video` * `youtubePartner#asset`
	Kind string `json:"kind,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Id") 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. "Id") 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 (GroupItemResource) MarshalJSON 

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

type GroupItemsDeleteCall 

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

func (*GroupItemsDeleteCall) Context 

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

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

func (*GroupItemsDeleteCall) Do 

func (c *GroupItemsDeleteCall) Do(opts ...googleapi.CallOption) (*EmptyResponse, error)

Do executes the "youtubeAnalytics.groupItems.delete" call. Any non-2xx status code is an error. Response headers are in either *EmptyResponse.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 (*GroupItemsDeleteCall) Fields 

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

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

func (*GroupItemsDeleteCall) Header 

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

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

func (*GroupItemsDeleteCall) Id 

func (c *GroupItemsDeleteCall) Id(id string) *GroupItemsDeleteCall

Id sets the optional parameter "id": The `id` parameter specifies the YouTube group item ID of the group item that is being deleted.

func (*GroupItemsDeleteCall) OnBehalfOfContentOwner 

func (c *GroupItemsDeleteCall) OnBehalfOfContentOwner(onBehalfOfContentOwner string) *GroupItemsDeleteCall

OnBehalfOfContentOwner sets the optional parameter "onBehalfOfContentOwner": This parameter can only be used in a properly authorized request. **Note:** This parameter is intended exclusively for YouTube content partners that own and manage many different YouTube channels. The `onBehalfOfContentOwner` parameter indicates that the request's authorization credentials identify a YouTube user who is acting on behalf of the content owner specified in the parameter value. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The account that the user authenticates with must be linked to the specified YouTube content owner.

type GroupItemsInsertCall 

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

func (*GroupItemsInsertCall) Context 

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

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

func (*GroupItemsInsertCall) Do 

func (c *GroupItemsInsertCall) Do(opts ...googleapi.CallOption) (*GroupItem, error)

Do executes the "youtubeAnalytics.groupItems.insert" call. Any non-2xx status code is an error. Response headers are in either *GroupItem.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 (*GroupItemsInsertCall) Fields 

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

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

func (*GroupItemsInsertCall) Header 

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

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

func (*GroupItemsInsertCall) OnBehalfOfContentOwner 

func (c *GroupItemsInsertCall) OnBehalfOfContentOwner(onBehalfOfContentOwner string) *GroupItemsInsertCall

OnBehalfOfContentOwner sets the optional parameter "onBehalfOfContentOwner": This parameter can only be used in a properly authorized request. **Note:** This parameter is intended exclusively for YouTube content partners that own and manage many different YouTube channels. The `onBehalfOfContentOwner` parameter indicates that the request's authorization credentials identify a YouTube user who is acting on behalf of the content owner specified in the parameter value. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The account that the user authenticates with must be linked to the specified YouTube content owner.

type GroupItemsListCall 

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

func (*GroupItemsListCall) Context 

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

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

func (*GroupItemsListCall) Do 

func (c *GroupItemsListCall) Do(opts ...googleapi.CallOption) (*ListGroupItemsResponse, error)

Do executes the "youtubeAnalytics.groupItems.list" call. Any non-2xx status code is an error. Response headers are in either *ListGroupItemsResponse.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 (*GroupItemsListCall) Fields 

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

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

func (*GroupItemsListCall) GroupId 

func (c *GroupItemsListCall) GroupId(groupId string) *GroupItemsListCall

GroupId sets the optional parameter "groupId": The `groupId` parameter specifies the unique ID of the group for which you want to retrieve group items.

func (*GroupItemsListCall) Header 

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

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

func (*GroupItemsListCall) IfNoneMatch 

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

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 (*GroupItemsListCall) OnBehalfOfContentOwner 

func (c *GroupItemsListCall) OnBehalfOfContentOwner(onBehalfOfContentOwner string) *GroupItemsListCall

OnBehalfOfContentOwner sets the optional parameter "onBehalfOfContentOwner": This parameter can only be used in a properly authorized request. **Note:** This parameter is intended exclusively for YouTube content partners that own and manage many different YouTube channels. The `onBehalfOfContentOwner` parameter indicates that the request's authorization credentials identify a YouTube user who is acting on behalf of the content owner specified in the parameter value. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The account that the user authenticates with must be linked to the specified YouTube content owner.

type GroupItemsService 

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

func NewGroupItemsService 

func NewGroupItemsService(s *Service) *GroupItemsService

func (*GroupItemsService) Delete 

func (r *GroupItemsService) Delete() *GroupItemsDeleteCall

Delete: Removes an item from a group.

func (*GroupItemsService) Insert 

func (r *GroupItemsService) Insert(groupitem *GroupItem) *GroupItemsInsertCall

Insert: Creates a group item.

func (*GroupItemsService) List 

func (r *GroupItemsService) List() *GroupItemsListCall

List: Returns a collection of group items that match the API request parameters.

type GroupSnippet 

type GroupSnippet struct {
	// PublishedAt: The date and time that the group was created. The value is
	// specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
	PublishedAt string `json:"publishedAt,omitempty"`
	// Title: The group name. The value must be a non-empty string.
	Title string `json:"title,omitempty"`
	// ForceSendFields is a list of field names (e.g. "PublishedAt") 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. "PublishedAt") 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:"-"`
}

GroupSnippet: A group snippet.

func (GroupSnippet) MarshalJSON 

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

type GroupsDeleteCall 

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

func (*GroupsDeleteCall) Context 

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

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

func (*GroupsDeleteCall) Do 

func (c *GroupsDeleteCall) Do(opts ...googleapi.CallOption) (*EmptyResponse, error)

Do executes the "youtubeAnalytics.groups.delete" call. Any non-2xx status code is an error. Response headers are in either *EmptyResponse.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 (*GroupsDeleteCall) Fields 

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

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

func (*GroupsDeleteCall) Header 

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

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

func (*GroupsDeleteCall) Id 

func (c *GroupsDeleteCall) Id(id string) *GroupsDeleteCall

Id sets the optional parameter "id": The `id` parameter specifies the YouTube group ID of the group that is being deleted.

func (*GroupsDeleteCall) OnBehalfOfContentOwner 

func (c *GroupsDeleteCall) OnBehalfOfContentOwner(onBehalfOfContentOwner string) *GroupsDeleteCall

OnBehalfOfContentOwner sets the optional parameter "onBehalfOfContentOwner": This parameter can only be used in a properly authorized request. **Note:** This parameter is intended exclusively for YouTube content partners that own and manage many different YouTube channels. The `onBehalfOfContentOwner` parameter indicates that the request's authorization credentials identify a YouTube user who is acting on behalf of the content owner specified in the parameter value. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The account that the user authenticates with must be linked to the specified YouTube content owner.

type GroupsInsertCall 

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

func (*GroupsInsertCall) Context 

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

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

func (*GroupsInsertCall) Do 

func (c *GroupsInsertCall) Do(opts ...googleapi.CallOption) (*Group, error)

Do executes the "youtubeAnalytics.groups.insert" call. Any non-2xx status code is an error. Response headers are in either *Group.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 (*GroupsInsertCall) Fields 

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

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

func (*GroupsInsertCall) Header 

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

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

func (*GroupsInsertCall) OnBehalfOfContentOwner 

func (c *GroupsInsertCall) OnBehalfOfContentOwner(onBehalfOfContentOwner string) *GroupsInsertCall

OnBehalfOfContentOwner sets the optional parameter "onBehalfOfContentOwner": This parameter can only be used in a properly authorized request. **Note:** This parameter is intended exclusively for YouTube content partners that own and manage many different YouTube channels. The `onBehalfOfContentOwner` parameter indicates that the request's authorization credentials identify a YouTube user who is acting on behalf of the content owner specified in the parameter value. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The account that the user authenticates with must be linked to the specified YouTube content owner.

type GroupsListCall 

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

func (*GroupsListCall) Context 

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

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

func (*GroupsListCall) Do 

func (c *GroupsListCall) Do(opts ...googleapi.CallOption) (*ListGroupsResponse, error)

Do executes the "youtubeAnalytics.groups.list" call. Any non-2xx status code is an error. Response headers are in either *ListGroupsResponse.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 (*GroupsListCall) Fields 

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

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

func (*GroupsListCall) Header 

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

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

func (*GroupsListCall) Id 

func (c *GroupsListCall) Id(id string) *GroupsListCall

Id sets the optional parameter "id": The `id` parameter specifies a comma-separated list of the YouTube group ID(s) for the resource(s) that are being retrieved. Each group must be owned by the authenticated user. In a `group` resource, the `id` property specifies the group's YouTube group ID. Note that if you do not specify a value for the `id` parameter, then you must set the `mine` parameter to `true`.

func (*GroupsListCall) IfNoneMatch 

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

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 (*GroupsListCall) Mine 

func (c *GroupsListCall) Mine(mine bool) *GroupsListCall

Mine sets the optional parameter "mine": This parameter can only be used in a properly authorized request. Set this parameter's value to true to retrieve all groups owned by the authenticated user.

func (*GroupsListCall) OnBehalfOfContentOwner 

func (c *GroupsListCall) OnBehalfOfContentOwner(onBehalfOfContentOwner string) *GroupsListCall

OnBehalfOfContentOwner sets the optional parameter "onBehalfOfContentOwner": This parameter can only be used in a properly authorized request. **Note:** This parameter is intended exclusively for YouTube content partners that own and manage many different YouTube channels. The `onBehalfOfContentOwner` parameter indicates that the request's authorization credentials identify a YouTube user who is acting on behalf of the content owner specified in the parameter value. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The account that the user authenticates with must be linked to the specified YouTube content owner.

func (*GroupsListCall) PageToken 

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

PageToken sets the optional parameter "pageToken": The `pageToken` parameter identifies a specific page in the result set that should be returned. In an API response, the `nextPageToken` property identifies the next page that can be retrieved.

func (*GroupsListCall) Pages 

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

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

func NewGroupsService 

func NewGroupsService(s *Service) *GroupsService

func (*GroupsService) Delete 

func (r *GroupsService) Delete() *GroupsDeleteCall

Delete: Deletes a group.

func (*GroupsService) Insert 

func (r *GroupsService) Insert(group *Group) *GroupsInsertCall

Insert: Creates a group.

func (*GroupsService) List 

func (r *GroupsService) List() *GroupsListCall

List: Returns a collection of groups that match the API request parameters. For example, you can retrieve all groups that the authenticated user owns, or you can retrieve one or more groups by their unique IDs.

func (*GroupsService) Update 

func (r *GroupsService) Update(group *Group) *GroupsUpdateCall

Update: Modifies a group. For example, you could change a group's title.

type GroupsUpdateCall 

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

func (*GroupsUpdateCall) Context 

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

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

func (*GroupsUpdateCall) Do 

func (c *GroupsUpdateCall) Do(opts ...googleapi.CallOption) (*Group, error)

Do executes the "youtubeAnalytics.groups.update" call. Any non-2xx status code is an error. Response headers are in either *Group.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 (*GroupsUpdateCall) Fields 

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

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

func (*GroupsUpdateCall) Header 

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

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

func (*GroupsUpdateCall) OnBehalfOfContentOwner 

func (c *GroupsUpdateCall) OnBehalfOfContentOwner(onBehalfOfContentOwner string) *GroupsUpdateCall

OnBehalfOfContentOwner sets the optional parameter "onBehalfOfContentOwner": This parameter can only be used in a properly authorized request. **Note:** This parameter is intended exclusively for YouTube content partners that own and manage many different YouTube channels. The `onBehalfOfContentOwner` parameter indicates that the request's authorization credentials identify a YouTube user who is acting on behalf of the content owner specified in the parameter value. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The account that the user authenticates with must be linked to the specified YouTube content owner.

type ListGroupItemsResponse 

type ListGroupItemsResponse struct {
	// Errors: Apiary error details
	Errors *Errors `json:"errors,omitempty"`
	// Etag: The Etag of this resource.
	Etag string `json:"etag,omitempty"`
	// Items: A list of groups that match the API request parameters. Each item in
	// the list represents a `groupItem` resource.
	Items []*GroupItem `json:"items,omitempty"`
	// Kind: Identifies the API resource's type. The value will be
	// `youtube#groupItemListResponse`.
	Kind string `json:"kind,omitempty"`

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

ListGroupItemsResponse: Response message for GroupsService.ListGroupItems.

func (ListGroupItemsResponse) MarshalJSON 

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

type ListGroupsResponse 

type ListGroupsResponse struct {
	// Errors: Apiary error details
	Errors *Errors `json:"errors,omitempty"`
	// Etag: The Etag of this resource.
	Etag string `json:"etag,omitempty"`
	// Items: A list of groups that match the API request parameters. Each item in
	// the list represents a `group` resource.
	Items []*Group `json:"items,omitempty"`
	// Kind: Identifies the API resource's type. The value will be
	// `youtube#groupListResponse`.
	Kind string `json:"kind,omitempty"`
	// NextPageToken: The token that can be used as the value of the `pageToken`
	// parameter to retrieve the next page in the result set.
	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. "Errors") 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. "Errors") 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:"-"`
}

ListGroupsResponse: Response message for GroupsService.ListGroups.

func (ListGroupsResponse) MarshalJSON 

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

type QueryResponse 

type QueryResponse struct {
	// ColumnHeaders: This value specifies information about the data returned in
	// the `rows` fields. Each item in the `columnHeaders` list identifies a field
	// returned in the `rows` value, which contains a list of comma-delimited data.
	// The `columnHeaders` list will begin with the dimensions specified in the API
	// request, which will be followed by the metrics specified in the API request.
	// The order of both dimensions and metrics will match the ordering in the API
	// request. For example, if the API request contains the parameters
	// `dimensions=ageGroup,gender&metrics=viewerPercentage`, the API response will
	// return columns in this order: `ageGroup`, `gender`, `viewerPercentage`.
	ColumnHeaders []*ResultTableColumnHeader `json:"columnHeaders,omitempty"`
	// Errors: When set, indicates that the operation failed.
	Errors *Errors `json:"errors,omitempty"`
	// Kind: This value specifies the type of data included in the API response.
	// For the query method, the kind property value will be
	// `youtubeAnalytics#resultTable`.
	Kind string `json:"kind,omitempty"`
	// Rows: The list contains all rows of the result table. Each item in the list
	// is an array that contains comma-delimited data corresponding to a single row
	// of data. The order of the comma-delimited data fields will match the order
	// of the columns listed in the `columnHeaders` field. If no data is available
	// for the given query, the `rows` element will be omitted from the response.
	// The response for a query with the `day` dimension will not contain rows for
	// the most recent days.
	Rows [][]interface{} `json:"rows,omitempty"`

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

QueryResponse: Response message for TargetedQueriesService.Query.

func (QueryResponse) MarshalJSON 

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

type ReportsQueryCall 

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

func (*ReportsQueryCall) Context 

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

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

func (*ReportsQueryCall) Currency 

func (c *ReportsQueryCall) Currency(currency string) *ReportsQueryCall

Currency sets the optional parameter "currency": The currency to which financial metrics should be converted. The default is US Dollar (USD). If the result contains no financial metrics, this flag will be ignored. Responds with an error if the specified currency is not recognized.", pattern: [A-Z]{3}

func (*ReportsQueryCall) Dimensions 

func (c *ReportsQueryCall) Dimensions(dimensions string) *ReportsQueryCall

Dimensions sets the optional parameter "dimensions": A comma-separated list of YouTube Analytics dimensions, such as `views` or `ageGroup,gender`. See the Available Reports (/youtube/analytics/v2/available_reports) document for a list of the reports that you can retrieve and the dimensions used for those reports. Also see the Dimensions (/youtube/analytics/v2/dimsmets/dims) document for definitions of those dimensions." pattern: [0-9a-zA-Z,]+

func (*ReportsQueryCall) Do 

func (c *ReportsQueryCall) Do(opts ...googleapi.CallOption) (*QueryResponse, error)

Do executes the "youtubeAnalytics.reports.query" call. Any non-2xx status code is an error. Response headers are in either *QueryResponse.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 (*ReportsQueryCall) EndDate 

func (c *ReportsQueryCall) EndDate(endDate string) *ReportsQueryCall

EndDate sets the optional parameter "endDate": The end date for fetching YouTube Analytics data. The value should be in `YYYY-MM-DD` format. required: true, pattern: [0-9]{4}-[0-9]{2}-[0-9]{2}

func (*ReportsQueryCall) Fields 

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

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

func (*ReportsQueryCall) Filters 

func (c *ReportsQueryCall) Filters(filters string) *ReportsQueryCall

Filters sets the optional parameter "filters": A list of filters that should be applied when retrieving YouTube Analytics data. The Available Reports (/youtube/analytics/v2/available_reports) document identifies the dimensions that can be used to filter each report, and the Dimensions (/youtube/analytics/v2/dimsmets/dims) document defines those dimensions. If a request uses multiple filters, join them together with a semicolon (`;`), and the returned result table will satisfy both filters. For example, a filters parameter value of `video==dMH0bHeiRNg;country==IT` restricts the result set to include data for the given video in Italy.",

func (*ReportsQueryCall) Header 

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

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

func (*ReportsQueryCall) Ids 

func (c *ReportsQueryCall) Ids(ids string) *ReportsQueryCall

Ids sets the optional parameter "ids": Identifies the YouTube channel or content owner for which you are retrieving YouTube Analytics data. - To request data for a YouTube user, set the `ids` parameter value to `channel==CHANNEL_ID`, where `CHANNEL_ID` specifies the unique YouTube channel ID. - To request data for a YouTube CMS content owner, set the `ids` parameter value to `contentOwner==OWNER_NAME`, where `OWNER_NAME` is the CMS name of the content owner. required: true, pattern: [a-zA-Z]+==[a-zA-Z0-9_+-]+

func (*ReportsQueryCall) IfNoneMatch 

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

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 (*ReportsQueryCall) IncludeHistoricalChannelData 

func (c *ReportsQueryCall) IncludeHistoricalChannelData(includeHistoricalChannelData bool) *ReportsQueryCall

IncludeHistoricalChannelData sets the optional parameter "includeHistoricalChannelData": If set to true historical data (i.e. channel data from before the linking of the channel to the content owner) will be retrieved.",

func (*ReportsQueryCall) MaxResults 

func (c *ReportsQueryCall) MaxResults(maxResults int64) *ReportsQueryCall

MaxResults sets the optional parameter "maxResults": The maximum number of rows to include in the response.", minValue: 1

func (*ReportsQueryCall) Metrics 

func (c *ReportsQueryCall) Metrics(metrics string) *ReportsQueryCall

Metrics sets the optional parameter "metrics": A comma-separated list of YouTube Analytics metrics, such as `views` or `likes,dislikes`. See the Available Reports (/youtube/analytics/v2/available_reports) document for a list of the reports that you can retrieve and the metrics available in each report, and see the Metrics (/youtube/analytics/v2/dimsmets/mets) document for definitions of those metrics. required: true, pattern: [0-9a-zA-Z,]+

func (*ReportsQueryCall) Sort 

func (c *ReportsQueryCall) Sort(sort string) *ReportsQueryCall

Sort sets the optional parameter "sort": A comma-separated list of dimensions or metrics that determine the sort order for YouTube Analytics data. By default the sort order is ascending. The '`-`' prefix causes descending sort order.", pattern: [-0-9a-zA-Z,]+

func (*ReportsQueryCall) StartDate 

func (c *ReportsQueryCall) StartDate(startDate string) *ReportsQueryCall

StartDate sets the optional parameter "startDate": The start date for fetching YouTube Analytics data. The value should be in `YYYY-MM-DD` format. required: true, pattern: "[0-9]{4}-[0-9]{2}-[0-9]{2}

func (*ReportsQueryCall) StartIndex 

func (c *ReportsQueryCall) StartIndex(startIndex int64) *ReportsQueryCall

StartIndex sets the optional parameter "startIndex": An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter (one-based, inclusive).", minValue: 1

type ReportsService 

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

func NewReportsService 

func NewReportsService(s *Service) *ReportsService

func (*ReportsService) Query 

func (r *ReportsService) Query() *ReportsQueryCall

Query: Retrieve your YouTube Analytics reports.

type ResultTableColumnHeader 

type ResultTableColumnHeader struct {
	// ColumnType: The type of the column (`DIMENSION` or `METRIC`).
	ColumnType string `json:"columnType,omitempty"`
	// DataType: The type of the data in the column (`STRING`, `INTEGER`, `FLOAT`,
	// etc.).
	DataType string `json:"dataType,omitempty"`
	// Name: The name of the dimension or metric.
	Name string `json:"name,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ColumnType") 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. "ColumnType") 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:"-"`
}

ResultTableColumnHeader: The description of a column of the result table.

func (ResultTableColumnHeader) MarshalJSON 

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

type Service 

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

	GroupItems *GroupItemsService

	Groups *GroupsService

	Reports *ReportsService
	// 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 added in v0.3.0 

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.