Documentation ¶
Overview ¶
Package youtubeanalytics provides access to the YouTube Analytics API.
See http://developers.google.com/youtube/analytics/
Usage example:
import "google.golang.org/api/youtubeanalytics/v1beta1" ... youtubeanalyticsService, err := youtubeanalytics.New(oauthHttpClient)
Index ¶
- Constants
- type BatchReport
- type BatchReportDefinition
- type BatchReportDefinitionList
- type BatchReportDefinitionsListCall
- func (c *BatchReportDefinitionsListCall) Context(ctx context.Context) *BatchReportDefinitionsListCall
- func (c *BatchReportDefinitionsListCall) Do() (*BatchReportDefinitionList, error)
- func (c *BatchReportDefinitionsListCall) Fields(s ...googleapi.Field) *BatchReportDefinitionsListCall
- func (c *BatchReportDefinitionsListCall) IfNoneMatch(entityTag string) *BatchReportDefinitionsListCall
- type BatchReportDefinitionsService
- type BatchReportList
- type BatchReportOutputs
- type BatchReportTimeSpan
- type BatchReportsListCall
- func (c *BatchReportsListCall) Context(ctx context.Context) *BatchReportsListCall
- func (c *BatchReportsListCall) Do() (*BatchReportList, error)
- func (c *BatchReportsListCall) Fields(s ...googleapi.Field) *BatchReportsListCall
- func (c *BatchReportsListCall) IfNoneMatch(entityTag string) *BatchReportsListCall
- type BatchReportsService
- type Group
- type GroupContentDetails
- type GroupItem
- type GroupItemListResponse
- type GroupItemResource
- type GroupItemsDeleteCall
- func (c *GroupItemsDeleteCall) Context(ctx context.Context) *GroupItemsDeleteCall
- func (c *GroupItemsDeleteCall) Do() error
- func (c *GroupItemsDeleteCall) Fields(s ...googleapi.Field) *GroupItemsDeleteCall
- func (c *GroupItemsDeleteCall) OnBehalfOfContentOwner(onBehalfOfContentOwner string) *GroupItemsDeleteCall
- type GroupItemsInsertCall
- func (c *GroupItemsInsertCall) Context(ctx context.Context) *GroupItemsInsertCall
- func (c *GroupItemsInsertCall) Do() (*GroupItem, error)
- func (c *GroupItemsInsertCall) Fields(s ...googleapi.Field) *GroupItemsInsertCall
- func (c *GroupItemsInsertCall) OnBehalfOfContentOwner(onBehalfOfContentOwner string) *GroupItemsInsertCall
- type GroupItemsListCall
- func (c *GroupItemsListCall) Context(ctx context.Context) *GroupItemsListCall
- func (c *GroupItemsListCall) Do() (*GroupItemListResponse, error)
- func (c *GroupItemsListCall) Fields(s ...googleapi.Field) *GroupItemsListCall
- func (c *GroupItemsListCall) IfNoneMatch(entityTag string) *GroupItemsListCall
- func (c *GroupItemsListCall) OnBehalfOfContentOwner(onBehalfOfContentOwner string) *GroupItemsListCall
- type GroupItemsService
- type GroupListResponse
- type GroupSnippet
- type GroupsDeleteCall
- type GroupsInsertCall
- type GroupsListCall
- func (c *GroupsListCall) Context(ctx context.Context) *GroupsListCall
- func (c *GroupsListCall) Do() (*GroupListResponse, error)
- func (c *GroupsListCall) Fields(s ...googleapi.Field) *GroupsListCall
- func (c *GroupsListCall) Id(id string) *GroupsListCall
- func (c *GroupsListCall) IfNoneMatch(entityTag string) *GroupsListCall
- func (c *GroupsListCall) Mine(mine bool) *GroupsListCall
- func (c *GroupsListCall) OnBehalfOfContentOwner(onBehalfOfContentOwner string) *GroupsListCall
- type GroupsService
- type GroupsUpdateCall
- type ReportsQueryCall
- func (c *ReportsQueryCall) Context(ctx context.Context) *ReportsQueryCall
- func (c *ReportsQueryCall) Currency(currency string) *ReportsQueryCall
- func (c *ReportsQueryCall) Dimensions(dimensions string) *ReportsQueryCall
- func (c *ReportsQueryCall) Do() (*ResultTable, error)
- func (c *ReportsQueryCall) Fields(s ...googleapi.Field) *ReportsQueryCall
- func (c *ReportsQueryCall) Filters(filters string) *ReportsQueryCall
- func (c *ReportsQueryCall) IfNoneMatch(entityTag string) *ReportsQueryCall
- func (c *ReportsQueryCall) MaxResults(maxResults int64) *ReportsQueryCall
- func (c *ReportsQueryCall) Sort(sort string) *ReportsQueryCall
- func (c *ReportsQueryCall) StartIndex(startIndex int64) *ReportsQueryCall
- type ReportsService
- type ResultTable
- type ResultTableColumnHeaders
- type Service
Constants ¶
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 BatchReport ¶
type BatchReport struct { // Id: The ID that YouTube assigns and uses to uniquely identify the // report. Id string `json:"id,omitempty"` // Kind: This value specifies the type of data of this item. For batch // report the kind property value is youtubeAnalytics#batchReport. Kind string `json:"kind,omitempty"` // Outputs: Report outputs. Outputs []*BatchReportOutputs `json:"outputs,omitempty"` // ReportId: The ID of the the report definition. ReportId string `json:"reportId,omitempty"` // TimeSpan: Period included in the report. For reports containing all // entities endTime is not set. Both startTime and endTime are // inclusive. TimeSpan *BatchReportTimeSpan `json:"timeSpan,omitempty"` // TimeUpdated: The time when the report was updated. TimeUpdated string `json:"timeUpdated,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:"-"` }
BatchReport: Contains single batchReport resource.
func (*BatchReport) MarshalJSON ¶
func (s *BatchReport) MarshalJSON() ([]byte, error)
type BatchReportDefinition ¶
type BatchReportDefinition struct { // Id: The ID that YouTube assigns and uses to uniquely identify the // report definition. Id string `json:"id,omitempty"` // Kind: This value specifies the type of data of this item. For batch // report definition the kind property value is // youtubeAnalytics#batchReportDefinition. Kind string `json:"kind,omitempty"` // Name: Name of the report definition. Name string `json:"name,omitempty"` // Status: Status of the report definition. Status string `json:"status,omitempty"` // Type: Type of the report definition. Type string `json:"type,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:"-"` }
BatchReportDefinition: Contains single batchReportDefinition resource.
func (*BatchReportDefinition) MarshalJSON ¶
func (s *BatchReportDefinition) MarshalJSON() ([]byte, error)
type BatchReportDefinitionList ¶
type BatchReportDefinitionList struct { // Items: A list of batchReportDefinition resources that match the // request criteria. Items []*BatchReportDefinition `json:"items,omitempty"` // Kind: This value specifies the type of data included in the API // response. For the list method, the kind property value is // youtubeAnalytics#batchReportDefinitionList. 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. "Items") 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:"-"` }
BatchReportDefinitionList: A paginated list of batchReportDefinition resources returned in response to a youtubeAnalytics.batchReportDefinitions.list request.
func (*BatchReportDefinitionList) MarshalJSON ¶
func (s *BatchReportDefinitionList) MarshalJSON() ([]byte, error)
type BatchReportDefinitionsListCall ¶
type BatchReportDefinitionsListCall struct {
// contains filtered or unexported fields
}
func (*BatchReportDefinitionsListCall) Context ¶
func (c *BatchReportDefinitionsListCall) Context(ctx context.Context) *BatchReportDefinitionsListCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*BatchReportDefinitionsListCall) Do ¶
func (c *BatchReportDefinitionsListCall) Do() (*BatchReportDefinitionList, error)
Do executes the "youtubeAnalytics.batchReportDefinitions.list" call. Exactly one of *BatchReportDefinitionList or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *BatchReportDefinitionList.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 (*BatchReportDefinitionsListCall) Fields ¶
func (c *BatchReportDefinitionsListCall) Fields(s ...googleapi.Field) *BatchReportDefinitionsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*BatchReportDefinitionsListCall) IfNoneMatch ¶
func (c *BatchReportDefinitionsListCall) IfNoneMatch(entityTag string) *BatchReportDefinitionsListCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
type BatchReportDefinitionsService ¶
type BatchReportDefinitionsService struct {
// contains filtered or unexported fields
}
func NewBatchReportDefinitionsService ¶
func NewBatchReportDefinitionsService(s *Service) *BatchReportDefinitionsService
func (*BatchReportDefinitionsService) List ¶
func (r *BatchReportDefinitionsService) List(onBehalfOfContentOwner string) *BatchReportDefinitionsListCall
List: Retrieves a list of available batch report definitions.
type BatchReportList ¶
type BatchReportList struct { // Items: A list of batchReport resources that match the request // criteria. Items []*BatchReport `json:"items,omitempty"` // Kind: This value specifies the type of data included in the API // response. For the list method, the kind property value is // youtubeAnalytics#batchReportList. 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. "Items") 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:"-"` }
BatchReportList: A paginated list of batchReport resources returned in response to a youtubeAnalytics.batchReport.list request.
func (*BatchReportList) MarshalJSON ¶
func (s *BatchReportList) MarshalJSON() ([]byte, error)
type BatchReportOutputs ¶
type BatchReportOutputs struct { // DownloadUrl: Cloud storage URL to download this report. This URL is // valid for 30 minutes. DownloadUrl string `json:"downloadUrl,omitempty"` // Format: Format of the output. Format string `json:"format,omitempty"` // Type: Type of the output. Type string `json:"type,omitempty"` // ForceSendFields is a list of field names (e.g. "DownloadUrl") 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:"-"` }
func (*BatchReportOutputs) MarshalJSON ¶
func (s *BatchReportOutputs) MarshalJSON() ([]byte, error)
type BatchReportTimeSpan ¶
type BatchReportTimeSpan struct { // EndTime: End of the period included in the report. Inclusive. For // reports containing all entities endTime is not set. EndTime string `json:"endTime,omitempty"` // StartTime: Start of the period included in the report. Inclusive. StartTime string `json:"startTime,omitempty"` // ForceSendFields is a list of field names (e.g. "EndTime") 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:"-"` }
BatchReportTimeSpan: Period included in the report. For reports containing all entities endTime is not set. Both startTime and endTime are inclusive.
func (*BatchReportTimeSpan) MarshalJSON ¶
func (s *BatchReportTimeSpan) MarshalJSON() ([]byte, error)
type BatchReportsListCall ¶
type BatchReportsListCall struct {
// contains filtered or unexported fields
}
func (*BatchReportsListCall) Context ¶
func (c *BatchReportsListCall) Context(ctx context.Context) *BatchReportsListCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*BatchReportsListCall) Do ¶
func (c *BatchReportsListCall) Do() (*BatchReportList, error)
Do executes the "youtubeAnalytics.batchReports.list" call. Exactly one of *BatchReportList or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *BatchReportList.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 (*BatchReportsListCall) Fields ¶
func (c *BatchReportsListCall) Fields(s ...googleapi.Field) *BatchReportsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*BatchReportsListCall) IfNoneMatch ¶
func (c *BatchReportsListCall) IfNoneMatch(entityTag string) *BatchReportsListCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
type BatchReportsService ¶
type BatchReportsService struct {
// contains filtered or unexported fields
}
func NewBatchReportsService ¶
func NewBatchReportsService(s *Service) *BatchReportsService
func (*BatchReportsService) List ¶
func (r *BatchReportsService) List(batchReportDefinitionId string, onBehalfOfContentOwner string) *BatchReportsListCall
List: Retrieves a list of processed batch reports.
type Group ¶
type Group struct { ContentDetails *GroupContentDetails `json:"contentDetails,omitempty"` Etag string `json:"etag,omitempty"` Id string `json:"id,omitempty"` Kind string `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:"-"` }
func (*Group) MarshalJSON ¶
type GroupContentDetails ¶
type GroupContentDetails struct { ItemCount uint64 `json:"itemCount,omitempty,string"` 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 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:"-"` }
func (*GroupContentDetails) MarshalJSON ¶
func (s *GroupContentDetails) MarshalJSON() ([]byte, error)
type GroupItem ¶
type GroupItem struct { Etag string `json:"etag,omitempty"` GroupId string `json:"groupId,omitempty"` Id string `json:"id,omitempty"` Kind string `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:"-"` }
func (*GroupItem) MarshalJSON ¶
type GroupItemListResponse ¶
type GroupItemListResponse struct { Etag string `json:"etag,omitempty"` Items []*GroupItem `json:"items,omitempty"` 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. "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:"-"` }
GroupItemListResponse: A paginated list of grouList resources returned in response to a youtubeAnalytics.groupApi.list request.
func (*GroupItemListResponse) MarshalJSON ¶
func (s *GroupItemListResponse) MarshalJSON() ([]byte, error)
type GroupItemResource ¶
type GroupItemResource struct { Id string `json:"id,omitempty"` 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 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:"-"` }
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. Any pending HTTP request will be aborted if the provided context is canceled.
func (*GroupItemsDeleteCall) Do ¶
func (c *GroupItemsDeleteCall) Do() error
Do executes the "youtubeAnalytics.groupItems.delete" call.
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 information.
func (*GroupItemsDeleteCall) OnBehalfOfContentOwner ¶
func (c *GroupItemsDeleteCall) OnBehalfOfContentOwner(onBehalfOfContentOwner string) *GroupItemsDeleteCall
OnBehalfOfContentOwner sets the optional parameter "onBehalfOfContentOwner": Note: This parameter is intended exclusively for YouTube content partners.
The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. 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 CMS 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. Any pending HTTP request will be aborted if the provided context is canceled.
func (*GroupItemsInsertCall) Do ¶
func (c *GroupItemsInsertCall) Do() (*GroupItem, error)
Do executes the "youtubeAnalytics.groupItems.insert" call. Exactly one of *GroupItem or error will be non-nil. 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 information.
func (*GroupItemsInsertCall) OnBehalfOfContentOwner ¶
func (c *GroupItemsInsertCall) OnBehalfOfContentOwner(onBehalfOfContentOwner string) *GroupItemsInsertCall
OnBehalfOfContentOwner sets the optional parameter "onBehalfOfContentOwner": Note: This parameter is intended exclusively for YouTube content partners.
The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. 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 CMS 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. Any pending HTTP request will be aborted if the provided context is canceled.
func (*GroupItemsListCall) Do ¶
func (c *GroupItemsListCall) Do() (*GroupItemListResponse, error)
Do executes the "youtubeAnalytics.groupItems.list" call. Exactly one of *GroupItemListResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GroupItemListResponse.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 information.
func (*GroupItemsListCall) IfNoneMatch ¶
func (c *GroupItemsListCall) IfNoneMatch(entityTag string) *GroupItemsListCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*GroupItemsListCall) OnBehalfOfContentOwner ¶
func (c *GroupItemsListCall) OnBehalfOfContentOwner(onBehalfOfContentOwner string) *GroupItemsListCall
OnBehalfOfContentOwner sets the optional parameter "onBehalfOfContentOwner": Note: This parameter is intended exclusively for YouTube content partners.
The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. 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 CMS 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(id string) *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(groupId string) *GroupItemsListCall
List: Returns a collection of group items that match the API request parameters.
type GroupListResponse ¶
type GroupListResponse struct { Etag string `json:"etag,omitempty"` Items []*Group `json:"items,omitempty"` 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. "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:"-"` }
GroupListResponse: A paginated list of grouList resources returned in response to a youtubeAnalytics.groupApi.list request.
func (*GroupListResponse) MarshalJSON ¶
func (s *GroupListResponse) MarshalJSON() ([]byte, error)
type GroupSnippet ¶
type GroupSnippet struct { PublishedAt string `json:"publishedAt,omitempty"` 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 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:"-"` }
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. Any pending HTTP request will be aborted if the provided context is canceled.
func (*GroupsDeleteCall) Do ¶
func (c *GroupsDeleteCall) Do() error
Do executes the "youtubeAnalytics.groups.delete" call.
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 information.
func (*GroupsDeleteCall) OnBehalfOfContentOwner ¶
func (c *GroupsDeleteCall) OnBehalfOfContentOwner(onBehalfOfContentOwner string) *GroupsDeleteCall
OnBehalfOfContentOwner sets the optional parameter "onBehalfOfContentOwner": Note: This parameter is intended exclusively for YouTube content partners.
The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. 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 CMS 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. Any pending HTTP request will be aborted if the provided context is canceled.
func (*GroupsInsertCall) Do ¶
func (c *GroupsInsertCall) Do() (*Group, error)
Do executes the "youtubeAnalytics.groups.insert" call. Exactly one of *Group or error will be non-nil. 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 information.
func (*GroupsInsertCall) OnBehalfOfContentOwner ¶
func (c *GroupsInsertCall) OnBehalfOfContentOwner(onBehalfOfContentOwner string) *GroupsInsertCall
OnBehalfOfContentOwner sets the optional parameter "onBehalfOfContentOwner": Note: This parameter is intended exclusively for YouTube content partners.
The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. 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 CMS 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. Any pending HTTP request will be aborted if the provided context is canceled.
func (*GroupsListCall) Do ¶
func (c *GroupsListCall) Do() (*GroupListResponse, error)
Do executes the "youtubeAnalytics.groups.list" call. Exactly one of *GroupListResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GroupListResponse.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 information.
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. In a group resource, the id property specifies the group's YouTube group ID.
func (*GroupsListCall) IfNoneMatch ¶
func (c *GroupsListCall) IfNoneMatch(entityTag string) *GroupsListCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*GroupsListCall) Mine ¶
func (c *GroupsListCall) Mine(mine bool) *GroupsListCall
Mine sets the optional parameter "mine": Set this parameter's value to true to instruct the API to only return groups owned by the authenticated user.
func (*GroupsListCall) OnBehalfOfContentOwner ¶
func (c *GroupsListCall) OnBehalfOfContentOwner(onBehalfOfContentOwner string) *GroupsListCall
OnBehalfOfContentOwner sets the optional parameter "onBehalfOfContentOwner": Note: This parameter is intended exclusively for YouTube content partners.
The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. 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 CMS account that the user authenticates with must be linked to the specified YouTube content owner.
type GroupsService ¶
type GroupsService struct {
// contains filtered or unexported fields
}
func NewGroupsService ¶
func NewGroupsService(s *Service) *GroupsService
func (*GroupsService) Delete ¶
func (r *GroupsService) Delete(id string) *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. Any pending HTTP request will be aborted if the provided context is canceled.
func (*GroupsUpdateCall) Do ¶
func (c *GroupsUpdateCall) Do() (*Group, error)
Do executes the "youtubeAnalytics.groups.update" call. Exactly one of *Group or error will be non-nil. 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 information.
func (*GroupsUpdateCall) OnBehalfOfContentOwner ¶
func (c *GroupsUpdateCall) OnBehalfOfContentOwner(onBehalfOfContentOwner string) *GroupsUpdateCall
OnBehalfOfContentOwner sets the optional parameter "onBehalfOfContentOwner": Note: This parameter is intended exclusively for YouTube content partners.
The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. 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 CMS account that the user authenticates with must be linked to the specified YouTube content owner.
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. Any pending HTTP request will be aborted if the provided context is canceled.
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.
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 document for a list of the reports that you can retrieve and the dimensions used for those reports. Also see the Dimensions document for definitions of those dimensions.
func (*ReportsQueryCall) Do ¶
func (c *ReportsQueryCall) Do() (*ResultTable, error)
Do executes the "youtubeAnalytics.reports.query" call. Exactly one of *ResultTable or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ResultTable.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) 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 information.
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 document identifies the dimensions that can be used to filter each report, and the Dimensions 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) IfNoneMatch ¶
func (c *ReportsQueryCall) IfNoneMatch(entityTag string) *ReportsQueryCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*ReportsQueryCall) MaxResults ¶
func (c *ReportsQueryCall) MaxResults(maxResults int64) *ReportsQueryCall
MaxResults sets the optional parameter "max-results": The maximum number of rows to include in the response.
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.
func (*ReportsQueryCall) StartIndex ¶
func (c *ReportsQueryCall) StartIndex(startIndex int64) *ReportsQueryCall
StartIndex sets the optional parameter "start-index": An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter (one-based, inclusive).
type ReportsService ¶
type ReportsService struct {
// contains filtered or unexported fields
}
func NewReportsService ¶
func NewReportsService(s *Service) *ReportsService
func (*ReportsService) Query ¶
func (r *ReportsService) Query(ids string, startDate string, endDate string, metrics string) *ReportsQueryCall
Query: Retrieve your YouTube Analytics reports.
type ResultTable ¶
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. 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 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:"-"` }
ResultTable: Contains a single result table. The table is returned as an 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 of likes).
func (*ResultTable) MarshalJSON ¶
func (s *ResultTable) MarshalJSON() ([]byte, error)
type ResultTableColumnHeaders ¶
type ResultTableColumnHeaders 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 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:"-"` }
func (*ResultTableColumnHeaders) MarshalJSON ¶
func (s *ResultTableColumnHeaders) MarshalJSON() ([]byte, error)
type Service ¶
type Service struct { BasePath string // API endpoint base URL UserAgent string // optional additional User-Agent fragment BatchReportDefinitions *BatchReportDefinitionsService BatchReports *BatchReportsService GroupItems *GroupItemsService Groups *GroupsService Reports *ReportsService // contains filtered or unexported fields }