CData Python Connector for YouTube Analytics

Build 23.0.8839

UserActivityByCity

This report provides user activity statistics, sorted by city.

Table Specific Information

Select Rules

Querying user activity by city requires you to set maxResults to an integer value of 250 or less. You must also specify a value for the sort request parameter.

Video Reports:

Dimensions Required city
Use 0 or more creatorContentType, country, province, subscribedStatus

Note: If you include the province dimension, you must also use the country==US filter.
Use 0 or 1 day, month
Metrics Use 1 or more views, estimatedMinutesWatched, averageViewDuration, averageViewPercentage
Filters Use 0 or 1 country, province, continent, subContinent
Use 0 or 1 video, group
Sorting options: -views
-estimatedMinutesWatched


Content Owner Reports:

Dimensions Required city
Use 0 or more creatorContentType,country,province, subscribedStatus
Note: If you include the province dimension, you must also use the country==US filter.
Use 0 or 1 day,month
Metrics Use 1 or more views, estimatedMinutesWatched, averageViewDuration, averageViewPercentage
Filters Use exactly 1 video, channel, group, or a supported combination of uploaderType and claimedStatus
Use 0 or 1 country, province, continent, subContinent
Sorting options -views
-estimatedMinutesWatched

Columns

Name Type Dimension DefaultMetric DefaultDimension Description
Channel String True (only used in content owner reports) The Id for a YouTube channel. The channel dimension is frequently used in content owner reports because those reports typically aggregate data for multiple channels.
Video String True The Id of a YouTube video.
Group String True (filter only) The Id of a YouTube Analytics group.
Country String True False The country associated with the metrics in the report row. The dimension value is a two-letter ISO-3166-1 country code, such as US, CN (China), or FR (France). The country code ZZ is used to report metrics for which YouTube could not identify the associated country.
City String True True The estimated city associated with the metrics in the report row. Data for this dimension is available for dates beginning January 1, 2022.
Province String True False The U.S. state or territory associated with the metrics in the report row. The dimension value is an ISO 3166-2 code that identifies a U.S. state or the District of Columbia, such as US-MI (Michigan) or US-TX (Texas). The province code US-ZZ is used to report metrics for which YouTube could not identify the associated U.S. state. If the Province column is specified, Country must be set to US in the WHERE clause.
Continent String True (filter only) A United Nations (U.N.) statistical region code. The allowed values are 002 Africa, 019 Americas (Northern America, Latin America, South America, and the Caribbean), 142 Asia, 150 Europe, 009 Oceania. This dimension can only be used to filter data.
SubContinent String True (filter only) A U.N. statistical region code that identifies a geographical subregion.
Day String True When you use this dimension, data in the report is aggregated on a daily basis and each row contains data for one day.
Month String True Data in the report is aggregated by calendar month. In the report, dates are listed in YYYY-MM format. Note: If your SQL query uses the Month dimension, then the StartDate and EndDate parameters must both be set to the first day of the month.
SubscribedStatus String True This dimension indicates whether the user activity metrics in the data row are associated with viewers who were subscribed to the video or playlist channel. The allowed values are SUBSCRIBED, UNSUBSCRIBED. Note that the dimension value is accurate as of the time that the user activity occurs.
CreatorContentType String True This dimension identifies the type of content associated with the user activity metrics in the data row. The allowed values are LIVE_STREAM, SHORTS, STORY, VIDEO_ON_DEMAND, UNSPECIFIED.
ClaimedStatus String True (only used in content owner reports) This dimension lets you indicate that a result set will only contain metrics for claimed content. The allowed value is claimed.
UploaderType String True (only used in content owner reports) This dimension lets you indicate whether a result set will contain metrics for content uploaded by the specified content owner or content uploaded by third parties, such as user-uploaded videos. The allowed values are self and thirdParty.
Views Double False True The number of times that a video was viewed. In a playlist report, the metric indicates the number of times that a video was viewed in the context of a playlist.
EstimatedMinutesWatched Double False False The number of minutes that users watched videos for the specified channel, content owner, video, or playlist.
AverageViewDuration Double False False The average length, in seconds, of video playbacks. As of December 13, 2021, this metric excludes looping clips traffic. In a playlist report, the metric indicates the average length, in seconds, of video playbacks that occurred in the context of a playlist.
AverageViewPercentage Double False False The average percentage of a video watched during a video playback. As of December 13, 2021, this metric excludes looping clips traffic.
StartDate Date Start date for fetching Analytics data.
EndDate Date End date for fetching Analytics data.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
Segments String Segments the data returned for your request. Either a SegmentId or a custom segment.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 23.0.8839