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:14Imported by:0

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:http://developers.google.com/youtube/analytics/

Creating a client

Usage example:

import "google.golang.org/api/youtubeanalytics/v1beta1"...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, 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, use 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 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 option.WithTokenSource:

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

Seehttps://godoc.org/google.golang.org/api/option/ 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

typeGroup

type Group struct {ContentDetails *GroupContentDetails `json:"contentDetails,omitempty"`Etagstring `json:"etag,omitempty"`Idstring `json:"id,omitempty"`Kindstring `json:"kind,omitempty"`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 values are omitted from API requests. However, any non-pointer,// non-interface field appearing in ForceSendFields will be sent to the// server regardless of whether the field is empty or not. This may be// used to include empty fields in Patch requests.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ContentDetails") to// include in API requests with the JSON null value. By default, fields// with empty values are omitted from API requests. However, any field// with an empty value appearing in NullFields will be sent to the// server as null. It is an error if a field in this list has a// non-empty value. This may be used to include null fields in Patch// requests.NullFields []string `json:"-"`}

func (*Group)MarshalJSON

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

typeGroupContentDetails

type GroupContentDetails struct {ItemCountuint64 `json:"itemCount,omitempty,string"`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 values are omitted from API requests. However, any non-pointer,// non-interface field appearing in ForceSendFields will be sent to the// server regardless of whether the field is empty or not. This may be// used to include empty fields in Patch requests.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ItemCount") to include in// API requests with the JSON null value. By default, fields with empty// values are omitted from API requests. However, any field with an// empty value appearing in NullFields will be sent to the server as// null. It is an error if a field in this list has a non-empty value.// This may be used to include null fields in Patch requests.NullFields []string `json:"-"`}

func (*GroupContentDetails)MarshalJSON

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

typeGroupItem

type GroupItem struct {Etagstring `json:"etag,omitempty"`GroupIdstring `json:"groupId,omitempty"`Idstring `json:"id,omitempty"`Kindstring `json:"kind,omitempty"`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. "Etag") to// unconditionally include in API requests. By default, fields with// empty values are omitted from API requests. However, any non-pointer,// non-interface field appearing in ForceSendFields will be sent to the// server regardless of whether the field is empty or not. This may be// used to include empty fields in Patch requests.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Etag") to include in API// requests with the JSON null value. By default, fields with empty// values are omitted from API requests. However, any field with an// empty value appearing in NullFields will be sent to the server as// null. It is an error if a field in this list has a non-empty value.// This may be used to include null fields in Patch requests.NullFields []string `json:"-"`}

func (*GroupItem)MarshalJSON

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

typeGroupItemListResponse

type GroupItemListResponse struct {Etagstring `json:"etag,omitempty"`Items []*GroupItem `json:"items,omitempty"`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. "Etag") to// unconditionally include in API requests. By default, fields with// empty values are omitted from API requests. However, any non-pointer,// non-interface field appearing in ForceSendFields will be sent to the// server regardless of whether the field is empty or not. This may be// used to include empty fields in Patch requests.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Etag") to include in API// requests with the JSON null value. By default, fields with empty// values are omitted from API requests. However, any field with an// empty value appearing in NullFields will be sent to the server as// null. It is an error if a field in this list has a non-empty value.// This may be used to include null fields in Patch requests.NullFields []string `json:"-"`}

GroupItemListResponse: A paginated list of grouList resourcesreturned in response to a youtubeAnalytics.groupApi.list request.

func (*GroupItemListResponse)MarshalJSON

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

typeGroupItemResource

type GroupItemResource struct {Idstring `json:"id,omitempty"`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 values are omitted from API requests. However, any non-pointer,// non-interface field appearing in ForceSendFields will be sent to the// server regardless of whether the field is empty or not. This may be// used to include empty fields in Patch requests.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Id") to include in API// requests with the JSON null value. By default, fields with empty// values are omitted from API requests. However, any field with an// empty value appearing in NullFields will be sent to the server as// null. It is an error if a field in this list has a non-empty value.// This may be used to include null fields in Patch requests.NullFields []string `json:"-"`}

func (*GroupItemResource)MarshalJSON

func (s *GroupItemResource) 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. Anypending HTTP request will be aborted if the provided context iscanceled.

func (*GroupItemsDeleteCall)Do

Do executes the "youtubeAnalytics.groupItems.delete" call.

func (*GroupItemsDeleteCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponsefor more information.

func (*GroupItemsDeleteCall)Header

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

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

func (*GroupItemsDeleteCall)OnBehalfOfContentOwner

func (c *GroupItemsDeleteCall) OnBehalfOfContentOwner(onBehalfOfContentOwnerstring) *GroupItemsDeleteCall

OnBehalfOfContentOwner sets the optional parameter"onBehalfOfContentOwner": Note: This parameter is intendedexclusively for YouTube content partners.

The onBehalfOfContentOwner parameter indicates that the request'sauthorization credentials identify a YouTube CMS user who is actingon behalf of the content owner specified in the parameter value. Thisparameter is intended for YouTube content partners that own andmanage many different YouTube channels. It allows content owners toauthenticate once and get access to all their video and channel data,without having to provide authentication credentials for eachindividual channel. The CMS account that the user authenticates withmust be linked to the specified YouTube content owner.

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. Anypending HTTP request will be aborted if the provided context iscanceled.

func (*GroupItemsInsertCall)Do

Do executes the "youtubeAnalytics.groupItems.insert" call.Exactly one of *GroupItem or error will be non-nil. Any non-2xxstatus code is an error. Response headers are in either*GroupItem.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModifiedto check whether the returned error was becausehttp.StatusNotModified was returned.

func (*GroupItemsInsertCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponsefor more information.

func (*GroupItemsInsertCall)Header

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

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

func (*GroupItemsInsertCall)OnBehalfOfContentOwner

func (c *GroupItemsInsertCall) OnBehalfOfContentOwner(onBehalfOfContentOwnerstring) *GroupItemsInsertCall

OnBehalfOfContentOwner sets the optional parameter"onBehalfOfContentOwner": Note: This parameter is intendedexclusively for YouTube content partners.

The onBehalfOfContentOwner parameter indicates that the request'sauthorization credentials identify a YouTube CMS user who is actingon behalf of the content owner specified in the parameter value. Thisparameter is intended for YouTube content partners that own andmanage many different YouTube channels. It allows content owners toauthenticate once and get access to all their video and channel data,without having to provide authentication credentials for eachindividual channel. The CMS account that the user authenticates withmust be linked to the specified YouTube content owner.

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. Anypending HTTP request will be aborted if the provided context iscanceled.

func (*GroupItemsListCall)Do

Do executes the "youtubeAnalytics.groupItems.list" call.Exactly one of *GroupItemListResponse or error will be non-nil. Anynon-2xx status code is an error. Response headers are in either*GroupItemListResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error wasbecause http.StatusNotModified was returned.

func (*GroupItemsListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponsefor more information.

func (*GroupItemsListCall)Header

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

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

func (*GroupItemsListCall)IfNoneMatch

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

IfNoneMatch sets the optional parameter which makes the operationfail if the object's ETag matches the given value. This is useful forgetting updates only after the object has changed since the lastrequest. Use googleapi.IsNotModified to check whether the responseerror from Do is the result of In-None-Match.

func (*GroupItemsListCall)OnBehalfOfContentOwner

func (c *GroupItemsListCall) OnBehalfOfContentOwner(onBehalfOfContentOwnerstring) *GroupItemsListCall

OnBehalfOfContentOwner sets the optional parameter"onBehalfOfContentOwner": Note: This parameter is intendedexclusively for YouTube content partners.

The onBehalfOfContentOwner parameter indicates that the request'sauthorization credentials identify a YouTube CMS user who is actingon behalf of the content owner specified in the parameter value. Thisparameter is intended for YouTube content partners that own andmanage many different YouTube channels. It allows content owners toauthenticate once and get access to all their video and channel data,without having to provide authentication credentials for eachindividual channel. The CMS account that the user authenticates withmust be linked to the specified YouTube content owner.

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.

typeGroupListResponse

type GroupListResponse struct {Etagstring `json:"etag,omitempty"`Items []*Group `json:"items,omitempty"`Kindstring `json:"kind,omitempty"`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. "Etag") to// unconditionally include in API requests. By default, fields with// empty values are omitted from API requests. However, any non-pointer,// non-interface field appearing in ForceSendFields will be sent to the// server regardless of whether the field is empty or not. This may be// used to include empty fields in Patch requests.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Etag") to include in API// requests with the JSON null value. By default, fields with empty// values are omitted from API requests. However, any field with an// empty value appearing in NullFields will be sent to the server as// null. It is an error if a field in this list has a non-empty value.// This may be used to include null fields in Patch requests.NullFields []string `json:"-"`}

GroupListResponse: A paginated list of grouList resources returned inresponse to a youtubeAnalytics.groupApi.list request.

func (*GroupListResponse)MarshalJSON

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

typeGroupSnippet

type GroupSnippet struct {PublishedAtstring `json:"publishedAt,omitempty"`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 values are omitted from API requests. However, any non-pointer,// non-interface field appearing in ForceSendFields will be sent to the// server regardless of whether the field is empty or not. This may be// used to include empty fields in Patch requests.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "PublishedAt") to include// in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. However, any field with// an empty value appearing in NullFields will be sent to the server as// null. It is an error if a field in this list has a non-empty value.// This may be used to include null fields in Patch requests.NullFields []string `json:"-"`}

func (*GroupSnippet)MarshalJSON

func (s *GroupSnippet) 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. Anypending HTTP request will be aborted if the provided context iscanceled.

func (*GroupsDeleteCall)Do

Do executes the "youtubeAnalytics.groups.delete" call.

func (*GroupsDeleteCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponsefor more information.

func (*GroupsDeleteCall)Header

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

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

func (*GroupsDeleteCall)OnBehalfOfContentOwner

func (c *GroupsDeleteCall) OnBehalfOfContentOwner(onBehalfOfContentOwnerstring) *GroupsDeleteCall

OnBehalfOfContentOwner sets the optional parameter"onBehalfOfContentOwner": Note: This parameter is intendedexclusively for YouTube content partners.

The onBehalfOfContentOwner parameter indicates that the request'sauthorization credentials identify a YouTube CMS user who is actingon behalf of the content owner specified in the parameter value. Thisparameter is intended for YouTube content partners that own andmanage many different YouTube channels. It allows content owners toauthenticate once and get access to all their video and channel data,without having to provide authentication credentials for eachindividual channel. The CMS account that the user authenticates withmust be linked to the specified YouTube content owner.

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. Anypending HTTP request will be aborted if the provided context iscanceled.

func (*GroupsInsertCall)Do

Do executes the "youtubeAnalytics.groups.insert" call.Exactly one of *Group or error will be non-nil. Any non-2xx statuscode 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 tocheck whether the returned error was because http.StatusNotModifiedwas returned.

func (*GroupsInsertCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponsefor more information.

func (*GroupsInsertCall)Header

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

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

func (*GroupsInsertCall)OnBehalfOfContentOwner

func (c *GroupsInsertCall) OnBehalfOfContentOwner(onBehalfOfContentOwnerstring) *GroupsInsertCall

OnBehalfOfContentOwner sets the optional parameter"onBehalfOfContentOwner": Note: This parameter is intendedexclusively for YouTube content partners.

The onBehalfOfContentOwner parameter indicates that the request'sauthorization credentials identify a YouTube CMS user who is actingon behalf of the content owner specified in the parameter value. Thisparameter is intended for YouTube content partners that own andmanage many different YouTube channels. It allows content owners toauthenticate once and get access to all their video and channel data,without having to provide authentication credentials for eachindividual channel. The CMS account that the user authenticates withmust be linked to the specified YouTube content owner.

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. Anypending HTTP request will be aborted if the provided context iscanceled.

func (*GroupsListCall)Do

Do executes the "youtubeAnalytics.groups.list" call.Exactly one of *GroupListResponse or error will be non-nil. Anynon-2xx status code is an error. Response headers are in either*GroupListResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error wasbecause http.StatusNotModified was returned.

func (*GroupsListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponsefor more information.

func (*GroupsListCall)Header

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

Header returns an http.Header that can be modified by the caller toadd HTTP headers 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 are being retrieved. In a group resource, the id propertyspecifies the group's YouTube group ID.

func (*GroupsListCall)IfNoneMatch

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

IfNoneMatch sets the optional parameter which makes the operationfail if the object's ETag matches the given value. This is useful forgetting updates only after the object has changed since the lastrequest. Use googleapi.IsNotModified to check whether the responseerror from Do is the result of In-None-Match.

func (*GroupsListCall)Mine

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

Mine sets the optional parameter "mine": Set this parameter's valueto true to instruct the API to only return groups owned by theauthenticated user.

func (*GroupsListCall)OnBehalfOfContentOwner

func (c *GroupsListCall) OnBehalfOfContentOwner(onBehalfOfContentOwnerstring) *GroupsListCall

OnBehalfOfContentOwner sets the optional parameter"onBehalfOfContentOwner": Note: This parameter is intendedexclusively for YouTube content partners.

The onBehalfOfContentOwner parameter indicates that the request'sauthorization credentials identify a YouTube CMS user who is actingon behalf of the content owner specified in the parameter value. Thisparameter is intended for YouTube content partners that own andmanage many different YouTube channels. It allows content owners toauthenticate once and get access to all their video and channel data,without having to provide authentication credentials for eachindividual channel. The CMS account that the user authenticates withmust be linked to the specified YouTube content owner.

func (*GroupsListCall)PageToken

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

PageToken sets the optional parameter "pageToken": The pageTokenparameter identifies a specific page in the result set that should bereturned. In an API response, the nextPageToken property identifiesthe next page that can be 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

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 requestparameters. For example, you can retrieve all groups that theauthenticated user owns, or you can retrieve one or more groups bytheir unique IDs.

func (*GroupsService)Update

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

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

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. Anypending HTTP request will be aborted if the provided context iscanceled.

func (*GroupsUpdateCall)Do

Do executes the "youtubeAnalytics.groups.update" call.Exactly one of *Group or error will be non-nil. Any non-2xx statuscode 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 tocheck whether the returned error was because http.StatusNotModifiedwas returned.

func (*GroupsUpdateCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponsefor more information.

func (*GroupsUpdateCall)Header

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

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

func (*GroupsUpdateCall)OnBehalfOfContentOwner

func (c *GroupsUpdateCall) OnBehalfOfContentOwner(onBehalfOfContentOwnerstring) *GroupsUpdateCall

OnBehalfOfContentOwner sets the optional parameter"onBehalfOfContentOwner": Note: This parameter is intendedexclusively for YouTube content partners.

The onBehalfOfContentOwner parameter indicates that the request'sauthorization credentials identify a YouTube CMS user who is actingon behalf of the content owner specified in the parameter value. Thisparameter is intended for YouTube content partners that own andmanage many different YouTube channels. It allows content owners toauthenticate once and get access to all their video and channel data,without having to provide authentication credentials for eachindividual channel. The CMS account that the user authenticates withmust be linked to the specified YouTube content owner.

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. Anypending HTTP request will be aborted if the provided context iscanceled.

func (*ReportsQueryCall)Currency

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

Currency sets the optional parameter "currency": The currency towhich financial metrics should be converted. The default is US Dollar(USD). If the result contains no financial metrics, this flag will beignored. Responds with an error if the specified currency is notrecognized.

func (*ReportsQueryCall)Dimensions

func (c *ReportsQueryCall) Dimensions(dimensionsstring) *ReportsQueryCall

Dimensions sets the optional parameter "dimensions": Acomma-separated list of YouTube Analytics dimensions, such as viewsor ageGroup,gender. See the Available Reports document for a list ofthe reports that you can retrieve and the dimensions used for thosereports. Also see the Dimensions document for definitions of thosedimensions.

func (*ReportsQueryCall)Do

Do executes the "youtubeAnalytics.reports.query" call.Exactly one of *ResultTable or error will be non-nil. Any non-2xxstatus code is an error. Response headers are in either*ResultTable.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModifiedto check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ReportsQueryCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponsefor more information.

func (*ReportsQueryCall)Filters

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

Filters sets the optional parameter "filters": A list of filters thatshould be applied when retrieving YouTube Analytics data. TheAvailable Reports document identifies the dimensions that can be usedto filter each report, and the Dimensions document defines thosedimensions. If a request uses multiple filters, join them togetherwith a semicolon (;), and the returned result table will satisfy bothfilters. For example, a filters parameter value ofvideo==dMH0bHeiRNg;country==IT restricts the result set to includedata for the given video in Italy.

func (*ReportsQueryCall)Header

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

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

func (*ReportsQueryCall)IfNoneMatch

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

IfNoneMatch sets the optional parameter which makes the operationfail if the object's ETag matches the given value. This is useful forgetting updates only after the object has changed since the lastrequest. Use googleapi.IsNotModified to check whether the responseerror from Do is the result of In-None-Match.

func (*ReportsQueryCall)IncludeHistoricalChannelData

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

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

func (*ReportsQueryCall)MaxResults

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

MaxResults sets the optional parameter "max-results": The maximumnumber of rows to include in the response.

func (*ReportsQueryCall)Sort

Sort sets the optional parameter "sort": A comma-separated list ofdimensions or metrics that determine the sort order for YouTubeAnalytics data. By default the sort order is ascending. The '-'prefix causes descending sort order.

func (*ReportsQueryCall)StartIndex

func (c *ReportsQueryCall) StartIndex(startIndexint64) *ReportsQueryCall

StartIndex sets the optional parameter "start-index": An index of thefirst entity to retrieve. Use this parameter as a paginationmechanism along with the max-results parameter (one-based,inclusive).

typeReportsService

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

funcNewReportsService

func NewReportsService(s *Service) *ReportsService

func (*ReportsService)Query

func (r *ReportsService) Query(idsstring, startDatestring, endDatestring, metricsstring) *ReportsQueryCall

Query: Retrieve your YouTube Analytics reports.

typeResultTable

type ResultTable 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 []*ResultTableColumnHeaders `json:"columnHeaders,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 values are omitted from API requests. However, any non-pointer,// non-interface field appearing in ForceSendFields will be sent to the// server regardless of whether the field is empty or not. This may be// used to include empty fields in Patch requests.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ColumnHeaders") to include// in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. However, any field with// an empty value appearing in NullFields will be sent to the server as// null. It is an error if a field in this list has a non-empty value.// This may be used to include null fields in Patch requests.NullFields []string `json:"-"`}

ResultTable: Contains a single result table. The table is returned asan array of rows that contain the values for the cells of the table.Depending on the metric or dimension, the cell can contain a string(video ID, country code) or a number (number of views or number oflikes).

func (*ResultTable)MarshalJSON

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

typeResultTableColumnHeaders

type ResultTableColumnHeaders 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 values are omitted from API requests. However, any non-pointer,// non-interface field appearing in ForceSendFields will be sent to the// server regardless of whether the field is empty or not. This may be// used to include empty fields in Patch requests.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ColumnType") to include in// API requests with the JSON null value. By default, fields with empty// values are omitted from API requests. However, any field with an// empty value appearing in NullFields will be sent to the server as// null. It is an error if a field in this list has a non-empty value.// This may be used to include null fields in Patch requests.NullFields []string `json:"-"`}

func (*ResultTableColumnHeaders)MarshalJSON

func (s *ResultTableColumnHeaders) 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