youtubereporting

package
v0.199.0 Latest Latest
Warning

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

 Go to latest Published: Sep 25, 2024 License: BSD-3-Clause Imports: 16 Imported by: 1

Documentation

Overview

Package youtubereporting provides access to the YouTube Reporting API.

For product documentation, see: https://developers.google.com/youtube/reporting/v1/reports/

Library status

These client libraries are officially supported by Google. However, this library is considered complete and is in maintenance mode. This means that we will address critical bugs and security issues but will not add any new features.

When possible, we recommend using our newer [Cloud Client Libraries for Go](https://pkg.go.dev/cloud.google.com/go) that are still actively being worked and iterated on.

Creating a client

Usage example: 

import "google.golang.org/api/youtubereporting/v1"
...
ctx := context.Background()
youtubereportingService, err := youtubereporting.NewService(ctx)

In this example, Google Application Default Credentials are used for authentication. For information on how to create and obtain Application Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.

Other authentication options

By default, all available scopes (see "Constants") are used to authenticate. To restrict scopes, use google.golang.org/api/option.WithScopes: 

youtubereportingService, err := youtubereporting.NewService(ctx, option.WithScopes(youtubereporting.YtAnalyticsReadonlyScope))

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

youtubereportingService, err := youtubereporting.NewService(ctx, option.WithAPIKey("AIza..."))

To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow, use google.golang.org/api/option.WithTokenSource: 

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

See google.golang.org/api/option.ClientOption for details on options.

Index

Constants

View Source 
const (
	// 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 Empty 

type Empty struct {
	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
}

Empty: A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

type GdataBlobstore2Info 

type GdataBlobstore2Info struct {
	// BlobGeneration: gdata
	BlobGeneration int64 `json:"blobGeneration,omitempty,string"`
	// BlobId: gdata
	BlobId string `json:"blobId,omitempty"`
	// DownloadReadHandle: gdata
	DownloadReadHandle string `json:"downloadReadHandle,omitempty"`
	// ReadToken: gdata
	ReadToken string `json:"readToken,omitempty"`
	// UploadMetadataContainer: gdata
	UploadMetadataContainer string `json:"uploadMetadataContainer,omitempty"`
	// ForceSendFields is a list of field names (e.g. "BlobGeneration") 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. "BlobGeneration") 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:"-"`
}

GdataBlobstore2Info: gdata

func (GdataBlobstore2Info) MarshalJSON 

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

type GdataCompositeMedia 

type GdataCompositeMedia struct {
	// BlobRef: gdata
	BlobRef string `json:"blobRef,omitempty"`
	// Blobstore2Info: gdata
	Blobstore2Info *GdataBlobstore2Info `json:"blobstore2Info,omitempty"`
	// CosmoBinaryReference: gdata
	CosmoBinaryReference string `json:"cosmoBinaryReference,omitempty"`
	// Crc32cHash: gdata
	Crc32cHash int64 `json:"crc32cHash,omitempty"`
	// Inline: gdata
	Inline string `json:"inline,omitempty"`
	// Length: gdata
	Length int64 `json:"length,omitempty,string"`
	// Md5Hash: gdata
	Md5Hash string `json:"md5Hash,omitempty"`
	// ObjectId: gdata
	ObjectId *GdataObjectId `json:"objectId,omitempty"`
	// Path: gdata
	Path string `json:"path,omitempty"`
	// ReferenceType: gdata
	//
	// Possible values:
	//   "PATH" - gdata
	//   "BLOB_REF" - gdata
	//   "INLINE" - gdata
	//   "BIGSTORE_REF" - gdata
	//   "COSMO_BINARY_REFERENCE" - gdata
	ReferenceType string `json:"referenceType,omitempty"`
	// Sha1Hash: gdata
	Sha1Hash string `json:"sha1Hash,omitempty"`
	// ForceSendFields is a list of field names (e.g. "BlobRef") 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. "BlobRef") 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:"-"`
}

GdataCompositeMedia: gdata

func (GdataCompositeMedia) MarshalJSON 

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

type GdataContentTypeInfo 

type GdataContentTypeInfo struct {
	// BestGuess: gdata
	BestGuess string `json:"bestGuess,omitempty"`
	// FromBytes: gdata
	FromBytes string `json:"fromBytes,omitempty"`
	// FromFileName: gdata
	FromFileName string `json:"fromFileName,omitempty"`
	// FromHeader: gdata
	FromHeader string `json:"fromHeader,omitempty"`
	// FromUrlPath: gdata
	FromUrlPath string `json:"fromUrlPath,omitempty"`
	// ForceSendFields is a list of field names (e.g. "BestGuess") 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. "BestGuess") 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:"-"`
}

GdataContentTypeInfo: gdata

func (GdataContentTypeInfo) MarshalJSON 

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

type GdataDiffChecksumsResponse 

type GdataDiffChecksumsResponse struct {
	// ChecksumsLocation: gdata
	ChecksumsLocation *GdataCompositeMedia `json:"checksumsLocation,omitempty"`
	// ChunkSizeBytes: gdata
	ChunkSizeBytes int64 `json:"chunkSizeBytes,omitempty,string"`
	// ObjectLocation: gdata
	ObjectLocation *GdataCompositeMedia `json:"objectLocation,omitempty"`
	// ObjectSizeBytes: gdata
	ObjectSizeBytes int64 `json:"objectSizeBytes,omitempty,string"`
	// ObjectVersion: gdata
	ObjectVersion string `json:"objectVersion,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ChecksumsLocation") 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. "ChecksumsLocation") 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:"-"`
}

GdataDiffChecksumsResponse: gdata

func (GdataDiffChecksumsResponse) MarshalJSON 

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

type GdataDiffDownloadResponse 

type GdataDiffDownloadResponse struct {
	// ObjectLocation: gdata
	ObjectLocation *GdataCompositeMedia `json:"objectLocation,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ObjectLocation") 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. "ObjectLocation") 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:"-"`
}

GdataDiffDownloadResponse: gdata

func (GdataDiffDownloadResponse) MarshalJSON 

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

type GdataDiffUploadRequest 

type GdataDiffUploadRequest struct {
	// ChecksumsInfo: gdata
	ChecksumsInfo *GdataCompositeMedia `json:"checksumsInfo,omitempty"`
	// ObjectInfo: gdata
	ObjectInfo *GdataCompositeMedia `json:"objectInfo,omitempty"`
	// ObjectVersion: gdata
	ObjectVersion string `json:"objectVersion,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ChecksumsInfo") 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. "ChecksumsInfo") 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:"-"`
}

GdataDiffUploadRequest: gdata

func (GdataDiffUploadRequest) MarshalJSON 

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

type GdataDiffUploadResponse 

type GdataDiffUploadResponse struct {
	// ObjectVersion: gdata
	ObjectVersion string `json:"objectVersion,omitempty"`
	// OriginalObject: gdata
	OriginalObject *GdataCompositeMedia `json:"originalObject,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ObjectVersion") 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. "ObjectVersion") 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:"-"`
}

GdataDiffUploadResponse: gdata

func (GdataDiffUploadResponse) MarshalJSON 

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

type GdataDiffVersionResponse 

type GdataDiffVersionResponse struct {
	// ObjectSizeBytes: gdata
	ObjectSizeBytes int64 `json:"objectSizeBytes,omitempty,string"`
	// ObjectVersion: gdata
	ObjectVersion string `json:"objectVersion,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ObjectSizeBytes") 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. "ObjectSizeBytes") 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:"-"`
}

GdataDiffVersionResponse: gdata

func (GdataDiffVersionResponse) MarshalJSON 

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

type GdataDownloadParameters 

type GdataDownloadParameters struct {
	// AllowGzipCompression: gdata
	AllowGzipCompression bool `json:"allowGzipCompression,omitempty"`
	// IgnoreRange: gdata
	IgnoreRange bool `json:"ignoreRange,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AllowGzipCompression") 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. "AllowGzipCompression") 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:"-"`
}

GdataDownloadParameters: gdata

func (GdataDownloadParameters) MarshalJSON 

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

type GdataMedia 

type GdataMedia struct {
	// Algorithm: gdata
	Algorithm string `json:"algorithm,omitempty"`
	// BigstoreObjectRef: gdata
	BigstoreObjectRef string `json:"bigstoreObjectRef,omitempty"`
	// BlobRef: gdata
	BlobRef string `json:"blobRef,omitempty"`
	// Blobstore2Info: gdata
	Blobstore2Info *GdataBlobstore2Info `json:"blobstore2Info,omitempty"`
	// CompositeMedia: gdata
	CompositeMedia []*GdataCompositeMedia `json:"compositeMedia,omitempty"`
	// ContentType: gdata
	ContentType string `json:"contentType,omitempty"`
	// ContentTypeInfo: gdata
	ContentTypeInfo *GdataContentTypeInfo `json:"contentTypeInfo,omitempty"`
	// CosmoBinaryReference: gdata
	CosmoBinaryReference string `json:"cosmoBinaryReference,omitempty"`
	// Crc32cHash: gdata
	Crc32cHash int64 `json:"crc32cHash,omitempty"`
	// DiffChecksumsResponse: gdata
	DiffChecksumsResponse *GdataDiffChecksumsResponse `json:"diffChecksumsResponse,omitempty"`
	// DiffDownloadResponse: gdata
	DiffDownloadResponse *GdataDiffDownloadResponse `json:"diffDownloadResponse,omitempty"`
	// DiffUploadRequest: gdata
	DiffUploadRequest *GdataDiffUploadRequest `json:"diffUploadRequest,omitempty"`
	// DiffUploadResponse: gdata
	DiffUploadResponse *GdataDiffUploadResponse `json:"diffUploadResponse,omitempty"`
	// DiffVersionResponse: gdata
	DiffVersionResponse *GdataDiffVersionResponse `json:"diffVersionResponse,omitempty"`
	// DownloadParameters: gdata
	DownloadParameters *GdataDownloadParameters `json:"downloadParameters,omitempty"`
	// Filename: gdata
	Filename string `json:"filename,omitempty"`
	// Hash: gdata
	Hash string `json:"hash,omitempty"`
	// HashVerified: gdata
	HashVerified bool `json:"hashVerified,omitempty"`
	// Inline: gdata
	Inline string `json:"inline,omitempty"`
	// IsPotentialRetry: gdata
	IsPotentialRetry bool `json:"isPotentialRetry,omitempty"`
	// Length: gdata
	Length int64 `json:"length,omitempty,string"`
	// Md5Hash: gdata
	Md5Hash string `json:"md5Hash,omitempty"`
	// MediaId: gdata
	MediaId string `json:"mediaId,omitempty"`
	// ObjectId: gdata
	ObjectId *GdataObjectId `json:"objectId,omitempty"`
	// Path: gdata
	Path string `json:"path,omitempty"`
	// ReferenceType: gdata
	//
	// Possible values:
	//   "PATH" - gdata
	//   "BLOB_REF" - gdata
	//   "INLINE" - gdata
	//   "GET_MEDIA" - gdata
	//   "COMPOSITE_MEDIA" - gdata
	//   "BIGSTORE_REF" - gdata
	//   "DIFF_VERSION_RESPONSE" - gdata
	//   "DIFF_CHECKSUMS_RESPONSE" - gdata
	//   "DIFF_DOWNLOAD_RESPONSE" - gdata
	//   "DIFF_UPLOAD_REQUEST" - gdata
	//   "DIFF_UPLOAD_RESPONSE" - gdata
	//   "COSMO_BINARY_REFERENCE" - gdata
	//   "ARBITRARY_BYTES" - gdata
	ReferenceType string `json:"referenceType,omitempty"`
	// Sha1Hash: gdata
	Sha1Hash string `json:"sha1Hash,omitempty"`
	// Sha256Hash: gdata
	Sha256Hash string `json:"sha256Hash,omitempty"`
	// Timestamp: gdata
	Timestamp uint64 `json:"timestamp,omitempty,string"`
	// Token: gdata
	Token string `json:"token,omitempty"`

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

GdataMedia: gdata

func (GdataMedia) MarshalJSON 

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

type GdataObjectId 

type GdataObjectId struct {
	// BucketName: gdata
	BucketName string `json:"bucketName,omitempty"`
	// Generation: gdata
	Generation int64 `json:"generation,omitempty,string"`
	// ObjectName: gdata
	ObjectName string `json:"objectName,omitempty"`
	// ForceSendFields is a list of field names (e.g. "BucketName") 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. "BucketName") 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:"-"`
}

GdataObjectId: gdata

func (GdataObjectId) MarshalJSON 

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

type Job 

type Job struct {
	// CreateTime: The creation date/time of the job.
	CreateTime string `json:"createTime,omitempty"`
	// ExpireTime: The date/time when this job will expire/expired. After a job
	// expired, no new reports are generated.
	ExpireTime string `json:"expireTime,omitempty"`
	// Id: The server-generated ID of the job (max. 40 characters).
	Id string `json:"id,omitempty"`
	// Name: The name of the job (max. 100 characters).
	Name string `json:"name,omitempty"`
	// ReportTypeId: The type of reports this job creates. Corresponds to the ID of
	// a ReportType.
	ReportTypeId string `json:"reportTypeId,omitempty"`
	// SystemManaged: True if this a system-managed job that cannot be modified by
	// the user; otherwise false.
	SystemManaged bool `json:"systemManaged,omitempty"`

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

Job: A job creating reports of a specific type.

func (Job) MarshalJSON 

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

type JobsCreateCall 

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

func (*JobsCreateCall) Context 

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

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

func (*JobsCreateCall) Do 

func (c *JobsCreateCall) Do(opts ...googleapi.CallOption) (*Job, error)

Do executes the "youtubereporting.jobs.create" call. Any non-2xx status code is an error. Response headers are in either *Job.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 (*JobsCreateCall) Fields 

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

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

func (*JobsCreateCall) Header 

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

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

func (*JobsCreateCall) OnBehalfOfContentOwner 

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

OnBehalfOfContentOwner sets the optional parameter "onBehalfOfContentOwner": The content owner's external ID on which behalf the user is acting on. If not set, the user is acting for himself (his own channel).

type JobsDeleteCall 

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

func (*JobsDeleteCall) Context 

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

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

func (*JobsDeleteCall) Do 

func (c *JobsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)

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

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

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

func (*JobsDeleteCall) Header 

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

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

func (*JobsDeleteCall) OnBehalfOfContentOwner 

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

OnBehalfOfContentOwner sets the optional parameter "onBehalfOfContentOwner": The content owner's external ID on which behalf the user is acting on. If not set, the user is acting for himself (his own channel).

type JobsGetCall 

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

func (*JobsGetCall) Context 

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

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

func (*JobsGetCall) Do 

func (c *JobsGetCall) Do(opts ...googleapi.CallOption) (*Job, error)

Do executes the "youtubereporting.jobs.get" call. Any non-2xx status code is an error. Response headers are in either *Job.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 (*JobsGetCall) Fields 

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

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

func (*JobsGetCall) Header 

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

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

func (*JobsGetCall) IfNoneMatch 

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

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

func (*JobsGetCall) OnBehalfOfContentOwner 

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

OnBehalfOfContentOwner sets the optional parameter "onBehalfOfContentOwner": The content owner's external ID on which behalf the user is acting on. If not set, the user is acting for himself (his own channel).

type JobsListCall 

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

func (*JobsListCall) Context 

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

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

func (*JobsListCall) Do 

func (c *JobsListCall) Do(opts ...googleapi.CallOption) (*ListJobsResponse, error)

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

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

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

func (*JobsListCall) Header 

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

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

func (*JobsListCall) IfNoneMatch 

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

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

func (*JobsListCall) IncludeSystemManaged 

func (c *JobsListCall) IncludeSystemManaged(includeSystemManaged bool) *JobsListCall

IncludeSystemManaged sets the optional parameter "includeSystemManaged": If set to true, also system-managed jobs will be returned; otherwise only user-created jobs will be returned. System-managed jobs can neither be modified nor deleted.

func (*JobsListCall) OnBehalfOfContentOwner 

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

OnBehalfOfContentOwner sets the optional parameter "onBehalfOfContentOwner": The content owner's external ID on which behalf the user is acting on. If not set, the user is acting for himself (his own channel).

func (*JobsListCall) PageSize 

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

PageSize sets the optional parameter "pageSize": Requested page size. Server may return fewer jobs than requested. If unspecified, server will pick an appropriate default.

func (*JobsListCall) PageToken 

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

PageToken sets the optional parameter "pageToken": A token identifying a page of results the server should return. Typically, this is the value of ListReportTypesResponse.next_page_token returned in response to the previous call to the `ListJobs` method.

func (*JobsListCall) Pages 

func (c *JobsListCall) Pages(ctx context.Context, f func(*ListJobsResponse) error) error

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type JobsReportsGetCall 

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

func (*JobsReportsGetCall) Context 

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

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

func (*JobsReportsGetCall) Do 

func (c *JobsReportsGetCall) Do(opts ...googleapi.CallOption) (*Report, error)

Do executes the "youtubereporting.jobs.reports.get" call. Any non-2xx status code is an error. Response headers are in either *Report.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 (*JobsReportsGetCall) Fields 

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

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

func (*JobsReportsGetCall) Header 

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

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

func (*JobsReportsGetCall) IfNoneMatch 

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

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

func (*JobsReportsGetCall) OnBehalfOfContentOwner 

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

OnBehalfOfContentOwner sets the optional parameter "onBehalfOfContentOwner": The content owner's external ID on which behalf the user is acting on. If not set, the user is acting for himself (his own channel).

type JobsReportsListCall 

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

func (*JobsReportsListCall) Context 

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

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

func (*JobsReportsListCall) CreatedAfter 

func (c *JobsReportsListCall) CreatedAfter(createdAfter string) *JobsReportsListCall

CreatedAfter sets the optional parameter "createdAfter": If set, only reports created after the specified date/time are returned.

func (*JobsReportsListCall) Do 

func (c *JobsReportsListCall) Do(opts ...googleapi.CallOption) (*ListReportsResponse, error)

Do executes the "youtubereporting.jobs.reports.list" call. Any non-2xx status code is an error. Response headers are in either *ListReportsResponse.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 (*JobsReportsListCall) Fields 

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

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

func (*JobsReportsListCall) Header 

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

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

func (*JobsReportsListCall) IfNoneMatch 

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

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

func (*JobsReportsListCall) OnBehalfOfContentOwner 

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

OnBehalfOfContentOwner sets the optional parameter "onBehalfOfContentOwner": The content owner's external ID on which behalf the user is acting on. If not set, the user is acting for himself (his own channel).

func (*JobsReportsListCall) PageSize 

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

PageSize sets the optional parameter "pageSize": Requested page size. Server may return fewer report types than requested. If unspecified, server will pick an appropriate default.

func (*JobsReportsListCall) PageToken 

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

PageToken sets the optional parameter "pageToken": A token identifying a page of results the server should return. Typically, this is the value of ListReportsResponse.next_page_token returned in response to the previous call to the `ListReports` method.

func (*JobsReportsListCall) Pages 

func (c *JobsReportsListCall) Pages(ctx context.Context, f func(*ListReportsResponse) error) error

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

func (*JobsReportsListCall) StartTimeAtOrAfter 

func (c *JobsReportsListCall) StartTimeAtOrAfter(startTimeAtOrAfter string) *JobsReportsListCall

StartTimeAtOrAfter sets the optional parameter "startTimeAtOrAfter": If set, only reports whose start time is greater than or equal the specified date/time are returned.

func (*JobsReportsListCall) StartTimeBefore 

func (c *JobsReportsListCall) StartTimeBefore(startTimeBefore string) *JobsReportsListCall

StartTimeBefore sets the optional parameter "startTimeBefore": If set, only reports whose start time is smaller than the specified date/time are returned.

type JobsReportsService 

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

func NewJobsReportsService 

func NewJobsReportsService(s *Service) *JobsReportsService

func (*JobsReportsService) Get 

func (r *JobsReportsService) Get(jobId string, reportId string) *JobsReportsGetCall

Get: Gets the metadata of a specific report.

- jobId: The ID of the job. - reportId: The ID of the report to retrieve.

func (*JobsReportsService) List 

func (r *JobsReportsService) List(jobId string) *JobsReportsListCall

List: Lists reports created by a specific job. Returns NOT_FOUND if the job does not exist.

- jobId: The ID of the job.

type JobsService 

type JobsService struct {
	Reports *JobsReportsService
	// contains filtered or unexported fields
}

func NewJobsService 

func NewJobsService(s *Service) *JobsService

func (*JobsService) Create 

func (r *JobsService) Create(job *Job) *JobsCreateCall

Create: Creates a job and returns it.

func (*JobsService) Delete 

func (r *JobsService) Delete(jobId string) *JobsDeleteCall

Delete: Deletes a job.

- jobId: The ID of the job to delete.

func (*JobsService) Get 

func (r *JobsService) Get(jobId string) *JobsGetCall

Get: Gets a job.

- jobId: The ID of the job to retrieve.

func (*JobsService) List 

func (r *JobsService) List() *JobsListCall

List: Lists jobs.

type ListJobsResponse 

type ListJobsResponse struct {
	// Jobs: The list of jobs.
	Jobs []*Job `json:"jobs,omitempty"`
	// NextPageToken: A token to retrieve next page of results. Pass this value in
	// the ListJobsRequest.page_token field in the subsequent call to `ListJobs`
	// method to retrieve the next page of results.
	NextPageToken string `json:"nextPageToken,omitempty"`

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

ListJobsResponse: Response message for ReportingService.ListJobs.

func (ListJobsResponse) MarshalJSON 

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

type ListReportTypesResponse 

type ListReportTypesResponse struct {
	// NextPageToken: A token to retrieve next page of results. Pass this value in
	// the ListReportTypesRequest.page_token field in the subsequent call to
	// `ListReportTypes` method to retrieve the next page of results.
	NextPageToken string `json:"nextPageToken,omitempty"`
	// ReportTypes: The list of report types.
	ReportTypes []*ReportType `json:"reportTypes,omitempty"`

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

ListReportTypesResponse: Response message for ReportingService.ListReportTypes.

func (ListReportTypesResponse) MarshalJSON 

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

type ListReportsResponse 

type ListReportsResponse struct {
	// NextPageToken: A token to retrieve next page of results. Pass this value in
	// the ListReportsRequest.page_token field in the subsequent call to
	// `ListReports` method to retrieve the next page of results.
	NextPageToken string `json:"nextPageToken,omitempty"`
	// Reports: The list of report types.
	Reports []*Report `json:"reports,omitempty"`

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

ListReportsResponse: Response message for ReportingService.ListReports.

func (ListReportsResponse) MarshalJSON 

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

type MediaDownloadCall 

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

func (*MediaDownloadCall) Context 

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

Context sets the context to be used in this call's Do and Download methods.

func (*MediaDownloadCall) Do 

func (c *MediaDownloadCall) Do(opts ...googleapi.CallOption) (*GdataMedia, error)

Do executes the "youtubereporting.media.download" call. Any non-2xx status code is an error. Response headers are in either *GdataMedia.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 (*MediaDownloadCall) Download 

func (c *MediaDownloadCall) Download(opts ...googleapi.CallOption) (*http.Response, error)

Download fetches the API endpoint's "media" value, instead of the normal API response value. If the returned error is nil, the Response is guaranteed to have a 2xx status code. Callers must close the Response.Body as usual.

func (*MediaDownloadCall) Fields 

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

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

func (*MediaDownloadCall) Header 

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

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

func (*MediaDownloadCall) IfNoneMatch 

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

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

type MediaService 

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

func NewMediaService 

func NewMediaService(s *Service) *MediaService

func (*MediaService) Download 

func (r *MediaService) Download(resourceName string) *MediaDownloadCall

Download: Method for media download. Download is supported on the URI `/v1/media/{+name}?alt=media`.

- resourceName: Name of the media that is being downloaded.

type Report 

type Report struct {
	// CreateTime: The date/time when this report was created.
	CreateTime string `json:"createTime,omitempty"`
	// DownloadUrl: The URL from which the report can be downloaded (max. 1000
	// characters).
	DownloadUrl string `json:"downloadUrl,omitempty"`
	// EndTime: The end of the time period that the report instance covers. The
	// value is exclusive.
	EndTime string `json:"endTime,omitempty"`
	// Id: The server-generated ID of the report.
	Id string `json:"id,omitempty"`
	// JobExpireTime: The date/time when the job this report belongs to will
	// expire/expired.
	JobExpireTime string `json:"jobExpireTime,omitempty"`
	// JobId: The ID of the job that created this report.
	JobId string `json:"jobId,omitempty"`
	// StartTime: The start of the time period that the report instance covers. The
	// value is inclusive.
	StartTime string `json:"startTime,omitempty"`

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

Report: A report's metadata including the URL from which the report itself can be downloaded.

func (Report) MarshalJSON 

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

type ReportType 

type ReportType struct {
	// DeprecateTime: The date/time when this report type was/will be deprecated.
	DeprecateTime string `json:"deprecateTime,omitempty"`
	// Id: The ID of the report type (max. 100 characters).
	Id string `json:"id,omitempty"`
	// Name: The name of the report type (max. 100 characters).
	Name string `json:"name,omitempty"`
	// SystemManaged: True if this a system-managed report type; otherwise false.
	// Reporting jobs for system-managed report types are created automatically and
	// can thus not be used in the `CreateJob` method.
	SystemManaged bool `json:"systemManaged,omitempty"`
	// ForceSendFields is a list of field names (e.g. "DeprecateTime") 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. "DeprecateTime") 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:"-"`
}

ReportType: A report type.

func (ReportType) MarshalJSON 

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

type ReportTypesListCall 

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

func (*ReportTypesListCall) Context 

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

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

func (*ReportTypesListCall) Do 

func (c *ReportTypesListCall) Do(opts ...googleapi.CallOption) (*ListReportTypesResponse, error)

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

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

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

func (*ReportTypesListCall) Header 

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

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

func (*ReportTypesListCall) IfNoneMatch 

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

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

func (*ReportTypesListCall) IncludeSystemManaged 

func (c *ReportTypesListCall) IncludeSystemManaged(includeSystemManaged bool) *ReportTypesListCall

IncludeSystemManaged sets the optional parameter "includeSystemManaged": If set to true, also system-managed report types will be returned; otherwise only the report types that can be used to create new reporting jobs will be returned.

func (*ReportTypesListCall) OnBehalfOfContentOwner 

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

OnBehalfOfContentOwner sets the optional parameter "onBehalfOfContentOwner": The content owner's external ID on which behalf the user is acting on. If not set, the user is acting for himself (his own channel).

func (*ReportTypesListCall) PageSize 

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

PageSize sets the optional parameter "pageSize": Requested page size. Server may return fewer report types than requested. If unspecified, server will pick an appropriate default.

func (*ReportTypesListCall) PageToken 

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

PageToken sets the optional parameter "pageToken": A token identifying a page of results the server should return. Typically, this is the value of ListReportTypesResponse.next_page_token returned in response to the previous call to the `ListReportTypes` method.

func (*ReportTypesListCall) Pages 

func (c *ReportTypesListCall) Pages(ctx context.Context, f func(*ListReportTypesResponse) error) error

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ReportTypesService 

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

func NewReportTypesService 

func NewReportTypesService(s *Service) *ReportTypesService

func (*ReportTypesService) List 

func (r *ReportTypesService) List() *ReportTypesListCall

List: Lists report types.

type Service 

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

	Jobs *JobsService

	Media *MediaService

	ReportTypes *ReportTypesService
	// contains filtered or unexported fields
}

func New deprecated 

func New(client *http.Client) (*Service, error)

New creates a new Service. It uses the provided http.Client for requests.

Deprecated: please use NewService instead. To provide a custom HTTP client, use option.WithHTTPClient. If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.

func NewService added in v0.3.0 

func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error)

NewService creates a new Service.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.