Autogenerated update (2019-05-23)

Delete:
- youtube_analytics_v1beta1

Update:
- alertcenter_v1beta1
- composer_v1
- composer_v1beta1
- container_v1
- dialogflow_v2
- games_v1
- healthcare_v1alpha2
- healthcare_v1beta1
- remotebuildexecution_v1
- remotebuildexecution_v1alpha
- remotebuildexecution_v2
- youtube_analytics_v1
This commit is contained in:
Google APIs 2019-05-23 00:38:08 +00:00
parent 8c6f7bce71
commit 659fd6dff8
36 changed files with 247 additions and 2032 deletions

View File

@ -25,7 +25,7 @@ module Google
# @see https://developers.google.com/admin-sdk/alertcenter/
module AlertcenterV1beta1
VERSION = 'V1beta1'
REVISION = '20190418'
REVISION = '20190520'
# See and delete your domain's G Suite alerts, and send alert feedback
AUTH_APPS_ALERTS = 'https://www.googleapis.com/auth/apps.alerts'

View File

@ -788,6 +788,11 @@ module Google
class MaliciousEntity
include Google::Apis::Core::Hashable
# The header from display name.
# Corresponds to the JSON property `displayName`
# @return [String]
attr_accessor :display_name
# The sender email address.
# Corresponds to the JSON property `fromHeader`
# @return [String]
@ -799,6 +804,7 @@ module Google
# Update properties of this object
def update!(**args)
@display_name = args[:display_name] if args.key?(:display_name)
@from_header = args[:from_header] if args.key?(:from_header)
end
end

View File

@ -400,6 +400,7 @@ module Google
class MaliciousEntity
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :display_name, as: 'displayName'
property :from_header, as: 'fromHeader'
end
end

View File

@ -25,7 +25,7 @@ module Google
# @see https://cloud.google.com/composer/
module ComposerV1
VERSION = 'V1'
REVISION = '20190311'
REVISION = '20190514'
# View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

View File

@ -113,8 +113,8 @@ module Google
# Output only.
# The URI of the Apache Airflow Web UI hosted within this environment (see
# [Airflow web interface](/composer/docs/how-to/accessing/airflow-web-interface))
# .
# [Airflow web
# interface](/composer/docs/how-to/accessing/airflow-web-interface)).
# Corresponds to the JSON property `airflowUri`
# @return [String]
attr_accessor :airflow_uri
@ -288,8 +288,9 @@ module Google
# Optional. The Compute Engine [zone](/compute/docs/regions-zones) in which
# to deploy the VMs used to run the Apache Airflow software, specified as a
# [relative resource name](/apis/design/resource_names#relative_resource_name).
# For example: "projects/`projectId`/zones/`zoneId`".
# [relative resource
# name](/apis/design/resource_names#relative_resource_name). For example:
# "projects/`projectId`/zones/`zoneId`".
# This `location` must belong to the enclosing environment's project and
# location. If both this field and `nodeConfig.machineType` are specified,
# `nodeConfig.machineType` must belong to this `location`; if both are
@ -305,8 +306,8 @@ module Google
# Optional. The Compute Engine
# [machine type](/compute/docs/machine-types) used for cluster instances,
# specified as a
# [relative resource name](/apis/design/resource_names#relative_resource_name).
# For example:
# [relative resource
# name](/apis/design/resource_names#relative_resource_name). For example:
# "projects/`projectId`/zones/`zoneId`/machineTypes/`machineTypeId`".
# The `machineType` must belong to the enclosing environment's project and
# location. If both this field and `nodeConfig.location` are specified,
@ -324,8 +325,9 @@ module Google
# Optional. The Compute Engine network to be used for machine
# communications, specified as a
# [relative resource name](/apis/design/resource_names#relative_resource_name).
# For example: "projects/`projectId`/global/networks/`networkId`".
# [relative resource
# name](/apis/design/resource_names#relative_resource_name). For example:
# "projects/`projectId`/global/networks/`networkId`".
# [Shared VPC](/vpc/docs/shared-vpc) is not currently supported. The
# network must belong to the environment's project. If unspecified, the
# "default" network ID in the environment's project is used. If a
@ -351,8 +353,8 @@ module Google
# Optional. The Compute Engine subnetwork to be used for machine
# communications, specified as a
# [relative resource name](/apis/design/resource_names#relative_resource_name).
# For example:
# [relative resource
# name](/apis/design/resource_names#relative_resource_name). For example:
# "projects/`projectId`/regions/`regionId`/subnetworks/`subnetworkId`"
# If a subnetwork is provided, `nodeConfig.network` must also be provided,
# and the subnetwork must belong to the enclosing environment's project and
@ -452,7 +454,7 @@ module Google
# The server-assigned name, which is only unique within the same service that
# originally returns it. If you use the default HTTP mapping, the
# `name` should have the format of `operations/some/unique/name`.
# `name` should be a resource name ending with `operations/`unique_id``.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
@ -545,15 +547,15 @@ module Google
include Google::Apis::Core::Hashable
# Optional. Apache Airflow configuration properties to override.
# Property keys contain the section and property names, separated by a hyphen,
# for example "core-dags_are_paused_at_creation". Section names must not
# contain hyphens ("-"), opening square brackets ("["), or closing square
# brackets ("]"). The property name must not be empty and must not contain
# an equals sign ("=") or semicolon (";"). Section and property names must
# not contain a period ("."). Apache Airflow configuration property names
# must be written in [snake_case](https://en.wikipedia.org/wiki/Snake_case).
# Property values can contain any character, and can be written in any
# lower/upper case format.
# Property keys contain the section and property names, separated by a
# hyphen, for example "core-dags_are_paused_at_creation". Section names must
# not contain hyphens ("-"), opening square brackets ("["), or closing
# square brackets ("]"). The property name must not be empty and must not
# contain an equals sign ("=") or semicolon (";"). Section and property names
# must not contain a period ("."). Apache Airflow configuration property
# names must be written in
# [snake_case](https://en.wikipedia.org/wiki/Snake_case). Property values can
# contain any character, and can be written in any lower/upper case format.
# Certain Apache Airflow configuration property values are
# [blacklisted](/composer/docs/how-to/managing/setting-airflow-configurations#
# airflow_configuration_blacklists),
@ -601,7 +603,8 @@ module Google
# The portion of the image version that follows <em>airflow-</em> is an
# official Apache Airflow repository
# [release name](https://github.com/apache/incubator-airflow/releases).
# See also [Version List](/composer/docs/concepts/versioning/composer-versions).
# See also [Version
# List](/composer/docs/concepts/versioning/composer-versions).
# Corresponds to the JSON property `imageVersion`
# @return [String]
attr_accessor :image_version

View File

@ -49,7 +49,8 @@ module Google
# Create a new environment.
# @param [String] parent
# The parent must be of the form "projects/`projectId`/locations/`locationId`".
# The parent must be of the form
# "projects/`projectId`/locations/`locationId`".
# @param [Google::Apis::ComposerV1::Environment] environment_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@ -277,7 +278,8 @@ module Google
# <tr>
# <td>config.nodeCount</td>
# <td>Horizontally scale the number of nodes in the environment. An integer
# greater than or equal to 3 must be provided in the `config.nodeCount` field.
# greater than or equal to 3 must be provided in the `config.nodeCount`
# field.
# </td>
# </tr>
# <tr>

View File

@ -25,7 +25,7 @@ module Google
# @see https://cloud.google.com/composer/
module ComposerV1beta1
VERSION = 'V1beta1'
REVISION = '20190323'
REVISION = '20190514'
# View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

View File

@ -113,8 +113,8 @@ module Google
# Output only.
# The URI of the Apache Airflow Web UI hosted within this environment (see
# [Airflow web interface](/composer/docs/how-to/accessing/airflow-web-interface))
# .
# [Airflow web
# interface](/composer/docs/how-to/accessing/airflow-web-interface)).
# Corresponds to the JSON property `airflowUri`
# @return [String]
attr_accessor :airflow_uri
@ -377,8 +377,9 @@ module Google
# Optional. The Compute Engine [zone](/compute/docs/regions-zones) in which
# to deploy the VMs used to run the Apache Airflow software, specified as a
# [relative resource name](/apis/design/resource_names#relative_resource_name).
# For example: "projects/`projectId`/zones/`zoneId`".
# [relative resource
# name](/apis/design/resource_names#relative_resource_name). For example:
# "projects/`projectId`/zones/`zoneId`".
# This `location` must belong to the enclosing environment's project and
# location. If both this field and `nodeConfig.machineType` are specified,
# `nodeConfig.machineType` must belong to this `location`; if both are
@ -394,8 +395,8 @@ module Google
# Optional. The Compute Engine
# [machine type](/compute/docs/machine-types) used for cluster instances,
# specified as a
# [relative resource name](/apis/design/resource_names#relative_resource_name).
# For example:
# [relative resource
# name](/apis/design/resource_names#relative_resource_name). For example:
# "projects/`projectId`/zones/`zoneId`/machineTypes/`machineTypeId`".
# The `machineType` must belong to the enclosing environment's project and
# location. If both this field and `nodeConfig.location` are specified,
@ -413,8 +414,9 @@ module Google
# Optional. The Compute Engine network to be used for machine
# communications, specified as a
# [relative resource name](/apis/design/resource_names#relative_resource_name).
# For example: "projects/`projectId`/global/networks/`networkId`".
# [relative resource
# name](/apis/design/resource_names#relative_resource_name). For example:
# "projects/`projectId`/global/networks/`networkId`".
# If unspecified, the default network in the environment's project is used.
# If a [Custom Subnet Network](/vpc/docs/vpc#vpc_networks_and_subnets)
# is provided, `nodeConfig.subnetwork` must also be provided. For
@ -440,8 +442,8 @@ module Google
# Optional. The Compute Engine subnetwork to be used for machine
# communications, specified as a
# [relative resource name](/apis/design/resource_names#relative_resource_name).
# For example:
# [relative resource
# name](/apis/design/resource_names#relative_resource_name). For example:
# "projects/`projectId`/regions/`regionId`/subnetworks/`subnetworkId`"
# If a subnetwork is provided, `nodeConfig.network` must also be provided,
# and the subnetwork must belong to the enclosing environment's project and
@ -542,7 +544,7 @@ module Google
# The server-assigned name, which is only unique within the same service that
# originally returns it. If you use the default HTTP mapping, the
# `name` should have the format of `operations/some/unique/name`.
# `name` should be a resource name ending with `operations/`unique_id``.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
@ -697,15 +699,15 @@ module Google
include Google::Apis::Core::Hashable
# Optional. Apache Airflow configuration properties to override.
# Property keys contain the section and property names, separated by a hyphen,
# for example "core-dags_are_paused_at_creation". Section names must not
# contain hyphens ("-"), opening square brackets ("["), or closing square
# brackets ("]"). The property name must not be empty and must not contain
# an equals sign ("=") or semicolon (";"). Section and property names must
# not contain a period ("."). Apache Airflow configuration property names
# must be written in [snake_case](https://en.wikipedia.org/wiki/Snake_case).
# Property values can contain any character, and can be written in any
# lower/upper case format.
# Property keys contain the section and property names, separated by a
# hyphen, for example "core-dags_are_paused_at_creation". Section names must
# not contain hyphens ("-"), opening square brackets ("["), or closing
# square brackets ("]"). The property name must not be empty and must not
# contain an equals sign ("=") or semicolon (";"). Section and property names
# must not contain a period ("."). Apache Airflow configuration property
# names must be written in
# [snake_case](https://en.wikipedia.org/wiki/Snake_case). Property values can
# contain any character, and can be written in any lower/upper case format.
# Certain Apache Airflow configuration property values are
# [blacklisted](/composer/docs/how-to/managing/setting-airflow-configurations#
# airflow_configuration_blacklists),
@ -753,7 +755,8 @@ module Google
# The portion of the image version that follows <em>airflow-</em> is an
# official Apache Airflow repository
# [release name](https://github.com/apache/incubator-airflow/releases).
# See also [Version List](/composer/docs/concepts/versioning/composer-versions).
# See also [Version
# List](/composer/docs/concepts/versioning/composer-versions).
# Corresponds to the JSON property `imageVersion`
# @return [String]
attr_accessor :image_version

View File

@ -49,7 +49,8 @@ module Google
# Create a new environment.
# @param [String] parent
# The parent must be of the form "projects/`projectId`/locations/`locationId`".
# The parent must be of the form
# "projects/`projectId`/locations/`locationId`".
# @param [Google::Apis::ComposerV1beta1::Environment] environment_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@ -277,7 +278,8 @@ module Google
# <tr>
# <td>config.nodeCount</td>
# <td>Horizontally scale the number of nodes in the environment. An integer
# greater than or equal to 3 must be provided in the `config.nodeCount` field.
# greater than or equal to 3 must be provided in the `config.nodeCount`
# field.
# </td>
# </tr>
# <tr>

View File

@ -26,7 +26,7 @@ module Google
# @see https://cloud.google.com/container-engine/
module ContainerV1
VERSION = 'V1'
REVISION = '20190423'
REVISION = '20190514'
# View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

View File

@ -817,7 +817,7 @@ module Google
# Time within the maintenance window to start the maintenance operations.
# Time format should be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt)
# format "HH:MM, where HH : [00-23] and MM : [00-59] GMT.
# format "HH:MM", where HH : [00-23] and MM : [00-59] GMT.
# Corresponds to the JSON property `startTime`
# @return [String]
attr_accessor :start_time

View File

@ -26,7 +26,7 @@ module Google
# @see https://cloud.google.com/dialogflow-enterprise/
module DialogflowV2
VERSION = 'V2'
REVISION = '20190514'
REVISION = '20190520'
# View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

View File

@ -2201,7 +2201,8 @@ module Google
# - If natural language speech audio was provided as input, `query_text`
# contains the speech recognition result. If speech recognizer produced
# multiple alternatives, a particular one is picked.
# - If an event was provided as input, `query_text` is not set.
# - If automatic spell correction is enabled, `query_text` will contain the
# corrected user input.
# Corresponds to the JSON property `queryText`
# @return [String]
attr_accessor :query_text
@ -4228,7 +4229,8 @@ module Google
# - If natural language speech audio was provided as input, `query_text`
# contains the speech recognition result. If speech recognizer produced
# multiple alternatives, a particular one is picked.
# - If an event was provided as input, `query_text` is not set.
# - If automatic spell correction is enabled, `query_text` will contain the
# corrected user input.
# Corresponds to the JSON property `queryText`
# @return [String]
attr_accessor :query_text

View File

@ -25,16 +25,13 @@ module Google
# @see https://developers.google.com/games/services/
module GamesV1
VERSION = 'V1'
REVISION = '20190404'
REVISION = '20190516'
# View and manage its own configuration data in your Google Drive
AUTH_DRIVE_APPDATA = 'https://www.googleapis.com/auth/drive.appdata'
# Create, edit, and delete your Google Play Games activity
AUTH_GAMES = 'https://www.googleapis.com/auth/games'
# Associate you with your personal info on Google
AUTH_PLUS_ME = 'https://www.googleapis.com/auth/plus.me'
end
end
end

View File

@ -25,7 +25,7 @@ module Google
# @see https://cloud.google.com/healthcare
module HealthcareV1alpha2
VERSION = 'V1alpha2'
REVISION = '20190503'
REVISION = '20190517'
# View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

View File

@ -1176,7 +1176,7 @@ module Google
# @return [String]
attr_accessor :dataset_uri
# Configuration for the FHIR BigQuery schema. Determines how the server
# Configuration for the FHIR BigQuery and GCS schema. Determines how the server
# generates the schema.
# Corresponds to the JSON property `schemaConfig`
# @return [Google::Apis::HealthcareV1alpha2::SchemaConfig]
@ -2477,7 +2477,7 @@ module Google
end
end
# Configuration for the FHIR BigQuery schema. Determines how the server
# Configuration for the FHIR BigQuery and GCS schema. Determines how the server
# generates the schema.
class SchemaConfig
include Google::Apis::Core::Hashable

View File

@ -1295,7 +1295,7 @@ module Google
end
# SearchForInstances returns a list of matching instances. See
# http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.7
# http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6.
# @param [String] parent
# The name of the DICOM store that is being accessed (e.g.,
# `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
@ -1333,7 +1333,7 @@ module Google
end
# SearchForSeries returns a list of matching series. See
# http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.7
# http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6.
# @param [String] parent
# The name of the DICOM store that is being accessed (e.g.,
# `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
@ -1371,7 +1371,7 @@ module Google
end
# SearchForStudies returns a list of matching studies. See
# http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.7
# http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6.
# @param [String] parent
# The name of the DICOM store that is being accessed (e.g.,
# `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
@ -1410,7 +1410,7 @@ module Google
# StoreInstances stores DICOM instances associated with study instance unique
# identifiers (SUID). See
# http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.6.1.
# http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5.
# @param [String] parent
# The name of the DICOM store that is being accessed (e.g.,
# `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
@ -1488,7 +1488,7 @@ module Google
# RetrieveStudyMetadata returns instance associated with the given study
# presented as metadata with the bulk data removed. See
# http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.5.6.
# http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4.
# @param [String] parent
# The name of the DICOM store that is being accessed (e.g.,
# `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
@ -1525,7 +1525,7 @@ module Google
end
# RetrieveStudy returns all instances within the given study. See
# http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.5.1.
# http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4.
# @param [String] parent
# The name of the DICOM store that is being accessed (e.g.,
# `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
@ -1562,7 +1562,7 @@ module Google
end
# SearchForInstances returns a list of matching instances. See
# http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.7
# http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6.
# @param [String] parent
# The name of the DICOM store that is being accessed (e.g.,
# `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
@ -1600,7 +1600,7 @@ module Google
end
# SearchForSeries returns a list of matching series. See
# http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.7
# http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6.
# @param [String] parent
# The name of the DICOM store that is being accessed (e.g.,
# `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
@ -1639,7 +1639,7 @@ module Google
# StoreInstances stores DICOM instances associated with study instance unique
# identifiers (SUID). See
# http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.6.1.
# http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5.
# @param [String] parent
# The name of the DICOM store that is being accessed (e.g.,
# `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
@ -1718,7 +1718,7 @@ module Google
# RetrieveSeriesMetadata returns instance associated with the given study and
# series, presented as metadata with the bulk data removed. See
# http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.5.6.
# http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4.
# @param [String] parent
# The name of the DICOM store that is being accessed (e.g.,
# `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
@ -1755,7 +1755,7 @@ module Google
end
# RetrieveSeries returns all instances within the given study and series. See
# http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.5.2.
# http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4.
# @param [String] parent
# The name of the DICOM store that is being accessed (e.g.,
# `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
@ -1792,7 +1792,7 @@ module Google
end
# SearchForInstances returns a list of matching instances. See
# http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.7
# http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6.
# @param [String] parent
# The name of the DICOM store that is being accessed (e.g.,
# `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
@ -1871,7 +1871,7 @@ module Google
# RetrieveInstanceMetadata returns instance associated with the given study,
# series, and SOP Instance UID presented as metadata with the bulk data
# removed. See
# http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.5.6.
# http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4.
# @param [String] parent
# The name of the DICOM store that is being accessed (e.g.,
# `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
@ -1910,7 +1910,7 @@ module Google
# RetrieveRenderedInstance returns instance associated with the given study,
# series, and SOP Instance UID in an acceptable Rendered Media Type. See
# http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.5.8.
# http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4.
# @param [String] parent
# The name of the DICOM store that is being accessed (e.g.,
# `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
@ -1918,7 +1918,7 @@ module Google
# @param [String] dicom_web_path
# The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or
# QIDO-RS standard (e.g.,
# `studies/`study_id`/series/`series_id`/instance/`instance_id`/rendered`).
# `studies/`study_id`/series/`series_id`/instances/`instance_id`/rendered`).
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -1949,7 +1949,7 @@ module Google
# RetrieveInstance returns instance associated with the given study, series,
# and SOP Instance UID. See
# http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.5.3.
# http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4.
# @param [String] parent
# The name of the DICOM store that is being accessed (e.g.,
# `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
@ -1957,7 +1957,7 @@ module Google
# @param [String] dicom_web_path
# The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or
# QIDO-RS standard (e.g.,
# `studies/`study_id`/series/`series_id`/instance/`instance_id``).
# `studies/`study_id`/series/`series_id`/instances/`instance_id``).
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -1989,7 +1989,7 @@ module Google
# RetrieveRenderedFrames returns instances associated with the given study,
# series, SOP Instance UID and frame numbers in an acceptable Rendered Media
# Type. See
# http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.5.8.
# http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4.
# @param [String] parent
# The name of the DICOM store that is being accessed (e.g.,
# `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
@ -1997,7 +1997,7 @@ module Google
# @param [String] dicom_web_path
# The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or
# QIDO-RS standard (e.g.,
# `studies/`study_id`/series/`series_id`/instance/`instance_id`/frames/`
# `studies/`study_id`/series/`series_id`/instances/`instance_id`/frames/`
# frame_list`/rendered`).
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@ -2029,7 +2029,7 @@ module Google
# RetrieveFrames returns instances associated with the given study, series,
# SOP Instance UID and frame numbers. See
# http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.5.4.
# http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4.
# @param [String] parent
# The name of the DICOM store that is being accessed (e.g.,
# `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
@ -2037,7 +2037,7 @@ module Google
# @param [String] dicom_web_path
# The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or
# QIDO-RS standard (e.g.,
# `studies/`study_id`/series/`series_id`/instance/`instance_id`/frames/`
# `studies/`study_id`/series/`series_id`/instances/`instance_id`/frames/`
# frame_list``).
# @param [String] fields
# Selector specifying which fields to include in a partial response.

View File

@ -25,7 +25,7 @@ module Google
# @see https://cloud.google.com/healthcare
module HealthcareV1beta1
VERSION = 'V1beta1'
REVISION = '20190503'
REVISION = '20190517'
# View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

View File

@ -742,7 +742,7 @@ module Google
end
# SearchForInstances returns a list of matching instances. See
# http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.7
# http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6.
# @param [String] parent
# The name of the DICOM store that is being accessed (e.g.,
# `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
@ -780,7 +780,7 @@ module Google
end
# SearchForSeries returns a list of matching series. See
# http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.7
# http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6.
# @param [String] parent
# The name of the DICOM store that is being accessed (e.g.,
# `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
@ -818,7 +818,7 @@ module Google
end
# SearchForStudies returns a list of matching studies. See
# http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.7
# http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6.
# @param [String] parent
# The name of the DICOM store that is being accessed (e.g.,
# `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
@ -892,7 +892,7 @@ module Google
# StoreInstances stores DICOM instances associated with study instance unique
# identifiers (SUID). See
# http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.6.1.
# http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5.
# @param [String] parent
# The name of the DICOM store that is being accessed (e.g.,
# `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
@ -1009,7 +1009,7 @@ module Google
# RetrieveStudyMetadata returns instance associated with the given study
# presented as metadata with the bulk data removed. See
# http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.5.6.
# http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4.
# @param [String] parent
# The name of the DICOM store that is being accessed (e.g.,
# `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
@ -1046,7 +1046,7 @@ module Google
end
# RetrieveStudy returns all instances within the given study. See
# http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.5.1.
# http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4.
# @param [String] parent
# The name of the DICOM store that is being accessed (e.g.,
# `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
@ -1083,7 +1083,7 @@ module Google
end
# SearchForInstances returns a list of matching instances. See
# http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.7
# http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6.
# @param [String] parent
# The name of the DICOM store that is being accessed (e.g.,
# `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
@ -1121,7 +1121,7 @@ module Google
end
# SearchForSeries returns a list of matching series. See
# http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.7
# http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6.
# @param [String] parent
# The name of the DICOM store that is being accessed (e.g.,
# `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
@ -1160,7 +1160,7 @@ module Google
# StoreInstances stores DICOM instances associated with study instance unique
# identifiers (SUID). See
# http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.6.1.
# http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5.
# @param [String] parent
# The name of the DICOM store that is being accessed (e.g.,
# `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
@ -1239,7 +1239,7 @@ module Google
# RetrieveSeriesMetadata returns instance associated with the given study and
# series, presented as metadata with the bulk data removed. See
# http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.5.6.
# http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4.
# @param [String] parent
# The name of the DICOM store that is being accessed (e.g.,
# `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
@ -1276,7 +1276,7 @@ module Google
end
# RetrieveSeries returns all instances within the given study and series. See
# http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.5.2.
# http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4.
# @param [String] parent
# The name of the DICOM store that is being accessed (e.g.,
# `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
@ -1313,7 +1313,7 @@ module Google
end
# SearchForInstances returns a list of matching instances. See
# http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.7
# http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6.
# @param [String] parent
# The name of the DICOM store that is being accessed (e.g.,
# `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
@ -1391,7 +1391,7 @@ module Google
# RetrieveInstance returns instance associated with the given study, series,
# and SOP Instance UID. See
# http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.5.3.
# http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4.
# @param [String] parent
# The name of the DICOM store that is being accessed (e.g.,
# `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
@ -1399,7 +1399,7 @@ module Google
# @param [String] dicom_web_path
# The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or
# QIDO-RS standard (e.g.,
# `studies/`study_id`/series/`series_id`/instance/`instance_id``).
# `studies/`study_id`/series/`series_id`/instances/`instance_id``).
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -1431,7 +1431,7 @@ module Google
# RetrieveInstanceMetadata returns instance associated with the given study,
# series, and SOP Instance UID presented as metadata with the bulk data
# removed. See
# http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.5.6.
# http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4.
# @param [String] parent
# The name of the DICOM store that is being accessed (e.g.,
# `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
@ -1470,7 +1470,7 @@ module Google
# RetrieveRenderedInstance returns instance associated with the given study,
# series, and SOP Instance UID in an acceptable Rendered Media Type. See
# http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.5.8.
# http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4.
# @param [String] parent
# The name of the DICOM store that is being accessed (e.g.,
# `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
@ -1478,7 +1478,7 @@ module Google
# @param [String] dicom_web_path
# The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or
# QIDO-RS standard (e.g.,
# `studies/`study_id`/series/`series_id`/instance/`instance_id`/rendered`).
# `studies/`study_id`/series/`series_id`/instances/`instance_id`/rendered`).
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -1509,7 +1509,7 @@ module Google
# RetrieveFrames returns instances associated with the given study, series,
# SOP Instance UID and frame numbers. See
# http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.5.4.
# http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4.
# @param [String] parent
# The name of the DICOM store that is being accessed (e.g.,
# `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
@ -1517,7 +1517,7 @@ module Google
# @param [String] dicom_web_path
# The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or
# QIDO-RS standard (e.g.,
# `studies/`study_id`/series/`series_id`/instance/`instance_id`/frames/`
# `studies/`study_id`/series/`series_id`/instances/`instance_id`/frames/`
# frame_list``).
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@ -1550,7 +1550,7 @@ module Google
# RetrieveRenderedFrames returns instances associated with the given study,
# series, SOP Instance UID and frame numbers in an acceptable Rendered Media
# Type. See
# http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.5.8.
# http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4.
# @param [String] parent
# The name of the DICOM store that is being accessed (e.g.,
# `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
@ -1558,7 +1558,7 @@ module Google
# @param [String] dicom_web_path
# The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or
# QIDO-RS standard (e.g.,
# `studies/`study_id`/series/`series_id`/instance/`instance_id`/frames/`
# `studies/`study_id`/series/`series_id`/instances/`instance_id`/frames/`
# frame_list`/rendered`).
# @param [String] fields
# Selector specifying which fields to include in a partial response.

View File

@ -25,7 +25,7 @@ module Google
# @see https://cloud.google.com/remote-build-execution/docs/
module RemotebuildexecutionV1
VERSION = 'V1'
REVISION = '20190507'
REVISION = '20190521'
# View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

View File

@ -1565,6 +1565,31 @@ module Google
end
end
# The internal status of the command result.
class GoogleDevtoolsRemotebuildbotCommandStatus
include Google::Apis::Core::Hashable
# The status code.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# The error message.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@message = args[:message] if args.key?(:message)
end
end
# The request used for `CreateInstance`.
class GoogleDevtoolsRemotebuildexecutionAdminV1alphaCreateInstanceRequest
include Google::Apis::Core::Hashable

View File

@ -166,6 +166,12 @@ module Google
include Google::Apis::Core::JsonObjectSupport
end
class GoogleDevtoolsRemotebuildbotCommandStatus
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleDevtoolsRemotebuildexecutionAdminV1alphaCreateInstanceRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
@ -722,6 +728,14 @@ module Google
end
end
class GoogleDevtoolsRemotebuildbotCommandStatus
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :code, as: 'code'
property :message, as: 'message'
end
end
class GoogleDevtoolsRemotebuildexecutionAdminV1alphaCreateInstanceRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation

View File

@ -25,7 +25,7 @@ module Google
# @see https://cloud.google.com/remote-build-execution/docs/
module RemotebuildexecutionV1alpha
VERSION = 'V1alpha'
REVISION = '20190507'
REVISION = '20190521'
# View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

View File

@ -1546,6 +1546,31 @@ module Google
end
end
# The internal status of the command result.
class GoogleDevtoolsRemotebuildbotCommandStatus
include Google::Apis::Core::Hashable
# The status code.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# The error message.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@message = args[:message] if args.key?(:message)
end
end
# The request used for `CreateInstance`.
class GoogleDevtoolsRemotebuildexecutionAdminV1alphaCreateInstanceRequest
include Google::Apis::Core::Hashable

View File

@ -160,6 +160,12 @@ module Google
include Google::Apis::Core::JsonObjectSupport
end
class GoogleDevtoolsRemotebuildbotCommandStatus
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleDevtoolsRemotebuildexecutionAdminV1alphaCreateInstanceRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
@ -679,6 +685,14 @@ module Google
end
end
class GoogleDevtoolsRemotebuildbotCommandStatus
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :code, as: 'code'
property :message, as: 'message'
end
end
class GoogleDevtoolsRemotebuildexecutionAdminV1alphaCreateInstanceRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation

View File

@ -25,7 +25,7 @@ module Google
# @see https://cloud.google.com/remote-build-execution/docs/
module RemotebuildexecutionV2
VERSION = 'V2'
REVISION = '20190507'
REVISION = '20190521'
# View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

View File

@ -2299,6 +2299,31 @@ module Google
end
end
# The internal status of the command result.
class GoogleDevtoolsRemotebuildbotCommandStatus
include Google::Apis::Core::Hashable
# The status code.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# The error message.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@message = args[:message] if args.key?(:message)
end
end
# The request used for `CreateInstance`.
class GoogleDevtoolsRemotebuildexecutionAdminV1alphaCreateInstanceRequest
include Google::Apis::Core::Hashable

View File

@ -286,6 +286,12 @@ module Google
include Google::Apis::Core::JsonObjectSupport
end
class GoogleDevtoolsRemotebuildbotCommandStatus
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleDevtoolsRemotebuildexecutionAdminV1alphaCreateInstanceRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
@ -997,6 +1003,14 @@ module Google
end
end
class GoogleDevtoolsRemotebuildbotCommandStatus
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :code, as: 'code'
property :message, as: 'message'
end
end
class GoogleDevtoolsRemotebuildexecutionAdminV1alphaCreateInstanceRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation

View File

@ -22,25 +22,10 @@ module Google
#
# Retrieves your YouTube Analytics data.
#
# @see http://developers.google.com/youtube/analytics/
# @see https://developers.google.com/youtube/analytics
module YoutubeAnalyticsV1
VERSION = 'V1'
REVISION = '20180805'
# Manage your YouTube account
AUTH_YOUTUBE = 'https://www.googleapis.com/auth/youtube'
# View your YouTube account
AUTH_YOUTUBE_READONLY = 'https://www.googleapis.com/auth/youtube.readonly'
# View and manage your assets and associated content on YouTube
AUTH_YOUTUBEPARTNER = 'https://www.googleapis.com/auth/youtubepartner'
# View monetary and non-monetary YouTube Analytics reports for your YouTube content
AUTH_YT_ANALYTICS_MONETARY_READONLY = 'https://www.googleapis.com/auth/yt-analytics-monetary.readonly'
# View YouTube Analytics reports for your YouTube content
AUTH_YT_ANALYTICS_READONLY = 'https://www.googleapis.com/auth/yt-analytics.readonly'
REVISION = '20190521'
end
end
end

View File

@ -21,317 +21,6 @@ require 'google/apis/errors'
module Google
module Apis
module YoutubeAnalyticsV1
#
class Group
include Google::Apis::Core::Hashable
#
# Corresponds to the JSON property `contentDetails`
# @return [Google::Apis::YoutubeAnalyticsV1::Group::ContentDetails]
attr_accessor :content_details
#
# Corresponds to the JSON property `etag`
# @return [String]
attr_accessor :etag
#
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
#
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
#
# Corresponds to the JSON property `snippet`
# @return [Google::Apis::YoutubeAnalyticsV1::Group::Snippet]
attr_accessor :snippet
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@content_details = args[:content_details] if args.key?(:content_details)
@etag = args[:etag] if args.key?(:etag)
@id = args[:id] if args.key?(:id)
@kind = args[:kind] if args.key?(:kind)
@snippet = args[:snippet] if args.key?(:snippet)
end
#
class ContentDetails
include Google::Apis::Core::Hashable
#
# Corresponds to the JSON property `itemCount`
# @return [Fixnum]
attr_accessor :item_count
#
# Corresponds to the JSON property `itemType`
# @return [String]
attr_accessor :item_type
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@item_count = args[:item_count] if args.key?(:item_count)
@item_type = args[:item_type] if args.key?(:item_type)
end
end
#
class Snippet
include Google::Apis::Core::Hashable
#
# Corresponds to the JSON property `publishedAt`
# @return [DateTime]
attr_accessor :published_at
#
# Corresponds to the JSON property `title`
# @return [String]
attr_accessor :title
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@published_at = args[:published_at] if args.key?(:published_at)
@title = args[:title] if args.key?(:title)
end
end
end
#
class GroupItem
include Google::Apis::Core::Hashable
#
# Corresponds to the JSON property `etag`
# @return [String]
attr_accessor :etag
#
# Corresponds to the JSON property `groupId`
# @return [String]
attr_accessor :group_id
#
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
#
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
#
# Corresponds to the JSON property `resource`
# @return [Google::Apis::YoutubeAnalyticsV1::GroupItem::Resource]
attr_accessor :resource
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@etag = args[:etag] if args.key?(:etag)
@group_id = args[:group_id] if args.key?(:group_id)
@id = args[:id] if args.key?(:id)
@kind = args[:kind] if args.key?(:kind)
@resource = args[:resource] if args.key?(:resource)
end
#
class Resource
include Google::Apis::Core::Hashable
#
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
#
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@kind = args[:kind] if args.key?(:kind)
end
end
end
# A paginated list of grouList resources returned in response to a
# youtubeAnalytics.groupApi.list request.
class ListGroupItemResponse
include Google::Apis::Core::Hashable
#
# Corresponds to the JSON property `etag`
# @return [String]
attr_accessor :etag
#
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::YoutubeAnalyticsV1::GroupItem>]
attr_accessor :items
#
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@etag = args[:etag] if args.key?(:etag)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
end
end
# A paginated list of grouList resources returned in response to a
# youtubeAnalytics.groupApi.list request.
class ListGroupsResponse
include Google::Apis::Core::Hashable
#
# Corresponds to the JSON property `etag`
# @return [String]
attr_accessor :etag
#
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::YoutubeAnalyticsV1::Group>]
attr_accessor :items
#
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
#
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@etag = args[:etag] if args.key?(:etag)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
end
end
# Contains a single result table. The table is returned as an array of rows that
# contain the values for the cells of the table. Depending on the metric or
# dimension, the cell can contain a string (video ID, country code) or a number (
# number of views or number of likes).
class ResultTable
include Google::Apis::Core::Hashable
# This value specifies information about the data returned in the rows fields.
# Each item in the columnHeaders list identifies a field returned in the rows
# value, which contains a list of comma-delimited data. The columnHeaders list
# will begin with the dimensions specified in the API request, which will be
# followed by the metrics specified in the API request. The order of both
# dimensions and metrics will match the ordering in the API request. For example,
# if the API request contains the parameters dimensions=ageGroup,gender&metrics=
# viewerPercentage, the API response will return columns in this order: ageGroup,
# gender,viewerPercentage.
# Corresponds to the JSON property `columnHeaders`
# @return [Array<Google::Apis::YoutubeAnalyticsV1::ResultTable::ColumnHeader>]
attr_accessor :column_headers
# This value specifies the type of data included in the API response. For the
# query method, the kind property value will be youtubeAnalytics#resultTable.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# The list contains all rows of the result table. Each item in the list is an
# array that contains comma-delimited data corresponding to a single row of data.
# The order of the comma-delimited data fields will match the order of the
# columns listed in the columnHeaders field. If no data is available for the
# given query, the rows element will be omitted from the response. The response
# for a query with the day dimension will not contain rows for the most recent
# days.
# Corresponds to the JSON property `rows`
# @return [Array<Array<Object>>]
attr_accessor :rows
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@column_headers = args[:column_headers] if args.key?(:column_headers)
@kind = args[:kind] if args.key?(:kind)
@rows = args[:rows] if args.key?(:rows)
end
#
class ColumnHeader
include Google::Apis::Core::Hashable
# The type of the column (DIMENSION or METRIC).
# Corresponds to the JSON property `columnType`
# @return [String]
attr_accessor :column_type
# The type of the data in the column (STRING, INTEGER, FLOAT, etc.).
# Corresponds to the JSON property `dataType`
# @return [String]
attr_accessor :data_type
# The name of the dimension or metric.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@column_type = args[:column_type] if args.key?(:column_type)
@data_type = args[:data_type] if args.key?(:data_type)
@name = args[:name] if args.key?(:name)
end
end
end
end
end
end

View File

@ -21,154 +21,6 @@ require 'google/apis/errors'
module Google
module Apis
module YoutubeAnalyticsV1
class Group
class Representation < Google::Apis::Core::JsonRepresentation; end
class ContentDetails
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Snippet
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
include Google::Apis::Core::JsonObjectSupport
end
class GroupItem
class Representation < Google::Apis::Core::JsonRepresentation; end
class Resource
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
include Google::Apis::Core::JsonObjectSupport
end
class ListGroupItemResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ListGroupsResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ResultTable
class Representation < Google::Apis::Core::JsonRepresentation; end
class ColumnHeader
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
include Google::Apis::Core::JsonObjectSupport
end
class Group
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :content_details, as: 'contentDetails', class: Google::Apis::YoutubeAnalyticsV1::Group::ContentDetails, decorator: Google::Apis::YoutubeAnalyticsV1::Group::ContentDetails::Representation
property :etag, as: 'etag'
property :id, as: 'id'
property :kind, as: 'kind'
property :snippet, as: 'snippet', class: Google::Apis::YoutubeAnalyticsV1::Group::Snippet, decorator: Google::Apis::YoutubeAnalyticsV1::Group::Snippet::Representation
end
class ContentDetails
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :item_count, :numeric_string => true, as: 'itemCount'
property :item_type, as: 'itemType'
end
end
class Snippet
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :published_at, as: 'publishedAt', type: DateTime
property :title, as: 'title'
end
end
end
class GroupItem
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :etag, as: 'etag'
property :group_id, as: 'groupId'
property :id, as: 'id'
property :kind, as: 'kind'
property :resource, as: 'resource', class: Google::Apis::YoutubeAnalyticsV1::GroupItem::Resource, decorator: Google::Apis::YoutubeAnalyticsV1::GroupItem::Resource::Representation
end
class Resource
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :id, as: 'id'
property :kind, as: 'kind'
end
end
end
class ListGroupItemResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :etag, as: 'etag'
collection :items, as: 'items', class: Google::Apis::YoutubeAnalyticsV1::GroupItem, decorator: Google::Apis::YoutubeAnalyticsV1::GroupItem::Representation
property :kind, as: 'kind'
end
end
class ListGroupsResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :etag, as: 'etag'
collection :items, as: 'items', class: Google::Apis::YoutubeAnalyticsV1::Group, decorator: Google::Apis::YoutubeAnalyticsV1::Group::Representation
property :kind, as: 'kind'
property :next_page_token, as: 'nextPageToken'
end
end
class ResultTable
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :column_headers, as: 'columnHeaders', class: Google::Apis::YoutubeAnalyticsV1::ResultTable::ColumnHeader, decorator: Google::Apis::YoutubeAnalyticsV1::ResultTable::ColumnHeader::Representation
property :kind, as: 'kind'
collection :rows, as: 'rows', :class => Array do
include Representable::JSON::Collection
items
end
end
class ColumnHeader
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :column_type, as: 'columnType'
property :data_type, as: 'dataType'
property :name, as: 'name'
end
end
end
end
end
end

View File

@ -30,7 +30,7 @@ module Google
# YoutubeAnalytics = Google::Apis::YoutubeAnalyticsV1 # Alias the module
# service = YoutubeAnalytics::YouTubeAnalyticsService.new
#
# @see http://developers.google.com/youtube/analytics/
# @see https://developers.google.com/youtube/analytics
class YouTubeAnalyticsService < Google::Apis::Core::BaseService
# @return [String]
# API key. Your API key identifies your project and provides you with API access,
@ -38,426 +38,13 @@ module Google
attr_accessor :key
# @return [String]
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
attr_accessor :quota_user
# @return [String]
# Deprecated. Please use quotaUser instead.
attr_accessor :user_ip
def initialize
super('https://www.googleapis.com/', 'youtube/analytics/v1/')
@batch_path = 'batch/youtubeAnalytics/v1'
end
# Removes an item from a group.
# @param [String] id
# The id parameter specifies the YouTube group item ID for the group that is
# being deleted.
# @param [String] on_behalf_of_content_owner
# Note: This parameter is intended exclusively for YouTube content partners.
# The onBehalfOfContentOwner parameter indicates that the request's
# authorization credentials identify a YouTube CMS user who is acting on behalf
# of the content owner specified in the parameter value. This parameter is
# intended for YouTube content partners that own and manage many different
# YouTube channels. It allows content owners to authenticate once and get access
# to all their video and channel data, without having to provide authentication
# credentials for each individual channel. The CMS account that the user
# authenticates with must be linked to the specified YouTube content owner.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [NilClass] No result returned for this method
# @yieldparam err [StandardError] error object if request failed
#
# @return [void]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_group_item(id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:delete, 'groupItems', options)
command.query['id'] = id unless id.nil?
command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
# Creates a group item.
# @param [Google::Apis::YoutubeAnalyticsV1::GroupItem] group_item_object
# @param [String] on_behalf_of_content_owner
# Note: This parameter is intended exclusively for YouTube content partners.
# The onBehalfOfContentOwner parameter indicates that the request's
# authorization credentials identify a YouTube CMS user who is acting on behalf
# of the content owner specified in the parameter value. This parameter is
# intended for YouTube content partners that own and manage many different
# YouTube channels. It allows content owners to authenticate once and get access
# to all their video and channel data, without having to provide authentication
# credentials for each individual channel. The CMS account that the user
# authenticates with must be linked to the specified YouTube content owner.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::YoutubeAnalyticsV1::GroupItem] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::YoutubeAnalyticsV1::GroupItem]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def insert_group_item(group_item_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:post, 'groupItems', options)
command.request_representation = Google::Apis::YoutubeAnalyticsV1::GroupItem::Representation
command.request_object = group_item_object
command.response_representation = Google::Apis::YoutubeAnalyticsV1::GroupItem::Representation
command.response_class = Google::Apis::YoutubeAnalyticsV1::GroupItem
command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
# Returns a collection of group items that match the API request parameters.
# @param [String] group_id
# The id parameter specifies the unique ID of the group for which you want to
# retrieve group items.
# @param [String] on_behalf_of_content_owner
# Note: This parameter is intended exclusively for YouTube content partners.
# The onBehalfOfContentOwner parameter indicates that the request's
# authorization credentials identify a YouTube CMS user who is acting on behalf
# of the content owner specified in the parameter value. This parameter is
# intended for YouTube content partners that own and manage many different
# YouTube channels. It allows content owners to authenticate once and get access
# to all their video and channel data, without having to provide authentication
# credentials for each individual channel. The CMS account that the user
# authenticates with must be linked to the specified YouTube content owner.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::YoutubeAnalyticsV1::ListGroupItemResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::YoutubeAnalyticsV1::ListGroupItemResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_group_items(group_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:get, 'groupItems', options)
command.response_representation = Google::Apis::YoutubeAnalyticsV1::ListGroupItemResponse::Representation
command.response_class = Google::Apis::YoutubeAnalyticsV1::ListGroupItemResponse
command.query['groupId'] = group_id unless group_id.nil?
command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
# Deletes a group.
# @param [String] id
# The id parameter specifies the YouTube group ID for the group that is being
# deleted.
# @param [String] on_behalf_of_content_owner
# Note: This parameter is intended exclusively for YouTube content partners.
# The onBehalfOfContentOwner parameter indicates that the request's
# authorization credentials identify a YouTube CMS user who is acting on behalf
# of the content owner specified in the parameter value. This parameter is
# intended for YouTube content partners that own and manage many different
# YouTube channels. It allows content owners to authenticate once and get access
# to all their video and channel data, without having to provide authentication
# credentials for each individual channel. The CMS account that the user
# authenticates with must be linked to the specified YouTube content owner.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [NilClass] No result returned for this method
# @yieldparam err [StandardError] error object if request failed
#
# @return [void]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_group(id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:delete, 'groups', options)
command.query['id'] = id unless id.nil?
command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
# Creates a group.
# @param [Google::Apis::YoutubeAnalyticsV1::Group] group_object
# @param [String] on_behalf_of_content_owner
# Note: This parameter is intended exclusively for YouTube content partners.
# The onBehalfOfContentOwner parameter indicates that the request's
# authorization credentials identify a YouTube CMS user who is acting on behalf
# of the content owner specified in the parameter value. This parameter is
# intended for YouTube content partners that own and manage many different
# YouTube channels. It allows content owners to authenticate once and get access
# to all their video and channel data, without having to provide authentication
# credentials for each individual channel. The CMS account that the user
# authenticates with must be linked to the specified YouTube content owner.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::YoutubeAnalyticsV1::Group] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::YoutubeAnalyticsV1::Group]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def insert_group(group_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:post, 'groups', options)
command.request_representation = Google::Apis::YoutubeAnalyticsV1::Group::Representation
command.request_object = group_object
command.response_representation = Google::Apis::YoutubeAnalyticsV1::Group::Representation
command.response_class = Google::Apis::YoutubeAnalyticsV1::Group
command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
# Returns a collection of groups that match the API request parameters. For
# example, you can retrieve all groups that the authenticated user owns, or you
# can retrieve one or more groups by their unique IDs.
# @param [String] id
# The id parameter specifies a comma-separated list of the YouTube group ID(s)
# for the resource(s) that are being retrieved. In a group resource, the id
# property specifies the group's YouTube group ID.
# @param [Boolean] mine
# Set this parameter's value to true to instruct the API to only return groups
# owned by the authenticated user.
# @param [String] on_behalf_of_content_owner
# Note: This parameter is intended exclusively for YouTube content partners.
# The onBehalfOfContentOwner parameter indicates that the request's
# authorization credentials identify a YouTube CMS user who is acting on behalf
# of the content owner specified in the parameter value. This parameter is
# intended for YouTube content partners that own and manage many different
# YouTube channels. It allows content owners to authenticate once and get access
# to all their video and channel data, without having to provide authentication
# credentials for each individual channel. The CMS account that the user
# authenticates with must be linked to the specified YouTube content owner.
# @param [String] page_token
# The pageToken parameter identifies a specific page in the result set that
# should be returned. In an API response, the nextPageToken property identifies
# the next page that can be retrieved.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::YoutubeAnalyticsV1::ListGroupsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::YoutubeAnalyticsV1::ListGroupsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_groups(id: nil, mine: nil, on_behalf_of_content_owner: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:get, 'groups', options)
command.response_representation = Google::Apis::YoutubeAnalyticsV1::ListGroupsResponse::Representation
command.response_class = Google::Apis::YoutubeAnalyticsV1::ListGroupsResponse
command.query['id'] = id unless id.nil?
command.query['mine'] = mine unless mine.nil?
command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
# Modifies a group. For example, you could change a group's title.
# @param [Google::Apis::YoutubeAnalyticsV1::Group] group_object
# @param [String] on_behalf_of_content_owner
# Note: This parameter is intended exclusively for YouTube content partners.
# The onBehalfOfContentOwner parameter indicates that the request's
# authorization credentials identify a YouTube CMS user who is acting on behalf
# of the content owner specified in the parameter value. This parameter is
# intended for YouTube content partners that own and manage many different
# YouTube channels. It allows content owners to authenticate once and get access
# to all their video and channel data, without having to provide authentication
# credentials for each individual channel. The CMS account that the user
# authenticates with must be linked to the specified YouTube content owner.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::YoutubeAnalyticsV1::Group] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::YoutubeAnalyticsV1::Group]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def update_group(group_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:put, 'groups', options)
command.request_representation = Google::Apis::YoutubeAnalyticsV1::Group::Representation
command.request_object = group_object
command.response_representation = Google::Apis::YoutubeAnalyticsV1::Group::Representation
command.response_class = Google::Apis::YoutubeAnalyticsV1::Group
command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
# Retrieve your YouTube Analytics reports.
# @param [String] ids
# Identifies the YouTube channel or content owner for which you are retrieving
# YouTube Analytics data.
# - To request data for a YouTube user, set the ids parameter value to channel==
# CHANNEL_ID, where CHANNEL_ID specifies the unique YouTube channel ID.
# - To request data for a YouTube CMS content owner, set the ids parameter value
# to contentOwner==OWNER_NAME, where OWNER_NAME is the CMS name of the content
# owner.
# @param [String] start_date
# The start date for fetching YouTube Analytics data. The value should be in
# YYYY-MM-DD format.
# @param [String] end_date
# The end date for fetching YouTube Analytics data. The value should be in YYYY-
# MM-DD format.
# @param [String] metrics
# A comma-separated list of YouTube Analytics metrics, such as views or likes,
# dislikes. See the Available Reports document for a list of the reports that
# you can retrieve and the metrics available in each report, and see the Metrics
# document for definitions of those metrics.
# @param [String] currency
# The currency to which financial metrics should be converted. The default is US
# Dollar (USD). If the result contains no financial metrics, this flag will be
# ignored. Responds with an error if the specified currency is not recognized.
# @param [String] dimensions
# A comma-separated list of YouTube Analytics dimensions, such as views or
# ageGroup,gender. See the Available Reports document for a list of the reports
# that you can retrieve and the dimensions used for those reports. Also see the
# Dimensions document for definitions of those dimensions.
# @param [String] filters
# A list of filters that should be applied when retrieving YouTube Analytics
# data. The Available Reports document identifies the dimensions that can be
# used to filter each report, and the Dimensions document defines those
# dimensions. If a request uses multiple filters, join them together with a
# semicolon (;), and the returned result table will satisfy both filters. For
# example, a filters parameter value of video==dMH0bHeiRNg;country==IT restricts
# the result set to include data for the given video in Italy.
# @param [Boolean] include_historical_channel_data
# If set to true historical data (i.e. channel data from before the linking of
# the channel to the content owner) will be retrieved.
# @param [Fixnum] max_results
# The maximum number of rows to include in the response.
# @param [String] sort
# A comma-separated list of dimensions or metrics that determine the sort order
# for YouTube Analytics data. By default the sort order is ascending. The '-'
# prefix causes descending sort order.
# @param [Fixnum] start_index
# An index of the first entity to retrieve. Use this parameter as a pagination
# mechanism along with the max-results parameter (one-based, inclusive).
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::YoutubeAnalyticsV1::ResultTable] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::YoutubeAnalyticsV1::ResultTable]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def query_report(ids, start_date, end_date, metrics, currency: nil, dimensions: nil, filters: nil, include_historical_channel_data: nil, max_results: nil, sort: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:get, 'reports', options)
command.response_representation = Google::Apis::YoutubeAnalyticsV1::ResultTable::Representation
command.response_class = Google::Apis::YoutubeAnalyticsV1::ResultTable
command.query['currency'] = currency unless currency.nil?
command.query['dimensions'] = dimensions unless dimensions.nil?
command.query['end-date'] = end_date unless end_date.nil?
command.query['filters'] = filters unless filters.nil?
command.query['ids'] = ids unless ids.nil?
command.query['include-historical-channel-data'] = include_historical_channel_data unless include_historical_channel_data.nil?
command.query['max-results'] = max_results unless max_results.nil?
command.query['metrics'] = metrics unless metrics.nil?
command.query['sort'] = sort unless sort.nil?
command.query['start-date'] = start_date unless start_date.nil?
command.query['start-index'] = start_index unless start_index.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
super('https://youtubeanalytics.googleapis.com/', '')
@batch_path = 'batch'
end
protected
@ -465,7 +52,6 @@ module Google
def apply_command_defaults(command)
command.query['key'] = key unless key.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
end
end
end

View File

@ -1,46 +0,0 @@
# Copyright 2015 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
require 'google/apis/youtube_analytics_v1beta1/service.rb'
require 'google/apis/youtube_analytics_v1beta1/classes.rb'
require 'google/apis/youtube_analytics_v1beta1/representations.rb'
module Google
module Apis
# YouTube Analytics API
#
# Retrieves your YouTube Analytics data.
#
# @see http://developers.google.com/youtube/analytics/
module YoutubeAnalyticsV1beta1
VERSION = 'V1beta1'
REVISION = '20180805'
# Manage your YouTube account
AUTH_YOUTUBE = 'https://www.googleapis.com/auth/youtube'
# View your YouTube account
AUTH_YOUTUBE_READONLY = 'https://www.googleapis.com/auth/youtube.readonly'
# View and manage your assets and associated content on YouTube
AUTH_YOUTUBEPARTNER = 'https://www.googleapis.com/auth/youtubepartner'
# View monetary and non-monetary YouTube Analytics reports for your YouTube content
AUTH_YT_ANALYTICS_MONETARY_READONLY = 'https://www.googleapis.com/auth/yt-analytics-monetary.readonly'
# View YouTube Analytics reports for your YouTube content
AUTH_YT_ANALYTICS_READONLY = 'https://www.googleapis.com/auth/yt-analytics.readonly'
end
end
end

View File

@ -1,337 +0,0 @@
# Copyright 2015 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
require 'date'
require 'google/apis/core/base_service'
require 'google/apis/core/json_representation'
require 'google/apis/core/hashable'
require 'google/apis/errors'
module Google
module Apis
module YoutubeAnalyticsV1beta1
#
class Group
include Google::Apis::Core::Hashable
#
# Corresponds to the JSON property `contentDetails`
# @return [Google::Apis::YoutubeAnalyticsV1beta1::Group::ContentDetails]
attr_accessor :content_details
#
# Corresponds to the JSON property `etag`
# @return [String]
attr_accessor :etag
#
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
#
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
#
# Corresponds to the JSON property `snippet`
# @return [Google::Apis::YoutubeAnalyticsV1beta1::Group::Snippet]
attr_accessor :snippet
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@content_details = args[:content_details] if args.key?(:content_details)
@etag = args[:etag] if args.key?(:etag)
@id = args[:id] if args.key?(:id)
@kind = args[:kind] if args.key?(:kind)
@snippet = args[:snippet] if args.key?(:snippet)
end
#
class ContentDetails
include Google::Apis::Core::Hashable
#
# Corresponds to the JSON property `itemCount`
# @return [Fixnum]
attr_accessor :item_count
#
# Corresponds to the JSON property `itemType`
# @return [String]
attr_accessor :item_type
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@item_count = args[:item_count] if args.key?(:item_count)
@item_type = args[:item_type] if args.key?(:item_type)
end
end
#
class Snippet
include Google::Apis::Core::Hashable
#
# Corresponds to the JSON property `publishedAt`
# @return [DateTime]
attr_accessor :published_at
#
# Corresponds to the JSON property `title`
# @return [String]
attr_accessor :title
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@published_at = args[:published_at] if args.key?(:published_at)
@title = args[:title] if args.key?(:title)
end
end
end
#
class GroupItem
include Google::Apis::Core::Hashable
#
# Corresponds to the JSON property `etag`
# @return [String]
attr_accessor :etag
#
# Corresponds to the JSON property `groupId`
# @return [String]
attr_accessor :group_id
#
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
#
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
#
# Corresponds to the JSON property `resource`
# @return [Google::Apis::YoutubeAnalyticsV1beta1::GroupItem::Resource]
attr_accessor :resource
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@etag = args[:etag] if args.key?(:etag)
@group_id = args[:group_id] if args.key?(:group_id)
@id = args[:id] if args.key?(:id)
@kind = args[:kind] if args.key?(:kind)
@resource = args[:resource] if args.key?(:resource)
end
#
class Resource
include Google::Apis::Core::Hashable
#
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
#
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@kind = args[:kind] if args.key?(:kind)
end
end
end
# A paginated list of grouList resources returned in response to a
# youtubeAnalytics.groupApi.list request.
class GroupItemListResponse
include Google::Apis::Core::Hashable
#
# Corresponds to the JSON property `etag`
# @return [String]
attr_accessor :etag
#
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::YoutubeAnalyticsV1beta1::GroupItem>]
attr_accessor :items
#
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@etag = args[:etag] if args.key?(:etag)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
end
end
# A paginated list of grouList resources returned in response to a
# youtubeAnalytics.groupApi.list request.
class GroupListResponse
include Google::Apis::Core::Hashable
#
# Corresponds to the JSON property `etag`
# @return [String]
attr_accessor :etag
#
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::YoutubeAnalyticsV1beta1::Group>]
attr_accessor :items
#
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
#
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@etag = args[:etag] if args.key?(:etag)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
end
end
# Contains a single result table. The table is returned as an array of rows that
# contain the values for the cells of the table. Depending on the metric or
# dimension, the cell can contain a string (video ID, country code) or a number (
# number of views or number of likes).
class ResultTable
include Google::Apis::Core::Hashable
# This value specifies information about the data returned in the rows fields.
# Each item in the columnHeaders list identifies a field returned in the rows
# value, which contains a list of comma-delimited data. The columnHeaders list
# will begin with the dimensions specified in the API request, which will be
# followed by the metrics specified in the API request. The order of both
# dimensions and metrics will match the ordering in the API request. For example,
# if the API request contains the parameters dimensions=ageGroup,gender&metrics=
# viewerPercentage, the API response will return columns in this order: ageGroup,
# gender,viewerPercentage.
# Corresponds to the JSON property `columnHeaders`
# @return [Array<Google::Apis::YoutubeAnalyticsV1beta1::ResultTable::ColumnHeader>]
attr_accessor :column_headers
# This value specifies the type of data included in the API response. For the
# query method, the kind property value will be youtubeAnalytics#resultTable.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# The list contains all rows of the result table. Each item in the list is an
# array that contains comma-delimited data corresponding to a single row of data.
# The order of the comma-delimited data fields will match the order of the
# columns listed in the columnHeaders field. If no data is available for the
# given query, the rows element will be omitted from the response. The response
# for a query with the day dimension will not contain rows for the most recent
# days.
# Corresponds to the JSON property `rows`
# @return [Array<Array<Object>>]
attr_accessor :rows
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@column_headers = args[:column_headers] if args.key?(:column_headers)
@kind = args[:kind] if args.key?(:kind)
@rows = args[:rows] if args.key?(:rows)
end
#
class ColumnHeader
include Google::Apis::Core::Hashable
# The type of the column (DIMENSION or METRIC).
# Corresponds to the JSON property `columnType`
# @return [String]
attr_accessor :column_type
# The type of the data in the column (STRING, INTEGER, FLOAT, etc.).
# Corresponds to the JSON property `dataType`
# @return [String]
attr_accessor :data_type
# The name of the dimension or metric.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@column_type = args[:column_type] if args.key?(:column_type)
@data_type = args[:data_type] if args.key?(:data_type)
@name = args[:name] if args.key?(:name)
end
end
end
end
end
end

View File

@ -1,174 +0,0 @@
# Copyright 2015 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
require 'date'
require 'google/apis/core/base_service'
require 'google/apis/core/json_representation'
require 'google/apis/core/hashable'
require 'google/apis/errors'
module Google
module Apis
module YoutubeAnalyticsV1beta1
class Group
class Representation < Google::Apis::Core::JsonRepresentation; end
class ContentDetails
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Snippet
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
include Google::Apis::Core::JsonObjectSupport
end
class GroupItem
class Representation < Google::Apis::Core::JsonRepresentation; end
class Resource
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
include Google::Apis::Core::JsonObjectSupport
end
class GroupItemListResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GroupListResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ResultTable
class Representation < Google::Apis::Core::JsonRepresentation; end
class ColumnHeader
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
include Google::Apis::Core::JsonObjectSupport
end
class Group
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :content_details, as: 'contentDetails', class: Google::Apis::YoutubeAnalyticsV1beta1::Group::ContentDetails, decorator: Google::Apis::YoutubeAnalyticsV1beta1::Group::ContentDetails::Representation
property :etag, as: 'etag'
property :id, as: 'id'
property :kind, as: 'kind'
property :snippet, as: 'snippet', class: Google::Apis::YoutubeAnalyticsV1beta1::Group::Snippet, decorator: Google::Apis::YoutubeAnalyticsV1beta1::Group::Snippet::Representation
end
class ContentDetails
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :item_count, :numeric_string => true, as: 'itemCount'
property :item_type, as: 'itemType'
end
end
class Snippet
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :published_at, as: 'publishedAt', type: DateTime
property :title, as: 'title'
end
end
end
class GroupItem
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :etag, as: 'etag'
property :group_id, as: 'groupId'
property :id, as: 'id'
property :kind, as: 'kind'
property :resource, as: 'resource', class: Google::Apis::YoutubeAnalyticsV1beta1::GroupItem::Resource, decorator: Google::Apis::YoutubeAnalyticsV1beta1::GroupItem::Resource::Representation
end
class Resource
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :id, as: 'id'
property :kind, as: 'kind'
end
end
end
class GroupItemListResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :etag, as: 'etag'
collection :items, as: 'items', class: Google::Apis::YoutubeAnalyticsV1beta1::GroupItem, decorator: Google::Apis::YoutubeAnalyticsV1beta1::GroupItem::Representation
property :kind, as: 'kind'
end
end
class GroupListResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :etag, as: 'etag'
collection :items, as: 'items', class: Google::Apis::YoutubeAnalyticsV1beta1::Group, decorator: Google::Apis::YoutubeAnalyticsV1beta1::Group::Representation
property :kind, as: 'kind'
property :next_page_token, as: 'nextPageToken'
end
end
class ResultTable
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :column_headers, as: 'columnHeaders', class: Google::Apis::YoutubeAnalyticsV1beta1::ResultTable::ColumnHeader, decorator: Google::Apis::YoutubeAnalyticsV1beta1::ResultTable::ColumnHeader::Representation
property :kind, as: 'kind'
collection :rows, as: 'rows', :class => Array do
include Representable::JSON::Collection
items
end
end
class ColumnHeader
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :column_type, as: 'columnType'
property :data_type, as: 'dataType'
property :name, as: 'name'
end
end
end
end
end
end

View File

@ -1,473 +0,0 @@
# Copyright 2015 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
require 'google/apis/core/base_service'
require 'google/apis/core/json_representation'
require 'google/apis/core/hashable'
require 'google/apis/errors'
module Google
module Apis
module YoutubeAnalyticsV1beta1
# YouTube Analytics API
#
# Retrieves your YouTube Analytics data.
#
# @example
# require 'google/apis/youtube_analytics_v1beta1'
#
# YoutubeAnalytics = Google::Apis::YoutubeAnalyticsV1beta1 # Alias the module
# service = YoutubeAnalytics::YouTubeAnalyticsService.new
#
# @see http://developers.google.com/youtube/analytics/
class YouTubeAnalyticsService < Google::Apis::Core::BaseService
# @return [String]
# API key. Your API key identifies your project and provides you with API access,
# quota, and reports. Required unless you provide an OAuth 2.0 token.
attr_accessor :key
# @return [String]
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
attr_accessor :quota_user
# @return [String]
# Deprecated. Please use quotaUser instead.
attr_accessor :user_ip
def initialize
super('https://www.googleapis.com/', 'youtube/analytics/v1beta1/')
@batch_path = 'batch/youtubeAnalytics/v1beta1'
end
# Removes an item from a group.
# @param [String] id
# The id parameter specifies the YouTube group item ID for the group that is
# being deleted.
# @param [String] on_behalf_of_content_owner
# Note: This parameter is intended exclusively for YouTube content partners.
# The onBehalfOfContentOwner parameter indicates that the request's
# authorization credentials identify a YouTube CMS user who is acting on behalf
# of the content owner specified in the parameter value. This parameter is
# intended for YouTube content partners that own and manage many different
# YouTube channels. It allows content owners to authenticate once and get access
# to all their video and channel data, without having to provide authentication
# credentials for each individual channel. The CMS account that the user
# authenticates with must be linked to the specified YouTube content owner.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [NilClass] No result returned for this method
# @yieldparam err [StandardError] error object if request failed
#
# @return [void]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_group_item(id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:delete, 'groupItems', options)
command.query['id'] = id unless id.nil?
command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
# Creates a group item.
# @param [Google::Apis::YoutubeAnalyticsV1beta1::GroupItem] group_item_object
# @param [String] on_behalf_of_content_owner
# Note: This parameter is intended exclusively for YouTube content partners.
# The onBehalfOfContentOwner parameter indicates that the request's
# authorization credentials identify a YouTube CMS user who is acting on behalf
# of the content owner specified in the parameter value. This parameter is
# intended for YouTube content partners that own and manage many different
# YouTube channels. It allows content owners to authenticate once and get access
# to all their video and channel data, without having to provide authentication
# credentials for each individual channel. The CMS account that the user
# authenticates with must be linked to the specified YouTube content owner.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::YoutubeAnalyticsV1beta1::GroupItem] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::YoutubeAnalyticsV1beta1::GroupItem]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def insert_group_item(group_item_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:post, 'groupItems', options)
command.request_representation = Google::Apis::YoutubeAnalyticsV1beta1::GroupItem::Representation
command.request_object = group_item_object
command.response_representation = Google::Apis::YoutubeAnalyticsV1beta1::GroupItem::Representation
command.response_class = Google::Apis::YoutubeAnalyticsV1beta1::GroupItem
command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
# Returns a collection of group items that match the API request parameters.
# @param [String] group_id
# The id parameter specifies the unique ID of the group for which you want to
# retrieve group items.
# @param [String] on_behalf_of_content_owner
# Note: This parameter is intended exclusively for YouTube content partners.
# The onBehalfOfContentOwner parameter indicates that the request's
# authorization credentials identify a YouTube CMS user who is acting on behalf
# of the content owner specified in the parameter value. This parameter is
# intended for YouTube content partners that own and manage many different
# YouTube channels. It allows content owners to authenticate once and get access
# to all their video and channel data, without having to provide authentication
# credentials for each individual channel. The CMS account that the user
# authenticates with must be linked to the specified YouTube content owner.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::YoutubeAnalyticsV1beta1::GroupItemListResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::YoutubeAnalyticsV1beta1::GroupItemListResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_group_items(group_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:get, 'groupItems', options)
command.response_representation = Google::Apis::YoutubeAnalyticsV1beta1::GroupItemListResponse::Representation
command.response_class = Google::Apis::YoutubeAnalyticsV1beta1::GroupItemListResponse
command.query['groupId'] = group_id unless group_id.nil?
command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
# Deletes a group.
# @param [String] id
# The id parameter specifies the YouTube group ID for the group that is being
# deleted.
# @param [String] on_behalf_of_content_owner
# Note: This parameter is intended exclusively for YouTube content partners.
# The onBehalfOfContentOwner parameter indicates that the request's
# authorization credentials identify a YouTube CMS user who is acting on behalf
# of the content owner specified in the parameter value. This parameter is
# intended for YouTube content partners that own and manage many different
# YouTube channels. It allows content owners to authenticate once and get access
# to all their video and channel data, without having to provide authentication
# credentials for each individual channel. The CMS account that the user
# authenticates with must be linked to the specified YouTube content owner.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [NilClass] No result returned for this method
# @yieldparam err [StandardError] error object if request failed
#
# @return [void]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_group(id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:delete, 'groups', options)
command.query['id'] = id unless id.nil?
command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
# Creates a group.
# @param [Google::Apis::YoutubeAnalyticsV1beta1::Group] group_object
# @param [String] on_behalf_of_content_owner
# Note: This parameter is intended exclusively for YouTube content partners.
# The onBehalfOfContentOwner parameter indicates that the request's
# authorization credentials identify a YouTube CMS user who is acting on behalf
# of the content owner specified in the parameter value. This parameter is
# intended for YouTube content partners that own and manage many different
# YouTube channels. It allows content owners to authenticate once and get access
# to all their video and channel data, without having to provide authentication
# credentials for each individual channel. The CMS account that the user
# authenticates with must be linked to the specified YouTube content owner.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::YoutubeAnalyticsV1beta1::Group] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::YoutubeAnalyticsV1beta1::Group]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def insert_group(group_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:post, 'groups', options)
command.request_representation = Google::Apis::YoutubeAnalyticsV1beta1::Group::Representation
command.request_object = group_object
command.response_representation = Google::Apis::YoutubeAnalyticsV1beta1::Group::Representation
command.response_class = Google::Apis::YoutubeAnalyticsV1beta1::Group
command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
# Returns a collection of groups that match the API request parameters. For
# example, you can retrieve all groups that the authenticated user owns, or you
# can retrieve one or more groups by their unique IDs.
# @param [String] id
# The id parameter specifies a comma-separated list of the YouTube group ID(s)
# for the resource(s) that are being retrieved. In a group resource, the id
# property specifies the group's YouTube group ID.
# @param [Boolean] mine
# Set this parameter's value to true to instruct the API to only return groups
# owned by the authenticated user.
# @param [String] on_behalf_of_content_owner
# Note: This parameter is intended exclusively for YouTube content partners.
# The onBehalfOfContentOwner parameter indicates that the request's
# authorization credentials identify a YouTube CMS user who is acting on behalf
# of the content owner specified in the parameter value. This parameter is
# intended for YouTube content partners that own and manage many different
# YouTube channels. It allows content owners to authenticate once and get access
# to all their video and channel data, without having to provide authentication
# credentials for each individual channel. The CMS account that the user
# authenticates with must be linked to the specified YouTube content owner.
# @param [String] page_token
# The pageToken parameter identifies a specific page in the result set that
# should be returned. In an API response, the nextPageToken property identifies
# the next page that can be retrieved.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::YoutubeAnalyticsV1beta1::GroupListResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::YoutubeAnalyticsV1beta1::GroupListResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_groups(id: nil, mine: nil, on_behalf_of_content_owner: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:get, 'groups', options)
command.response_representation = Google::Apis::YoutubeAnalyticsV1beta1::GroupListResponse::Representation
command.response_class = Google::Apis::YoutubeAnalyticsV1beta1::GroupListResponse
command.query['id'] = id unless id.nil?
command.query['mine'] = mine unless mine.nil?
command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
# Modifies a group. For example, you could change a group's title.
# @param [Google::Apis::YoutubeAnalyticsV1beta1::Group] group_object
# @param [String] on_behalf_of_content_owner
# Note: This parameter is intended exclusively for YouTube content partners.
# The onBehalfOfContentOwner parameter indicates that the request's
# authorization credentials identify a YouTube CMS user who is acting on behalf
# of the content owner specified in the parameter value. This parameter is
# intended for YouTube content partners that own and manage many different
# YouTube channels. It allows content owners to authenticate once and get access
# to all their video and channel data, without having to provide authentication
# credentials for each individual channel. The CMS account that the user
# authenticates with must be linked to the specified YouTube content owner.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::YoutubeAnalyticsV1beta1::Group] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::YoutubeAnalyticsV1beta1::Group]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def update_group(group_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:put, 'groups', options)
command.request_representation = Google::Apis::YoutubeAnalyticsV1beta1::Group::Representation
command.request_object = group_object
command.response_representation = Google::Apis::YoutubeAnalyticsV1beta1::Group::Representation
command.response_class = Google::Apis::YoutubeAnalyticsV1beta1::Group
command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
# Retrieve your YouTube Analytics reports.
# @param [String] ids
# Identifies the YouTube channel or content owner for which you are retrieving
# YouTube Analytics data.
# - To request data for a YouTube user, set the ids parameter value to channel==
# CHANNEL_ID, where CHANNEL_ID specifies the unique YouTube channel ID.
# - To request data for a YouTube CMS content owner, set the ids parameter value
# to contentOwner==OWNER_NAME, where OWNER_NAME is the CMS name of the content
# owner.
# @param [String] start_date
# The start date for fetching YouTube Analytics data. The value should be in
# YYYY-MM-DD format.
# @param [String] end_date
# The end date for fetching YouTube Analytics data. The value should be in YYYY-
# MM-DD format.
# @param [String] metrics
# A comma-separated list of YouTube Analytics metrics, such as views or likes,
# dislikes. See the Available Reports document for a list of the reports that
# you can retrieve and the metrics available in each report, and see the Metrics
# document for definitions of those metrics.
# @param [String] currency
# The currency to which financial metrics should be converted. The default is US
# Dollar (USD). If the result contains no financial metrics, this flag will be
# ignored. Responds with an error if the specified currency is not recognized.
# @param [String] dimensions
# A comma-separated list of YouTube Analytics dimensions, such as views or
# ageGroup,gender. See the Available Reports document for a list of the reports
# that you can retrieve and the dimensions used for those reports. Also see the
# Dimensions document for definitions of those dimensions.
# @param [String] filters
# A list of filters that should be applied when retrieving YouTube Analytics
# data. The Available Reports document identifies the dimensions that can be
# used to filter each report, and the Dimensions document defines those
# dimensions. If a request uses multiple filters, join them together with a
# semicolon (;), and the returned result table will satisfy both filters. For
# example, a filters parameter value of video==dMH0bHeiRNg;country==IT restricts
# the result set to include data for the given video in Italy.
# @param [Boolean] include_historical_channel_data
# If set to true historical data (i.e. channel data from before the linking of
# the channel to the content owner) will be retrieved.
# @param [Fixnum] max_results
# The maximum number of rows to include in the response.
# @param [String] sort
# A comma-separated list of dimensions or metrics that determine the sort order
# for YouTube Analytics data. By default the sort order is ascending. The '-'
# prefix causes descending sort order.
# @param [Fixnum] start_index
# An index of the first entity to retrieve. Use this parameter as a pagination
# mechanism along with the max-results parameter (one-based, inclusive).
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::YoutubeAnalyticsV1beta1::ResultTable] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::YoutubeAnalyticsV1beta1::ResultTable]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def query_report(ids, start_date, end_date, metrics, currency: nil, dimensions: nil, filters: nil, include_historical_channel_data: nil, max_results: nil, sort: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:get, 'reports', options)
command.response_representation = Google::Apis::YoutubeAnalyticsV1beta1::ResultTable::Representation
command.response_class = Google::Apis::YoutubeAnalyticsV1beta1::ResultTable
command.query['currency'] = currency unless currency.nil?
command.query['dimensions'] = dimensions unless dimensions.nil?
command.query['end-date'] = end_date unless end_date.nil?
command.query['filters'] = filters unless filters.nil?
command.query['ids'] = ids unless ids.nil?
command.query['include-historical-channel-data'] = include_historical_channel_data unless include_historical_channel_data.nil?
command.query['max-results'] = max_results unless max_results.nil?
command.query['metrics'] = metrics unless metrics.nil?
command.query['sort'] = sort unless sort.nil?
command.query['start-date'] = start_date unless start_date.nil?
command.query['start-index'] = start_index unless start_index.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
protected
def apply_command_defaults(command)
command.query['key'] = key unless key.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
end
end
end
end
end