Cloud

Build 25.0.9434
  • YouTube Analytics
    • はじめに
      • 接続の確立
      • カスタムOAuth アプリケーションの作成
      • YouTube Analytics データの取得
      • SSL の設定
      • ファイアウォールとプロキシ
    • データモデル
      • テーブル
        • GroupItems
        • Groups
      • ビュー
        • Activities
        • AdPerformanceReports
        • AudienceRetention
        • Captions
        • Channels
        • ChannelSections
        • Comments
        • CommentThreads
        • Demographics
        • Devices
        • EngagementReports
        • Languages
        • MostPopularVideosByCategory
        • MostPopularVideosByRegion
        • MyDislikedVideos
        • MyLikedVideos
        • OperatingSystems
        • PlayListItems
        • PlayLists
        • Regions
        • Subscriptions
        • TimeBasedReports
        • TopPlaylists
        • TopVideos
        • TrafficSources
        • UserActivityByCity
        • UserActivityByCountry
        • UserActivityByProvince
        • VideoAbuseReportReasons
        • VideoCategories
        • Videos
      • ストアドプロシージャ
        • CreateCustomSchema
      • システムテーブル
        • sys_catalogs
        • sys_schemas
        • sys_tables
        • sys_tablecolumns
        • sys_procedures
        • sys_procedureparameters
        • sys_keycolumns
        • sys_foreignkeys
        • sys_primarykeys
        • sys_indexes
        • sys_connection_props
        • sys_sqlinfo
        • sys_identity
        • sys_information
    • 接続文字列オプション
      • Authentication
        • AuthScheme
        • ChannelId
        • ContentOwnerId
      • OAuth
        • OAuthClientId
        • OAuthClientSecret
        • DelegatedServiceAccounts
        • RequestingServiceAccount
        • Scope
      • JWT OAuth
        • OAuthJWTCert
        • OAuthJWTCertType
        • OAuthJWTCertPassword
        • OAuthJWTCertSubject
      • SSL
        • SSLServerCert
      • Logging
        • Verbosity
      • Schema
        • BrowsableSchemas
      • Miscellaneous
        • AWSWorkloadIdentityConfig
        • AzureWorkloadIdentityConfig
        • DefaultFilter
        • MaxRows
        • PseudoColumns
        • Timeout
        • WorkloadPoolId
        • WorkloadProjectId
        • WorkloadProviderId
    • Third Party Copyrights

YouTube Analytics - CData Cloud

概要

CData Cloud は、クラウドホスト型のソリューションで、複数の標準サービスやプロトコルにまたがるYouTube Analytics へのアクセスを実現します。SQL Server データベースに接続できるアプリケーションであれば、CData Cloud を介してYouTube Analytics に接続できます。

CData Cloud により、他のOData エンドポイントや標準SQL Server と同じように、YouTube Analytics への接続を標準化し、構成することができます。

主要機能

  • SQL をフルサポート:YouTube Analytics は、標準のリレーショナルデータベースとして表示され、Filter、Group、Join などの操作を実行できます。これらの操作は基盤となるAPI でサポートされているかどうかに関わらず、標準SQL を使用します。
  • CRUD サポート:読み取りと書き込みの両方の操作がサポートされており、Cloud またはデータソースのダウンストリームで設定できるセキュリティ設定によってのみ制限されます。
  • セキュアアクセス:管理者は、ユーザーを作成し、特定のデータベースへのアクセス、読み取り専用操作、または完全な読み書きの権限を定義することができます。
  • 包括的なデータモデルとダイナミックディスカバリー:CData Cloud は、動的データや検索可能なメタデータへのフルアクセスなど、基盤となるデータソースで公開されるすべてのデータへの包括的なアクセスを提供します。

CData Cloud

はじめに

このページでは、CData Cloud でのYouTube Analytics への接続の確立 のガイド、利用可能なリソースに関する情報、および使用可能な接続プロパティのリファレンスについて説明します。

YouTube Analytics への接続

接続の確立 は、CData Cloud にデータベースを作成するためのYouTube Analytics への認証方法と必要な接続プロパティの設定方法について示します。

CData Cloud サービスからデータにアクセス

利用可能な標準サービスを経由してYouTube Analytics からデータにアクセスする方法と、CData Cloud の管理については、CData Cloud ドキュメント で詳しく説明します。

CData Cloud

接続の確立

Database タブで対応するアイコンを選択して、YouTube Analytics に接続します。必須プロパティはSettings にリストされています。Advanced タブには、通常は必要ない接続プロパティが表示されます。

YouTube Analytics への接続

YouTube Analytics はOAuth 認証のみサポートします。すべてのOAuth フローで、この認証を有効にするにはAuthScheme をOAuth に設定する必要があります。

以下のサブセクションでは、3つの一般的な認証フローでのYouTube Analytics への認証について詳しく説明します。

  • デスクトップ:ユーザーのローカルマシン上でのサーバーへの接続で、テストやプロトタイピングによく使用されます。組み込みOAuth またはカスタムOAuth で認証されます。
  • Web:共有ウェブサイト経由でデータにアクセスします。カスタムOAuth でのみ認証されます。
  • ヘッドレスサーバー:他のコンピュータやそのユーザーにサービスを提供する専用コンピュータで、モニタやキーボードなしで動作するように構成されています。組み込みOAuth またはカスタムOAuth で認証されます。

カスタムOAuth アプリケーションの作成方法と、組み込みOAuth 認証情報を持つ認証フローでもカスタムOAuth アプリケーションを作成したほうがよい場合の説明については、カスタムOAuth アプリケーションの作成 を参照してください。

YouTube Analytics で利用可能な接続文字列プロパティの全リストは、Connection を参照してください。

アクセストークンの期限が切れたときは、Cloud は自動でアクセストークンをリフレッシュします。

OAuth アクセストークンの自動リフレッシュ:

Cloud がOAuth アクセストークンを自動的にリフレッシュするようにするには、次のように設定します。

  1. はじめてデータに接続する際、次の接続プロパティを設定します。
    • InitiateOAuth = REFRESH。
    • OAuthClientId = アプリケーション設定のクライアントId。
    • OAuthClientSecret = アプリケーション設定のクライアントシークレット。
    • OAuthAccessToken = GetOAuthAccessToken によって返されたアクセストークン。
    • OAuthSettingsLocation = Cloud がOAuth 値を保存する場所のパス。これは接続間で維持されます。
  2. その後のデータ接続では、以下を設定します。
    • InitiateOAuth
    • OAuthSettingsLocation

OAuth アクセストークンの手動リフレッシュ:

OAuth アクセストークンを手動でリフレッシュするために必要な唯一の値は、OAuth リフレッシュトークンです。

  1. ExpiresIn 期間(GetOAuthAccessToken が返す)が経過した後にOAuthAccessToken を手動でリフレッシュするには、RefreshOAuthAccessToken ストアドプロシージャを呼び出します。
  2. 次の接続プロパティを設定します。

    • OAuthClientId = アプリケーション設定のクライアントId。
    • OAuthClientSecret = アプリケーション設定のクライアントシークレット。

  3. RefreshOAuthAccessToken を呼び出し、OAuthRefreshToken にGetOAuthAccessToken によって返されたOAuth リフレッシュトークンを設定します。
  4. 新しいトークンが取得できたら、OAuthAccessToken プロパティにRefreshOAuthAccessToken によって返された値を設定します。Open は、新規接続を開きます。

OAuth リフレッシュトークンを保存し、OAuth アクセストークンの有効期限が切れた後に手動でリフレッシュできるようにします。

CData Cloud

カスタムOAuth アプリケーションの作成

OAuth 認証を設定するには、いくつかの事前設定が必要です。ユーザーアカウント、サービスアカウント、またはGCP インスタンスアカウントが正しく構成されると、接続の準備が整います。

ユーザーアカウント

このセクションでは、カスタムOAuth アプリケーションを登録してユーザーアカウント用のOAuthClientId およびOAuthClientSecret を取得する方法について説明します。

デスクトップ

アプリを登録してOAuth クライアントクレデンシャルを取得するには:

  1. Google API コンソールにログインします。
  2. プロジェクトを開きます。
  3. メインメニューからAPI マネージャーを選択します。
  4. ユーザー同意フローで、認証情報 -> 認証情報を作成 -> OAuth クライアントID をクリックします。
  5. その他をクリックします。Google API Console はカスタムアプリケーションを作成し、OAuthClientId およびOAuthClientSecretを表示します。
  6. あとで使用するためにOAuthClientId およびOAuthClientSecret を記録します。
  7. ライブラリ -> YouTube Analytics API -> 有効にするをクリックします。

サービスアカウント

OAuth アプリケーションを作成するには、プライベートキーを生成してサービスアカウント認証します。

  1. Google API コンソールにログインします。
  2. プロジェクトを開きます。
  3. メインメニューからAPI マネージャーを選択します。
  4. ユーザー同意フローで、認証情報 -> 認証情報を作成 -> サービスアカウントキーをクリックします。
  5. [サービスアカウント]メニューで新しいサービスアカウント(該当する場合)か既存のサービスアカウントのいずれかを選択します。
  6. 新しいサービスアカウントの場合、1つもしくは複数のロールを選択します。IAM およびAdmin セクションのプロジェクトレベルでプリミティブロールをアサインすることが可能です。他のロールでは、Google API へのカスタムアクセスを有効にできます。
  7. [キーのタイプ]でP12 キーを選択します。
  8. 作成をクリックします。Google API Console はカスタムアプリケーションを作成し、鍵ペアと 秘密鍵のパスワードを表示します。
  9. 鍵ペアをダウンロードし、OAuthJWTCertPassword に秘密鍵のパスワードを設定します。
  10. [サービスアカウント]メニューでサービスアカウントの管理をクリックします。
  11. OAuthJWTIssuer をサービスアカウントID フィールドで表示されたE メールアドレスに設定します。
  12. ライブラリ -> YouTube Analytics API -> 有効にするをクリックします。

GCP インスタンスアカウント

GCP 仮想マシン上で実行している場合は、Cloud は仮想マシンに関連付けられたサービスアカウントを使用して認証できます。 このモードを使用するには、AuthScheme をGCPInstanceAccount に設定します。

CData Cloud

YouTube Analytics データの取得

YouTube Analytics データは、さまざまな指標(Viewers, ViewerPercentage, AgeGroup, etc.)に分類され、さまざまなディメンション(Day, DeviceType, etc.)でクエリすることができます。有効な指標とディメンションの組み合わせは多数あります。Cloud は、最もよく使用される組み合わせを使いやすくリレーショナルビューとして公開しています。

また、Cloud は、事前定義されたビューに含まれない組み合わせであっても、有効なすべての組み合わせをクエリできるようにしています。CreateCustomSchema ストアドプロシージャを使用してクエリのビューを作成できます。クエリおよびスキーマで指標とディメンションを結合する方法については、データモデル を参照してください。以下に、まずデフォルトのビューを使用する方法を示します。

ディメンションおよび指標の選択

ディメンションおよび指標は各テーブルに明確に定義されており、データモデル で参照できます。興味のある指標およびディメンションを選択してください。 例えば、特定の国でほとんどが視聴されたチャンネルのトップ動画は、次のように選択できます。

SELECT Video, Views, EstimatedMinutesWatched, AverageViewDuration, AverageViewPercentage FROM TopVideos WHERE Country='AL'

SELECT * クエリの実行

通常のデータベーステーブルとは異なり、特定のテーブルですべての指標およびディメンションを選択しても、あまり役には立ちません。このため、Cloud では、SELECT * クエリは、デフォルトの指標とディメンションのセットが要求されていると解釈されます。これは、明示的にすべてのカラムを選択しているクエリにも適用されます。スキーマごとのデフォルトのフィールドを確認するには、データモデル で各ビューのドキュメントを参照してください。

CData Cloud

SSL の設定

SSL 設定のカスタマイズ

デフォルトでは、Cloud はサーバーとのTLS のネゴシエーションを試みます。サーバー証明書は、デフォルトのシステム信頼済み証明書ストアで検証されます。SSLServerCert 接続プロパティを使用して、証明書の検証方法をオーバーライドできます。

別の証明書を指定するには、SSLServerCert 接続プロパティを参照してください。

CData Cloud

ファイアウォールとプロキシ

Firewall またはProxy 経由の接続

HTTP プロキシ

HTTP プロキシへの認証には、以下のように設定します。

  • ProxyServer:HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。
  • ProxyPort:プロキシサーバーが起動しているTCP ポート。
  • ProxyAuthScheme:プロキシサーバーに対して認証する際にCloud が使用する認証方法。
  • ProxyUser:プロキシサーバーに登録されているユーザーアカウントのユーザー名。
  • ProxyPassword:ProxyUser に紐付けられたパスワード。

その他のプロキシ

次のプロパティを設定します。

  • プロキシベースのファイヤーウォールを使用するには、FirewallType、FirewallServer、およびFirewallPort を設定します。
  • 接続をトンネルするには、FirewallType をTUNNEL に設定します。
  • 認証するには、FirewallUser とFirewallPassword を設定します。
  • SOCKS プロキシへの認証には、さらにFirewallType をSOCKS5 に設定します。

CData Cloud

データモデル

CData Cloud は、YouTube Analytics エンティティをリレーショナルテーブル、ビュー、およびストアドプロシージャにモデル化します。

YouTube Analytics を使用すると、ディメンションおよび指標のクエリをさまざまな組み合わせで実行できます。 YouTube Analytics レポートに基づいて、いくつかのサンプルビューが用意されています。また、必要に応じてディメンションおよび指標を任意に組み合わせて、独自のカスタムビューを作成することもできます。

スキーマの表示方法、およびAPI の制限と要件については、以下のカスタムビューの 定義を参照してください。

テーブル

Groups およびGroup Items にテーブル としてアクセス可能です。

ストアドプロシージャ

ストアドプロシージャ は、YouTube Analytics API の追加機能を利用可能にする、データソースのファンクションライクなインターフェースです。

ビュー

レポートはビュー、つまりデータの「スナップショット」であるテーブルとして表示され、変更することはできません。 従来のデータベースビューとは異なり、テーブル内のすべての指標とディメンションを選択してテーブル全体のビュ ーを作成することはあまり有益ではありません。プロバイダは SELECT * クエリを、指標とディメンションの既定のセットを要求しているかのように解釈するからです。 これは、明示的にすべてのカラムを選択しているクエリにも当てはまります。

YouTube Analytics API は、データに投影できるまたは返される結果を制限するために使用する、カラムの数や組み合わせを制限していることに留意してください。これらの制限および各スキーマのデフォルトフィールドについては、 ビュー で説明しています。独自のビューを定義する場合は、これらのセクションを参照してください。

カスタムビューの定義

CreateCustomSchema ストアドプロシージャを使用してクエリのビューを作成します。ストアドプロシージャを使用すると、ディメンションと指標を独自に組み合わせて、簡単に新しいビュー定義を生成できます。 このストアドプロシージャを呼び出すと、新しいスキーマファイルが作成されます。このファイルは、他のビューと同様にクエリすることができます。

このストアドプロシージャは、入力として、ビュー名、指標のカンマ区切りリスト、ディメンションのカンマ区切りリスト、および出力フォルダを受け取ります。 作成されたスクリプトファイルにアクセスするには、Location を新しいスクリプトファイルを含むフォルダに設定します。言い換えれば、Location は出力フォルダの代わりとなります。

例えば、デフォルトスキーマとともに新しいスキーマを使用するには、Location をインストールフォルダ内のdb サブフォルダに設定し、呼び出しを行います。

EXEC CreateCustomSchema Dimensions='Day,DeviceType', Metrics='Views,EstimatedMinutesWatched', TableName='DailyDeviceReports'

CData Cloud

テーブル

Cloud はYouTube Analytics のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。

CData Cloud - YouTube Analytics テーブル

Name Description
GroupItems Create, delete, and query Items that compose a Group.
Groups Create, update, delete, and query YouTube Analytics Groups.

CData Cloud

GroupItems

Create, delete, and query Items that compose a Group.

テーブル固有の情報

Select

次のクエリは、YouTube Analytics グループを構成するアイテムを返します。

SELECT * FROM GroupItems

次のクエリは、特定のYouTube Analytics グループを構成するアイテムを返します。

SELECT * FROM GroupItems WHERE GroupId = '239_65GrkKS6kRL'
さらに、OnBehalfOfContentOwner をWHERE 句で任意で使用することもできます。

Insert

グループにアイテムを挿入するには、GroupId とResource_Id が必須です。

INSERT INTO GroupItems (GroupId, Resource_Id) VALUES ('fjgeeljgio54', 'dkhgjio5sfff')

Columns

Name Type ReadOnly Description
Id [KEY] String True

The Id that YouTube uses to uniquely identify the channel, video, playlist, or asset that is included in the group. Note that this Id refers specifically to the inclusion of that entity in a particular group and is different than the channel Id, video Id, playlist Id, or asset Id that uniquely identifies the entity itself.

Kind String False

Identifies the type of the group item. The value will be youtube#groupItem.

Etag String False

The Etag of this item.

GroupId String False

The Id that YouTube uses to uniquely identify the group that contains the item.

Resource_Kind String False

The type of the group item. The allowed values are youtube#channel, youtube#playlist, youtube#video, youtubePartner#asset.

Resource_Id String False

The channel, video, playlist, or asset Id that YouTube uses to uniquely identify the group item.

OnBehalfOfContentOwner String False

This parameter is intended exclusively for YouTube content partners that own and manage many different YouTube channels. The OnBehalfOfContentOwner parameter indicates that the authorization credentials in the request identify a YouTube user who is acting on behalf of the content owner specified in the parameter value.

CData Cloud

Groups

Create, update, delete, and query YouTube Analytics Groups.

テーブル固有の情報

グループとは最大200 のチャンネル、動画、再生リスト、またはアセットのカスタムコレクションです。グループ内のすべてのアイテムは同じタイプのエンティティを表す必要があります。例えば、100 の動画と100 の再生リストを持つグループを作成することはできません。Analytics グループには、アップロードした、主張した、または管理しているチャンネルにリンクされているエンティティのみが含まれます。結果として、コンテンツ所有者は動画、再生リスト、チャンネル、またはアセットのグループを作成できます。チャンネル所有者は、動画および再生リストのグループを作成できます。

Select

WHERE 句で次のカラムを使用できます:OnBehalfOfContentOwner およびMine。

Insert

グループを挿入するには、ContentDetails_ItemType が必須です。

INSERT INTO Groups (Snippet_Title, ContentDetails_ItemType) VALUES ('test2', 'youtube#channel')

Columns

Name Type ReadOnly Description
Id [KEY] String False

The Id that YouTube uses to uniquely identify the group.

Kind String False

Identifies the type of the YouTube Analytics entity. The value will be youtube#group.

Etag String False

The Etag of this resource.

Snippet_PublishedAt DateTime True

The date and time that the group was created.

Snippet_Title String False

The group name. The value must be a nonempty string.

ContentDetails_ItemCount String False

The number of items in the group.

ContentDetails_ItemType String False

The type of entities that the group contains. The allowed values are youtube#channel, youtube#playlist, youtube#video, youtubePartner#asset.

Mine String False

Set this to true to retrieve all groups owned by the authenticated user.

PageToken String False

The PageToken parameter identifies a specific page in the result set that should be returned.

OnBehalfOfContentOwner String False

This parameter is intended exclusively for YouTube content partners that own and manage many different YouTube channels. The OnBehalfOfContentOwner parameter indicates that the authorization credentials in the request identify a YouTube user who is acting on behalf of the content owner specified in the parameter value.

CData Cloud

ビュー

ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。

クエリは、ビューに対して通常のテーブルと同様に実行することができます。

CData Cloud - YouTube Analytics ビュー

Name Description
Activities Query YouTube Activities. An Activity resource contains information about an action that a particular Channel, or User, has taken on YouTube.
AdPerformanceReports Query Ad Performance Reports. Ad Performance Reports provide impression-based metrics for ads that ran during video playbacks. These metrics account for each ad impression, and each video playback can yield multiple impressions.
AudienceRetention This report measures a video's ability to retain its audience.
Captions Query YouTube Captions. A Caption resource represents a YouTube caption track.
Channels Query YouTube Channels.
ChannelSections Query YouTube ChannelSections. A ChannelSection contains information about a set of Videos that a Channel has chosen to feature.
Comments Query YouTube Comments.
CommentThreads Query YouTube CommentThreads. A CommentThread record contains information about a YouTube comment thread, a top-level comment and replies, if any exist, to that comment.
Demographics Query YouTubeAnalytics Demographics grouped by age groups and gender.
Devices Query YouTubeAnalytics Devices statistics. This table allows you to aggregate viewing statistics based on the manner in which viewers reached your video content. For example, you can identify the number of views that occurred on mobile devices or game consoles.
EngagementReports Query Engagement Reports info. For example, how many times a user shared a video.
Languages Query YouTube i18nLanguages. An i18nLanguage resource identifies an application language that the YouTube website supports. The application language can also be referred to as a UI language.
MostPopularVideosByCategory Query YouTube Videos.
MostPopularVideosByRegion Query YouTube Videos.
MyDislikedVideos Query YouTube Liked Videos.
MyLikedVideos Query YouTube Liked Videos.
OperatingSystems Query YouTubeAnalytics Operating Systems statistics. This report aggregates viewing statistics based on viewers' operating systems. For example, it identifies the number of views that occurred on Android devices or on PlayStations.
PlayListItems Query YouTube PlayListItems. A PlayListItem resource identifies another YouTube entity, such as a Video, that is included in a PlayList. In addition, the PlayListItem record contains details about how that entity is used in that PlayList.
PlayLists Query YouTube PlayLists. A PlayList is a collection of videos that can be viewed sequentially and shared with other users.
Regions Query YouTube i18nRegions. An i18nRegion resource identifies a geographic area that a YouTube user can select as the preferred content region. The content region can also be referred to as a content locale.
Subscriptions Query YouTube User Subscriptions. A Subscription notifies a User when new Videos are added to a Channel, or when another user takes one of several actions on YouTube, such as uploading a Video, rating a Video, or commenting on a Video.
TimeBasedReports Query time-based info on views, subscribers, etc. For example, how many new subscribers were gained at a specific time.
TopPlaylists Query the TopPlaylists for a channel. You can also use this view to query playback detail and geographic filters.
TopVideos Query the TopVideos for a channel. You can also use this view to query playback detail and geographic filters.
TrafficSources Query TrafficSources. Statistics are based on the manner in which viewers reached your video and playlist content.
UserActivityByCity This report provides user activity statistics by city.
UserActivityByCountry This report provides user activity statistics.
UserActivityByProvince This report provides user activity statistics, sorted by province (includes Washington DC).
VideoAbuseReportReasons Query YouTube VideoAbuseReportReasons. A VideoAbuseReportReason resource contains information about a reason that a Video would be flagged for containing abusive content.
VideoCategories Query YouTube VideoCategories. A VideoCategory resource identifies a category that has been or could be associated with uploaded Videos.
Videos Query YouTube Videos.

CData Cloud

Activities

Query YouTube Activities. An Activity resource contains information about an action that a particular Channel, or User, has taken on YouTube.

Table Specific Information

Select

YouTube Analytics only allows Channel Id to be used as filter criteria. Additionally, the extra optional columns supported are PublishedAt and Region.

All columns support the '=' operator. PublishedAt also supports '>', '>=', '<', and '<='.

By default, if no filters are specified, the driver will return activities generated by authenticated user.

SELECT * FROM Activities WHERE ChannelId = "abc123" AND PublishedAt < '2016-01-01T10:00:00Z'

Columns

Name Type Dimension DefaultMetric DefaultDimension Description
Id [KEY] String The Id that YouTube uses to uniquely identify the activity.
PublishedAt Datetime The date and time that the activity occurred. The value is in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
ChannelId String The Id that YouTube uses to uniquely identify the channel associated with the activity.
Title String The title of the resource primarily associated with the activity.
Description String The description of the resource primarily associated with the activity.
ChannelTitle String Channel title for the channel responsible for this activity.
Type String The type of activity that the resource describes. Valid values: channelItem, comment (not currently returned), favorite, like, playlistItem, recommendation, social, subscription, and upload.
GroupId String The group Id associated with the activity.
ThumbnailsDefaultUrl String The URL of the default image thumbnail.
UploadVideoId String The Id that YouTube uses to uniquely identify the uploaded video.
LikeResourceIdKind String The type of the resource that received a positive (like) rating.
LikeResourceIdVideoId String The Id that YouTube uses to uniquely identify the video, if the rated resource is a video. This column is only present if the ResourceIdKind is youtube#video.
FavoriteResourceIdKind String The type of the YouTube entity marked as a favorite.
FavoriteResourceIdVideoId String The Id that YouTube uses to uniquely identify the favorite video.
CommentResourceIdKind String The comment on the API resource.
CommentResourceIdVideoId String The Id that YouTube uses to uniquely identify the video associated with a comment.
CommentResourceIdChannelId String The Id that YouTube uses to uniquely identify the channel associated with a comment.
SubscriptionResourceIdKind String The type of the subscription. A subscription is a channel that a user subscribed to.
SubscriptionResourceIdChannelId String The Id that YouTube uses to uniquely identify the channel that the user subscribed to.
PlaylistItemResourceIdKind String The type of the playlist item.
PlaylistItemResourceIdVideoId String The Id that YouTube uses to uniquely identify the video that was added to the playlist.
PlaylistItemPlaylistId String The value that YouTube uses to uniquely identify the playlist.
PlaylistItemPlaylistItemId String The value that YouTube uses to uniquely identify the item in the playlist.
RecommendationResourceIdKind String The type of the recommendation.
RecommendationResourceIdVideoId String The Id that YouTube uses to uniquely identify the video, if the recommended resource is a video.
RecommendationResourceIdChannelId String The Id that YouTube uses to uniquely identify the channel, if the recommended resource is a channel.
RecommendationReason String The reason that the YouTube entity was recommended to the user. Valid values for this column : unspecified, videoFavorited, videoLiked, and videoWatched.
RecommendationSeedResourceIdKind String The type of the YouTube entity that caused the recommendation.
RecommendationSeedResourceIdVideoId String The Id that YouTube uses to uniquely identify the video, if the recommendation was caused by a particular video.
RecommendationSeedResourceIdChannelId String The Id that YouTube uses to uniquely identify the channel, if the recommendation was caused by a particular channel.
RecommendationSeedResourceIdPlaylistId String The Id that YouTube uses to uniquely identify the playlist, if the recommendation was caused by a particular playlist.
SocialType String The name of the social network post. Valid values for this column: facebook, googlePlus, twitter, and unspecified.
SocialResourceIdKind String The type of the social network post.
SocialResourceIdVideoId String The Id that YouTube uses to uniquely identify the video featured in a social network post, if the post refers to a video.
SocialResourceIdChannelId String The Id that YouTube uses to uniquely identify the channel featured in a social network post, if the post refers to a channel.
SocialResourceIdPlaylistId String The Id that YouTube uses to uniquely identify the playlist featured in a social network post.
SocialAuthor String The author of the social network post.
SocialReferenceUrl String The URL of the social network post.
SocialImageUrl String An image of the author of the post.
ChannelItemResourceId String The Id of the YouTube entity that was added to the channel.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
Region String Instructs the API to filter by region. The parameter value is an ISO 3166-1 alpha-2 country code.

CData Cloud

AdPerformanceReports

Query Ad Performance Reports. Ad Performance Reports provide impression-based metrics for ads that ran during video playbacks. These metrics account for each ad impression, and each video playback can yield multiple impressions.

テーブル固有の情報

Select

広告タイプと日によってグループ化された特定の国の動画のGrossRevenue を取得します。

SELECT Country, AdType, Day, GrossRevenue, StartDate, EndDate FROM AdPerformanceReports WHERE video = 'vid123' AND continent = '019'

Select Rules

コンテンツ所有者の広告パフォーマンスレポート

ディメンション 必須 adType
オプション day
指標 1つ以上使用 grossRevenue、adImpressions、cpm
フィルタ 1つだけ使用 video、group、またはuploaderType とclaimedStatus のサポートされている組み合わせ
0または1つ使用 country、continent、subContinent

Columns

Name Type Dimension DefaultMetric DefaultDimension Description
AdType String True The AdType dimension is used in ad performance reports and aggregates the requested metrics based on the types of ads that ran during video playbacks: auctionDisplay, auctionInstream, auctionTrueviewInslate, auctionTrueviewInstream, auctionUnknown, reservedClickToPlay, reservedDisplay, reservedInstream, reservedInstreamSelect, reservedMasthead, reservedUnknown.
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.
GrossRevenue Decimal The estimated gross revenue, in USD, from all Google-sold or DoubleClick-partner-sold advertising for the selected date range and region. Gross revenue is subject to month-end adjustment and does not include partner-served advertising. Gross revenue should not be confused with earnings, or net revenue, which factors in your share of ownership and revenue-sharing agreements.
AdImpressions Double The number of verified ad impressions served.
Cpm Decimal The estimated gross revenue per thousand ad impressions.
Video String The Id of a YouTube video.
Group String (filter only) The Id of a YouTube Analytics group.
ClaimedStatus String (only used in content owner reports) This dimension lets you indicate that a result set should only contain metrics for claimed content. The allowed value is claimed.
UploaderType String (only used in content owner reports) This dimension lets you indicate whether a result set should 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.
Country String 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.
Continent String (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 (filter only) A U.N. statistical region code that identifies a geographical subregion.
StartDate Date Start date for fetching Analytics data.
EndDate Date End date for fetching Analytics data.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

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

CData Cloud

AudienceRetention

This report measures a video's ability to retain its audience.

Columns

Name Type Dimension DefaultMetric DefaultDimension Description
ElapsedVideoTimeRatio String True True This dimension specifies the ratio of the elapsed portion of the video to the video's length.
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.
AudienceWatchRatio Double True The absolute ratio of viewers watching the video at the given point in the video.
RelativeRetentionPerformance Double True A measurement that shows how well a video retains viewers during playbacks in comparison to all YouTube videos of similar length.
StartedWatching Int64 The number of times a particular segment of the video was the first segment seen during a video playback.
StoppedWatching Int64 The number of times a particular segment of the video was the last segment seen during a video playback.
TotalSegmentImpressions Int64 The number of times a particular segment of a video was viewed.
Video String The Id of a YouTube video.
AudienceType String The dimension value identifies the type of traffic associated with the report data. Supported values are ORGANIC, AD_INSTREAM, and AD_INDISPLAY.
SubscribedStatus String 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. Possible values are SUBSCRIBED and UNSUBSCRIBED. Note that the dimension value is accurate as of the time that the user activity occurs.
YoutubeProduct String This dimension identifies the YouTube service on which the user activity occurred. Data for this dimension is available as of July 18, 2015. The allowed values are CORE, GAMING, KIDS, UNKNOWN.
StartDate Date Start date for fetching Analytics data. Either a date string or a relative date (e.g., today, yesterday, or #daysAgo).
EndDate Date End date for fetching Analytics data. Either a date string or a relative date (e.g., today, yesterday, or #daysAgo).

CData Cloud

Captions

Query YouTube Captions. A Caption resource represents a YouTube caption track.

Table Specific Information

Select

YouTube Analytics allows only a subset of columns to be used as filter criteria. The VideoId column must be specified. Extra optional columns supported are Id and OnBehalfOfContentOwner.

All columns support the '=' operator.

SELECT * FROM Captions WHERE VideoId = '123456789'

Columns

Name Type Dimension DefaultMetric DefaultDimension Description
Id [KEY] String The Id that YouTube uses to uniquely identify the caption track.
VideoId String The Id that YouTube uses to uniquely identify the video associated with the caption track.
LastUpdated Datetime The date and time when the caption track was last updated. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
TrackKind String The type of the caption track. Valid values for this column: ASR (a caption track generated using automatic speech recognition); Forced (a caption track that plays when no other track is selected in the player. For example, a video that shows aliens speaking in an alien language might have a forced caption track to only show subtitles for the alien language); standard (a regular caption track. This is the default value).
Language String The language of the caption track. The column value is a BCP-47 language tag.
Name String The name of the caption track. The name is intended to be visible to the user as an option during playback.
AudioTrackType String The type of audio track associated with the caption track. Valid values for this column: commentary (the caption track corresponds to an alternate audio track that includes commentary, such as director commentary); descriptive (the caption track corresponds to an alternate audio track that includes additional descriptive audio); primary (the caption track corresponds to the primary audio track for the video, which is the audio track normally associated with the video); unknown (this is the default value).
IsCC Boolean Indicates whether the track contains closed captions for the deaf and hard of hearing. The default value is false.
IsLarge Boolean Indicates whether the caption track uses large text for the vision-impaired. The default value is false.
IsEasyReader Boolean Indicates whether the caption track is formatted for easy reader, meaning it is at a third-grade level for language learners. The default value is false.
IsDraft Boolean Indicates whether the caption track is a draft. If the value is true, then the track is not publicly visible. The default value is false.
IsAutoSynced Boolean Indicates whether YouTube synchronized the caption track to the audio track in the video. The value will be true if a sync was explicitly requested when the caption track was uploaded. If the value is false, YouTube uses the time codes in the uploaded caption track to determine when to display captions.
Status String The status of the caption track. Valid values for this column: failed, serving, syncing.
FailureReason String The reason that YouTube failed to process the caption track. Valid values: processingFailed (YouTube failed to process the uploaded caption track); unknownFormat (the format of the caption track was not recognized); unsupportedFormat (the format of the caption track is not supported).

CData Cloud

Channels

Query YouTube Channels.

Table Specific Information

Select

The following filters are passed to YouTube Analytics if present. Other filters are executed client side.

By default, if no filters are specified, the driver will return all channels owned by the authenticated user.

YouTube Analytics allows only a subset of columns to be used as filter criteria. The channels can be filtered by the Id. Extra optional columns supported are Language and ChannelId.

A search against all channels in YouTube Analytics may be triggered by specifying one or more of SearchTerms, ChannelId, Region, SafeSearch, Rating, or Relevance to search all channels.

All columns support the '=' operator. 'PublishedAt', also supports '>', '>=', '<', and '<='.

Order by is supported for the Rating, Relevance, and Title columns.

SELECT * FROM Channels WHERE Id = 'abc123'

SELECT * FROM Channels WHERE ChannelId = 'abc123' AND SearchTerms = 'music|movies-horror' ORDER BY Rating LIMIT 10

Note: Ordering is not supported when specifying one of the colums used for searching channels such as SearchTerms.

Columns

Name Type Dimension DefaultMetric DefaultDimension Description
Id [KEY] String The Id that YouTube uses to uniquely identify the channel.
Title String The title of the channel.
Description String The description of the channel. The value of the column has a maximum length of 1000 characters.
CustomUrl String The channel's custom URL.
PublishedAt Datetime The date and time that the channel was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
ThumbnailsDefaultUrl String The URL of the default image thumbnail.
DefaultLanguage String This column is confidential to trusted testers.
LiveBroadcastContent String An indication of whether a video or channel resource has live broadcast content.
LocalizedTitle String This column is confidential to trusted testers. The localized video title.
LocalizedDescription String This column is confidential to trusted testers. The localized video description.
Country String The country with which the channel is associated.
ViewCount Long The number of times the channel has been viewed.
SubscriberCount Long The number of subscribers that the channel has. This value is rounded down to three significant figures.
HiddenSubscriberCount Boolean Indicates whether the subscriber count of the channel is publicly visible.
VideoCount Long The number of videos uploaded to the channel.
RelatedPlaylistsLikes String The Id of the playlist that contains the liked videos of the channel.
RelatedPlaylistsUploads String The Id of the playlist that contains the uploaded videos of the channel.
PrivacyStatus String Privacy status of the channel. Valid values for this column: private, public, unlisted.
IsLinked Boolean Indicates whether the channel data identifies a user who is already linked to either a YouTube username or a Google+ account. A user who has one of these links already has a public YouTube identity, which is a prerequisite for several actions, such as uploading videos.
LongUploadsStatus String Indicates whether the channel is eligible to upload videos that are more than 15 minutes long. This column is only returned if the channel owner authorized the API request. See the YouTube Help Center for more information about this feature.
MadeForKids Boolean This value indicates whether the channel is designated as child-directed, and it contains the current 'made for kids' status of the channel.
Keywords String Keywords associated with your channel. The value is a space-separated list of strings.
TrackingAnalyticsAccountId String The Id for a Google Analytics account that you want to use to track and measure traffic to your channel.
ModerateComments Boolean This setting determines whether user-submitted comments left on the channel page need to be approved by the channel owner to be publicly visible. The default value is false.
SearchTerms String The SearchTerms parameter specifies the query term to search for.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
ForUsername String The username associated with the channel.
Language String Retrieve localized resource metadata for a specific application language that the YouTube website supports.
Language String Retrieve localized resource metadata for a specific application language that the YouTube website supports.
ManagedByMe String This parameter is intended exclusively for YouTube content partners. Set this parameter's value to true to instruct the API to only return channels managed by the content owner that the onBehalfOfContentOwner parameter specifies. The user must be authenticated as a CMS account linked to the specified content owner and onBehalfOfContentOwner must be provided.
OnBehalfOfContentOwner String 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.
ChannelId String The Id that YouTube uses to uniquely identify a channel.
Region String The country associated with the channel.
SafeSearch String Indicates whether the search results should include restricted content as well as standard content. Acceptable values: moderate, none, or strict.
Rating String Resources are sorted from highest to lowest rating.
Relevance String Resources are sorted based on their relevance to the search query. This is the default value for this parameter.

CData Cloud

ChannelSections

Query YouTube ChannelSections. A ChannelSection contains information about a set of Videos that a Channel has chosen to feature.

Table Specific Information

Select

YouTube Analytics allows only a subset of columns to be used as filter criteria. You can specify exactly one of the following columns: ChannelId or Id. Extra optional columns supported are Language and OnBehalfOfContentOwner.

All columns support the '=' operator.

By default, if no channel id is specified, the driver will return channel sections for the channel owned by authenticated user.

SELECT * FROM ChannelSections WHERE ChannelId = '123456789'

Columns

Name Type Dimension DefaultMetric DefaultDimension Description
Id [KEY] String The Id that YouTube uses to uniquely identify the channel section.
Type String The type of the channel section.
ChannelId String The Id that YouTube uses to uniquely identify the channel.
Title String The title of the section.
Position Integer The position of the section on the channel page.
PlaylistsAggregate String A list of one or more playlist Ids that are featured in a channel section. You must specify a list of playlist Ids if the type of the ChannelSection is either singlePlaylist or multiplePlaylists, and this column should not be specified for other types of sections. If the type is singlePlaylist, this list must specify exactly one playlist Id.
ChannelsAggregate String A list of one or more channel Ids that are featured in a channel section. You must specify a list of channel Ids if the Type of the ChannelSection is multipleChannels, and this column should not be specified for other types of sections. You cannot include your own channel in the list.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
Language String Retrieve localized resource metadata for a specific application language that the YouTube website supports.
OnBehalfOfContentOwner String This parameter is intended exclusively for YouTube content partners.

CData Cloud

Comments

Query YouTube Comments.

Table Specific Information

Select

YouTube Analytics allows only a subset of columns to be used as filter criteria. You must specify exactly one of the following columns: Id or ParentId. Extra optional columns supported are TextFormat.

All columns support the '=' operator.

SELECT * FROM Comments WHERE Id = '123456789'

Columns

Name Type Dimension DefaultMetric DefaultDimension Description
Id [KEY] String The Id that YouTube uses to uniquely identify the comment.
ChannelId String The Id of the YouTube channel associated with the comment. If the comment is a video comment, then this column identifies the channel of the video, and the VideoId column identifies the video. If the comment is a channel comment, then this column identifies the channel that the comment is about.
VideoId String The Id of the video that the comment refers to.
TextDisplay String The text of the comment. The text can be retrieved in either plaintext or HTML. The TextFormat pseudo column specifies the desired text format.
TextOriginal String The original, raw text of the comment as it was initially posted or last updated. The original text is only returned if it is accessible to the authenticated user, which is only guaranteed if the user is the author of the comment.
ParentId String The unique Id of the parent comment. This column value is only set if the comment was submitted as a reply to another comment.
AuthorDisplayName String The display name of the user who posted the comment.
AuthorProfileImageUrl String The URL for the avatar of the user who posted the comment.
AuthorChannelUrl String The URL of the YouTube channel of the comment author, if available.
AuthorChannelIdValue String The Id of the YouTube channel of the comment author, if available.
AuthorGoogleplusProfileUrl String The URL of the Google+ profile of the comment author, if available.
CanRate Boolean This setting indicates whether the current viewer can rate the comment.
ViewerRating String The rating the viewer has given to this comment. Valid values for this column: like, none. Note that this column does not currently identify dislike ratings. The column value is like if the viewer has rated the comment positively. The value is none in all other cases, including the user having given the comment a negative rating or not having rated the comment.
LikeCount Integer The total number of likes (positive ratings) the comment has received.
ModerationStatus String The moderation status of the comment. This value is only returned if the API request was authorized by the owner of the channel or the video on which the requested comments were made. In addition, note that this value is not set if the query filtered on the Id column. Valid values: heldForReview, likelySpam, published, rejected.
PublishedAt Datetime The date and time when the comment was orignally published. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
UpdatedAt Datetime The date and time when the comment was last updated. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
TextFormat String This parameter indicates whether the API should return comments formatted as HTML or as plaintext.

CData Cloud

CommentThreads

Query YouTube CommentThreads. A CommentThread record contains information about a YouTube comment thread, a top-level comment and replies, if any exist, to that comment.

Table Specific Information

Select

YouTube Analytics allows only a subset of columns to be used as filter criteria. You must specify exactly one of the following columns: AllThreadsRelatedToChannelId, ChannelId, Id, or VideoId.

Extra optional columns supported are ModerationStatus, SearchTerms, and TextFormat. All columns support the '=' operator.

Order is supported for CommentThreads. Relevance are the supported order columns.

SELECT * FROM CommentThreads WHERE VideoId = 'abcdef123456' ORDER BY Relevance DESC LIMIT 10

Note: Ordering is not supported for use in conjunction with the Id parameter.

Columns

Name Type Dimension DefaultMetric DefaultDimension Description
Id [KEY] String The Id that YouTube uses to uniquely identify the comment thread.
ChannelId String The YouTube channel that is associated with the comments in the thread. The VideoId column identifies the video. If the comments are about a video, then the value identifies the channel that uploaded the video. If the comments refer to the channel itself, the VideoId column will not have a value.
VideoId String The Id of the video that the comments refer to, if any. If this column is not present or does not have a value, then the thread applies to the channel and not to a specific video.
TopCommentId String The Id of the top-level comment of the thread.
PublishedAt Datetime The publish date of the top-level comment of the thread.
UpdatedAt Datetime The last update date of the top-level comment of the thread.
TopCommentChannelId String The Id of the channel associated with the top-level comment of the thread.
TopCommentVideoId String The Id of the video associated with the top-level comment of the thread.
TopCommentTextDisplay String The display text of the top-level comment of the thread.
TopCommentTextOriginal String The original text of the top-level comment of the thread.
TopCommentParentId String The Id of the parent of the top-level comment of the thread.
TopCommentAuthorDisplayName String The display name of the author of the top-level comment of the thread.
TopCommentAuthorChannelIdValue String The Id of the channel of the author of the top-level comment of the thread.
TopCommentCanRate Boolean Whether the current user can rate the top-level comment of the thread.
TopCommentViewerRating String The viewer rating of the top-level comment of the thread.
TopCommentLikeCount Integer The like count of the top-level comment of the thread.
TopCommentModerationStatus String The moderation status of the top-level comment of the thread.
CanReply Boolean This setting indicates whether the current viewer can reply to the thread.
TotalReplyCount Integer The total number of replies that have been submitted in response to the top-level comment.
IsPublic Boolean This setting indicates whether the thread, including all of its comments and comment replies, is visible to all YouTube users.
CommentsAggregate String A list of one or more replies to the top-level comment.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
AllThreadsRelatedToChannelId String Instructs the API to return all comment threads associated with the specified channel.
ModerationStatus String Set this parameter to limit the returned comment threads to a particular moderation state.
TextFormat String Set the value of this parameter to HTML or plainText.

CData Cloud

Demographics

Query YouTubeAnalytics Demographics grouped by age groups and gender.

テーブル固有の情報

Select

動画の統計情報を視聴者の年齢層と性別に基づいて集計します。

SELECT * FROM Demographics

デモグラフィックを1動画のみに減らします。

SELECT * FROM Demographics WHERE Video = 'video_Id'

再生リストの統計情報を視聴者の年齢層と性別に基づいて集計します。

SELECT * FROM Demographics WHERE IsCurated = true

Select Rules

次のテーブルを使用してトップ動画への他のクエリを作成できます。

動画のデモグラフィック:

ディメンション 1つ以上使用 ageGroup、gender、video
0または1つ以上使用 creatorContentType、liveOrOnDemand、subscribedStatus、youtubeProduct
指標 1つ以上使用 viewerPercentage
フィルタ 0または1つ使用 country、province、continent、subContinent
0または1つ使用 video、group
0または1つ以上使用 liveOrOnDemand、subscribedStatus、youtubeProduct

再生リストのデモグラフィック:

ディメンション 1つ以上使用 ageGroup、gender
0または1つ以上使用 subscribedStatus、youtubeProduct
指標 必須 viewerPercentage
フィルタ 必須 isCurated=true
0または1つ使用 country、province、continent、subContinent
0または1つ使用 video、group
0または1つ以上使用 subscribedStatus、youtubeProduct

コンテンツ所有者のデモグラフィック:

ディメンション 1つ以上使用 ageGroup、gender
0または1つ以上使用 creatorContentType、liveOrOnDemand、subscribedStatus、youtubeProduct
指標 1つ以上使用 viewerPercentage
フィルタ 1つだけ使用 video、channel、group
0または1つ使用 country、province、continent、subContinent
0または1つ以上使用 liveOrOnDemand、subscribedStatus、youtubeProduct

コンテンツ所有者の再生リストのデモグラフィック:

ディメンション 1つ以上使用 ageGroup、gender
0または1つ以上使用 subscribedStatus、youtubeProduct
指標 必須 viewerPercentage
フィルタ 必須 isCurated=true
0または1つ使用 country、province、continent、subContinent
0または1つ使用 playlist、channel、group
0または1つ以上使用 subscribedStatus、youtubeProduct

Columns

Name Type Dimension DefaultMetric DefaultDimension Description
AgeGroup String True True This dimension identifies the age group of the logged-in users associated with the report data. The allowed values are age13-17, age18-24, age25-34, age35-44, age45-54, age55-64, age65-
Gender String True This dimension identifies the gender of the logged-in users associated with the query. The allowed values are female, male and user_specified.
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.
LiveOrOnDemand String True This dimension indicates whether the user activity metrics in the data row are associated with views of a live broadcast. Data for this dimension is available for dates beginning April 1, 2014. The allowed values are LIVE, ON_DEMAND.
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 and UNSUBSCRIBED. Note that the dimension value is accurate as of the time that the user activity occurs.
ViewerPercentage Double True The percentage of viewers who were logged in when watching the video or playlist. The viewerPercentage values in this report are not normalized for different values or combinations of values for playback detail dimensions (subscribedStatus and youtubeProduct). For example, a report that uses the subscribedStatus dimension returns viewerPercentage data adding up to 100 percent for subscribed views and viewerPercentage data adding up to 100 percent for unsubscribed views. (The total value of all viewerPercentage fields in the report is 200 percent.) You can use filters to ensure that the report only contains viewerPercentage data for one value (or combination of values) for playback detail dimensions.
Video String True The Id of a YouTube video.
Playlist String The Id of a YouTube playlist.
Group String (filter only) The Id of a YouTube Analytics group.
UploaderType String (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.
ClaimedStatus String (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.
Country String 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.
Province String 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 (filter only) A United Nations (U.N.) statistical region code. The API supports the following values: 002 Africa, 019 Americas (Northern America, Latin America, South America, and the Caribbean), 142 Asia, 150 Europe, 009 Oceania.
SubContinent String (filter only) A U.N. statistical region code that identifies a geographical subregion.
StartDate Date Start date for fetching Analytics data.
EndDate Date End date for fetching Analytics data.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

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

CData Cloud

Devices

Query YouTubeAnalytics Devices statistics. This table allows you to aggregate viewing statistics based on the manner in which viewers reached your video content. For example, you can identify the number of views that occurred on mobile devices or game consoles.

テーブル固有の情報

Select

デフォルトでは、グループ化はデバイスタイプによって行われます。

SELECT * FROM Devices

オペレーティングシステムなど他のディメンションでビューをグループ化できます。

SELECT OperatingSystem, Views, EstimatedMinutesWatched FROM Devices
同じクエリでデバイスタイプとオペレーティングシステムの両方を混在させることは、YouTube Analytics API の制限によりできません。

Select Rules

次のテーブルを使用してデバイスへの他のクエリを作成できます。

動画のデバイス:

ディメンション 1つだけ使用 deviceType、operatingSystem
0または1つ以上使用 creatorContentType、day、liveOrOnDemand、subscribedStatus、youtubeProduct
指標 1つ以上使用 views、estimatedMinutesWatched
フィルタ 0または1つ使用 country、province、continent、subContinent
0または1つ使用 video、group
0または1つ以上使用 operatingSystem、liveOrOnDemand、subscribedStatus、youtubeProduct

再生リストのデバイスデータ:

ディメンション 1つだけ使用 deviceType、operatingSystem
0または1つ以上使用 day、subscribedStatus、youtubeProduct
指標 1つ以上使用 views、estimatedMinutesWatched、playlistStarts、viewsPerPlaylistStart、averageTimeInPlaylist
フィルタ 必須 isCurated=true
0または1つ使用 country、province、continent、subContinent
0または1つ使用 playlist、channel、group
0または1つ以上使用 operatingSystem、subscribedStatus、youtubeProduct

コンテンツ所有者のデバイスデータ:

ディメンション 必須 deviceType
0または1つ以上使用 creatorContentType、day、liveOrOnDemand、subscribedStatus、youtubeProduct
指標 1つ以上使用 views、estimatedMinutesWatched
フィルタ 1つだけ使用 video、channel、group
0または1つ使用 country、province、continent、subContinent
0または1つ以上使用 operatingSystem、liveOrOnDemand、subscribedStatus、youtubeProduct

コンテンツ所有者の再生リストのデバイスデータ:

ディメンション 必須 deviceType
0または1つ以上使用 day、subscribedStatus、youtubeProduct
指標 1つ以上使用 views、estimatedMinutesWatched、playlistStarts、viewsPerPlaylistStart、averageTimeInPlaylist
フィルタ 必須 isCurated=true
0または1つ使用 country、province、continent、subContinent
0または1つ使用 playlist、channel、group
0または1つ以上使用 operatingSystem、subscribedStatus、youtubeProduct

Columns

Name Type Dimension DefaultMetric DefaultDimension Description
DeviceType String True True This dimension identifies the physical form factor of the device on which the view occurred. The allowed values are DESKTOP, GAME_CONSOLE, MOBILE, TABLET, TV, UNKNOWN_PLATFORM.
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.
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.
LiveOrOnDemand String True This dimension indicates whether the user activity metrics in the data row are associated with views of a live broadcast. Data for this dimension is available for dates beginning April 1, 2014. The allowed values are LIVE, ON_DEMAND.
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.
YoutubeProduct String True This dimension identifies the YouTube service on which the user activity occurred. Data for this dimension is available as of July 18, 2015. The allowed values are CORE, GAMING, KIDS, UNKNOWN.
Views Double True The number of times that a video was viewed.
EstimatedMinutesWatched Double True The number of minutes that users watched videos for the specified channel, content owner, video, or playlist.
AverageViewDuration Double 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.
AverageTimeInPlaylist Double The estimated average amount of time, in minutes, that a viewer viewed videos in a playlist after the playlist was initiated. Note that this metric includes only playlist views that occurred on the web.
PlaylistAverageViewDuration Double The estimated average length, in seconds, watched per playlist view. Note that this metric represents the average length of views of individual videos within a playlist; the averageTimeInPlaylist metric, by contrast, represents the average time each viewer spends watching the playlist as a whole. This metric includes data for playlist videos that are owned by other channels.
PlaylistEstimatedMinutesWatched Double The number of minutes that users watched the playlist content as a part of the playlist. Watch time that occurred in other contexts?for example, watch time from views that occurred when viewers were watching the same video as part of other playlists?is not counted. This metric includes data for playlist videos that are owned by other channels.
PlaylistStarts Double The number of times that viewers initiated playback of a playlist. Note that this metric includes only playlist views that occurred on the web.
PlaylistViews Double The number of times that videos in the playlist were viewed in the context of that playlist. This metric includes data for playlist videos that are owned by other channels.
ViewsPerPlaylistStart Double The average number of video views that occurred each time a playlist was initiated.
Country String 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.
Province String 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 (filter only) A United Nations (U.N.) statistical region code: 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 (filter only) A U.N. statistical region code that identifies a geographical subregion.
Video String True The Id of a YouTube video.
Playlist String The Id of a YouTube playlist.
Group String (filter only) The Id of a YouTube Analytics group.
ClaimedStatus String (only used in content owner reports) This dimension lets you indicate that the result set will only contain metrics for claimed content. The allowed value is claimed.
UploaderType String (only used in content owner reports) This dimension lets you indicate whether the 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.
OperatingSystem String This dimension identifies the software system of the device on which the view occurred. The allowed values are ANDROID, BADA, BLACKBERRY, DOCOMO, HIPTOP, IOS, LINUX, MACINTOSH, MEEGO, NINTENDO_3DS, OTHER, PLAYSTATION, PLAYSTATION_VITA, SMART_TV, SYMBIAN, WEBOS.
StartDate Date Start date for fetching Analytics data.
EndDate Date End date for fetching Analytics data.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

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

CData Cloud

EngagementReports

Query Engagement Reports info. For example, how many times a user shared a video.

テーブル固有の情報

Select

デフォルトでは、結果はDay でグループ化されます。次のクエリは、Day によってグループ化されたComments、Likes、Dislikes、etc. を返します。

SELECT * FROM EngagementReports

Select Rules

次のクエリは、チャンネルの動画が異なるソーシャルプラットフォームでシェアされた頻度を返します。

SELECT SharingService, Shares FROM EngagementReports
次のテーブルを使用してエンゲージメントレポートへの他のクエリを作成できます。

動画のエンゲージメントレポート

ディメンション 必須 sharingService
オプション creatorContentType、subscribedStatus
指標 1つ以上使用 shares
フィルタ 0または1つ使用 country、continent、subContinent
0または1つ使用 video、group
オプション subscribedStatus

コンテンツ所有者のエンゲージメントレポート

ディメンション 必須 sharingService
オプション creatorContentType、subscribedStatus
指標 1つ以上使用 shares
フィルタ 1つだけ使用 video、channel、group
0または1つ使用 country、continent、subContinent
オプション subscribedStatus

Columns

Name Type Dimension DefaultMetric DefaultDimension Description
SharingService String True This dimension identifies the service that was used to share videos. Videos can be shared on YouTube (or via the YouTube player) using the Share button.
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.
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. Possible values are SUBSCRIBED and UNSUBSCRIBED. Note that the dimension value is accurate as of the time that the user activity occurs.
Shares Double True The number of times that users shared a video through the Share button.
Country String 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.
Continent String (filter only) A United Nations (U.N.) statistical region code: 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 (filter only) A U.N. statistical region code that identifies a geographical subregion.
Channel String (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 (filter only) The Id of a YouTube Analytics group.
ClaimedStatus String (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 (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.
StartDate Date Start date for fetching Analytics data.
EndDate Date End date for fetching Analytics data.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

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

CData Cloud

Languages

Query YouTube i18nLanguages. An i18nLanguage resource identifies an application language that the YouTube website supports. The application language can also be referred to as a UI language.

Table Specific Information

Select

There are no required filters for this table. An optional column supported is Language.

All columns support the '=' operator.

Columns

Name Type Dimension DefaultMetric DefaultDimension Description
Id [KEY] String The Id that YouTube uses to uniquely identify the i18n language.
Language String A BCP-47 code that uniquely identifies a language.
Name String The name of the language as it is written in that language.

CData Cloud

MostPopularVideosByCategory

Query YouTube Videos.

Columns

Name Type Dimension DefaultMetric DefaultDimension Description
Id [KEY] String The Id that YouTube uses to uniquely identify the video.
ChannelId String The Id that YouTube uses to uniquely identify the channel that the video was uploaded to.
CategoryId String The YouTube video category associated with the video.
Title String The title of the video.
ChannelTitle String Channel title for the channel that the video belongs to.
PublishedAt Datetime The date and time that the video was published. Note that this time might be different than the time that the video was uploaded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
Description String The description of the video.
Duration String The length of the video. The property value is an ISO 8601 duration.
ViewCount Long The number of times the video has been viewed.
LikeCount Long The number of users who have indicated that they liked the video.
DislikeCount Long The number of users who have indicated that they disliked the video. In conjunction with changes to make video dislike counts private across the entire YouTube platform, this field is returned only if the API request was authenticated by the video owner.
CommentCount Long The number of comments for the video.
EmbedHtml String An iframe tag that embeds a player that will play the video.
PublicStatsViewable Boolean This value indicates whether the extended video statistics on the watch page are publicly viewable. By default, those statistics are viewable, and statistics like the viewcount and ratings will still be publicly visible even if this value is set to false.
TagsAggregate String A list of keyword tags associated with the video.
LiveBroadcastContent String Indicates if the video is an upcoming/active live broadcast. A value of none indicates the video is not an upcoming/active live broadcast. Valid values for this column: live, none, upcoming.
Dimension String Indicates whether the video is available in 3D or in 2D.
Definition String Indicates whether the video is available in high definition HD or only in standard definition. Valid values for this column: hd,sd.
Caption String Indicates whether captions are available for the video. Valid values for this column: false, true.
LicensedContent Boolean Indicates whether the video represents licensed content, which means that the content was uploaded to a channel linked to a YouTube content partner and then claimed by that partner.
AllowedAggregate String A list of region codes that identify countries where the video is viewable.
BlockedAggregate String A list of region codes that identify countries where the video is blocked.
Projection String Specifies the projection format of the video. Valid values: 360, rectangular.
PrivacyStatus String The privacy status of the playlist. Valid values: private, public, unlisted.
MadeForKids Boolean This value indicates whether the video is Made For Kids.
License String The license. Valid values: creativeCommon, youtube.
Embeddable Boolean This value indicates whether the video can be embedded on another website.
ThumbnailsDefaultUrl String The URL of the default image.
DefaultLanguage String This column is confidential to trusted testers. The language of the text in the Title and Description columns.
DefaultAudioLanguage String The default_audio_language column specifies the language spoken in the default audio track of the video.
UploadStatus String The status of the uploaded video. Valid values for this column: deleted, failed, processed, rejected, uploaded.
FailureReason String This value explains why a video failed to upload. This column only has a value if the UploadStatus column indicates that the upload failed. Valid values for this column: codec, conversion, emptyFile, invalidFile, tooSmall, uploadAborted.
RejectionReason String This value explains why YouTube rejected an uploaded video. This column only has a value if the UploadStatus column indicates that the upload was rejected. Valid values for this column: claim, copyright, duplicate, inappropriate, length, termsOfUse, trademark, uploaderAccountClosed, uploaderAccountSuspended.
RecordingDate Datetime The date and time when the video was recorded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sssZ) format.
SearchTerms String The query term to search for.
Region String The country from which to retrieve video categories.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
SafeSearch String Indicates whether the search results should include restricted content as well as standard content. Acceptable values: moderate, none, or strict.
EventType String The eventType parameter restricts a search to broadcast events. Acceptable values are: COMPLETED, LIVE, UPCOMING.

使用できる値は次のとおりです。COMPLETED, LIVE, UPCOMING

RelatedToVideoId String Retrieves a list of videos that are related to the video that the column value identifies.
VideoDuration String Filters video search results based on their duration. Acceptable values: any, long, medium or short.
VideoCategoryId String The videoCategoryId parameter identifies the video category for which the chart should be retrieved.
ForMine String Restricts the search to only retrieve videos owned by the authenticated user. It is false by default.
Language String Retrieve localized resource metadata for a specific application language that the YouTube website supports.
ForContentOwner String Restricts the search to only retrieve videos owned by the content owner specified by the OnBehalfOfContentOwner parameter.
OnBehalfOfContentOwner String This parameter is intended exclusively for YouTube content partners.

CData Cloud

MostPopularVideosByRegion

Query YouTube Videos.

Columns

Name Type Dimension DefaultMetric DefaultDimension Description
Id [KEY] String The Id that YouTube uses to uniquely identify the video.
ChannelId String The Id that YouTube uses to uniquely identify the channel that the video was uploaded to.
CategoryId String The YouTube video category associated with the video.
Title String The title of the video.
ChannelTitle String Channel title for the channel that the video belongs to.
PublishedAt Datetime The date and time that the video was published. Note that this time might be different than the time that the video was uploaded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
Description String The description of the video.
Duration String The length of the video. The property value is an ISO 8601 duration.
ViewCount Long The number of times the video has been viewed.
LikeCount Long The number of users who have indicated that they liked the video.
DislikeCount Long The number of users who have indicated that they disliked the video. In conjunction with changes to make video dislike counts private across the entire YouTube platform, this field is returned only if the API request was authenticated by the video owner.
CommentCount Long The number of comments for the video.
EmbedHtml String An iframe tag that embeds a player that will play the video.
PublicStatsViewable Boolean This value indicates whether the extended video statistics on the watch page are publicly viewable. By default, those statistics are viewable, and statistics like the viewcount and ratings will still be publicly visible even if this value is set to false.
TagsAggregate String A list of keyword tags associated with the video.
LiveBroadcastContent String Indicates if the video is an upcoming/active live broadcast. A value of none indicates the video is not an upcoming/active live broadcast. Valid values for this column: live, none, upcoming.
Dimension String Indicates whether the video is available in 3D or in 2D.
Definition String Indicates whether the video is available in high definition HD or only in standard definition. Valid values for this column: hd,sd.
Caption String Indicates whether captions are available for the video. Valid values for this column: false, true.
LicensedContent Boolean Indicates whether the video represents licensed content, which means that the content was uploaded to a channel linked to a YouTube content partner and then claimed by that partner.
AllowedAggregate String A list of region codes that identify countries where the video is viewable.
BlockedAggregate String A list of region codes that identify countries where the video is blocked.
Projection String Specifies the projection format of the video. Valid values: 360, rectangular.
PrivacyStatus String The privacy status of the playlist. Valid values: private, public, unlisted.
MadeForKids Boolean This value indicates whether the video is Made For Kids.
License String The license. Valid values: creativeCommon, youtube.
Embeddable Boolean This value indicates whether the video can be embedded on another website.
ThumbnailsDefaultUrl String The URL of the default image.
DefaultLanguage String This column is confidential to trusted testers. The language of the text in the Title and Description columns.
DefaultAudioLanguage String The default_audio_language column specifies the language spoken in the default audio track of the video.
UploadStatus String The status of the uploaded video. Valid values for this column: deleted, failed, processed, rejected, uploaded.
FailureReason String This value explains why a video failed to upload. This column only has a value if the UploadStatus column indicates that the upload failed. Valid values for this column: codec, conversion, emptyFile, invalidFile, tooSmall, uploadAborted.
RejectionReason String This value explains why YouTube rejected an uploaded video. This column only has a value if the UploadStatus column indicates that the upload was rejected. Valid values for this column: claim, copyright, duplicate, inappropriate, length, termsOfUse, trademark, uploaderAccountClosed, uploaderAccountSuspended.
RecordingDate Datetime The date and time when the video was recorded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sssZ) format.
SearchTerms String The query term to search for.
Region String The country from which to retrieve video categories.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
SafeSearch String Indicates whether the search results should include restricted content as well as standard content. Acceptable values: moderate, none, or strict.
EventType String The eventType parameter restricts a search to broadcast events. Acceptable values are: COMPLETED, LIVE, UPCOMING.

使用できる値は次のとおりです。COMPLETED, LIVE, UPCOMING

RelatedToVideoId String Retrieves a list of videos that are related to the video that the column value identifies.
VideoDuration String Filters video search results based on their duration. Acceptable values: any, long, medium or short.
VideoCategoryId String The videoCategoryId parameter identifies the video category for which the chart should be retrieved.
ForMine String Restricts the search to only retrieve videos owned by the authenticated user. It is false by default.
Language String Retrieve localized resource metadata for a specific application language that the YouTube website supports.
ForContentOwner String Restricts the search to only retrieve videos owned by the content owner specified by the OnBehalfOfContentOwner parameter.
OnBehalfOfContentOwner String This parameter is intended exclusively for YouTube content partners.

CData Cloud

MyDislikedVideos

Query YouTube Liked Videos.

Columns

Name Type Dimension DefaultMetric DefaultDimension Description
Id [KEY] String The Id that YouTube uses to uniquely identify the video.
ChannelId String The Id that YouTube uses to uniquely identify the channel that the video was uploaded to.
CategoryId String The YouTube video category associated with the video.
Title String The title of the video.
ChannelTitle String Channel title for the channel that the video belongs to.
PublishedAt Datetime The date and time that the video was published. Note that this time might be different than the time that the video was uploaded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
Description String The description of the video.
Duration String The length of the video. The property value is an ISO 8601 duration.
ViewCount Long The number of times the video has been viewed.
LikeCount Long The number of users who have indicated that they liked the video.
DislikeCount Long The number of users who have indicated that they disliked the video. In conjunction with changes to make video dislike counts private across the entire YouTube platform, this field is returned only if the API request was authenticated by the video owner.
CommentCount Long The number of comments for the video.
EmbedHtml String An iframe tag that embeds a player that will play the video.
PublicStatsViewable Boolean This value indicates whether the extended video statistics on the watch page are publicly viewable. By default, those statistics are viewable, and statistics like the viewcount and ratings will still be publicly visible even if this value is set to false.
TagsAggregate String A list of keyword tags associated with the video.
LiveBroadcastContent String Indicates if the video is an upcoming/active live broadcast. A value of none indicates the video is not an upcoming/active live broadcast. Valid values for this column: live, none, upcoming.
Dimension String Indicates whether the video is available in 3D or in 2D.
Definition String Indicates whether the video is available in high definition HD or only in standard definition. Valid values for this column: hd,sd.
Caption String Indicates whether captions are available for the video. Valid values for this column: false, true.
LicensedContent Boolean Indicates whether the video represents licensed content, which means that the content was uploaded to a channel linked to a YouTube content partner and then claimed by that partner.
AllowedAggregate String A list of region codes that identify countries where the video is viewable.
BlockedAggregate String A list of region codes that identify countries where the video is blocked.
Projection String Specifies the projection format of the video. Valid values: 360, rectangular.
PrivacyStatus String The privacy status of the playlist. Valid values: private, public, unlisted.
MadeForKids Boolean This value indicates whether the video is Made For Kids.
License String The license. Valid values: creativeCommon, youtube.
Embeddable Boolean This value indicates whether the video can be embedded on another website.
ThumbnailsDefaultUrl String The URL of the default image.
DefaultLanguage String This column is confidential to trusted testers. The language of the text in the Title and Description columns.
DefaultAudioLanguage String The default_audio_language column specifies the language spoken in the default audio track of the video.
UploadStatus String The status of the uploaded video. Valid values for this column: deleted, failed, processed, rejected, uploaded.
FailureReason String This value explains why a video failed to upload. This column only has a value if the UploadStatus column indicates that the upload failed. Valid values for this column: codec, conversion, emptyFile, invalidFile, tooSmall, uploadAborted.
RejectionReason String This value explains why YouTube rejected an uploaded video. This column only has a value if the UploadStatus column indicates that the upload was rejected. Valid values for this column: claim, copyright, duplicate, inappropriate, length, termsOfUse, trademark, uploaderAccountClosed, uploaderAccountSuspended.
RecordingDate Datetime The date and time when the video was recorded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sssZ) format.
SearchTerms String The query term to search for.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
SafeSearch String Indicates whether the search results should include restricted content as well as standard content. Acceptable values: moderate, none, or strict.
EventType String The eventType parameter restricts a search to broadcast events. Acceptable values are: COMPLETED, LIVE, UPCOMING.

使用できる値は次のとおりです。COMPLETED, LIVE, UPCOMING

RelatedToVideoId String Retrieves a list of videos that are related to the video that the column value identifies.
VideoDuration String Filters video search results based on their duration. Acceptable values: any, long, medium or short.
VideoCategoryId String The videoCategoryId parameter identifies the video category for which the chart should be retrieved.
ForMine String Restricts the search to only retrieve videos owned by the authenticated user. It is false by default.
Language String Retrieve localized resource metadata for a specific application language that the YouTube website supports.
ForContentOwner String Restricts the search to only retrieve videos owned by the content owner specified by the OnBehalfOfContentOwner parameter.
OnBehalfOfContentOwner String This parameter is intended exclusively for YouTube content partners.

CData Cloud

MyLikedVideos

Query YouTube Liked Videos.

Columns

Name Type Dimension DefaultMetric DefaultDimension Description
Id [KEY] String The Id that YouTube uses to uniquely identify the video.
ChannelId String The Id that YouTube uses to uniquely identify the channel that the video was uploaded to.
CategoryId String The YouTube video category associated with the video.
Title String The title of the video.
ChannelTitle String Channel title for the channel that the video belongs to.
PublishedAt Datetime The date and time that the video was published. Note that this time might be different than the time that the video was uploaded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
Description String The description of the video.
Duration String The length of the video. The property value is an ISO 8601 duration.
ViewCount Long The number of times the video has been viewed.
LikeCount Long The number of users who have indicated that they liked the video.
DislikeCount Long The number of users who have indicated that they disliked the video. In conjunction with changes to make video dislike counts private across the entire YouTube platform, this field is returned only if the API request was authenticated by the video owner.
CommentCount Long The number of comments for the video.
EmbedHtml String An iframe tag that embeds a player that will play the video.
PublicStatsViewable Boolean This value indicates whether the extended video statistics on the watch page are publicly viewable. By default, those statistics are viewable, and statistics like the viewcount and ratings will still be publicly visible even if this value is set to false.
TagsAggregate String A list of keyword tags associated with the video.
LiveBroadcastContent String Indicates if the video is an upcoming/active live broadcast. A value of none indicates the video is not an upcoming/active live broadcast. Valid values for this column: live, none, upcoming.
Dimension String Indicates whether the video is available in 3D or in 2D.
Definition String Indicates whether the video is available in high definition HD or only in standard definition. Valid values for this column: hd,sd.
Caption String Indicates whether captions are available for the video. Valid values for this column: false, true.
LicensedContent Boolean Indicates whether the video represents licensed content, which means that the content was uploaded to a channel linked to a YouTube content partner and then claimed by that partner.
AllowedAggregate String A list of region codes that identify countries where the video is viewable.
BlockedAggregate String A list of region codes that identify countries where the video is blocked.
Projection String Specifies the projection format of the video. Valid values: 360, rectangular.
PrivacyStatus String The privacy status of the playlist. Valid values: private, public, unlisted.
MadeForKids Boolean This value indicates whether the video is Made For Kids.
License String The license. Valid values: creativeCommon, youtube.
Embeddable Boolean This value indicates whether the video can be embedded on another website.
ThumbnailsDefaultUrl String The URL of the default image.
DefaultLanguage String This column is confidential to trusted testers. The language of the text in the Title and Description columns.
DefaultAudioLanguage String The default_audio_language column specifies the language spoken in the default audio track of the video.
UploadStatus String The status of the uploaded video. Valid values for this column: deleted, failed, processed, rejected, uploaded.
FailureReason String This value explains why a video failed to upload. This column only has a value if the UploadStatus column indicates that the upload failed. Valid values for this column: codec, conversion, emptyFile, invalidFile, tooSmall, uploadAborted.
RejectionReason String This value explains why YouTube rejected an uploaded video. This column only has a value if the UploadStatus column indicates that the upload was rejected. Valid values for this column: claim, copyright, duplicate, inappropriate, length, termsOfUse, trademark, uploaderAccountClosed, uploaderAccountSuspended.
RecordingDate Datetime The date and time when the video was recorded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sssZ) format.
SearchTerms String The query term to search for.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
SafeSearch String Indicates whether the search results should include restricted content as well as standard content. Acceptable values: moderate, none, or strict.
EventType String The eventType parameter restricts a search to broadcast events. Acceptable values are: COMPLETED, LIVE, UPCOMING.

使用できる値は次のとおりです。COMPLETED, LIVE, UPCOMING

RelatedToVideoId String Retrieves a list of videos that are related to the video that the column value identifies.
VideoDuration String Filters video search results based on their duration. Acceptable values: any, long, medium or short.
VideoCategoryId String The videoCategoryId parameter identifies the video category for which the chart should be retrieved.
ForMine String Restricts the search to only retrieve videos owned by the authenticated user. It is false by default.
Language String Retrieve localized resource metadata for a specific application language that the YouTube website supports.
ForContentOwner String Restricts the search to only retrieve videos owned by the content owner specified by the OnBehalfOfContentOwner parameter.
OnBehalfOfContentOwner String This parameter is intended exclusively for YouTube content partners.

CData Cloud

OperatingSystems

Query YouTubeAnalytics Operating Systems statistics. This report aggregates viewing statistics based on viewers' operating systems. For example, it identifies the number of views that occurred on Android devices or on PlayStations.

Columns

Name Type Dimension DefaultMetric DefaultDimension Description
OperatingSystem String True This dimension identifies the software system of the device on which the view occurred. The allowed values are ANDROID, BADA, BLACKBERRY, DOCOMO, HIPTOP, IOS, LINUX, MACINTOSH, MEEGO, NINTENDO_3DS, OTHER, PLAYSTATION, PLAYSTATION_VITA, SMART_TV, SYMBIAN, WEBOS.
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.
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.
LiveOrOnDemand String True This dimension indicates whether the user activity metrics in the data row are associated with views of a live broadcast. Data for this dimension is available for dates beginning April 1, 2014. The allowed values are LIVE, ON_DEMAND.
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.
YoutubeProduct String True This dimension identifies the YouTube service on which the user activity occurred. Data for this dimension is available as of July 18, 2015. The allowed values are CORE, GAMING, KIDS, UNKNOWN.
Views Double True The number of times that a video was viewed.
EstimatedMinutesWatched Double The number of minutes that users watched videos for the specified channel, content owner, video, or playlist.
AverageViewDuration Double 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.
AverageTimeInPlaylist Double The estimated average amount of time, in minutes, that a viewer viewed videos in a playlist after the playlist was initiated. Note that this metric includes only playlist views that occurred on the web.
PlaylistAverageViewDuration Double The estimated average length, in seconds, watched per playlist view. Note that this metric represents the average length of views of individual videos within a playlist; the averageTimeInPlaylist metric, by contrast, represents the average time each viewer spends watching the playlist as a whole. This metric includes data for playlist videos that are owned by other channels.
PlaylistEstimatedMinutesWatched Double The number of minutes that users watched the playlist content as a part of the playlist. Watch time that occurred in other contexts?for example, watch time from views that occurred when viewers were watching the same video as part of other playlists?is not counted. This metric includes data for playlist videos that are owned by other channels.
PlaylistStarts Double The number of times that viewers initiated playback of a playlist. Note that this metric includes only playlist views that occurred on the web.
PlaylistViews Double The number of times that videos in the playlist were viewed in the context of that playlist. This metric includes data for playlist videos that are owned by other channels.
ViewsPerPlaylistStart Double The average number of video views that occurred each time a playlist was initiated.
Country String 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.
Province String 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 (filter only) A United Nations (U.N.) statistical region code: 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 (filter only) A U.N. statistical region code that identifies a geographical subregion.
Video String True The Id of a YouTube video.
Playlist String The Id of a YouTube playlist.
Group String (filter only) The Id of a YouTube Analytics group.
ClaimedStatus String (only used in content owner reports) This dimension lets you indicate that the result set will only contain metrics for claimed content. The allowed value is claimed.
UploaderType String (only used in content owner reports) This dimension lets you indicate whether the 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.
DeviceType String This dimension identifies the physical form factor of the device on which the view occurred. The allowed values are DESKTOP, GAME_CONSOLE, MOBILE, TABLET, TV, UNKNOWN_PLATFORM.
StartDate Date Start date for fetching Analytics data.
EndDate Date End date for fetching Analytics data.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

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

CData Cloud

PlayListItems

Query YouTube PlayListItems. A PlayListItem resource identifies another YouTube entity, such as a Video, that is included in a PlayList. In addition, the PlayListItem record contains details about how that entity is used in that PlayList.

Table Specific Information

Select

You must specify exactly one of the following columns in the WHERE clause: Id or PlayListId. Extra optional columns supported are OnBehalfOfContentOwner and VideoId.

All columns support the '=' operator.

SELECT * FROM PlaylistItems WHERE PlaylistId = 'abcdef123456'

Columns

Name Type Dimension DefaultMetric DefaultDimension Description
Id [KEY] String The Id that YouTube uses to uniquely identify the playlist item.
PublishedAt Datetime The date and time that the item was added to the playlist. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
ChannelId String The Id that YouTube uses to uniquely identify the user that added the item to the playlist.
Title String The title of the item.
Description String The description of the item.
ThumbnailsDefaultUrl String The URL of the item.
ChannelTitle String The channel title of the channel that the playlist item belongs to.
VideoOwnerChannelTitle String The channel title of the channel that uploaded this video.
VideoOwnerChannelId String The channel ID of the channel that uploaded this video.
PlaylistId String The Id that YouTube uses to uniquely identify the playlist that the playlist item is in.
Position String The order in which the item appears in the playlist. The value uses a zero-based index, so the first item has a position of 0, the second item has a position of 1, and so forth.
ResourceIdKind String The kind, or type, of the referred resource.
ResourceIdVideoId String If the ResourceIdKind value of the column is youtube#video, then this column will be present and its value will contain the Id that YouTube uses to uniquely identify the video in the playlist.
VideoId String The Id that YouTube uses to uniquely identify a video. To retrieve the video resource, set the Id column to this value.
Note String A user-generated note for this item.
VideoOwnerPublishedAt Datetime The date and time that the video was published to YouTube. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
PrivacyStatus String The privacy status of the playlist item.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
OnBehalfOfContentOwner String This parameter is intended exclusively for YouTube content partners.

CData Cloud

PlayLists

Query YouTube PlayLists. A PlayList is a collection of videos that can be viewed sequentially and shared with other users.

Table Specific Information

Select

The following filters are passed to YouTube Analytics if present. Other filters are executed client side.

By default, if no filters are specified, the CData Cloud will return all playlists for the channel owned by authenticated user.

YouTube Analytics allows only a subset of columns to be used as filter criteria. You can specify exactly one of the following columns: ChannelId or Id. Extra optional columns supported are PublishedAt, Language, OnBehalfOfContentOwner, and OnBehalfOfContentOwnerChannel.

A search against all channels in YouTube Analytics may be triggered by specifying one or more of SearchTerms, ForContentOwner, Region, SafeSearch, Rating and Rating to search all playlists.

All columns support the '=' operator. PublishedAt also supports these additional operators: '>', '>=', '<', and '<='.

Order by is supported for the Rating, Relevance, and Title columns.

SELECT * FROM PlayLists WHERE Id = 'abcdef123456'

SELECT title FROM PlayLists WHERE PublishedAt >= '2016-01-01' ORDER BY Title LIMIT 10

Note: Ordering is not supported when specifying one of the colums used for searching playlists such as SearchTerms.

Columns

Name Type Dimension DefaultMetric DefaultDimension Description
Id [KEY] String The Id that YouTube uses to uniquely identify the playlist.
PublishedAt Datetime The date and time that the playlist was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
ChannelId String The Id that YouTube uses to uniquely identify the channel that published the playlist.
Title String The title of the playlist.
Description String The description of the playlist.
ThumbnailsDefaultUrl String The URL of the image.
ChannelTitle String Channel title of the channel that the video belongs to.
DefaultLanguage String This column is confidential to trusted testers. The language of the text in the Title and Description columns.
LocalizedTitle String This column is confidential to trusted testers. The localized playlist title.
LocalizedDescription String This column is confidential to trusted testers. The localized playlist description.
PrivacyStatus String The privacy status of the playlist. Valid values for this column: private, public, unlisted.
VideoCount Integer The number of videos in the playlist.
EmbedHtml String An iframe tag that embeds a player that will play the playlist.
SearchTerms String The SearchTerms parameter specifies the query term to search for.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
Language String A value of hl instructs the API to retrieve localized resource metadata for a specific application language that the YouTube supports.
OnBehalfOfContentOwner String This parameter is intended exclusively for YouTube content partners.
OnBehalfOfContentOwnerChannel String Specifies the YouTube channel Id of the channel to which a video is being added.
ForContentOwner String Restricts the search to only retrieve playlists owned by the content owner specified by the OnBehalfOfContentOwner column.
Region String Instructs the API to return search results for the specified country.
SafeSearch String Indicates whether the search results should include restricted content as well as standard content. Valid values: moderate, none, or strict.
Rating String Specifies that playlists are sorted from highest to lowest rating.

CData Cloud

Regions

Query YouTube i18nRegions. An i18nRegion resource identifies a geographic area that a YouTube user can select as the preferred content region. The content region can also be referred to as a content locale.

Table Specific Information

Select

There are no required filters for this table. An optional column supported is Language.

All columns support the '=' operator.

Columns

Name Type Dimension DefaultMetric DefaultDimension Description
Id [KEY] String The Id that YouTube uses to uniquely identify the i18n region.
Country String The two-letter ISO country code that identifies the region.
Name String The name of the region.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
Language String The hl parameter specifies the language that should be used for text values in the API response. The default value is en_US.

CData Cloud

Subscriptions

Query YouTube User Subscriptions. A Subscription notifies a User when new Videos are added to a Channel, or when another user takes one of several actions on YouTube, such as uploading a Video, rating a Video, or commenting on a Video.

Table Specific Information

Select

You can specify exactly one of the following columns: ChannelId, Id, MyRecentSubscribers, or MySubscribers.

Extra optional columns supported are ForChannelId, OnBehalfOfContentOwner, and OnBehalfOfContentOwnerChannel. All columns support the '=' operator.

Order is supported for Subscriptions. 'Alphabetical', 'Relevance', and 'Unread' are the supported order columns.

By default, if no filters are specified, the driver will return a list of channels subscribed by authenticated user.

SELECT Title FROM Subscriptions WHERE ChannelId = 'abc123' ORDER BY Unread DESC

The default value is SUBSCRIPTION_ORDER_RELEVANCE.

Columns

Name Type Dimension DefaultMetric DefaultDimension Description
Id [KEY] String The Id that YouTube uses to uniquely identify the subscription.
PublishedAt Datetime The date and time that the subscription was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
ChannelTitle String The title of the channel that the subscription belongs to.
Title String The title of the subscription.
Description String The details of the subscription.
ResourceIdKind String The type of the API resource.
ResourceIdChannelId String The value that YouTube uses to uniquely identify the channel that the user subscribed to.
ChannelId String The Id that YouTube uses to uniquely identify the channel of the subscriber.
ThumbnailsDefaultUrl String The URL of the default image.
TotalItemCount Integer The approximate number of items that the subscription points to.
NewItemCount Integer The number of new items in the subscription since its content was last read.
ActivityType String The type of activity this subscription is for. Valid values: all, uploads.
SubscriberTitle String The title of the channel of the subscriber.
SubscriberDescription String The description of the channel of the subscriber.
SubscriberChannelId String The Id that YouTube assigns to uniquely identify the channel of the subscriber.
SubscriberThumbnailsDefaultUrl String The URL of the default image.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
MySubscribers String Set this value of this parameter to true to retrieve a feed of the subscribers of the authenticated user.
ForChannelId String The ForChannelId column specifies a comma-separated list of channel Ids.
OnBehalfOfContentOwner String This column is intended exclusively for YouTube content partners.
OnBehalfOfContentOwnerChannel String Specifies the YouTube ChannelId of the channel to which a video is being added.
Alphabetical String Sort alphabetically
Relevance String Sort by relevance.
Unread String Sort by order of activity.

CData Cloud

TimeBasedReports

Query time-based info on views, subscribers, etc. For example, how many new subscribers were gained at a specific time.

テーブル固有の情報

Select Rules

次のテーブルを使用してTimeBased レポートへのクエリを作成できます。 動画のTimeBased レポート:

ディメンション 0または1つ使用 day、month、video
指標 1つ以上使用 views、comments、likes、dislikes、videosAddedToPlaylists、videosRemovedFromPlaylists、shares、estimatedMinutesWatched、averageViewDuration、averageViewPercentage、annotationClickThroughRate、annotationCloseRate、annotationImpressions、annotationClickableImpressions、annotationClosableImpressions、annotationClicks、annotationCloses、subscribersGained、subscribersLost、uniques、earnings、adEarnings、grossRevenue、redPartnerRevenue、monetizedPlaybacks、playbackBasedCpm、impressions、impressionBasedCpm
フィルタ 0または1つ使用 country
0または1つ使用 video、group

再生リストルールのTimeBased レポート:

ディメンション 1つだけ使用 day、month
オプション creatorContentType
0または1つ以上使用 subscribedStatus、youtubeProduct
指標 1つ以上使用 views、estimatedMinutesWatched、averageViewDuration、playlistStarts、viewsPerPlaylistStart、averageTimeInPlaylist
フィルタ 必須 isCurated=true
0または1つ使用 country、province
0または1つ使用 playlist、channel、group
0または1つ以上使用 subscribedStatus、youtubeProduct

コンテンツ所有者ルールのTimebased レポート:

ディメンション 1つだけ使用 day、month
オプション creatorContentType
指標 1つ以上使用 views、comments、likes、dislikes、videosAddedToPlaylists、videosRemovedFromPlaylists、shares、estimatedMinutesWatched、averageViewDuration、averageViewPercentage、annotationClickThroughRate、annotationCloseRate、annotationImpressions、annotationClickableImpressions、annotationClosableImpressions、annotationClicks、annotationCloses、subscribersGained、subscribersLost、uniques、earnings、adEarnings、grossRevenue、redPartnerRevenue、monetizedPlaybacks、playbackBasedCpm、impressions、impressionBasedCpm
フィルタ 1つだけ使用 video、channel、group
0または1つ使用 country

コンテンツ所有者の再生リストルールのTimebased レポート:

ディメンション 1つだけ使用 day、month
0または1つ以上使用 subscribedStatus、youtubeProduct
指標 1つ以上使用 views、estimatedMinutesWatched、averageViewDuration、playlistStarts、viewsPerPlaylistStart、averageTimeInPlaylis
フィルタ 必須 isCurated=true
0または1つ使用 country、province
0または1つ使用 playlist、channel、group
0または1つ以上使用 subscribedStatus、youtubeProduct

Columns

Name Type Dimension DefaultMetric DefaultDimension Description
Day String True 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.
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.
Views Double 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.
RedViews Double True The number of times that a video was viewed by YouTube Premium (previously known as YouTube Red) members.
Comments Double True The number of times that users commented on a video.
Likes Double True The number of times that users indicated that they liked a video by giving it a positive rating.
Dislikes Double True The number of times that users indicated that they disliked a video by giving it a negative rating. This is a core metric and is subject to the Deprecation Policy.
VideosAddedToPlaylists Double True The number of times that videos were added to the video owner playlist or other channel playlists like the Watch Later playlist. Channel uploads playlists and user watch history are not reported. This metric returns an absolute number, meaning that if a user adds a video to a playlist, removes it, and then adds it again, the metric value reflects the video being added to a playlist twice. Data for this metric is not available for dates before October 1, 2014.
VideosRemovedFromPlaylists Double True The number of times that videos were removed from the video owner playlist and other YouTube playlists like the Watch Later playlist. This metric returns an absolute number, meaning that if a user adds a video to a playlist, removes it, adds it again, and then removes it again, the metric value reflects the video being removed from a playlist twice. Data for this metric is not available for dates before October 1, 2014.
Shares Double True The number of times that users shared a video through the Share button.
EstimatedMinutesWatched Double True The number of minutes that users watched videos for the specified channel, content owner, video, or playlist.
EstimatedRedMinutesWatched Double True The number of minutes that YouTube Premium (previously known as YouTube Red) members watched a video.
AverageViewDuration Double True The average length, in seconds, of video playbacks. In a playlist report, the metric indicates the average length, in seconds, of video playbacks that occurred in the context of a playlist.
AverageTimeInPlaylist Double The estimated average amount of time, in minutes, that a viewer viewed videos in a playlist after the playlist was initiated.
AverageViewPercentage Double True The average percentage of a video watched during a video playback.
AnnotationClickThroughRate Double True The ratio of annotations that viewers clicked to the total number of clickable annotation impressions.
AnnotationCloseRate Double True The ratio of annotations that viewers closed to the total number of annotation impressions.
AnnotationImpressions Double True The total number of annotation impressions.
AnnotationClickableImpressions Double True The number of annotations that appeared and could be clicked.
AnnotationClosableImpressions Double True The number of annotations that appeared and could be closed.
AnnotationClicks Double True The number of clicked annotations.
AnnotationCloses Double True The number of closed annotations.
CardClickRate Double True The click-through-rate for cards, which is calculated as the ratio of card clicks to card impressions.
CardTeaserClickRate Double True The click-through-rate for card teasers, which is calculated as the ratio of clicks on card teasers to the total number of card teaser impressions.
CardImpressions Double True The number of times cards were displayed. When the card panel is opened, a card impression is logged for each of the video's cards.
CardTeaserImpressions Double True The number of times that card teasers were displayed. A video view can generate multiple teaser impressions.
CardClicks Double True The number of times that cards were clicked.
CardTeaserClicks Double True The number of clicks on card teasers. Card icon clicks are attributed to the last teaser displayed to the user.
SubscribersGained Double True The number of times that users subscribed to a channel or video.
SubscribersLost Double True The number of times that users unsubscribed from a channel or video.
EstimatedRevenue Decimal The total estimated earnings (net revenue) from all Google-sold advertising sources as well as from nonadvertising sources for the selected date range and region. Estimated earnings are subject to month-end adjustment and do not include partner-sold and partner-served advertising.
EstimatedAdRevenue Decimal The total estimated earnings (net revenue) from all Google-sold advertising sources for the selected date range and region. Estimated earnings are subject to month-end adjustment and do not include partner-sold and partner-served advertising.
GrossRevenue Decimal The estimated gross revenue, in USD, from all Google-sold or DoubleClick-partner-sold advertising for the selected date range and region. Gross revenue is subject to month-end adjustment and does not include partner-served advertising. Gross revenue should not be confused with earnings, or net revenue, which factors in your share of ownership and revenue-sharing agreements.
EstimatedRedPartnerRevenue Decimal The total estimated revenue earned from YouTube Red subscriptions for the selected report dimensions. The value of the metric reflects earnings from both music and nonmusic content and is subject to month-end adjustment.
MonetizedPlaybacks Double The number of instances when a viewer played your video and was shown at least one ad impression. A monetized playback is counted if a viewer is shown a preroll ad but quits watching the ad before your video ever starts. The expected estimated error for this figure is ?2.0%.
PlaybackBasedCpm Decimal The estimated gross revenue per thousand playbacks.
AdImpressions Double The number of verified ad impressions served.
Cpm Decimal The estimated gross revenue per thousand ad impressions.
PlaylistAverageViewDuration Double The estimated average length, in seconds, watched per playlist view. Note that this metric represents the average length of views of individual videos within a playlist; the averageTimeInPlaylist metric, by contrast, represents the average time each viewer spends watching the playlist as a whole. This metric includes data for playlist videos that are owned by other channels.
PlaylistEstimatedMinutesWatched Double The number of minutes that users watched the playlist content as a part of the playlist. Watch time that occurred in other contexts?for example, watch time from views that occurred when viewers were watching the same video as part of other playlists?is not counted. This metric includes data for playlist videos that are owned by other channels.
PlaylistSaves Double The net number of times that users saved a playlist. This metric returns a net change number, meaning that if a user saves a playlist, removes it from the list of saved playlists, and saves it again, the metric value reflects one playlist save being added.
PlaylistStarts Double The number of times that viewers initiated playback of a playlist. Note that this metric includes only playlist views that occurred on the web.
PlaylistViews Double The number of times that videos in the playlist were viewed in the context of that playlist. This metric includes data for playlist videos that are owned by other channels.
ViewsPerPlaylistStart Double The average number of video views that occurred each time a playlist was initiated.
Video String True The Id of a YouTube video.
Playlist String The Id of a YouTube playlist.
Group String (filter only) The Id of a YouTube Analytics group.
Country String 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.
UploaderType String (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.
ClaimedStatus String (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.
Channel String (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.
StartDate Date Start date for fetching Analytics data.
EndDate Date End date for fetching Analytics data.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

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

CData Cloud

TopPlaylists

Query the TopPlaylists for a channel. You can also use this view to query playback detail and geographic filters.

Columns

Name Type Dimension DefaultMetric DefaultDimension Description
Playlist String True True The Id of a YouTube playlist.
AverageTimeInPlaylist Double The estimated average amount of time, in minutes, that a viewer viewed videos in a playlist after the playlist was initiated. Note that this metric includes only playlist views that occurred on the web.
PlaylistAverageViewDuration Double The estimated average length, in seconds, watched per playlist view. Note that this metric represents the average length of views of individual videos within a playlist; the averageTimeInPlaylist metric, by contrast, represents the average time each viewer spends watching the playlist as a whole. This metric includes data for playlist videos that are owned by other channels.
PlaylistEstimatedMinutesWatched Double The number of minutes that users watched the playlist content as a part of the playlist. Watch time that occurred in other contexts?for example, watch time from views that occurred when viewers were watching the same video as part of other playlists?is not counted. This metric includes data for playlist videos that are owned by other channels.
PlaylistSaves Double The net number of times that users saved a playlist. This metric returns a net change number, meaning that if a user saves a playlist, removes it from the list of saved playlists, and saves it again, the metric value reflects one playlist save being added.
PlaylistStarts Double The number of times that viewers initiated playback of a playlist. Note that this metric includes only playlist views that occurred on the web.
PlaylistViews Double The number of times that videos in the playlist were viewed in the context of that playlist. This metric includes data for playlist videos that are owned by other channels.
ViewsPerPlaylistStart Double The average number of video views that occurred each time a playlist was initiated.
StartDate Date Start date for fetching Analytics data. Either a date string or a relative date (e.g., today, yesterday, or #daysAgo).
EndDate Date End date for fetching Analytics data. Either a date string or a relative date (e.g., today, yesterday, or #daysAgo).

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

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

CData Cloud

TopVideos

Query the TopVideos for a channel. You can also use this view to query playback detail and geographic filters.

テーブル固有の情報

Select

次のクエリは、チャンネルのトップ動画を返します。

SELECT * FROM TopVideos

次のクエリは、特定の国でほとんどが視聴されたチャンネルのトップ動画を返します。

SELECT Video, Views, EstimatedMinutesWatched, AverageViewDuration, AverageViewPercentage FROM TopVideos WHERE Country = 'US'

次のクエリは、ほとんどが視聴されたチャンネルのトップ再生リストを返します。

SELECT Playlist, Views, EstimatedMinutesWatched, PlaylistStarts, AverageViewDuration FROM TopVideos WHERE IsCurated = true

Select Rules

次のテーブルを使用してトップ動画への他のクエリを作成できます。

動画のトップ動画:

ディメンション 必須 video
オプション creatorContentType
指標 1つ以上使用 views、comment、likes、dislikes、videosAddedToPlaylists、videosRemovedFromPlaylists、shares、estimatedMinutesWatched、averageViewDuration、averageViewPercentage、annotationClickThroughRate、annotationCloseRate、annotationImpressions、annotationClickableImpressions、annotationClosableImpressions、annotationClicks、annotationClose、subscribersGained、subscribersLost
フィルタ 0または1つ使用 country
Sort 0または1つ以上使用(降順のみ) views、estimatedMinutesWatched、subscribersGained、subscribersLost

再生リストのトップ動画:

ディメンション 必須 playlist
指標 1つ以上使用 views、estimatedMinutesWatched、averageViewDuration、playlistStarts、viewsPerPlaylistStart、averageTimeInPlaylist
フィルタ 必須 isCurated=true
0または1つ使用 country、province
0または1つ以上使用 playlist、subscribedStatus、youtubeProduct
Sort 0または1つ以上使用(降順のみ) views、estimatedMinutesWatched、playlistStarts

コンテンツ所有者のトップ動画:

ディメンション 必須 video
オプション creatorContentType
指標 1つ以上使用 views、comments、likes、dislikes、videosAddedToPlaylists、videosRemovedFromPlaylists、shares、estimatedMinutesWatched、averageViewDuration、averageViewPercentage、annotationClickThroughRate、annotationCloseRate、annotationImpressions、annotationClickableImpressions、annotationClosableImpressions、annotationClicks、annotationCloses、subscribersGained、subscribersLost、earnings、adEarnings、grossRevenue、redPartnerRevenue、monetizedPlaybacks、playbackBasedCpm、impressions、impressionBasedCpm
フィルタ 1つだけ使用 channel
0または1つ使用 country
Sort 0または1つ以上使用(降順のみ) views、earnings、redPartnerRevenue、estimatedMinutesWatched、subscribersGained、subscribersLost

コンテンツ所有者の再生リストのトップ動画:

ディメンション 必須 playlist
指標 1つ以上使用 views、estimatedMinutesWatched、averageViewDuration、playlistStarts、viewsPerPlaylistStart、averageTimeInPlaylist
フィルタ 必須 isCurated=true
0または1つ使用 playlist、channel
0または1つ使用 country、province
0または1つ以上使用 subscribedStatus、youtubeProduct
Sort 0または1つ以上使用(降順のみ) views、estimatedMinutesWatched、playlistStarts

Columns

Name Type Dimension DefaultMetric DefaultDimension Description
Video String True True The Id of a YouTube video.
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.
Views Double 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.
RedViews Double True The number of times that a video was viewed by YouTube Premium (previously known as YouTube Red) members.
Comments Double True The number of times that users commented on a video.
Likes Double True The number of times that users indicated that they liked a video by giving it a positive rating.
Dislikes Double True The number of times that users indicated that they disliked a video by giving it a negative rating. This is a core metric and is subject to the Deprecation Policy.
VideosAddedToPlaylists Double True The number of times that videos were added to the video owner playlist or other channel playlists like the Watch Later playlist. Channel uploads playlists and user watch history are not reported. This metric returns an absolute number, meaning that if a user adds a video to a playlist, removes it, and then adds it again, the metric value reflects the video being added to a playlist twice. Data for this metric is not available for dates before October 1, 2014.
VideosRemovedFromPlaylists Double True The number of times that videos were removed from the video owner playlist and other YouTube playlists like the Watch Later playlist. This metric returns an absolute number, meaning that if a user adds a video to a playlist, removes it, adds it again, and then removes it again, the metric value reflects the video being removed from a playlist twice. Data for this metric is not available for dates before October 1, 2014.
Shares Double True The number of times that users shared a video through the Share button.
EstimatedMinutesWatched Double True The number of minutes that users watched videos for the specified channel, content owner, video, or playlist.
EstimatedRedMinutesWatched Double True The number of minutes that YouTube Premium (previously known as YouTube Red) members watched a video.
AverageViewDuration Double True The average length, in seconds, of video playbacks. 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 True The average percentage of a video watched during a video playback.
AnnotationClickThroughRate Double True The ratio of annotations that viewers clicked to the total number of clickable annotation impressions.
AnnotationCloseRate Double True The ratio of annotations that viewers closed to the total number of annotation impressions.
AnnotationImpressions Double True The total number of annotation impressions.
AnnotationClickableImpressions Double True The number of annotations that appeared and could be clicked.
AnnotationClosableImpressions Double True The number of annotations that appeared and could be closed.
AnnotationClicks Double True The number of clicked annotations.
AnnotationCloses Double True The number of closed annotations.
CardClickRate Double True The click-through-rate for cards, which is calculated as the ratio of card clicks to card impressions.
CardTeaserClickRate Double True The click-through-rate for card teasers, which is calculated as the ratio of clicks on card teasers to the total number of card teaser impressions.
CardImpressions Double True The number of times cards were displayed. When the card panel is opened, a card impression is logged for each of the video's cards.
CardTeaserImpressions Double True The number of times that card teasers were displayed. A video view can generate multiple teaser impressions.
CardClicks Double True The number of times that cards were clicked.
CardTeaserClicks Double True The number of clicks on card teasers. Card icon clicks are attributed to the last teaser displayed to the user.
SubscribersGained Double True The number of times that users subscribed to a channel or video.
SubscribersLost Double True The number of times that users unsubscribed from a channel or video.
EstimatedRevenue Decimal The total estimated earnings (net revenue) from all Google-sold advertising sources as well as from nonadvertising sources for the selected date range and region. Estimated earnings are subject to month-end adjustment and do not include partner-sold and partner-served advertising.
EstimatedAdRevenue Decimal The total estimated earnings (net revenue) from all Google-sold advertising sources for the selected date range and region. Estimated earnings are subject to month-end adjustment and do not include partner-sold and partner-served advertising.
GrossRevenue Decimal The estimated gross revenue, in USD, from all Google-sold or DoubleClick-partner-sold advertising for the selected date range and region. Gross revenue is subject to month-end adjustment and does not include partner-served advertising. Gross revenue should not be confused with earnings, or net revenue, which factors in your share of ownership and revenue-sharing agreements.
EstimatedRedPartnerRevenue Decimal The total estimated revenue earned from YouTube Red subscriptions for the selected report dimensions. The value of the metric reflects earnings from both music and nonmusic content and is subject to month-end adjustment.
MonetizedPlaybacks Double The number of instances when a viewer played your video and was shown at least one ad impression. A monetized playback is counted if a viewer is shown a preroll ad but quits watching the ad before your video ever starts. The expected estimated error for this figure is ?2.0%.
PlaybackBasedCpm Decimal The estimated gross revenue per thousand playbacks.
AdImpressions Double The number of verified ad impressions served.
Cpm Decimal The estimated gross revenue per thousand ad impressions.
Channel String (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.
UploaderType String (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.
ClaimedStatus String (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.
SubscribedStatus String 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. Possible values are SUBSCRIBED and UNSUBSCRIBED. Note that the dimension value is accurate as of the time that the user activity occurs.
Country String 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.
StartDate Date Start date for fetching Analytics data. Either a date string or a relative date (e.g., today, yesterday, or #daysAgo).
EndDate Date End date for fetching Analytics data. Either a date string or a relative date (e.g., today, yesterday, or #daysAgo).

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

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

CData Cloud

TrafficSources

Query TrafficSources. Statistics are based on the manner in which viewers reached your video and playlist content.

テーブル固有の情報

Select

次のクエリは、視聴者が動画コンテンツに達した方法に基づいて統計情報を集計します。例えば、Google 検索や関連動画へのリンクからのビューの数を特定できます。

SELECT * FROM TrafficSources

次のクエリは、Day およびInsightTrafficSourceType ディメンションでグループ化されたViews およびEstimatedMinutesWatched 指標を表示します。

SELECT Day, InsightTrafficSourceType, Views, EstimatedMinutesWatched FROM TrafficSources

次のクエリは、特定の動画および国で集計される統計をフィルタリングします。

SELECT Day, InsightTrafficSourceType, Views, EstimatedMinutesWatched FROM TrafficSources WHERE Video = 'video_id' AND Country = 'US'

次のクエリは、視聴者が再生リストコンテンツに達した方法に基づいて統計情報を集計します。例えば、Google 検索からのビューの数を特定できます。

SELECT InsightTrafficSourceType, Views, EstimatedMinutesWatched, PlaylistStarts, ViewsPerPlaylistStart, AverageTimeInPlaylist FROM TrafficSources WHERE IsCurated = true

次のクエリは、再生リストにある動画のYouTube 検索結果から最も多くの視聴回数を生成した検索用語を返します。YouTube Analytics API の制限により、このようなクエリには順序付けと制限が必須であることに注意してください。

SELECT InsightTrafficSourceDetail, Views, EstimatedMinutesWatched, PlaylistStarts, ViewsPerPlaylistStart, AverageTimeInPlaylist FROM TrafficSources WHERE IsCurated = true AND InsightTrafficSourceType = 'YT_SEARCH' ORDER BY Views DESC LIMIT 25

Select Rules

次のテーブルを使用してトラフィックソースへの他のクエリを作成できます。

動画のトラフィックソース:

ディメンション 1つだけ使用 insightTrafficSourceType、insightTrafficSourceDetail
0または1つ以上使用 creatorContentType、day、liveOrOnDemand、subscribedStatus
指標 1つ以上使用 views、estimatedMinutesWatched
フィルタ 0または1つ使用 country、province、continent、subContinent
0または1つ使用 video、group
0または1つ以上使用 liveOrOnDemand、subscribedStatus
Sort 0または1つ以上使用(降順のみ) views、estimatedMinutesWatched

再生リストのトラフィックソース:

ディメンション 1つだけ使用 insightTrafficSourceType、insightTrafficSourceDetail
0または1つ以上使用 day、subscribedStatus
指標 1つ以上使用 views、estimatedMinutesWatched、playlistStarts、viewsPerPlaylistStart、averageTimeInPlaylist
フィルタ Required isCurated=true
0または1つ使用 country、province、continent、subContinent
0または1つ使用 playlist、channel、group
オプション subscribedStatus
Sort 0または1つ以上使用(降順のみ) views、estimatedMinutesWatched、playlistStarts

コンテンツ所有者のトラフィックソース:

ディメンション 必須 insightTrafficSourceType
0または1つ以上使用 creatorContentType、day、liveOrOnDemand、subscribedStatus
指標 1つ以上使用 views、estimatedMinutesWatched
フィルタ 1つだけ使用 video、channel、group
0または1つ使用 country、province、continent、subContinent
0または1つ以上使用 liveOrOnDemand、subscribedStatus

コンテンツ所有者の再生リストのトラフィックソース:

ディメンション 必須 insightTrafficSourceType
0または1つ以上使用 day、subscribedStatus
指標 1つ以上使用 views、estimatedMinutesWatched、playlistStarts、viewsPerPlaylistStart、averageTimeInPlaylist
フィルタ 必須 isCurated=true
0または1つ使用 country、province、continent、subContinent
0または1つ使用 playlist、channel、group
オプション subscribedStatus

Columns

Name Type Dimension DefaultMetric DefaultDimension Description
InsightTrafficSourceType String True True Data in the report is aggregated based on the referrer type, which describes the manner in which users reached the video. The allowed values are ADVERTISING, ANNOTATION, EXT_URL, NO_LINK_EMBEDDED, NO_LINK_OTHER, NOTIFICATION, PLAYLIST, PROMOTED, RELATED_VIDEO, SUBSCRIBER, YT_CHANNEL, YT_OTHER_PAGE, YT_SEARCH.
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.
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.
LiveOrOnDemand String True This dimension indicates whether the user activity metrics in the data row are associated with views of a live broadcast. Data for this dimension is available for dates beginning April 1, 2014. The allowed values are LIVE, ON_DEMAND.
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.
Views Double 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 True The number of minutes that users watched videos for the specified channel, content owner, video, or playlist.
AverageViewDuration Double 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.
AverageTimeInPlaylist Double The estimated average amount of time, in minutes, that a viewer viewed videos in a playlist after the playlist was initiated. Note that this metric includes only playlist views that occurred on the web.
PlaylistAverageViewDuration Double The estimated average length, in seconds, watched per playlist view. Note that this metric represents the average length of views of individual videos within a playlist; the averageTimeInPlaylist metric, by contrast, represents the average time each viewer spends watching the playlist as a whole. This metric includes data for playlist videos that are owned by other channels.
PlaylistEstimatedMinutesWatched Double The number of minutes that users watched the playlist content as a part of the playlist. Watch time that occurred in other contexts?for example, watch time from views that occurred when viewers were watching the same video as part of other playlists?is not counted. This metric includes data for playlist videos that are owned by other channels.
PlaylistSaves Double The net number of times that users saved a playlist. This metric returns a net change number, meaning that if a user saves a playlist, removes it from the list of saved playlists, and saves it again, the metric value reflects one playlist save being added.
PlaylistStarts Double The number of times that viewers initiated playback of a playlist. Note that this metric includes only playlist views that occurred on the web.
PlaylistViews Double The number of times that videos in the playlist were viewed in the context of that playlist. This metric includes data for playlist videos that are owned by other channels.
ViewsPerPlaylistStart Double The average number of video views that occurred each time a playlist was initiated.
Country String 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.
Province String 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 (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 (filter only) A U.N. statistical region code that identifies a geographical subregion.
Video String True The Id of a YouTube video.
Playlist String The Id of a YouTube playlist.
Group String (filter only) The Id of a YouTube Analytics group.
Channel String (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.
UploaderType String (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.
ClaimedStatus String (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.
StartDate Date Start date for fetching Analytics data.
EndDate Date End date for fetching Analytics data.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

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

CData Cloud

UserActivityByCity

This report provides user activity statistics by city.

テーブル固有の情報

Select Rules

都市別のユーザーアクティビティをクエリするには、maxResults を250以下の整数値に設定する必要があります。 また、ソートリクエストパラメータにも値を指定する必要があります。

Video レポート:

ディメンション 必須 city
0または1つ以上使用 creatorContentType、country、province、subscribedStatus

Note: province ディメンションを含める場合は、country==US フィルタも使用する必要があります。
0または1つ使用 day、month
指標 1つ以上使用 views、estimatedMinutesWatched、averageViewDuration、averageViewPercentage
フィルタ 0または1つ使用 country、province
0または1つ使用 video、group
ソートオプション: -views
-estimatedMinutesWatched


コンテンツ所有者レポート:

ディメンション 必須 city
0または1つ以上使用 creatorContentType、country、province、subscribedStatus
Note: province ディメンションを含める場合は、country==US フィルタも使用する必要があります。
0または1つ使用 day、month
指標 1つ以上使用 views、estimatedMinutesWatched、averageViewDuration、averageViewPercentage
フィルタ 1つだけ使用 video、channel、group、またはuploaderType とclaimedStatus のサポートされている組み合わせ
0または1つ使用 country、province
ソートオプション -views
-estimatedMinutesWatched

Columns

Name Type Dimension DefaultMetric DefaultDimension Description
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.
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.
Country String True 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.
Province String True 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.
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.
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.
Views Double 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 The number of minutes that users watched videos for the specified channel, content owner, video, or playlist.
AverageViewDuration Double 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 The average percentage of a video watched during a video playback. As of December 13, 2021, this metric excludes looping clips traffic.
Channel String (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 (filter only) The Id of a YouTube Analytics group.
ClaimedStatus String (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 (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.
StartDate Date Start date for fetching Analytics data.
EndDate Date End date for fetching Analytics data.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

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

CData Cloud

UserActivityByCountry

This report provides user activity statistics.

テーブル固有の情報

Select Rules

国別のユーザーアクティビティは、特定の動画のデータを返すためにのみフィルタリングすることができます。

Video レポート:

ディメンション 必須 country
オプション creatorContentType
指標 1つ以上使用 views、redViews、comments、likes、dislikes、videosAddedToPlaylists、videosRemovedFromPlaylists、shares、estimatedMinutesWatched、estimatedRedMinutesWatched、averageViewDuration、averageViewPercentage、annotationClickThroughRate、annotationCloseRate、annotationImpressions、annotationClickableImpressions、annotationClosableImpressions、annotationClicks、annotationCloses, cardClickRate、cardTeaserClickRate、cardImpressions、cardTeaserImpressions、cardClicks、cardTeaserClicks、subscribersGained、subscribersLost、estimatedRevenue*、estimatedAdRevenue*、grossRevenue*、estimatedRedPartnerRevenue*、monetizedPlaybacks*、playbackBasedCpm*、adImpressions*、cpm*
0または1つ使用 video、group


Playlist レポート:

ディメンション 必須 country
0または1つ以上使用 subscribedStatus、youtubeProduct
指標 1つ以上使用 views、redViews、estimatedMinutesWatched、estimatedRedMinutesWatched、averageViewDuration、playlistStarts、viewsPerPlaylistStart、averageTimeInPlaylist
フィルタ 必須 isCurated==1
0または1つ使用 playlist、group
0または1つ以上使用 subscribedStatus、youtubeProduct


コンテンツ所有者レポート:

ディメンション 必須 country
オプション creatorContentType
指標 1つ以上使用 views、redViews、comments、likes、dislikes、videosAddedToPlaylists、videosRemovedFromPlaylists、shares、estimatedMinutesWatched、estimatedRedMinutesWatched、averageViewDuration、averageViewPercentage、annotationClickThroughRate、annotationCloseRate、annotationImpressions、annotationClickableImpressions、annotationClosableImpressions、annotationClicks、annotationCloses, cardClickRate、cardTeaserClickRate、cardImpressions、cardTeaserImpressions、cardClicks、cardTeaserClicks、subscribersGained、subscribersLost、estimatedRevenue*、estimatedAdRevenue*、grossRevenue*、estimatedRedPartnerRevenue*、monetizedPlaybacks*、playbackBasedCpm*、adImpressions*、cpm*
フィルタ 1つだけ使用 video、channel、group、またはuploaderType とclaimedStatus のサポートされている組み合わせ

Columns

Name Type Dimension DefaultMetric DefaultDimension Description
Country String True True 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.
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.
Views Double 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.
RedViews Double The number of times that a video was viewed by YouTube Premium (previously known as YouTube Red) members.
Likes Double The number of times that users indicated that they liked a video by giving it a positive rating.
Comments Double The number of times that users commented on a video.
Dislikes Double The number of times that users indicated that they disliked a video by giving it a negative rating.
VideosAddedToPlaylists Double The number of times that videos were added to any YouTube playlists. The videos could have been added to the video owner's playlist or to other channels' playlists.
VideosRemovedFromPlaylists Double The number of times that videos were removed from any YouTube playlists. The videos could have been removed from the video owner's playlist or from other channels' playlists.
Shares Double The number of times that users shared a video through the Share button.
EstimatedMinutesWatched Double The number of minutes that users watched videos for the specified channel, content owner, video, or playlist.
EstimatedRedMinutesWatched Double The number of minutes that YouTube Premium (previously known as YouTube Red) members watched a video.
AverageViewDuration Double 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 The average percentage of a video watched during a video playback.
AnnotationClickThroughRate Double The ratio of annotations that viewers clicked to the total number of clickable annotation impressions.
AnnotationCloseRate Double The ratio of annotations that viewers closed to the total number of annotation impressions.
AnnotationImpressions Double The total number of annotation impressions.
AnnotationClickableImpressions Double The number of annotations that appeared and could be clicked.
AnnotationClosableImpressions Double The number of annotations that appeared and could be closed.
AnnotationClicks Double The number of clicked annotations.
AnnotationCloses Double The number of closed annotations.
CardClickRate Double The click-through-rate for cards, which is calculated as the ratio of card clicks to card impressions.
CardTeaserClickRate Double The click-through-rate for card teasers, which is calculated as the ratio of clicks on card teasers to the total number of card teaser impressions.
CardImpressions Double The number of times cards were displayed. When the card panel is opened, a card impression is logged for each of the video's cards.
CardTeaserImpressions Double The number of times that card teasers were displayed. A video view can generate multiple teaser impressions.
CardClicks Double The number of times that cards were clicked.
CardTeaserClicks Double The number of clicks on card teasers. Card icon clicks are attributed to the last teaser displayed to the user.
SubscribersGained Double The number of times that users subscribed to a channel.
SubscribersLost Double The number of times that users unsubscribed from a channel.
EstimatedRevenue Double The total estimated net revenue from all Google-sold advertising sources as well as from non-advertising sources for the selected date range and region.
EstimatedAdRevenue Double The total estimated net revenue from all Google-sold advertising sources for the selected date range and region.
GrossRevenue Double The estimated gross revenue, in USD, from all Google-sold or DoubleClick-partner-sold advertising for the selected date range and region. Gross revenue is subject to month-end adjustment and does not include partner-served advertising. Gross revenue should not be confused with estimated revenue, or net revenue, which factors in your share of ownership and revenue-sharing agreements.
EstimatedRedPartnerRevenue Double The total estimated revenue earned from YouTube Premium (previously known as YouTube Red) subscriptions for the selected report dimensions. The metric's value reflects revenue from both music and non-music content and is subject to month-end adjustment.
MonetizedPlaybacks Double The number of instances when a viewer played your video and was shown at least one ad impression. A monetized playback is counted if a viewer is shown a preroll ad but quits watching the ad before your video ever starts. The expected estimated error for this figure is ?2.0%.
PlaybackBasedCpm Double The estimated gross revenue per thousand playbacks.
AdImpressions Double The number of verified ad impressions served.
CPM Double The estimated gross revenue per thousand ad impressions.
Channel String (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.
Playlist String The Id of a YouTube playlist.
Group String (filter only) The Id of a YouTube Analytics group.
StartDate Date Start date for fetching Analytics data.
EndDate Date End date for fetching Analytics data.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

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

CData Cloud

UserActivityByProvince

This report provides user activity statistics, sorted by province (includes Washington DC).

テーブル固有の情報

Select Rules

州別のユーザーアクティビティは、米国の州およびコロンビア特別区に適用されます。province を使用するには、filters パラメータ値をcountry==US に設定する必要があります。

Video レポート:

ディメンション 必須 province
オプション creatorContentType
指標 1つ以上使用 views、redViews、estimatedMinutesWatched、estimatedRedMinutesWatched、averageViewDuration、averageViewPercentage、annotationClickThroughRate、annotationCloseRate、annotationImpressions、annotationClickableImpressions、annotationClosableImpressions、annotationClicks、annotationCloses、cardClickRate、cardTeaserClickRate、cardImpressions、cardTeaserImpressions、cardClicks、cardTeaserClicks
フィルタ 必須 country==US
0または1つ使用 video、group


Playlist レポート:

このレポートは、米国各州とワシントンDC のプレイリストのアクティビティの統計です。このレポートでは、 filters パラメータ値にcountry==US を含める必要があります。

ディメンション 必須 province
0または1つ以上使用 subscribedStatus、youtubeProduct
指標 1つ以上使用 views、redViews、estimatedMinutesWatched、estimatedRedMinutesWatched、averageViewDuration、playlistStarts、viewsPerPlaylistStart、averageTimeInPlaylist
フィルタ 必須 isCurated==1;country==US
0または1つ使用 continent、subContinent
0または1つ使用 playlist、group
0または1つ以上使用 subscribedStatus、youtubeProduct


コンテンツ所有者レポート:

ディメンション 必須 province
オプション creatorContentType
指標 1つ以上使用 views、redViews、estimatedMinutesWatched、estimatedRedMinutesWatched、averageViewDuration、averageViewPercentage、annotationClickThroughRate、annotationCloseRate、annotationImpressions、annotationClickableImpressions、annotationClosableImpressions、annotationClicks、annotationCloses、cardClickRate、cardTeaserClickRate、cardImpressions、cardTeaserImpressions、cardClicks、cardTeaserClicks
フィルタ 1つだけ使用 video、channel、group、またはuploaderType とclaimedStatus のサポートされている組み合わせ
必須 country==US


コンテンツ所有者の再生リストのレポート:

ディメンション 必須 province
0または1つ以上使用 subscribedStatus、estimatedMinutesWatched、estimatedRedMinutesWatched、averageViewDuration、playlistStarts、viewsPerPlaylistStart、averageTimeInPlaylist
フィルタ 必須 isCurated==1;country==US
0または1つ使用 playlist、channel、group
0または1つ以上使用 subscribedStatus、youtubeProduct

Columns

Name Type Dimension DefaultMetric DefaultDimension Description
Province String True True 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.
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.
Views Double 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.
RedViews Double The number of times that a video was viewed by YouTube Premium (previously known as YouTube Red) members.
EstimatedMinutesWatched Double The number of minutes that users watched videos for the specified channel, content owner, video, or playlist.
EstimatedRedMinutesWatched Double The number of minutes that YouTube Premium (previously known as YouTube Red) members watched a video.
AverageViewDuration Double 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 The average percentage of a video watched during a video playback.
AnnotationClickThroughRate Double The ratio of annotations that viewers clicked to the total number of clickable annotation impressions.
AnnotationCloseRate Double The ratio of annotations that viewers closed to the total number of annotation impressions.
AnnotationImpressions Double The total number of annotation impressions.
AnnotationClickableImpressions Double The number of annotations that appeared and could be clicked.
AnnotationClosableImpressions Double The number of annotations that appeared and could be closed.
AnnotationClicks Double The number of clicked annotations.
AnnotationCloses Double The number of closed annotations.
CardClickRate Double The click-through-rate for cards, which is calculated as the ratio of card clicks to card impressions.
CardTeaserClickRate Double The click-through-rate for card teasers, which is calculated as the ratio of clicks on card teasers to the total number of card teaser impressions.
CardImpressions Double The number of times cards were displayed. When the card panel is opened, a card impression is logged for each of the video's cards.
CardTeaserImpressions Double The number of times that card teasers were displayed. A video view can generate multiple teaser impressions.
CardClicks Double The number of times that cards were clicked.
CardTeaserClicks Double The number of clicks on card teasers. Card icon clicks are attributed to the last teaser displayed to the user.
Country String 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.
Video String True The Id of a YouTube video.
Playlist String The Id of a YouTube playlist.
Group String (filter only) The Id of a YouTube Analytics group.
Channel String (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.
StartDate Date Start date for fetching Analytics data.
EndDate Date End date for fetching Analytics data.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

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

CData Cloud

VideoAbuseReportReasons

Query YouTube VideoAbuseReportReasons. A VideoAbuseReportReason resource contains information about a reason that a Video would be flagged for containing abusive content.

Table Specific Information

Select

There are no required filters for this table. An optional column is Language.

The '=' operator is supported for this column.

Columns

Name Type Dimension DefaultMetric DefaultDimension Description
Id [KEY] String The Id that YouTube uses to identify the reason.
Label String The label text for the reason.
SecondaryReasonsAggregate String A list of secondary reasons associated with the reason, if any available. There might be 0 or more.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
Language String The hl parameter specifies the language that should be used for text values in the API response. The default value is en_US.

CData Cloud

VideoCategories

Query YouTube VideoCategories. A VideoCategory resource identifies a category that has been or could be associated with uploaded Videos.

Table Specific Information

Select

You can specify exactly one of the following columns: Id or Region. If you do not specify any filtering criteria, by default you will get results for the US Region. An extra optional parameter is Language.

SELECT * FROM VideoCategories WHERE Region = 'JP'
The IN operator can be used to filter on multiple Ids:
SELECT Id, Kind, Etag, ChannelId, Title, Assignable
FROM   VideoCategories
WHERE  (ID IN ('1', '2', '10'))

Columns

Name Type Dimension DefaultMetric DefaultDimension Description
Id [KEY] String The unique identifier for the video category.
ChannelId String The YouTube channel that created the video category.
Title String The title of the video category.
Assignable Boolean Indicates whether videos can be associated with the category.
Region String The country from which to retrieve video categories.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
Language String Specifies the language that should be used for text values in the API response. The default value is en_US.

CData Cloud

Videos

Query YouTube Videos.

Table Specific Information

Select

The following filters are passed to YouTube Analytics if present. Other filters are executed client side.

By default, if no filters are specified, the driver will return all videos owned by the authenticated user.

Only one of the following columns may be filtered by at a time: Id, MyRating, ChannelId, or Chart. Extra columns supported are ForMine, Language, ForContentOwner, OnBehalfOfContentOwner.

A search against all videos on Youtube may be executed by specifying SearchTerms, RelatedToVideoId, VideoDuration, VideoCategoryId, or Region.

All columns support the '=' operator. PublishedAt also supports these additional operators: '>', '>=', '<', and '<='. Id and ChannelId supports IN.

Order by is supported for the Date, Rating, Relevance and Title columns.

SELECT * FROM Videos WHERE Id = '12345679'

SELECT * FROM Videos WHERE PublishedAt >= '2016-01-01T20:30:00Z' LIMIT 10

SELECT Description FROM Videos WHERE ForMine = True ORDER BY Date

Note: Ordering is not supported when specifying one of the colums used for searching channels such as SearchTerms.

The IN operator can be used to specify a list of channels. This call returns a list of videos for each specified channel.

SELECT * FROM Videos WHERE ChannelId IN (a, b, c)
SELECT * FROM Videos WHERE ChannelId IN (SELECT Id FROM Channels)

IN operator can also be used for getting data for multiple videos.

SELECT * FROM Videos WHERE Id IN (a, b, c)

Columns

Name Type Dimension DefaultMetric DefaultDimension Description
Id [KEY] String The Id that YouTube uses to uniquely identify the video.
ChannelId String The Id that YouTube uses to uniquely identify the channel that the video was uploaded to.
CategoryId String The YouTube video category associated with the video.
Title String The title of the video.
ChannelTitle String Channel title for the channel that the video belongs to.
PublishedAt Datetime The date and time that the video was published. Note that this time might be different than the time that the video was uploaded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
Description String The description of the video.
Duration String The length of the video. The property value is an ISO 8601 duration.
ViewCount Long The number of times the video has been viewed.
LikeCount Long The number of users who have indicated that they liked the video.
DislikeCount Long The number of users who have indicated that they disliked the video. In conjunction with changes to make video dislike counts private across the entire YouTube platform, this field is returned only if the API request was authenticated by the video owner.
CommentCount Long The number of comments for the video.
EmbedHtml String An iframe tag that embeds a player that will play the video.
PublicStatsViewable Boolean This value indicates whether the extended video statistics on the watch page are publicly viewable. By default, those statistics are viewable, and statistics like the viewcount and ratings will still be publicly visible even if this value is set to false.
TagsAggregate String A list of keyword tags associated with the video.
LiveBroadcastContent String Indicates if the video is an upcoming/active live broadcast. A value of none indicates the video is not an upcoming/active live broadcast. Valid values for this column: live, none, upcoming.
Dimension String Indicates whether the video is available in 3D or in 2D.
Definition String Indicates whether the video is available in high definition HD or only in standard definition. Valid values for this column: hd,sd.
Caption String Indicates whether captions are available for the video. Valid values for this column: false, true.
LicensedContent Boolean Indicates whether the video represents licensed content, which means that the content was uploaded to a channel linked to a YouTube content partner and then claimed by that partner.
AllowedAggregate String A list of region codes that identify countries where the video is viewable.
BlockedAggregate String A list of region codes that identify countries where the video is blocked.
Projection String Specifies the projection format of the video. Valid values: 360, rectangular.
PrivacyStatus String The privacy status of the playlist. Valid values: private, public, unlisted.
MadeForKids Boolean This value indicates whether the video is Made For Kids.
License String The license. Valid values: creativeCommon, youtube.
Embeddable Boolean This value indicates whether the video can be embedded on another website.
ThumbnailsDefaultUrl String The URL of the default image.
DefaultLanguage String This column is confidential to trusted testers. The language of the text in the Title and Description columns.
DefaultAudioLanguage String The default_audio_language column specifies the language spoken in the default audio track of the video.
UploadStatus String The status of the uploaded video. Valid values for this column: deleted, failed, processed, rejected, uploaded.
FailureReason String This value explains why a video failed to upload. This column only has a value if the UploadStatus column indicates that the upload failed. Valid values for this column: codec, conversion, emptyFile, invalidFile, tooSmall, uploadAborted.
RejectionReason String This value explains why YouTube rejected an uploaded video. This column only has a value if the UploadStatus column indicates that the upload was rejected. Valid values for this column: claim, copyright, duplicate, inappropriate, length, termsOfUse, trademark, uploaderAccountClosed, uploaderAccountSuspended.
RecordingDate Datetime The date and time when the video was recorded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sssZ) format.
SearchTerms String The query term to search for.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
SafeSearch String Indicates whether the search results should include restricted content as well as standard content. Acceptable values: moderate, none, or strict.
EventType String The eventType parameter restricts a search to broadcast events. Acceptable values are: COMPLETED, LIVE, UPCOMING.

使用できる値は次のとおりです。COMPLETED, LIVE, UPCOMING

RelatedToVideoId String Retrieves a list of videos that are related to the video that the column value identifies.
VideoDuration String Filters video search results based on their duration. Acceptable values: any, long, medium or short.
VideoCategoryId String The videoCategoryId parameter identifies the video category for which the chart should be retrieved.
Region String Instructs the API to select a video chart available in the specified region. This column can only be used in conjunction with the chart column. The parameter value is an ISO 3166-1 alpha-2 country code.
ForMine String Restricts the search to only retrieve videos owned by the authenticated user. It is false by default.
Chart String The chart parameter identifies the chart that you want to retrieve. Acceptable values are: mostPopular - Return the most popular videos for the specified content region and video category.

使用できる値は次のとおりです。mostPopular

Language String Retrieve localized resource metadata for a specific application language that the YouTube website supports.
ForContentOwner String Restricts the search to only retrieve videos owned by the content owner specified by the OnBehalfOfContentOwner parameter.
OnBehalfOfContentOwner String This parameter is intended exclusively for YouTube content partners.

CData Cloud

ストアドプロシージャ

ストアドプロシージャはファンクションライクなインターフェースで、YouTube Analytics の単純なSELECT/INSERT/UPDATE/DELETE 処理にとどまらずCloud の機能を拡張します。

ストアドプロシージャは、パラメータのリストを受け取り、目的の機能を実行し、プロシージャが成功したか失敗したかを示すとともにYouTube Analytics から関連するレスポンスデータを返します。

CData Cloud - YouTube Analytics ストアドプロシージャ

Name Description
CreateCustomSchema Creates a custom schema file based on the specified Dimensions and Metrics.

CData Cloud

CreateCustomSchema

Creates a custom schema file based on the specified Dimensions and Metrics.

CreateCustomSchema

Creates a custom schema file based on the specified Dimensions and Metrics.

A custom schema may be used for a more tailored approach to your data. Custom options may include comma-separated lists for specific data.

Input

Name Type Required Description
TableName String True The name for the new table.
FileName String False The full file path and name of the schema to generate. Ex : 'C:\\Users\\User\\Desktop\\JiraSD\\DataSetTest.rsd'
Description String False An optional description for the table.
Dimensions String False A comma-separated list of dimensions to include in the schema file.
Metrics String True A comma-separated list of metrics to include in the schema file.

Result Set Columns

Name Type Description
Success String Whether or not the schema was created successfully.
SchemaFile String The generated schema file.
FileData String The generated schema encoded in Base64. Only returned if FileName or FileStream is not set.

CData Cloud

システムテーブル

このセクションで説明されているシステムテーブルをクエリして、スキーマ情報、データソース機能に関する情報、およびバッチ操作の統計にアクセスできます。

スキーマテーブル

以下のテーブルは、YouTube Analytics のデータベースメタデータを返します。

  • sys_catalogs:利用可能なデータベースをリスト。
  • sys_schemas:利用可能なスキーマをリスト。
  • sys_tables:利用可能なテーブルおよびビューをリスト。
  • sys_tablecolumns:利用可能なテーブルおよびビューのカラムについて説明。
  • sys_procedures:利用可能なストアドプロシージャについて説明。
  • sys_procedureparameters:ストアドプロシージャパラメータについて説明。
  • sys_keycolumns:主キーおよび外部キーについて説明。
  • sys_indexes:利用可能なインデックスについて説明。

データソーステーブル

以下のテーブルは、データソースへの接続方法およびクエリ方法についての情報を返します。

  • sys_connection_props:利用可能な接続プロパティについての情報を返す。
  • sys_sqlinfo:Cloud がデータソースにオフロードできるSELECT クエリについて説明。

クエリ情報テーブル

次のテーブルは、データ変更クエリのクエリ統計を返します。

  • sys_identity:バッチ処理または単一の更新に関する情報を返す。

CData Cloud

sys_catalogs

利用可能なデータベースをリストします。

次のクエリは、接続文字列で決定されるすべてのデータベースを取得します。

SELECT * FROM sys_catalogs

Columns

Name Type Description
CatalogName String データベース名。

CData Cloud

sys_schemas

利用可能なスキーマをリストします。

次のクエリは、すべての利用可能なスキーマを取得します。

          SELECT * FROM sys_schemas
          

Columns

Name Type Description
CatalogName String データベース名。
SchemaName String スキーマ名。

CData Cloud

sys_tables

利用可能なテーブルをリストします。

次のクエリは、利用可能なテーブルおよびビューを取得します。

          SELECT * FROM sys_tables
          

Columns

Name Type Description
CatalogName String テーブルまたはビューを含むデータベース。
SchemaName String テーブルまたはビューを含むスキーマ。
TableName String テーブル名またはビュー名。
TableType String テーブルの種類(テーブルまたはビュー)。
Description String テーブルまたはビューの説明。
IsUpdateable Boolean テーブルが更新可能かどうか。

CData Cloud

sys_tablecolumns

利用可能なテーブルおよびビューのカラムについて説明します。

次のクエリは、Groups テーブルのカラムとデータ型を返します。

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Groups' 

Columns

Name Type Description
CatalogName String テーブルまたはビューを含むデータベースの名前。
SchemaName String テーブルまたはビューを含むスキーマ。
TableName String カラムを含むテーブルまたはビューの名前。
ColumnName String カラム名。
DataTypeName String データ型の名前。
DataType Int32 データ型を示す整数値。この値は、実行時に環境に基づいて決定されます。
Length Int32 カラムのストレージサイズ。
DisplaySize Int32 指定されたカラムの通常の最大幅(文字数)。
NumericPrecision Int32 数値データの最大桁数。文字データおよび日時データの場合は、カラムの長さ(文字数)。
NumericScale Int32 カラムのスケール(小数点以下の桁数)。
IsNullable Boolean カラムがNull を含められるかどうか。
Description String カラムの簡単な説明。
Ordinal Int32 カラムのシーケンスナンバー。
IsAutoIncrement String カラムに固定増分値が割り当てられるかどうか。
IsGeneratedColumn String 生成されたカラムであるかどうか。
IsHidden Boolean カラムが非表示かどうか。
IsArray Boolean カラムが配列かどうか。
IsReadOnly Boolean カラムが読み取り専用かどうか。
IsKey Boolean sys_tablecolumns から返されたフィールドがテーブルの主キーであるかどうか。
ColumnType String スキーマ内のカラムの役割または分類。可能な値は、SYSTEM、LINKEDCOLUMN、NAVIGATIONKEY、REFERENCECOLUMN、およびNAVIGATIONPARENTCOLUMN が含まれます。

CData Cloud

sys_procedures

利用可能なストアドプロシージャをリストします。

次のクエリは、利用可能なストアドプロシージャを取得します。

          SELECT * FROM sys_procedures
          

Columns

Name Type Description
CatalogName String ストアドプロシージャを含むデータベース。
SchemaName String ストアドプロシージャを含むスキーマ。
ProcedureName String ストアドプロシージャの名前。
Description String ストアドプロシージャの説明。
ProcedureType String PROCEDURE やFUNCTION などのプロシージャのタイプ。

CData Cloud

sys_procedureparameters

ストアドプロシージャパラメータについて説明します。

次のクエリは、RefreshOAuthAccessToken ストアドプロシージャのすべての入力パラメータについての情報を返します。

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'RefreshOAuthAccessToken' AND Direction = 1 OR Direction = 2

パラメータに加えて結果セットのカラムを含めるには、IncludeResultColumns 擬似カラムをTrue に設定します。

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'RefreshOAuthAccessToken' AND IncludeResultColumns='True'

Columns

Name Type Description
CatalogName String ストアドプロシージャを含むデータベースの名前。
SchemaName String ストアドプロシージャを含むスキーマの名前。
ProcedureName String パラメータを含むストアドプロシージャの名前。
ColumnName String ストアドプロシージャパラメータの名前。
Direction Int32 パラメータのタイプに対応する整数値:input (1)。input/output (2)、またはoutput(4)。input/output タイプパラメータは、入力パラメータと出力パラメータの両方になれます。
DataType Int32 データ型を示す整数値。この値は、実行時に環境に基づいて決定されます。
DataTypeName String データ型の名前。
NumericPrecision Int32 数値データの場合は最大精度。文字データおよび日時データの場合は、カラムの長さ(文字数)。
Length Int32 文字データの場合は、許可される文字数。数値データの場合は、許可される桁数。
NumericScale Int32 数値データの小数点以下の桁数。
IsNullable Boolean パラメータがNull を含められるかどうか。
IsRequired Boolean プロシージャの実行にパラメータが必要かどうか。
IsArray Boolean パラメータが配列かどうか。
Description String パラメータの説明。
Ordinal Int32 パラメータのインデックス。
Values String このパラメータで設定できる値は、このカラムに表示されるものに限られます。指定できる値はカンマ区切りです。
SupportsStreams Boolean パラメータがファイルを表すかどうか。ファイルは、ファイルパスとして渡すことも、ストリームとして渡すこともできます。
IsPath Boolean パラメータがスキーマ作成操作のターゲットパスかどうか。
Default String 何も値が指定されていない場合に、このパラメータで使用される値。
SpecificName String 複数のストアドプロシージャが同じ名前を持つ場合、それぞれの同名のストアドプロシージャを一意に識別するラベル。特定の名前を持つプロシージャが1つだけの場合は、その名前がここに単純に反映されます。
IsCDataProvided Boolean プロシージャがネイティブのYouTube Analytics プロシージャではなく、CData によって追加 / 実装されているかどうか。

Pseudo-Columns

Name Type Description
IncludeResultColumns Boolean 出力にパラメータに加えて結果セットのカラムを含めるかどうか。デフォルトはFalse です。

CData Cloud

sys_keycolumns

主キーおよび外部キーについて説明します。

次のクエリは、Groups テーブルの主キーを取得します。

         SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Groups' 
          

Columns

Name Type Description
CatalogName String キーを含むデータベースの名前。
SchemaName String キーを含むスキーマの名前。
TableName String キーを含むテーブルの名前。
ColumnName String キーカラムの名前
IsKey Boolean カラムがTableName フィールドで参照されるテーブル内の主キーかどうか。
IsForeignKey Boolean カラムがTableName フィールドで参照される外部キーかどうか。
PrimaryKeyName String 主キーの名前。
ForeignKeyName String 外部キーの名前。
ReferencedCatalogName String 主キーを含むデータベース。
ReferencedSchemaName String 主キーを含むスキーマ。
ReferencedTableName String 主キーを含むテーブル。
ReferencedColumnName String 主キーのカラム名。

CData Cloud

sys_foreignkeys

外部キーについて説明します。

次のクエリは、他のテーブルを参照するすべての外部キーを取得します。

         SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
          

カラム

名前 タイプ 説明
CatalogName String キーを含むデータベースの名前。
SchemaName String キーを含むスキーマの名前。
TableName String キーを含むテーブルの名前。
ColumnName String キーカラムの名前
PrimaryKeyName String 主キーの名前。
ForeignKeyName String 外部キーの名前。
ReferencedCatalogName String 主キーを含むデータベース。
ReferencedSchemaName String 主キーを含むスキーマ。
ReferencedTableName String 主キーを含むテーブル。
ReferencedColumnName String 主キーのカラム名。
ForeignKeyType String 外部キーがインポート(他のテーブルを指す)キーかエクスポート(他のテーブルから参照される)キーかを指定します。

CData Cloud

sys_primarykeys

主キーについて説明します。

次のクエリは、すべてのテーブルとビューから主キーを取得します。

         SELECT * FROM sys_primarykeys
          

Columns

Name Type Description
CatalogName String キーを含むデータベースの名前。
SchemaName String キーを含むスキーマの名前。
TableName String キーを含むテーブルの名前。
ColumnName String キーカラムの名前。
KeySeq String 主キーのシーケンス番号。
KeyName String 主キーの名前。

CData Cloud

sys_indexes

利用可能なインデックスについて説明します。インデックスをフィルタリングすることで、より高速なクエリ応答時間でセレクティブクエリを記述できます。

次のクエリは、主キーでないすべてのインデックスを取得します。

          SELECT * FROM sys_indexes WHERE IsPrimary='false'
          

Columns

Name Type Description
CatalogName String インデックスを含むデータベースの名前。
SchemaName String インデックスを含むスキーマの名前。
TableName String インデックスを含むテーブルの名前。
IndexName String インデックス名。
ColumnName String インデックスに関連付けられたカラムの名前。
IsUnique Boolean インデックスが固有の場合はTrue。そうでない場合はFalse。
IsPrimary Boolean インデックスが主キーの場合はTrue。そうでない場合はFalse。
Type Int16 インデックスタイプに対応する整数値:statistic (0)、clustered (1)、hashed (2)、またはother (3)。
SortOrder String 並べ替え順序:A が昇順、D が降順。
OrdinalPosition Int16 インデックスのカラムのシーケンスナンバー。

CData Cloud

sys_connection_props

利用可能な接続プロパティと、接続文字列に設定されている接続プロパティに関する情報を返します。

次のクエリは、接続文字列に設定されている、あるいはデフォルト値で設定されているすべての接続プロパティを取得します。

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns

Name Type Description
Name String 接続プロパティ名。
ShortDescription String 簡単な説明。
Type String 接続プロパティのデータ型。
Default String 明示的に設定されていない場合のデフォルト値。
Values String 可能な値のカンマ区切りリスト。別な値が指定されていると、検証エラーがスローされます。
Value String 設定した値またはあらかじめ設定されたデフォルト。
Required Boolean プロパティが接続に必要かどうか。
Category String 接続プロパティのカテゴリ。
IsSessionProperty String プロパティが、現在の接続に関する情報を保存するために使用されるセッションプロパティかどうか。
Sensitivity String プロパティの機密度。これは、プロパティがロギングおよび認証フォームで難読化されているかどうかを通知します。
PropertyName String キャメルケースの短縮形の接続プロパティ名。
Ordinal Int32 パラメータのインデックス。
CatOrdinal Int32 パラメータカテゴリのインデックス。
Hierarchy String このプロパティと一緒に設定する必要がある、関連のある依存プロパティを表示します。
Visible Boolean プロパティが接続UI に表示されるかどうかを通知します。
ETC String プロパティに関するその他のさまざまな情報。

CData Cloud

sys_sqlinfo

Cloud がデータソースにオフロードできるSELECT クエリ処理について説明します。

SQL 構文の詳細については、SQL 準拠 を参照してください。

データソースのSELECT 機能

以下はSQL 機能のサンプルデータセットです。 SELECT 機能のいくつかの側面がサポートされている場合には、カンマ区切りのリストで返されます。サポートされていない場合、カラムにはNO が入ります。

名前説明有効な値
AGGREGATE_FUNCTIONSサポートされている集計関数。AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNTCOUNT 関数がサポートされているかどうか。YES, NO
IDENTIFIER_QUOTE_OPEN_CHAR識別子をエスケープするための開始文字。[
IDENTIFIER_QUOTE_CLOSE_CHAR識別子をエスケープするための終了文字。]
SUPPORTED_OPERATORSサポートされているSQL 演算子。=, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BYGROUP BY がサポートされているかどうか。サポートされている場合、どのレベルでサポートされているか。NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
OJ_CAPABILITIESサポートされている外部結合の種類。NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS
OUTER_JOINS外部結合がサポートされているかどうか。YES, NO
SUBQUERIESサブクエリがサポートされているかどうか。サポートされていれば、どのレベルでサポートされているか。NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED
STRING_FUNCTIONSサポートされている文字列関数。LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE
NUMERIC_FUNCTIONSサポートされている数値関数。ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE
TIMEDATE_FUNCTIONSサポートされている日付および時刻関数。NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT
REPLICATION_SKIP_TABLESレプリケーション中にスキップされたテーブルを示します。
REPLICATION_TIMECHECK_COLUMNSレプリケーション中に更新判断のカラムとして使用するかどうかを、(指定された順に)チェックするカラムのリストを含む文字列の配列。
IDENTIFIER_PATTERN識別子としてどの文字列が有効かを示す文字列値。
SUPPORT_TRANSACTIONプロバイダーが、コミットやロールバックなどのトランザクションをサポートしているかどうかを示します。YES, NO
DIALECT使用するSQL ダイアレクトを示します。
KEY_PROPERTIESUniform データベースを特定するプロパティを示します。
SUPPORTS_MULTIPLE_SCHEMASプロバイダー用に複数のスキームが存在するかどうかを示します。YES, NO
SUPPORTS_MULTIPLE_CATALOGSプロバイダー用に複数のカタログが存在するかどうかを示します。YES, NO
DATASYNCVERSIONこのドライバーにアクセスするために必要な、CData Sync のバージョン。Standard, Starter, Professional, Enterprise
DATASYNCCATEGORYこのドライバーのCData Sync カテゴリ。Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQLAPI で提供されている以上の、追加SQL 機能がサポートされているかどうか。TRUE, FALSE
SUPPORTS_BATCH_OPERATIONSバッチ操作がサポートされているかどうか。YES, NO
SQL_CAPこのドライバーでサポートされているすべてのSQL 機能。SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX
PREFERRED_CACHE_OPTIONS使用したいcacheOptions を指定する文字列値。
ENABLE_EF_ADVANCED_QUERYドライバーがEntity Framework の高度なクエリをサポートしているかどうかを示します。サポートしていなければ、クエリはクライアントサイドで処理されます。YES, NO
PSEUDO_COLUMNS利用可能な疑似カラムを示す文字列の配列。
MERGE_ALWAYS値がtrue であれば、CData Sync 内でMerge Model が強制的に実行されます。TRUE, FALSE
REPLICATION_MIN_DATE_QUERYレプリケート開始日時を返すSELECT クエリ。
REPLICATION_MIN_FUNCTIONサーバーサイドでmin を実行するために使用する式名を、プロバイダーが指定できるようになります。
REPLICATION_START_DATEレプリケート開始日を、プロバイダーが指定できるようになります。
REPLICATION_MAX_DATE_QUERYレプリケート終了日時を返すSELECT クエリ。
REPLICATION_MAX_FUNCTIONサーバーサイドでmax を実行するために使用する式名を、プロバイダーが指定できるようになります。
IGNORE_INTERVALS_ON_INITIAL_REPLICATE初回のレプリケートで、レプリケートをチャンクに分割しないテーブルのリスト。
CHECKCACHE_USE_PARENTIDCheckCache 構文を親キーカラムに対して実行するかどうかを示します。TRUE, FALSE
CREATE_SCHEMA_PROCEDURESスキーマファイルの生成に使用できる、ストアドプロシージャを示します。

次のクエリは、WHERE 句で使用できる演算子を取得します。

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'
WHERE 句では、個々のテーブルの制限や要件が異なる場合がありますので注意してください。詳しくは、データモデル セクションを参照してください。

Columns

Name Type Description
NAME String SQL 構文のコンポーネント、またはサーバー上で処理できる機能。
VALUE String サポートされるSQL またはSQL 構文の詳細。

CData Cloud

sys_identity

試行された変更に関する情報を返します。

次のクエリは、バッチ処理で変更された行のId を取得します。

         SELECT * FROM sys_identity
          

Columns

Name Type Description
Id String データ変更処理から返された、データベース生成Id。
Batch String バッチの識別子。1 は単一処理。
Operation String バッチ内の処理の結果:INSERTED、UPDATED、またはDELETED。
Message String SUCCESS、またはバッチ内の更新が失敗した場合のエラーメッセージ。

CData Cloud

sys_information

利用可能なシステム情報を説明します。

次のクエリは、すべてのカラムを取得します。

SELECT * FROM sys_information

Columns

NameTypeDescription
ProductString製品名。
VersionString製品のバージョン番号。
DatasourceString製品が接続するデータソースの名前。
NodeIdString製品がインストールされているマシンの固有識別子。
HelpURLString製品のヘルプドキュメントのURL。
LicenseString製品のライセンス情報。(この情報が利用できない場合、この項目は空白のままか「N/A」と表示されます。)
LocationString製品のライブラリが格納されているファイルパスの場所。
EnvironmentString製品が現在稼働している環境またはランタイムのバージョン。
DataSyncVersionString本コネクタを使用するために必要なCData Sync のティア。
DataSyncCategoryStringCData Sync 機能のカテゴリ(例:Source、Destination)。

CData Cloud

接続文字列オプション

接続文字列プロパティは、接続を確立するために使用できるさまざまなオプションです。このセクションでは、本プロバイダーの接続文字列で設定できるオプションの一覧を示します。詳細については各リンクをクリックしてください。

Authentication


プロパティ説明
AuthSchemeThe type of authentication to use when connecting to YouTube Analytics.
ChannelId認証されたユーザーに属するチャンネルのId。
ContentOwnerIdYouTube 権利管理システムにあるコンテンツの著作権者のId。

OAuth


プロパティ説明
OAuthClientIdカスタムOAuth アプリケーションに割り当てられたクライアントID(コンシューマーキーとも呼ばれます)を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。
OAuthClientSecretカスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。(カスタムOAuth アプリケーションのみ)
DelegatedServiceAccounts委任されたリクエストのためのサービスアカウントE メールをスペース区切りで指定します。
RequestingServiceAccount委任されたリクエストを行うためのサービスアカウントのE メールを指定します。
Scopeデータへの適切なアクセスを確実にするために、認証ユーザーのアプリケーションへのアクセス範囲を指定します。 カスタムOAuth アプリケーションが必要な場合は、通常、アプリケーションの作成時に指定します。

JWT OAuth


プロパティ説明
OAuthJWTCertクライアント証明書のJWT 証明書ストアの名前を指定します。
OAuthJWTCertTypeJWT 証明書を格納しているキーストアの種類を指定します。
OAuthJWTCertPasswordパスワードで保護された証明書ストアにアクセスするために使用されるOAuth JWT 証明書のパスワードを指定します。証明書ストアがパスワードを必要としない場合は、このプロパティを空白のままにします。
OAuthJWTCertSubjectストアで一致する証明書を検索するために使用される、OAuth JWT 証明書のサブジェクトを指定します。部分一致と、先頭の証明書を選択するためのワイルドカード '*' をサポートします。

SSL


プロパティ説明
SSLServerCertTLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。

Logging


プロパティ説明
VerbosityログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。

Schema


プロパティ説明
BrowsableSchemasレポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

Miscellaneous


プロパティ説明
AWSWorkloadIdentityConfigAWS 経由でWorkload Identity Federation を使用する場合に指定する設定プロパティ。
AzureWorkloadIdentityConfigAzure 経由でWorkload Identity Federation を使用する場合に指定する設定プロパティ。
DefaultFilterすべてのクエリに適用されるデフォルトのフィルタ。
MaxRows集計やGROUP BY を含まないクエリで返される最大行数を指定します。
PseudoColumnsテーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。
Timeoutprovider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。
WorkloadPoolIdWorkload Identity Federation プールのID。
WorkloadProjectIdWorkload Identity Federation プールをホストするGoogle Cloud プロジェクトのID。
WorkloadProviderIdWorkload Identity Federation プールプロバイダーのID。
CData Cloud

Authentication

このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。


プロパティ説明
AuthSchemeThe type of authentication to use when connecting to YouTube Analytics.
ChannelId認証されたユーザーに属するチャンネルのId。
ContentOwnerIdYouTube 権利管理システムにあるコンテンツの著作権者のId。
CData Cloud

AuthScheme

The type of authentication to use when connecting to YouTube Analytics.

Possible Values

OAuth, OAuthJWT, AWSWorkloadIdentity, AzureWorkloadIdentity

データ型

string

デフォルト値

"OAuth"

解説

  • OAuth: Set this to perform OAuth authentication using a standard user account.
  • OAuthJWT: Set this to perform OAuth authentication using an OAuth service account.

CData Cloud

ChannelId

認証されたユーザーに属するチャンネルのId。

データ型

string

デフォルト値

""

解説

認証されたユーザーに属するチャンネルのId。これは、チャンネルのアカウント詳細設定ページで確認できます。指定されていない場合は、認証されたユーザーのYouTube チャンネルのデータを返すMINE が使われます。

CData Cloud

ContentOwnerId

YouTube 権利管理システムにあるコンテンツの著作権者のId。

データ型

string

デフォルト値

""

解説

YouTube 権利管理システムにあるコンテンツの著作権者のId。コンテンツ所有者とは、動画を主張し収益化ポリシーを設定している個人もしくは組織です。

CData Cloud

OAuth

このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。


プロパティ説明
OAuthClientIdカスタムOAuth アプリケーションに割り当てられたクライアントID(コンシューマーキーとも呼ばれます)を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。
OAuthClientSecretカスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。(カスタムOAuth アプリケーションのみ)
DelegatedServiceAccounts委任されたリクエストのためのサービスアカウントE メールをスペース区切りで指定します。
RequestingServiceAccount委任されたリクエストを行うためのサービスアカウントのE メールを指定します。
Scopeデータへの適切なアクセスを確実にするために、認証ユーザーのアプリケーションへのアクセス範囲を指定します。 カスタムOAuth アプリケーションが必要な場合は、通常、アプリケーションの作成時に指定します。
CData Cloud

OAuthClientId

カスタムOAuth アプリケーションに割り当てられたクライアントID(コンシューマーキーとも呼ばれます)を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。

データ型

string

デフォルト値

""

解説

このプロパティは2つのケースで必要となります:

  • カスタムOAuth アプリケーションを使用する場合。たとえば、Web ベースの認証フロー、サービスベースの認証、またはアプリケーションの登録が必要な証明書ベースのフローなどが該当します。
  • ドライバーが埋め込みOAuth 資格情報を提供しない場合。

(ドライバーが埋め込みOAuth 資格情報を提供する場合、この値はすでにCloud によって設定されており、手動で入力する必要がないことがあります。)

OAuthClientId は、認証付きの接続を構成する際に、OAuthClientSecret やOAuthSettingsLocation などの他のOAuth 関連プロパティと一緒に使用されるのが一般的です。

OAuthClientId は、ユーザーがOAuth 経由で認証を行う前に設定する必要がある、主要な接続パラメータの1つです。 この値は、通常、ID プロバイダーのアプリケーション登録設定で確認できます。 Client ID、Application ID、Consumer Key などとラベル付けされた項目を探してください。

クライアントID は、クライアントシークレットのような機密情報とは見なされませんが、アプリケーションの識別情報の一部であるため、慎重に取り扱う必要があります。公開リポジトリや共有設定ファイルでこの値を露出させないようにしてください。

接続設定時にこのプロパティを使用する方法の詳細については、接続の確立 を参照してください。

CData Cloud

OAuthClientSecret

カスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。(カスタムOAuth アプリケーションのみ)

データ型

string

デフォルト値

""

解説

このプロパティ(アプリケーションシークレットまたはコンシューマシークレットとも呼ばれます)は、安全なクライアント認証を必要とするすべてのフローでカスタムOAuth アプリケーションを使用する場合に必要です。たとえば、Web ベースのOAuth、サービスベースの接続、証明書ベースの認可フローなどが該当します。 組み込みOAuth アプリケーションを使用する場合は必要ありません。

クライアントシークレットは、OAuth フローのトークン交換ステップで使用されます。このステップでは、ドライバーが認可サーバーにアクセストークンを要求します。 この値が欠落しているか正しくない場合、認証はinvalid_client またはunauthorized_client エラーで失敗します。

OAuthClientSecret は、ユーザーがOAuth 経由で認証を行う前に設定する必要がある、主要な接続パラメータの1つです。この値は、OAuth アプリケーションを登録する際にID プロバイダーから取得できます。

Notes:

  • この値は安全に保管し、公開リポジトリやスクリプト、安全でない環境では決して公開しないようにしてください。
  • クライアントシークレットは、一定期間が経過すると有効期限が切れる場合もあります。 アクセスを中断させないために、有効期限を常に監視し、必要に応じてシークレットをローテーションするようにしてください。

接続設定時にこのプロパティを使用する方法の詳細については、接続の確立 を参照してください。

CData Cloud

DelegatedServiceAccounts

委任されたリクエストのためのサービスアカウントE メールをスペース区切りで指定します。

データ型

string

デフォルト値

""

解説

サービスアカウントE メールは、スペース区切りのリストで指定する必要があります。

各サービスアカウントは、チェーン内の次のサービスアカウントのroles/iam.serviceAccountTokenCreator ロールを付与されている必要があります。

チェーンの最後のサービスアカウントは、リクエストするサービスアカウントのroles/iam.serviceAccountTokenCreator ロールが付与されている必要があります。 リクエストするサービスアカウントはRequestingServiceAccount プロパティで指定されたものです。

委任されたリクエストの場合、リクエストするサービスアカウントは、iam.serviceAccounts.getAccessToken 権限を持つ必要があることに注意してください。これは、serviceAccountTokenCreator ロールを介して付与することもできます。

CData Cloud

RequestingServiceAccount

委任されたリクエストを行うためのサービスアカウントのE メールを指定します。

データ型

string

デフォルト値

""

解説

委任されたリクエストで認証情報が要求されたアカウントのサービスアカウントのE メール。DelegatedServiceAccounts の委任されたサービスアカウントのリストを用いて、このプロパティは、委任されたリクエストを行うために使用されます。

このサービスアカウントには、IAM 権限iam.serviceAccounts.getAccessToken が必要です。

CData Cloud

Scope

データへの適切なアクセスを確実にするために、認証ユーザーのアプリケーションへのアクセス範囲を指定します。 カスタムOAuth アプリケーションが必要な場合は、通常、アプリケーションの作成時に指定します。

データ型

string

デフォルト値

""

解説

スコープは、認証ユーザーがどのようなアクセス権を持つかを定義するために設定されます。例えば、読み取り、読み取りと書き込み、機密情報への制限付きアクセスなどです。システム管理者は、スコープを使用して機能またはセキュリティクリアランスによるアクセスを選択的に有効化できます。

InitiateOAuth がGETANDREFRESH に設定されている場合、要求するスコープを変更したい場合はこのプロパティを使用する必要があります。

InitiateOAuth がREFRESH またはOFF のいずれかに設定されている場合、このプロパティまたはScope 入力を使用して、要求するスコープを変更できます。

CData Cloud

JWT OAuth

このセクションでは、本プロバイダーの接続文字列で設定可能なJWT OAuth プロパティの全リストを提供します。


プロパティ説明
OAuthJWTCertクライアント証明書のJWT 証明書ストアの名前を指定します。
OAuthJWTCertTypeJWT 証明書を格納しているキーストアの種類を指定します。
OAuthJWTCertPasswordパスワードで保護された証明書ストアにアクセスするために使用されるOAuth JWT 証明書のパスワードを指定します。証明書ストアがパスワードを必要としない場合は、このプロパティを空白のままにします。
OAuthJWTCertSubjectストアで一致する証明書を検索するために使用される、OAuth JWT 証明書のサブジェクトを指定します。部分一致と、先頭の証明書を選択するためのワイルドカード '*' をサポートします。
CData Cloud

OAuthJWTCert

クライアント証明書のJWT 証明書ストアの名前を指定します。

データ型

string

デフォルト値

""

解説

OAuthJWTCertType フィールドは、OAuthJWTCert により指定された証明書ストアの種類を指定します。 ストアがパスワードで保護されている場合は、OAuthJWTCertPassword を使用してパスワードを指定します。

OAuthJWTCert は、OAuthJWTCertSubject フィールドとともにクライアント証明書を指定するために使われます。 OAuthJWTCert に値が設定され、かつOAuthJWTCertSubject が設定されている場合、CData Cloud は証明書の検索を開始します。 詳しくは、OAuthJWTCertSubject を参照してください。

証明書ストアの指定はプラットフォームに依存します。

注記

  • Windows の共通のユーザーとシステム証明書ストアは以下のとおりです。
    • MY:個人証明書と関連付けられた秘密キーを 格納している証明書ストア。
    • CA:証明機関の証明書。
    • ROOT:ルート証明書。
    • SPC:ソフトウェア発行元証明書。
  • Javaでは、証明書ストアは通常、証明書および 任意の秘密キーを含むファイルです。
  • 証明書ストアの種類がPFXFile の場合は、 このプロパティにファイル名を設定します。
  • PFXBlob の場合は、このプロパティをPFX ファイルのバイナリコンテンツ(例えば、PKCS12証明書ストア)に設定する必要があります。

CData Cloud

OAuthJWTCertType

JWT 証明書を格納しているキーストアの種類を指定します。

Possible Values

PFXBLOB, JKSBLOB, PEMKEY_BLOB, PUBLIC_KEY_BLOB, SSHPUBLIC_KEY_BLOB, XMLBLOB, BCFKSBLOB, GOOGLEJSONBLOB

データ型

string

デフォルト値

"PEMKEY_BLOB"

解説

値説明注記
USER現在のユーザーが所有する証明書ストア。 Windows のみ使用可能です。
MACHINEマシンストア。Java やその他の非Windows 環境では使用できません。
PFXFILE証明書を含むPFX(PKCS12)ファイル。
PFXBLOBPFX(PKCS12)形式の証明書ストアをbase-64 でエンコードした文字列。
JKSFILE証明書を含むJava キーストア(JKS)ファイル。Java 専用。
JKSBLOBJava キーストア(JKS)形式の証明書ストアをbase-64 でエンコードした文字列。 Java 専用。
PEMKEY_FILE秘密鍵とオプションの証明書を含むPEM でエンコードされたファイル。
PEMKEY_BLOB秘密鍵とオプションの証明書をbase-64 でエンコードした文字列。
PUBLIC_KEY_FILEPEM またはDER でエンコードされた公開鍵証明書を含むファイル。
PUBLIC_KEY_BLOBPEM またはDER でエンコードされた公開鍵証明書をbase-64 でエンコードした文字列。
SSHPUBLIC_KEY_FILESSH 形式の公開鍵を含むファイル。
SSHPUBLIC_KEY_BLOBSSH 形式の公開鍵ををbase-64 でエンコードした文字列。
P7BFILE証明書を含むPKCS7 ファイル。
PPKFILEPuTTY 秘密キー(PPK)を含むファイル。
XMLFILEXML 形式の証明書を含むファイル。
XMLBLOBXML 形式の証明書を含む文字列。
BCFKSFILEBouncy Castle キーストアを含むファイル。
BCFKSBLOBBouncy Castle キーストアを含む文字列(base-64エンコード)。
GOOGLEJSONサービスアカウント情報を含むJSON ファイル。 Google サービスに接続する場合にのみ有効。
GOOGLEJSONBLOBサービスアカウントのJSON を含む文字列。 Google サービスに接続する場合にのみ有効。

CData Cloud

OAuthJWTCertPassword

パスワードで保護された証明書ストアにアクセスするために使用されるOAuth JWT 証明書のパスワードを指定します。証明書ストアがパスワードを必要としない場合は、このプロパティを空白のままにします。

データ型

string

デフォルト値

""

解説

このプロパティは、パスワードで保護された証明書ストアを開くために必要なパスワードを指定します。 パスワードが必要かどうかを判断するには、ご利用の証明書ストアのドキュメントまたは設定を参照してください。

GOOGLEJSON OAuthJWTCertType を使用する場合は必要ありません。Google JSON キーは暗号化されていません。

CData Cloud

OAuthJWTCertSubject

ストアで一致する証明書を検索するために使用される、OAuth JWT 証明書のサブジェクトを指定します。部分一致と、先頭の証明書を選択するためのワイルドカード '*' をサポートします。

データ型

string

デフォルト値

"*"

解説

このプロパティの値は、ストアで一致する証明書を検索するために使用されます。検索プロセスは以下のように動作します。

  • サブジェクトに完全に一致する証明書が見つかれば、該当する証明書が選択されます。
  • 完全に一致するものがない場合、ストアは、サブジェクトがプロパティ値を含む証明書を検索します。
  • 一致する証明書がない場合、証明書は選択されません。

値を '*' に設定すると、ストアの先頭の証明書が自動的に選択されます。 証明書のサブジェクトは識別名フィールドおよび値のカンマ区切りのリストです。 例:CN=www.server.com, OU=test, C=US, [email protected]。

一般的なフィールドには以下のものが含まれます。

フィールド説明
CN共通名。一般的には、www.server.com のようなホスト名です。
O法人名
OU法人の部署名
L法人の住所(市町村名)
S法人の住所(都道府県)
C国名
EE メールアドレス

フィールド値にカンマが含まれる場合は、引用符で囲んでください。例:"O=ACME, Inc."。

CData Cloud

SSL

このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。


プロパティ説明
SSLServerCertTLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。
CData Cloud

SSLServerCert

TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。

データ型

string

デフォルト値

""

解説

TLS/SSL 接続を使用している場合は、このプロパティを使用して、サーバーが受け入れるTLS/SSL 証明書を指定できます。このプロパティに値を指定すると、マシンによって信頼されていない他の証明書はすべて拒否されます。

このプロパティは、次のフォームを取ります:

説明 例
フルPEM 証明書(例では省略されています) -----BEGIN CERTIFICATE-----
MIIChTCCAe4CAQAwDQYJKoZIhv......Qw==
-----END CERTIFICATE-----
証明書を保有するローカルファイルへのパス。 C:\cert.cer
公開鍵(例では省略されています) -----BEGIN RSA PUBLIC KEY-----
MIGfMA0GCSq......AQAB
-----END RSA PUBLIC KEY-----
MD5 Thumbprint(hex 値はスペースまたはコロン区切り) ecadbdda5a1529c58a1e9e09828d70e4
SHA1 Thumbprint(hex 値はスペースまたはコロン区切り) 34a929226ae0819f2ec14b4a3d904f801cbb150d

Note:'*' を使用してすべての証明書を受け入れるように指定することも可能ですが、セキュリティ上の懸念があるため推奨されません。

CData Cloud

Logging

このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。


プロパティ説明
VerbosityログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。
CData Cloud

Verbosity

ログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。

データ型

string

デフォルト値

"1"

解説

このプロパティは、Cloud がログファイルに含める詳細レベルを定義します。 Verbosity レベルを高くするとログに記録される情報の詳細が増えますが、ログファイルが大きくなり取り込まれるデータが増えるためパフォーマンスが低下する可能性があります。

デフォルトのVerbosity レベルは1で、通常の運用にはこれが推奨されます。 より高いVerbosity レベルは主にデバッグを目的としています。 各レベルの詳細については、ログ を参照してください。

LogModules プロパティと組み合わせることで、Verbosity は特定の情報カテゴリに対するログの詳細度を調整できます。

CData Cloud

Schema

このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。


プロパティ説明
BrowsableSchemasレポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
CData Cloud

BrowsableSchemas

レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

データ型

string

デフォルト値

""

解説

利用可能なデータベーススキーマをすべてリストすると余分な時間がかかり、パフォーマンスが低下します。 接続文字列にスキーマのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。

CData Cloud

Miscellaneous

このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。


プロパティ説明
AWSWorkloadIdentityConfigAWS 経由でWorkload Identity Federation を使用する場合に指定する設定プロパティ。
AzureWorkloadIdentityConfigAzure 経由でWorkload Identity Federation を使用する場合に指定する設定プロパティ。
DefaultFilterすべてのクエリに適用されるデフォルトのフィルタ。
MaxRows集計やGROUP BY を含まないクエリで返される最大行数を指定します。
PseudoColumnsテーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。
Timeoutprovider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。
WorkloadPoolIdWorkload Identity Federation プールのID。
WorkloadProjectIdWorkload Identity Federation プールをホストするGoogle Cloud プロジェクトのID。
WorkloadProviderIdWorkload Identity Federation プールプロバイダーのID。
CData Cloud

AWSWorkloadIdentityConfig

AWS 経由でWorkload Identity Federation を使用する場合に指定する設定プロパティ。

データ型

string

デフォルト値

""

解説

このプロパティは、Key=Value プロパティのセミコロン区切りリストとしてフォーマットされ、値はオプションで引用符で囲むこともできます。 例えば、この設定はユーザーのルートキーを使用してAWS で認証します:

AWSWorkloadIdentityConfig="AuthScheme=AwsRootKeys;AccessKey='AKIAABCDEF123456';SecretKey=...;Region=us-east-1"

CData Cloud

AzureWorkloadIdentityConfig

Azure 経由でWorkload Identity Federation を使用する場合に指定する設定プロパティ。

データ型

string

デフォルト値

""

解説

このプロパティは、Key=Value プロパティのセミコロン区切りリストとしてフォーマットされ、値はオプションで引用符で囲むこともできます。 例えば、この設定はクライアント資格情報を使用してAzure で認証します:

AzureWorkloadIdentityConfig="AuthScheme=AzureServicePrincipal;AzureTenant=directory (tenant) id;OAuthClientID=application (client) id;OAuthClientSecret=client secret;AzureResource=application id uri;"

CData Cloud

DefaultFilter

すべてのクエリに適用されるデフォルトのフィルタ。

データ型

string

デフォルト値

"EndDate=Today"

解説

すべてのクエリに適用されるデフォルトのフィルタ。すべてのクエリにデフォルトのDimensions、StartDate、EndDate、およびSegments を設定するための便利な方法です。これらの値は、クエリで設定されると上書きされます。値の例:Dimensions=Year AND EndDate=Today

CData Cloud

MaxRows

集計やGROUP BY を含まないクエリで返される最大行数を指定します。

データ型

int

デフォルト値

-1

解説

このプロパティのデフォルト値である-1 は、クエリに明示的にLIMIT 句が含まれていない限り、行の制限が適用されないことを意味します。 (クエリにLIMIT 句が含まれている場合、クエリで指定された値がMaxRows 設定よりも優先されます。)

MaxRows を0より大きい整数に設定することで、クエリがデフォルトで過度に大きな結果セットを返さないようにします。

このプロパティは、非常に大きなデータセットを返す可能性のあるクエリを実行する際に、パフォーマンスを最適化し、過剰なリソース消費を防ぐのに役立ちます。

CData Cloud

PseudoColumns

テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。

データ型

string

デフォルト値

""

解説

このプロパティを使用すると、Cloud がテーブルカラムとして公開する擬似カラムを定義できます。

個々の擬似カラムを指定するには、以下の形式を使用します。

Table1=Column1;Table1=Column2;Table2=Column3

すべてのテーブルのすべての擬似カラムを含めるには、次を使用してください:

*=*

CData Cloud

Timeout

provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。

データ型

int

デフォルト値

60

解説

タイムアウトは、クエリや操作全体ではなくサーバーとの個々の通信に適用されます。 例えば、各ページング呼び出しがタイムアウト制限内に完了する場合、クエリは60秒を超えて実行を続けることができます。

タイムアウトはデフォルトで60秒に設定されています。タイムアウトを無効にするには、このプロパティを0に設定します。

タイムアウトを無効にすると、操作が成功するか、サーバー側のタイムアウト、ネットワークの中断、またはサーバーのリソース制限などの他の条件で失敗するまで無期限に実行されます。

Note: このプロパティは慎重に使用してください。長時間実行される操作がパフォーマンスを低下させたり、応答しなくなる可能性があるためです。

CData Cloud

WorkloadPoolId

Workload Identity Federation プールのID。

データ型

string

デフォルト値

""

解説

Workload Identity Federation プールのID。

CData Cloud

WorkloadProjectId

Workload Identity Federation プールをホストするGoogle Cloud プロジェクトのID。

データ型

string

デフォルト値

""

解説

Workload Identity Federation プールをホストするGoogle Cloud プロジェクトのID。

CData Cloud

WorkloadProviderId

Workload Identity Federation プールプロバイダーのID。

データ型

string

デフォルト値

""

解説

Workload Identity Federation プールプロバイダーのID。

CData Cloud

Third Party Copyrights

LZMA from 7Zip LZMA SDK

LZMA SDK is placed in the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or distribute the original LZMA SDK code, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.

LZMA2 from XZ SDK

Version 1.9 and older are in the public domain.

Xamarin.Forms

Xamarin SDK

The MIT License (MIT)

Copyright (c) .NET Foundation Contributors

All rights reserved.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

NSIS 3.10

Copyright (C) 1999-2025 Contributors THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS COMMON PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.

1. DEFINITIONS

"Contribution" means:

a) in the case of the initial Contributor, the initial code and documentation distributed under this Agreement, and b) in the case of each subsequent Contributor:

i) changes to the Program, and

ii) additions to the Program;

where such changes and/or additions to the Program originate from and are distributed by that particular Contributor. A Contribution 'originates' from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include additions to the Program which: (i) are separate modules of software distributed in conjunction with the Program under their own license agreement, and (ii) are not derivative works of the Program.

"Contributor" means any person or entity that distributes the Program.

"Licensed Patents " mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program.

"Program" means the Contributions distributed in accordance with this Agreement.

"Recipient" means anyone who receives the Program under this Agreement, including all Contributors.

2. GRANT OF RIGHTS

a) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, distribute and sublicense the Contribution of such Contributor, if any, and such derivative works, in source code and object code form.

b) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in source code and object code form. This patent license shall apply to the combination of the Contribution and the Program if, at the time the Contribution is added by the Contributor, such addition of the Contribution causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Contribution. No hardware per se is licensed hereunder.

c) Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program.

d) Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement.

3. REQUIREMENTS

A Contributor may choose to distribute the Program in object code form under its own license agreement, provided that:

a) it complies with the terms and conditions of this Agreement; and

b) its license agreement:

i) effectively disclaims on behalf of all Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose;

ii) effectively excludes on behalf of all Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits;

iii) states that any provisions which differ from this Agreement are offered by that Contributor alone and not by any other party; and

iv) states that source code for the Program is available from such Contributor, and informs licensees how to obtain it in a reasonable manner on or through a medium customarily used for software exchange.

When the Program is made available in source code form:

a) it must be made available under this Agreement; and

b) a copy of this Agreement must be included with each copy of the Program.

Contributors may not remove or alter any copyright notices contained within the Program.

Each Contributor must identify itself as the originator of its Contribution, if any, in a manner that reasonably allows subsequent Recipients to identify the originator of the Contribution.

4. COMMERCIAL DISTRIBUTION

Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor ("Commercial Contributor") hereby agrees to defend and indemnify every other Contributor ("Indemnified Contributor") against any losses, damages and costs (collectively "Losses") arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense.

For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages.

5. NO WARRANTY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations.

6. DISCLAIMER OF LIABILITY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

7. GENERAL

If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.

If Recipient institutes patent litigation against a Contributor with respect to a patent applicable to software (including a cross-claim or counterclaim in a lawsuit), then any patent licenses granted by that Contributor to such Recipient under this Agreement shall terminate as of the date such litigation is filed. In addition, if Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed.

All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive.

Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. IBM is the initial Agreement Steward. IBM may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to distribute the Program (including its Contributions) under the new version. Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved.

This Agreement is governed by the laws of the State of New York and the intellectual property laws of the United States of America. No party to this Agreement will bring a legal action under this Agreement more than one year after the cause of action arose. Each party waives its rights to a jury trial in any resulting litigation.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9434