Movatterモバイル変換


[0]ホーム

URL:


youtubeanalytics

package
v0.257.0Latest Latest
Warning

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

Go to latest
Published: Dec 2, 2025 License:BSD-3-ClauseImports:18Imported by:2

Details

Repository

github.com/googleapis/google-api-go-client

Links

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, thislibrary is considered complete and is in maintenance mode. This meansthat we will address critical bugs and security issues but will not addany 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 forauthentication. For information on how to create and obtain ApplicationDefault Credentials, seehttps://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, usegoogle.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 APIkeys), usegoogle.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 OAuthflow, usegoogle.golang.org/api/option.WithTokenSource:

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

Seegoogle.golang.org/api/option.ClientOption for details on options.

Index

Constants

View Source
const (// Manage your YouTube accountYoutubeScope = "https://www.googleapis.com/auth/youtube"// View your YouTube accountYoutubeReadonlyScope = "https://www.googleapis.com/auth/youtube.readonly"// View and manage your assets and associated content on YouTubeYoutubepartnerScope = "https://www.googleapis.com/auth/youtubepartner"// View monetary and non-monetary YouTube Analytics reports for your YouTube// contentYtAnalyticsMonetaryReadonlyScope = "https://www.googleapis.com/auth/yt-analytics-monetary.readonly"// View YouTube Analytics reports for your YouTube contentYtAnalyticsReadonlyScope = "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

typeEmptyResponse

type EmptyResponse struct {// Errors: Apiary error detailsErrors *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 (sEmptyResponse) MarshalJSON() ([]byte,error)

typeErrorProto

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.Codestring `json:"code,omitempty"`// DebugInfo: Debugging information, which should not be shared externally.DebugInfostring `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.CoreErrorDomainDomainstring `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.ExternalErrorMessagestring `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].countryLocationstring `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}.LocationTypestring `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 (sErrorProto) MarshalJSON() ([]byte,error)

typeErrors

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"Codestring `json:"code,omitempty"`// Error: Specific error description and codesError []*ErrorProto `json:"error,omitempty"`// RequestId: Request identifier generated by the service, which can be used to// identify the error in the logsRequestIdstring `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 signalsthat the operation has failed.

func (Errors)MarshalJSON

func (sErrors) MarshalJSON() ([]byte,error)

typeGroup

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 detailsErrors *Errors `json:"errors,omitempty"`// Etag: The Etag of this resource.Etagstring `json:"etag,omitempty"`// Id: The ID that YouTube uses to uniquely identify the group.Idstring `json:"id,omitempty"`// Kind: Identifies the API resource's type. The value will be `youtube#group`.Kindstring `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 (sGroup) MarshalJSON() ([]byte,error)

typeGroupContentDetails

type GroupContentDetails struct {// ItemCount: The number of items in the group.ItemCountuint64 `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`ItemTypestring `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 (sGroupContentDetails) MarshalJSON() ([]byte,error)

typeGroupItem

type GroupItem struct {// Errors: Apiary error detailsErrors *Errors `json:"errors,omitempty"`// Etag: The Etag of this resource.Etagstring `json:"etag,omitempty"`// GroupId: The ID that YouTube uses to uniquely identify the group that// contains the item.GroupIdstring `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.Idstring `json:"id,omitempty"`// Kind: Identifies the API resource's type. The value will be// `youtube#groupItem`.Kindstring `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 (sGroupItem) MarshalJSON() ([]byte,error)

typeGroupItemResource

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.Idstring `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`Kindstring `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 (sGroupItemResource) MarshalJSON() ([]byte,error)

typeGroupItemsDeleteCall

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

func (*GroupItemsDeleteCall)Context

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

func (*GroupItemsDeleteCall)Do

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 checkwhether the returned error was because http.StatusNotModified was returned.

func (*GroupItemsDeleteCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*GroupItemsDeleteCall)Header

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

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

func (*GroupItemsDeleteCall)Id

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

func (*GroupItemsDeleteCall)OnBehalfOfContentOwner

func (c *GroupItemsDeleteCall) OnBehalfOfContentOwner(onBehalfOfContentOwnerstring) *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 ownand manage many different YouTube channels. The `onBehalfOfContentOwner`parameter indicates that the request's authorization credentials identify aYouTube user who is acting on behalf of the content owner specified in theparameter value. It allows content owners to authenticate once and getaccess to all their video and channel data, without having to provideauthentication credentials for each individual channel. The account that theuser authenticates with must be linked to the specified YouTube contentowner.

typeGroupItemsInsertCall

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

func (*GroupItemsInsertCall)Context

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

func (*GroupItemsInsertCall)Do

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) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*GroupItemsInsertCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*GroupItemsInsertCall)Header

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

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

func (*GroupItemsInsertCall)OnBehalfOfContentOwner

func (c *GroupItemsInsertCall) OnBehalfOfContentOwner(onBehalfOfContentOwnerstring) *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 ownand manage many different YouTube channels. The `onBehalfOfContentOwner`parameter indicates that the request's authorization credentials identify aYouTube user who is acting on behalf of the content owner specified in theparameter value. It allows content owners to authenticate once and getaccess to all their video and channel data, without having to provideauthentication credentials for each individual channel. The account that theuser authenticates with must be linked to the specified YouTube contentowner.

typeGroupItemsListCall

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

func (*GroupItemsListCall)Context

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

func (*GroupItemsListCall)Do

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 returnedat all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*GroupItemsListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*GroupItemsListCall)GroupId

func (c *GroupItemsListCall) GroupId(groupIdstring) *GroupItemsListCall

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

func (*GroupItemsListCall)Header

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

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

func (*GroupItemsListCall)IfNoneMatch

func (c *GroupItemsListCall) IfNoneMatch(entityTagstring) *GroupItemsListCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*GroupItemsListCall)OnBehalfOfContentOwner

func (c *GroupItemsListCall) OnBehalfOfContentOwner(onBehalfOfContentOwnerstring) *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 ownand manage many different YouTube channels. The `onBehalfOfContentOwner`parameter indicates that the request's authorization credentials identify aYouTube user who is acting on behalf of the content owner specified in theparameter value. It allows content owners to authenticate once and getaccess to all their video and channel data, without having to provideauthentication credentials for each individual channel. The account that theuser authenticates with must be linked to the specified YouTube contentowner.

typeGroupItemsService

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

funcNewGroupItemsService

func NewGroupItemsService(s *Service) *GroupItemsService

func (*GroupItemsService)Delete

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

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

typeGroupSnippet

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.PublishedAtstring `json:"publishedAt,omitempty"`// Title: The group name. The value must be a non-empty string.Titlestring `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 (sGroupSnippet) MarshalJSON() ([]byte,error)

typeGroupsDeleteCall

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

func (*GroupsDeleteCall)Context

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

func (*GroupsDeleteCall)Do

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 checkwhether the returned error was because http.StatusNotModified was returned.

func (*GroupsDeleteCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*GroupsDeleteCall)Header

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

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

func (*GroupsDeleteCall)Id

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

func (*GroupsDeleteCall)OnBehalfOfContentOwner

func (c *GroupsDeleteCall) OnBehalfOfContentOwner(onBehalfOfContentOwnerstring) *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 ownand manage many different YouTube channels. The `onBehalfOfContentOwner`parameter indicates that the request's authorization credentials identify aYouTube user who is acting on behalf of the content owner specified in theparameter value. It allows content owners to authenticate once and getaccess to all their video and channel data, without having to provideauthentication credentials for each individual channel. The account that theuser authenticates with must be linked to the specified YouTube contentowner.

typeGroupsInsertCall

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

func (*GroupsInsertCall)Context

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

func (*GroupsInsertCall)Do

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) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*GroupsInsertCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*GroupsInsertCall)Header

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

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

func (*GroupsInsertCall)OnBehalfOfContentOwner

func (c *GroupsInsertCall) OnBehalfOfContentOwner(onBehalfOfContentOwnerstring) *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 ownand manage many different YouTube channels. The `onBehalfOfContentOwner`parameter indicates that the request's authorization credentials identify aYouTube user who is acting on behalf of the content owner specified in theparameter value. It allows content owners to authenticate once and getaccess to all their video and channel data, without having to provideauthentication credentials for each individual channel. The account that theuser authenticates with must be linked to the specified YouTube contentowner.

typeGroupsListCall

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

func (*GroupsListCall)Context

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

func (*GroupsListCall)Do

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 atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*GroupsListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*GroupsListCall)Header

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

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

func (*GroupsListCall)Id

Id sets the optional parameter "id": The `id` parameter specifies acomma-separated list of the YouTube group ID(s) for the resource(s) that arebeing 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 youmust set the `mine` parameter to `true`.

func (*GroupsListCall)IfNoneMatch

func (c *GroupsListCall) IfNoneMatch(entityTagstring) *GroupsListCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*GroupsListCall)Mine

func (c *GroupsListCall) Mine(minebool) *GroupsListCall

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

func (*GroupsListCall)OnBehalfOfContentOwner

func (c *GroupsListCall) OnBehalfOfContentOwner(onBehalfOfContentOwnerstring) *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 ownand manage many different YouTube channels. The `onBehalfOfContentOwner`parameter indicates that the request's authorization credentials identify aYouTube user who is acting on behalf of the content owner specified in theparameter value. It allows content owners to authenticate once and getaccess to all their video and channel data, without having to provideauthentication credentials for each individual channel. The account that theuser authenticates with must be linked to the specified YouTube contentowner.

func (*GroupsListCall)PageToken

func (c *GroupsListCall) PageToken(pageTokenstring) *GroupsListCall

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

func (*GroupsListCall)Pages

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.

typeGroupsService

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

funcNewGroupsService

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.

typeGroupsUpdateCall

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

func (*GroupsUpdateCall)Context

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

func (*GroupsUpdateCall)Do

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) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*GroupsUpdateCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*GroupsUpdateCall)Header

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

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

func (*GroupsUpdateCall)OnBehalfOfContentOwner

func (c *GroupsUpdateCall) OnBehalfOfContentOwner(onBehalfOfContentOwnerstring) *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 ownand manage many different YouTube channels. The `onBehalfOfContentOwner`parameter indicates that the request's authorization credentials identify aYouTube user who is acting on behalf of the content owner specified in theparameter value. It allows content owners to authenticate once and getaccess to all their video and channel data, without having to provideauthentication credentials for each individual channel. The account that theuser authenticates with must be linked to the specified YouTube contentowner.

typeListGroupItemsResponse

type ListGroupItemsResponse struct {// Errors: Apiary error detailsErrors *Errors `json:"errors,omitempty"`// Etag: The Etag of this resource.Etagstring `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`.Kindstring `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 (sListGroupItemsResponse) MarshalJSON() ([]byte,error)

typeListGroupsResponse

type ListGroupsResponse struct {// Errors: Apiary error detailsErrors *Errors `json:"errors,omitempty"`// Etag: The Etag of this resource.Etagstring `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`.Kindstring `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.NextPageTokenstring `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 (sListGroupsResponse) MarshalJSON() ([]byte,error)

typeQueryResponse

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`.Kindstring `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 (sQueryResponse) MarshalJSON() ([]byte,error)

typeReportsQueryCall

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

func (*ReportsQueryCall)Context

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

func (*ReportsQueryCall)Currency

func (c *ReportsQueryCall) Currency(currencystring) *ReportsQueryCall

Currency sets the optional parameter "currency": The currency to whichfinancial metrics should be converted. The default is US Dollar (USD). Ifthe 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(dimensionsstring) *ReportsQueryCall

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

func (*ReportsQueryCall)Do

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 checkwhether the returned error was because http.StatusNotModified was returned.

func (*ReportsQueryCall)EndDate

func (c *ReportsQueryCall) EndDate(endDatestring) *ReportsQueryCall

EndDate sets the optional parameter "endDate": The end date for fetchingYouTube 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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ReportsQueryCall)Filters

func (c *ReportsQueryCall) Filters(filtersstring) *ReportsQueryCall

Filters sets the optional parameter "filters": A list of filters that shouldbe applied when retrieving YouTube Analytics data. The Available Reports(/youtube/analytics/v2/available_reports) document identifies the dimensionsthat can be used to filter each report, and the Dimensions(/youtube/analytics/v2/dimsmets/dims) document defines those dimensions. Ifa request uses multiple filters, join them together with a semicolon (`;`),and the returned result table will satisfy both filters. For example, afilters parameter value of `video==dMH0bHeiRNg;country==IT` restricts theresult 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 addheaders to the request.

func (*ReportsQueryCall)Ids

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

func (*ReportsQueryCall)IfNoneMatch

func (c *ReportsQueryCall) IfNoneMatch(entityTagstring) *ReportsQueryCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ReportsQueryCall)IncludeHistoricalChannelData

func (c *ReportsQueryCall) IncludeHistoricalChannelData(includeHistoricalChannelDatabool) *ReportsQueryCall

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

func (*ReportsQueryCall)MaxResults

func (c *ReportsQueryCall) MaxResults(maxResultsint64) *ReportsQueryCall

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

func (*ReportsQueryCall)Metrics

func (c *ReportsQueryCall) Metrics(metricsstring) *ReportsQueryCall

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

func (*ReportsQueryCall)Sort

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

func (*ReportsQueryCall)StartDate

func (c *ReportsQueryCall) StartDate(startDatestring) *ReportsQueryCall

StartDate sets the optional parameter "startDate": The start date forfetching 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(startIndexint64) *ReportsQueryCall

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

typeReportsService

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

funcNewReportsService

func NewReportsService(s *Service) *ReportsService

func (*ReportsService)Query

func (r *ReportsService) Query() *ReportsQueryCall

Query: Retrieve your YouTube Analytics reports.

typeResultTableColumnHeader

type ResultTableColumnHeader struct {// ColumnType: The type of the column (`DIMENSION` or `METRIC`).ColumnTypestring `json:"columnType,omitempty"`// DataType: The type of the data in the column (`STRING`, `INTEGER`, `FLOAT`,// etc.).DataTypestring `json:"dataType,omitempty"`// Name: The name of the dimension or metric.Namestring `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 (sResultTableColumnHeader) MarshalJSON() ([]byte,error)

typeService

type Service struct {BasePathstring// API endpoint base URLUserAgentstring// optional additional User-Agent fragmentGroupItems *GroupItemsServiceGroups *GroupsServiceReports *ReportsService// contains filtered or unexported fields}

funcNewdeprecated

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.

funcNewServiceadded inv0.3.0

func NewService(ctxcontext.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 orF : Jump to
y orY : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic.Learn more.

[8]ページ先頭

©2009-2025 Movatter.jp