Class GroupsResource.ListRequest

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.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<ListGroupsResponse>
YouTubeAnalyticsBaseServiceRequest<ListGroupsResponse>
GroupsResource.ListRequest
Implements
Inherited Members
Namespace: Google.Apis.YouTubeAnalytics.v2
Assembly: Google.Apis.YouTubeAnalytics.v2.dll
Syntax
public class GroupsResource.ListRequest : YouTubeAnalyticsBaseServiceRequest<ListGroupsResponse>, IClientServiceRequest<ListGroupsResponse>, IClientServiceRequest

Constructors

ListRequest(IClientService)

Constructs a new List request.

Declaration
public ListRequest(IClientService service)
Parameters
Type Name Description
IClientService service

Properties

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.YouTubeAnalytics.v2.Data.ListGroupsResponse>.HttpMethod

Id

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

Declaration
[RequestParameter("id", RequestParameterType.Query)]
public virtual string Id { get; set; }
Property Value
Type Description
string

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.YouTubeAnalytics.v2.Data.ListGroupsResponse>.MethodName

Mine

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

Declaration
[RequestParameter("mine", RequestParameterType.Query)]
public virtual bool? Mine { get; set; }
Property Value
Type Description
bool?

OnBehalfOfContentOwner

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

Declaration
[RequestParameter("onBehalfOfContentOwner", RequestParameterType.Query)]
public virtual string OnBehalfOfContentOwner { get; set; }
Property Value
Type Description
string

PageToken

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

Declaration
[RequestParameter("pageToken", RequestParameterType.Query)]
public virtual string PageToken { get; set; }
Property Value
Type Description
string

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.YouTubeAnalytics.v2.Data.ListGroupsResponse>.RestPath

Methods

InitParameters()

Initializes List parameter list.

Declaration
protected override void InitParameters()
Overrides

Implements