From 33bbd8c955ff5c31b558442c4ee07dc43e7f94e4 Mon Sep 17 00:00:00 2001 From: Google APIs Date: Tue, 21 Jul 2020 00:38:15 +0000 Subject: [PATCH] Autogenerated update (2020-07-21) Update: - appengine_v1 - appengine_v1beta - bigtableadmin_v1 - bigtableadmin_v2 - displayvideo_v1 - gmailpostmastertools_v1beta1 - people_v1 - realtimebidding_v1 - serviceconsumermanagement_v1 - spanner_v1 - webfonts_v1 - youtube_partner_v1 - youtube_v3 --- api_names_out.yaml | 93 + generated/google/apis/appengine_v1.rb | 2 +- generated/google/apis/appengine_v1/service.rb | 9 +- generated/google/apis/appengine_v1beta.rb | 2 +- .../google/apis/appengine_v1beta/service.rb | 8 +- generated/google/apis/bigtableadmin_v1.rb | 2 +- .../google/apis/bigtableadmin_v1/classes.rb | 267 ++ .../apis/bigtableadmin_v1/representations.rb | 100 + generated/google/apis/bigtableadmin_v2.rb | 2 +- .../google/apis/bigtableadmin_v2/classes.rb | 355 ++ .../apis/bigtableadmin_v2/representations.rb | 146 + .../google/apis/bigtableadmin_v2/service.rb | 298 ++ generated/google/apis/displayvideo_v1.rb | 5 +- .../google/apis/displayvideo_v1/classes.rb | 2874 +++++++---------- .../google/apis/displayvideo_v1/service.rb | 1537 ++++----- .../apis/gmailpostmastertools_v1beta1.rb | 5 +- generated/google/apis/people_v1.rb | 2 +- generated/google/apis/people_v1/classes.rb | 640 ++-- generated/google/apis/people_v1/service.rb | 540 +--- generated/google/apis/realtimebidding_v1.rb | 2 +- .../apis/serviceconsumermanagement_v1.rb | 2 +- .../serviceconsumermanagement_v1/classes.rb | 2 +- .../serviceconsumermanagement_v1/service.rb | 12 +- generated/google/apis/spanner_v1.rb | 2 +- generated/google/apis/webfonts_v1.rb | 2 +- generated/google/apis/webfonts_v1/service.rb | 4 +- generated/google/apis/youtube_partner_v1.rb | 2 +- .../google/apis/youtube_partner_v1/classes.rb | 1398 ++++---- .../google/apis/youtube_partner_v1/service.rb | 1162 +++---- generated/google/apis/youtube_v3.rb | 2 +- generated/google/apis/youtube_v3/service.rb | 64 +- 31 files changed, 4637 insertions(+), 4904 deletions(-) diff --git a/api_names_out.yaml b/api_names_out.yaml index 5fdf983b8..da2076000 100644 --- a/api_names_out.yaml +++ b/api_names_out.yaml @@ -14915,12 +14915,30 @@ "/bigqueryreservation:v1beta1/fields": fields "/bigqueryreservation:v1beta1/key": key "/bigqueryreservation:v1beta1/quotaUser": quota_user +"/bigtableadmin:v1/Backup": backup +"/bigtableadmin:v1/Backup/endTime": end_time +"/bigtableadmin:v1/Backup/expireTime": expire_time +"/bigtableadmin:v1/Backup/name": name +"/bigtableadmin:v1/Backup/sizeBytes": size_bytes +"/bigtableadmin:v1/Backup/sourceTable": source_table +"/bigtableadmin:v1/Backup/startTime": start_time +"/bigtableadmin:v1/Backup/state": state +"/bigtableadmin:v1/BackupInfo": backup_info +"/bigtableadmin:v1/BackupInfo/backup": backup +"/bigtableadmin:v1/BackupInfo/endTime": end_time +"/bigtableadmin:v1/BackupInfo/sourceTable": source_table +"/bigtableadmin:v1/BackupInfo/startTime": start_time "/bigtableadmin:v1/Cluster": cluster "/bigtableadmin:v1/Cluster/defaultStorageType": default_storage_type "/bigtableadmin:v1/Cluster/location": location "/bigtableadmin:v1/Cluster/name": name "/bigtableadmin:v1/Cluster/serveNodes": serve_nodes "/bigtableadmin:v1/Cluster/state": state +"/bigtableadmin:v1/CreateBackupMetadata": create_backup_metadata +"/bigtableadmin:v1/CreateBackupMetadata/endTime": end_time +"/bigtableadmin:v1/CreateBackupMetadata/name": name +"/bigtableadmin:v1/CreateBackupMetadata/sourceTable": source_table +"/bigtableadmin:v1/CreateBackupMetadata/startTime": start_time "/bigtableadmin:v1/CreateClusterMetadata": create_cluster_metadata "/bigtableadmin:v1/CreateClusterMetadata/finishTime": finish_time "/bigtableadmin:v1/CreateClusterMetadata/originalRequest": original_request @@ -14960,9 +14978,22 @@ "/bigtableadmin:v1/Location/metadata": metadata "/bigtableadmin:v1/Location/metadata/metadatum": metadatum "/bigtableadmin:v1/Location/name": name +"/bigtableadmin:v1/OperationProgress": operation_progress +"/bigtableadmin:v1/OperationProgress/endTime": end_time +"/bigtableadmin:v1/OperationProgress/progressPercent": progress_percent +"/bigtableadmin:v1/OperationProgress/startTime": start_time +"/bigtableadmin:v1/OptimizeRestoredTableMetadata": optimize_restored_table_metadata +"/bigtableadmin:v1/OptimizeRestoredTableMetadata/name": name +"/bigtableadmin:v1/OptimizeRestoredTableMetadata/progress": progress "/bigtableadmin:v1/PartialUpdateInstanceRequest": partial_update_instance_request "/bigtableadmin:v1/PartialUpdateInstanceRequest/instance": instance "/bigtableadmin:v1/PartialUpdateInstanceRequest/updateMask": update_mask +"/bigtableadmin:v1/RestoreTableMetadata": restore_table_metadata +"/bigtableadmin:v1/RestoreTableMetadata/backupInfo": backup_info +"/bigtableadmin:v1/RestoreTableMetadata/name": name +"/bigtableadmin:v1/RestoreTableMetadata/optimizeTableOperationName": optimize_table_operation_name +"/bigtableadmin:v1/RestoreTableMetadata/progress": progress +"/bigtableadmin:v1/RestoreTableMetadata/sourceType": source_type "/bigtableadmin:v1/TableProgress": table_progress "/bigtableadmin:v1/TableProgress/estimatedCopiedBytes": estimated_copied_bytes "/bigtableadmin:v1/TableProgress/estimatedSizeBytes": estimated_size_bytes @@ -15000,6 +15031,19 @@ "/bigtableadmin:v2/AuditLogConfig/exemptedMembers": exempted_members "/bigtableadmin:v2/AuditLogConfig/exemptedMembers/exempted_member": exempted_member "/bigtableadmin:v2/AuditLogConfig/logType": log_type +"/bigtableadmin:v2/Backup": backup +"/bigtableadmin:v2/Backup/endTime": end_time +"/bigtableadmin:v2/Backup/expireTime": expire_time +"/bigtableadmin:v2/Backup/name": name +"/bigtableadmin:v2/Backup/sizeBytes": size_bytes +"/bigtableadmin:v2/Backup/sourceTable": source_table +"/bigtableadmin:v2/Backup/startTime": start_time +"/bigtableadmin:v2/Backup/state": state +"/bigtableadmin:v2/BackupInfo": backup_info +"/bigtableadmin:v2/BackupInfo/backup": backup +"/bigtableadmin:v2/BackupInfo/endTime": end_time +"/bigtableadmin:v2/BackupInfo/sourceTable": source_table +"/bigtableadmin:v2/BackupInfo/startTime": start_time "/bigtableadmin:v2/Binding": binding "/bigtableadmin:v2/Binding/condition": condition "/bigtableadmin:v2/Binding/members": members @@ -15019,6 +15063,11 @@ "/bigtableadmin:v2/ClusterState/replicationState": replication_state "/bigtableadmin:v2/ColumnFamily": column_family "/bigtableadmin:v2/ColumnFamily/gcRule": gc_rule +"/bigtableadmin:v2/CreateBackupMetadata": create_backup_metadata +"/bigtableadmin:v2/CreateBackupMetadata/endTime": end_time +"/bigtableadmin:v2/CreateBackupMetadata/name": name +"/bigtableadmin:v2/CreateBackupMetadata/sourceTable": source_table +"/bigtableadmin:v2/CreateBackupMetadata/startTime": start_time "/bigtableadmin:v2/CreateClusterMetadata": create_cluster_metadata "/bigtableadmin:v2/CreateClusterMetadata/finishTime": finish_time "/bigtableadmin:v2/CreateClusterMetadata/originalRequest": original_request @@ -15081,6 +15130,10 @@ "/bigtableadmin:v2/ListAppProfilesResponse/failedLocations": failed_locations "/bigtableadmin:v2/ListAppProfilesResponse/failedLocations/failed_location": failed_location "/bigtableadmin:v2/ListAppProfilesResponse/nextPageToken": next_page_token +"/bigtableadmin:v2/ListBackupsResponse": list_backups_response +"/bigtableadmin:v2/ListBackupsResponse/backups": backups +"/bigtableadmin:v2/ListBackupsResponse/backups/backup": backup +"/bigtableadmin:v2/ListBackupsResponse/nextPageToken": next_page_token "/bigtableadmin:v2/ListClustersResponse": list_clusters_response "/bigtableadmin:v2/ListClustersResponse/clusters": clusters "/bigtableadmin:v2/ListClustersResponse/clusters/cluster": cluster @@ -15130,6 +15183,13 @@ "/bigtableadmin:v2/Operation/name": name "/bigtableadmin:v2/Operation/response": response "/bigtableadmin:v2/Operation/response/response": response +"/bigtableadmin:v2/OperationProgress": operation_progress +"/bigtableadmin:v2/OperationProgress/endTime": end_time +"/bigtableadmin:v2/OperationProgress/progressPercent": progress_percent +"/bigtableadmin:v2/OperationProgress/startTime": start_time +"/bigtableadmin:v2/OptimizeRestoredTableMetadata": optimize_restored_table_metadata +"/bigtableadmin:v2/OptimizeRestoredTableMetadata/name": name +"/bigtableadmin:v2/OptimizeRestoredTableMetadata/progress": progress "/bigtableadmin:v2/PartialUpdateInstanceRequest": partial_update_instance_request "/bigtableadmin:v2/PartialUpdateInstanceRequest/instance": instance "/bigtableadmin:v2/PartialUpdateInstanceRequest/updateMask": update_mask @@ -15140,6 +15200,18 @@ "/bigtableadmin:v2/Policy/bindings/binding": binding "/bigtableadmin:v2/Policy/etag": etag "/bigtableadmin:v2/Policy/version": version +"/bigtableadmin:v2/RestoreInfo": restore_info +"/bigtableadmin:v2/RestoreInfo/backupInfo": backup_info +"/bigtableadmin:v2/RestoreInfo/sourceType": source_type +"/bigtableadmin:v2/RestoreTableMetadata": restore_table_metadata +"/bigtableadmin:v2/RestoreTableMetadata/backupInfo": backup_info +"/bigtableadmin:v2/RestoreTableMetadata/name": name +"/bigtableadmin:v2/RestoreTableMetadata/optimizeTableOperationName": optimize_table_operation_name +"/bigtableadmin:v2/RestoreTableMetadata/progress": progress +"/bigtableadmin:v2/RestoreTableMetadata/sourceType": source_type +"/bigtableadmin:v2/RestoreTableRequest": restore_table_request +"/bigtableadmin:v2/RestoreTableRequest/backup": backup +"/bigtableadmin:v2/RestoreTableRequest/tableId": table_id "/bigtableadmin:v2/SetIamPolicyRequest": set_iam_policy_request "/bigtableadmin:v2/SetIamPolicyRequest/policy": policy "/bigtableadmin:v2/SetIamPolicyRequest/updateMask": update_mask @@ -15161,6 +15233,7 @@ "/bigtableadmin:v2/Table/columnFamilies/column_family": column_family "/bigtableadmin:v2/Table/granularity": granularity "/bigtableadmin:v2/Table/name": name +"/bigtableadmin:v2/Table/restoreInfo": restore_info "/bigtableadmin:v2/TableProgress": table_progress "/bigtableadmin:v2/TableProgress/estimatedCopiedBytes": estimated_copied_bytes "/bigtableadmin:v2/TableProgress/estimatedSizeBytes": estimated_size_bytes @@ -15211,8 +15284,24 @@ "/bigtableadmin:v2/bigtableadmin.projects.instances.appProfiles.patch/ignoreWarnings": ignore_warnings "/bigtableadmin:v2/bigtableadmin.projects.instances.appProfiles.patch/name": name "/bigtableadmin:v2/bigtableadmin.projects.instances.appProfiles.patch/updateMask": update_mask +"/bigtableadmin:v2/bigtableadmin.projects.instances.clusters.backups.create": create_project_instance_cluster_backup +"/bigtableadmin:v2/bigtableadmin.projects.instances.clusters.backups.create/backupId": backup_id +"/bigtableadmin:v2/bigtableadmin.projects.instances.clusters.backups.create/parent": parent +"/bigtableadmin:v2/bigtableadmin.projects.instances.clusters.backups.delete": delete_project_instance_cluster_backup +"/bigtableadmin:v2/bigtableadmin.projects.instances.clusters.backups.delete/name": name +"/bigtableadmin:v2/bigtableadmin.projects.instances.clusters.backups.get": get_project_instance_cluster_backup +"/bigtableadmin:v2/bigtableadmin.projects.instances.clusters.backups.get/name": name "/bigtableadmin:v2/bigtableadmin.projects.instances.clusters.backups.getIamPolicy": get_backup_iam_policy "/bigtableadmin:v2/bigtableadmin.projects.instances.clusters.backups.getIamPolicy/resource": resource +"/bigtableadmin:v2/bigtableadmin.projects.instances.clusters.backups.list": list_project_instance_cluster_backups +"/bigtableadmin:v2/bigtableadmin.projects.instances.clusters.backups.list/filter": filter +"/bigtableadmin:v2/bigtableadmin.projects.instances.clusters.backups.list/orderBy": order_by +"/bigtableadmin:v2/bigtableadmin.projects.instances.clusters.backups.list/pageSize": page_size +"/bigtableadmin:v2/bigtableadmin.projects.instances.clusters.backups.list/pageToken": page_token +"/bigtableadmin:v2/bigtableadmin.projects.instances.clusters.backups.list/parent": parent +"/bigtableadmin:v2/bigtableadmin.projects.instances.clusters.backups.patch": patch_project_instance_cluster_backup +"/bigtableadmin:v2/bigtableadmin.projects.instances.clusters.backups.patch/name": name +"/bigtableadmin:v2/bigtableadmin.projects.instances.clusters.backups.patch/updateMask": update_mask "/bigtableadmin:v2/bigtableadmin.projects.instances.clusters.backups.setIamPolicy": set_backup_iam_policy "/bigtableadmin:v2/bigtableadmin.projects.instances.clusters.backups.setIamPolicy/resource": resource "/bigtableadmin:v2/bigtableadmin.projects.instances.clusters.backups.testIamPermissions": test_backup_iam_permissions @@ -15267,6 +15356,8 @@ "/bigtableadmin:v2/bigtableadmin.projects.instances.tables.list/view": view "/bigtableadmin:v2/bigtableadmin.projects.instances.tables.modifyColumnFamilies": modify_table_column_families "/bigtableadmin:v2/bigtableadmin.projects.instances.tables.modifyColumnFamilies/name": name +"/bigtableadmin:v2/bigtableadmin.projects.instances.tables.restore": restore_table +"/bigtableadmin:v2/bigtableadmin.projects.instances.tables.restore/parent": parent "/bigtableadmin:v2/bigtableadmin.projects.instances.tables.setIamPolicy": set_table_iam_policy "/bigtableadmin:v2/bigtableadmin.projects.instances.tables.setIamPolicy/resource": resource "/bigtableadmin:v2/bigtableadmin.projects.instances.tables.testIamPermissions": test_table_iam_permissions @@ -148411,6 +148502,8 @@ "/youtube:v3/youtube.superChatEvents.list/maxResults": max_results "/youtube:v3/youtube.superChatEvents.list/pageToken": page_token "/youtube:v3/youtube.superChatEvents.list/part": part +"/youtube:v3/youtube.tests.insert": insert_test +"/youtube:v3/youtube.tests.insert/part": part "/youtube:v3/youtube.thirdPartyLinks.delete": delete_third_party_link "/youtube:v3/youtube.thirdPartyLinks.delete/linkingToken": linking_token "/youtube:v3/youtube.thirdPartyLinks.delete/part": part diff --git a/generated/google/apis/appengine_v1.rb b/generated/google/apis/appengine_v1.rb index a3a7865fb..d3cb5d6b9 100644 --- a/generated/google/apis/appengine_v1.rb +++ b/generated/google/apis/appengine_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/appengine/docs/admin-api/ module AppengineV1 VERSION = 'V1' - REVISION = '20200507' + REVISION = '20200715' # View and manage your applications deployed on Google App Engine AUTH_APPENGINE_ADMIN = 'https://www.googleapis.com/auth/appengine.admin' diff --git a/generated/google/apis/appengine_v1/service.rb b/generated/google/apis/appengine_v1/service.rb index e2709bf9b..2f424e8e5 100644 --- a/generated/google/apis/appengine_v1/service.rb +++ b/generated/google/apis/appengine_v1/service.rb @@ -1320,8 +1320,9 @@ module Google # services.versions#StandardSchedulerSettings)basic scaling or manual scaling in # the standard environment: # serving_status (https://cloud.google.com/appengine/docs/admin-api/reference/ - # rest/v1/apps.services.versions#Version.FIELDS.serving_status)Flexible - # environment + # rest/v1/apps.services.versions#Version.FIELDS.serving_status) + # manual_scaling.instances (https://cloud.google.com/appengine/docs/admin-api/ + # reference/rest/v1/apps.services.versions#manualscaling)Flexible environment # serving_status (https://cloud.google.com/appengine/docs/admin-api/reference/ # rest/v1/apps.services.versions#Version.FIELDS.serving_status)automatic scaling # in the flexible environment: @@ -1336,7 +1337,9 @@ module Google # automatic_scaling) # automatic_scaling.cpu_utilization.target_utilization (https://cloud.google.com/ # appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version. - # FIELDS.automatic_scaling) + # FIELDS.automatic_scaling)manual scaling in the flexible environment: + # manual_scaling.instances (https://cloud.google.com/appengine/docs/admin-api/ + # reference/rest/v1/apps.services.versions#manualscaling) # @param [String] apps_id # Part of `name`. Name of the resource to update. Example: apps/myapp/services/ # default/versions/1. diff --git a/generated/google/apis/appengine_v1beta.rb b/generated/google/apis/appengine_v1beta.rb index 6d0d5e478..61120d3ba 100644 --- a/generated/google/apis/appengine_v1beta.rb +++ b/generated/google/apis/appengine_v1beta.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/appengine/docs/admin-api/ module AppengineV1beta VERSION = 'V1beta' - REVISION = '20200507' + REVISION = '20200715' # View and manage your applications deployed on Google App Engine AUTH_APPENGINE_ADMIN = 'https://www.googleapis.com/auth/appengine.admin' diff --git a/generated/google/apis/appengine_v1beta/service.rb b/generated/google/apis/appengine_v1beta/service.rb index 52a52b83e..c62078c1c 100644 --- a/generated/google/apis/appengine_v1beta/service.rb +++ b/generated/google/apis/appengine_v1beta/service.rb @@ -1320,7 +1320,9 @@ module Google # services.versions#StandardSchedulerSettings)basic scaling or manual scaling in # the standard environment: # serving_status (https://cloud.google.com/appengine/docs/admin-api/reference/ - # rest/v1beta/apps.services.versions#Version.FIELDS.serving_status)Flexible + # rest/v1beta/apps.services.versions#Version.FIELDS.serving_status) + # manual_scaling.instances (https://cloud.google.com/appengine/docs/admin-api/ + # reference/rest/v1beta/apps.services.versions#manualscaling)Flexible # environment # serving_status (https://cloud.google.com/appengine/docs/admin-api/reference/ # rest/v1beta/apps.services.versions#Version.FIELDS.serving_status)automatic @@ -1336,7 +1338,9 @@ module Google # automatic_scaling) # automatic_scaling.cpu_utilization.target_utilization (https://cloud.google.com/ # appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version. - # FIELDS.automatic_scaling) + # FIELDS.automatic_scaling)manual scaling in the flexible environment: + # manual_scaling.instances (https://cloud.google.com/appengine/docs/admin-api/ + # reference/rest/v1beta/apps.services.versions#manualscaling) # @param [String] apps_id # Part of `name`. Name of the resource to update. Example: apps/myapp/services/ # default/versions/1. diff --git a/generated/google/apis/bigtableadmin_v1.rb b/generated/google/apis/bigtableadmin_v1.rb index 817797cd9..9b8abf712 100644 --- a/generated/google/apis/bigtableadmin_v1.rb +++ b/generated/google/apis/bigtableadmin_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/bigtable/ module BigtableadminV1 VERSION = 'V1' - REVISION = '20200512' + REVISION = '20200629' end end end diff --git a/generated/google/apis/bigtableadmin_v1/classes.rb b/generated/google/apis/bigtableadmin_v1/classes.rb index b12a2b9a9..9453125a0 100644 --- a/generated/google/apis/bigtableadmin_v1/classes.rb +++ b/generated/google/apis/bigtableadmin_v1/classes.rb @@ -22,6 +22,119 @@ module Google module Apis module BigtableadminV1 + # A backup of a Cloud Bigtable table. + class Backup + include Google::Apis::Core::Hashable + + # Output only. `end_time` is the time that the backup was finished. The row + # data in the backup will be no newer than this timestamp. + # Corresponds to the JSON property `endTime` + # @return [String] + attr_accessor :end_time + + # Required. The expiration time of the backup, with microseconds + # granularity that must be at least 6 hours and at most 30 days + # from the time the request is received. Once the `expire_time` + # has passed, Cloud Bigtable will delete the backup and free the + # resources used by the backup. + # Corresponds to the JSON property `expireTime` + # @return [String] + attr_accessor :expire_time + + # A globally unique identifier for the backup which cannot be + # changed. Values are of the form + # `projects/`project`/instances/`instance`/clusters/`cluster`/ + # backups/_a-zA-Z0-9*` + # The final segment of the name must be between 1 and 50 characters + # in length. + # The backup is stored in the cluster identified by the prefix of the backup + # name of the form + # `projects/`project`/instances/`instance`/clusters/`cluster``. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Output only. Size of the backup in bytes. + # Corresponds to the JSON property `sizeBytes` + # @return [Fixnum] + attr_accessor :size_bytes + + # Required. Immutable. Name of the table from which this backup was created. + # This needs + # to be in the same instance as the backup. Values are of the form + # `projects/`project`/instances/`instance`/tables/`source_table``. + # Corresponds to the JSON property `sourceTable` + # @return [String] + attr_accessor :source_table + + # Output only. `start_time` is the time that the backup was started + # (i.e. approximately the time the + # CreateBackup request is received). The + # row data in this backup will be no older than this timestamp. + # Corresponds to the JSON property `startTime` + # @return [String] + attr_accessor :start_time + + # Output only. The current state of the backup. + # Corresponds to the JSON property `state` + # @return [String] + attr_accessor :state + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @end_time = args[:end_time] if args.key?(:end_time) + @expire_time = args[:expire_time] if args.key?(:expire_time) + @name = args[:name] if args.key?(:name) + @size_bytes = args[:size_bytes] if args.key?(:size_bytes) + @source_table = args[:source_table] if args.key?(:source_table) + @start_time = args[:start_time] if args.key?(:start_time) + @state = args[:state] if args.key?(:state) + end + end + + # Information about a backup. + class BackupInfo + include Google::Apis::Core::Hashable + + # Output only. Name of the backup. + # Corresponds to the JSON property `backup` + # @return [String] + attr_accessor :backup + + # Output only. This time that the backup was finished. Row data in the + # backup will be no newer than this timestamp. + # Corresponds to the JSON property `endTime` + # @return [String] + attr_accessor :end_time + + # Output only. Name of the table the backup was created from. + # Corresponds to the JSON property `sourceTable` + # @return [String] + attr_accessor :source_table + + # Output only. The time that the backup was started. Row data in the backup + # will be no older than this timestamp. + # Corresponds to the JSON property `startTime` + # @return [String] + attr_accessor :start_time + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @backup = args[:backup] if args.key?(:backup) + @end_time = args[:end_time] if args.key?(:end_time) + @source_table = args[:source_table] if args.key?(:source_table) + @start_time = args[:start_time] if args.key?(:start_time) + end + end + # A resizable group of nodes in a particular cloud location, capable # of serving all Tables in the parent # Instance. @@ -75,6 +188,44 @@ module Google end end + # Metadata type for the operation returned by + # CreateBackup. + class CreateBackupMetadata + include Google::Apis::Core::Hashable + + # If set, the time at which this operation finished or was cancelled. + # Corresponds to the JSON property `endTime` + # @return [String] + attr_accessor :end_time + + # The name of the backup being created. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # The name of the table the backup is created from. + # Corresponds to the JSON property `sourceTable` + # @return [String] + attr_accessor :source_table + + # The time at which this operation started. + # Corresponds to the JSON property `startTime` + # @return [String] + attr_accessor :start_time + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @end_time = args[:end_time] if args.key?(:end_time) + @name = args[:name] if args.key?(:name) + @source_table = args[:source_table] if args.key?(:source_table) + @start_time = args[:start_time] if args.key?(:start_time) + end + end + # The metadata for the Operation returned by CreateCluster. class CreateClusterMetadata include Google::Apis::Core::Hashable @@ -293,6 +444,69 @@ module Google end end + # Encapsulates progress related information for a Cloud Bigtable long + # running operation. + class OperationProgress + include Google::Apis::Core::Hashable + + # If set, the time at which this operation failed or was completed + # successfully. + # Corresponds to the JSON property `endTime` + # @return [String] + attr_accessor :end_time + + # Percent completion of the operation. + # Values are between 0 and 100 inclusive. + # Corresponds to the JSON property `progressPercent` + # @return [Fixnum] + attr_accessor :progress_percent + + # Time the request was received. + # Corresponds to the JSON property `startTime` + # @return [String] + attr_accessor :start_time + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @end_time = args[:end_time] if args.key?(:end_time) + @progress_percent = args[:progress_percent] if args.key?(:progress_percent) + @start_time = args[:start_time] if args.key?(:start_time) + end + end + + # Metadata type for the long-running operation used to track the progress + # of optimizations performed on a newly restored table. This long-running + # operation is automatically created by the system after the successful + # completion of a table restore, and cannot be cancelled. + class OptimizeRestoredTableMetadata + include Google::Apis::Core::Hashable + + # Name of the restored table being optimized. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Encapsulates progress related information for a Cloud Bigtable long + # running operation. + # Corresponds to the JSON property `progress` + # @return [Google::Apis::BigtableadminV1::OperationProgress] + attr_accessor :progress + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @name = args[:name] if args.key?(:name) + @progress = args[:progress] if args.key?(:progress) + end + end + # Request message for BigtableInstanceAdmin.PartialUpdateInstance. class PartialUpdateInstanceRequest include Google::Apis::Core::Hashable @@ -322,6 +536,59 @@ module Google end end + # Metadata type for the long-running operation returned by + # RestoreTable. + class RestoreTableMetadata + include Google::Apis::Core::Hashable + + # Information about a backup. + # Corresponds to the JSON property `backupInfo` + # @return [Google::Apis::BigtableadminV1::BackupInfo] + attr_accessor :backup_info + + # Name of the table being created and restored to. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # If exists, the name of the long-running operation that will be used to + # track the post-restore optimization process to optimize the performance of + # the restored table. The metadata type of the long-running operation is + # OptimizeRestoreTableMetadata. The response type is + # Empty. This long-running operation may be + # automatically created by the system if applicable after the + # RestoreTable long-running operation completes successfully. This operation + # may not be created if the table is already optimized or the restore was + # not successful. + # Corresponds to the JSON property `optimizeTableOperationName` + # @return [String] + attr_accessor :optimize_table_operation_name + + # Encapsulates progress related information for a Cloud Bigtable long + # running operation. + # Corresponds to the JSON property `progress` + # @return [Google::Apis::BigtableadminV1::OperationProgress] + attr_accessor :progress + + # The type of the restore source. + # Corresponds to the JSON property `sourceType` + # @return [String] + attr_accessor :source_type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @backup_info = args[:backup_info] if args.key?(:backup_info) + @name = args[:name] if args.key?(:name) + @optimize_table_operation_name = args[:optimize_table_operation_name] if args.key?(:optimize_table_operation_name) + @progress = args[:progress] if args.key?(:progress) + @source_type = args[:source_type] if args.key?(:source_type) + end + end + # Progress info for copying a table's data to the new cluster. class TableProgress include Google::Apis::Core::Hashable diff --git a/generated/google/apis/bigtableadmin_v1/representations.rb b/generated/google/apis/bigtableadmin_v1/representations.rb index ab5d8da29..a3315b961 100644 --- a/generated/google/apis/bigtableadmin_v1/representations.rb +++ b/generated/google/apis/bigtableadmin_v1/representations.rb @@ -22,12 +22,30 @@ module Google module Apis module BigtableadminV1 + class Backup + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class BackupInfo + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class Cluster class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end + class CreateBackupMetadata + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class CreateClusterMetadata class Representation < Google::Apis::Core::JsonRepresentation; end @@ -58,12 +76,30 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class OperationProgress + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class OptimizeRestoredTableMetadata + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class PartialUpdateInstanceRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end + class RestoreTableMetadata + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class TableProgress class Representation < Google::Apis::Core::JsonRepresentation; end @@ -88,6 +124,29 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class Backup + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :end_time, as: 'endTime' + property :expire_time, as: 'expireTime' + property :name, as: 'name' + property :size_bytes, :numeric_string => true, as: 'sizeBytes' + property :source_table, as: 'sourceTable' + property :start_time, as: 'startTime' + property :state, as: 'state' + end + end + + class BackupInfo + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :backup, as: 'backup' + property :end_time, as: 'endTime' + property :source_table, as: 'sourceTable' + property :start_time, as: 'startTime' + end + end + class Cluster # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -99,6 +158,16 @@ module Google end end + class CreateBackupMetadata + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :end_time, as: 'endTime' + property :name, as: 'name' + property :source_table, as: 'sourceTable' + property :start_time, as: 'startTime' + end + end + class CreateClusterMetadata # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -154,6 +223,24 @@ module Google end end + class OperationProgress + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :end_time, as: 'endTime' + property :progress_percent, as: 'progressPercent' + property :start_time, as: 'startTime' + end + end + + class OptimizeRestoredTableMetadata + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :name, as: 'name' + property :progress, as: 'progress', class: Google::Apis::BigtableadminV1::OperationProgress, decorator: Google::Apis::BigtableadminV1::OperationProgress::Representation + + end + end + class PartialUpdateInstanceRequest # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -163,6 +250,19 @@ module Google end end + class RestoreTableMetadata + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :backup_info, as: 'backupInfo', class: Google::Apis::BigtableadminV1::BackupInfo, decorator: Google::Apis::BigtableadminV1::BackupInfo::Representation + + property :name, as: 'name' + property :optimize_table_operation_name, as: 'optimizeTableOperationName' + property :progress, as: 'progress', class: Google::Apis::BigtableadminV1::OperationProgress, decorator: Google::Apis::BigtableadminV1::OperationProgress::Representation + + property :source_type, as: 'sourceType' + end + end + class TableProgress # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google/apis/bigtableadmin_v2.rb b/generated/google/apis/bigtableadmin_v2.rb index 8b838f1e4..35251d202 100644 --- a/generated/google/apis/bigtableadmin_v2.rb +++ b/generated/google/apis/bigtableadmin_v2.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/bigtable/ module BigtableadminV2 VERSION = 'V2' - REVISION = '20200609' + REVISION = '20200629' # Administer your Cloud Bigtable tables and clusters AUTH_BIGTABLE_ADMIN = 'https://www.googleapis.com/auth/bigtable.admin' diff --git a/generated/google/apis/bigtableadmin_v2/classes.rb b/generated/google/apis/bigtableadmin_v2/classes.rb index 2f91a8ac1..e356e47e1 100644 --- a/generated/google/apis/bigtableadmin_v2/classes.rb +++ b/generated/google/apis/bigtableadmin_v2/classes.rb @@ -196,6 +196,119 @@ module Google end end + # A backup of a Cloud Bigtable table. + class Backup + include Google::Apis::Core::Hashable + + # Output only. `end_time` is the time that the backup was finished. The row + # data in the backup will be no newer than this timestamp. + # Corresponds to the JSON property `endTime` + # @return [String] + attr_accessor :end_time + + # Required. The expiration time of the backup, with microseconds + # granularity that must be at least 6 hours and at most 30 days + # from the time the request is received. Once the `expire_time` + # has passed, Cloud Bigtable will delete the backup and free the + # resources used by the backup. + # Corresponds to the JSON property `expireTime` + # @return [String] + attr_accessor :expire_time + + # A globally unique identifier for the backup which cannot be + # changed. Values are of the form + # `projects/`project`/instances/`instance`/clusters/`cluster`/ + # backups/_a-zA-Z0-9*` + # The final segment of the name must be between 1 and 50 characters + # in length. + # The backup is stored in the cluster identified by the prefix of the backup + # name of the form + # `projects/`project`/instances/`instance`/clusters/`cluster``. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Output only. Size of the backup in bytes. + # Corresponds to the JSON property `sizeBytes` + # @return [Fixnum] + attr_accessor :size_bytes + + # Required. Immutable. Name of the table from which this backup was created. + # This needs + # to be in the same instance as the backup. Values are of the form + # `projects/`project`/instances/`instance`/tables/`source_table``. + # Corresponds to the JSON property `sourceTable` + # @return [String] + attr_accessor :source_table + + # Output only. `start_time` is the time that the backup was started + # (i.e. approximately the time the + # CreateBackup request is received). The + # row data in this backup will be no older than this timestamp. + # Corresponds to the JSON property `startTime` + # @return [String] + attr_accessor :start_time + + # Output only. The current state of the backup. + # Corresponds to the JSON property `state` + # @return [String] + attr_accessor :state + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @end_time = args[:end_time] if args.key?(:end_time) + @expire_time = args[:expire_time] if args.key?(:expire_time) + @name = args[:name] if args.key?(:name) + @size_bytes = args[:size_bytes] if args.key?(:size_bytes) + @source_table = args[:source_table] if args.key?(:source_table) + @start_time = args[:start_time] if args.key?(:start_time) + @state = args[:state] if args.key?(:state) + end + end + + # Information about a backup. + class BackupInfo + include Google::Apis::Core::Hashable + + # Output only. Name of the backup. + # Corresponds to the JSON property `backup` + # @return [String] + attr_accessor :backup + + # Output only. This time that the backup was finished. Row data in the + # backup will be no newer than this timestamp. + # Corresponds to the JSON property `endTime` + # @return [String] + attr_accessor :end_time + + # Output only. Name of the table the backup was created from. + # Corresponds to the JSON property `sourceTable` + # @return [String] + attr_accessor :source_table + + # Output only. The time that the backup was started. Row data in the backup + # will be no older than this timestamp. + # Corresponds to the JSON property `startTime` + # @return [String] + attr_accessor :start_time + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @backup = args[:backup] if args.key?(:backup) + @end_time = args[:end_time] if args.key?(:end_time) + @source_table = args[:source_table] if args.key?(:source_table) + @start_time = args[:start_time] if args.key?(:start_time) + end + end + # Associates `members` with a `role`. class Binding include Google::Apis::Core::Hashable @@ -412,6 +525,44 @@ module Google end end + # Metadata type for the operation returned by + # CreateBackup. + class CreateBackupMetadata + include Google::Apis::Core::Hashable + + # If set, the time at which this operation finished or was cancelled. + # Corresponds to the JSON property `endTime` + # @return [String] + attr_accessor :end_time + + # The name of the backup being created. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # The name of the table the backup is created from. + # Corresponds to the JSON property `sourceTable` + # @return [String] + attr_accessor :source_table + + # The time at which this operation started. + # Corresponds to the JSON property `startTime` + # @return [String] + attr_accessor :start_time + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @end_time = args[:end_time] if args.key?(:end_time) + @name = args[:name] if args.key?(:name) + @source_table = args[:source_table] if args.key?(:source_table) + @start_time = args[:start_time] if args.key?(:start_time) + end + end + # The metadata for the Operation returned by CreateCluster. class CreateClusterMetadata include Google::Apis::Core::Hashable @@ -964,6 +1115,33 @@ module Google end end + # The response for ListBackups. + class ListBackupsResponse + include Google::Apis::Core::Hashable + + # The list of matching backups. + # Corresponds to the JSON property `backups` + # @return [Array] + attr_accessor :backups + + # `next_page_token` can be sent in a subsequent + # ListBackups call to fetch more + # of the matching backups. + # 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) + @backups = args[:backups] if args.key?(:backups) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + # Response message for BigtableInstanceAdmin.ListClusters. class ListClustersResponse include Google::Apis::Core::Hashable @@ -1304,6 +1482,69 @@ module Google end end + # Encapsulates progress related information for a Cloud Bigtable long + # running operation. + class OperationProgress + include Google::Apis::Core::Hashable + + # If set, the time at which this operation failed or was completed + # successfully. + # Corresponds to the JSON property `endTime` + # @return [String] + attr_accessor :end_time + + # Percent completion of the operation. + # Values are between 0 and 100 inclusive. + # Corresponds to the JSON property `progressPercent` + # @return [Fixnum] + attr_accessor :progress_percent + + # Time the request was received. + # Corresponds to the JSON property `startTime` + # @return [String] + attr_accessor :start_time + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @end_time = args[:end_time] if args.key?(:end_time) + @progress_percent = args[:progress_percent] if args.key?(:progress_percent) + @start_time = args[:start_time] if args.key?(:start_time) + end + end + + # Metadata type for the long-running operation used to track the progress + # of optimizations performed on a newly restored table. This long-running + # operation is automatically created by the system after the successful + # completion of a table restore, and cannot be cancelled. + class OptimizeRestoredTableMetadata + include Google::Apis::Core::Hashable + + # Name of the restored table being optimized. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Encapsulates progress related information for a Cloud Bigtable long + # running operation. + # Corresponds to the JSON property `progress` + # @return [Google::Apis::BigtableadminV2::OperationProgress] + attr_accessor :progress + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @name = args[:name] if args.key?(:name) + @progress = args[:progress] if args.key?(:progress) + end + end + # Request message for BigtableInstanceAdmin.PartialUpdateInstance. class PartialUpdateInstanceRequest include Google::Apis::Core::Hashable @@ -1461,6 +1702,114 @@ module Google end end + # Information about a table restore. + class RestoreInfo + include Google::Apis::Core::Hashable + + # Information about a backup. + # Corresponds to the JSON property `backupInfo` + # @return [Google::Apis::BigtableadminV2::BackupInfo] + attr_accessor :backup_info + + # The type of the restore source. + # Corresponds to the JSON property `sourceType` + # @return [String] + attr_accessor :source_type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @backup_info = args[:backup_info] if args.key?(:backup_info) + @source_type = args[:source_type] if args.key?(:source_type) + end + end + + # Metadata type for the long-running operation returned by + # RestoreTable. + class RestoreTableMetadata + include Google::Apis::Core::Hashable + + # Information about a backup. + # Corresponds to the JSON property `backupInfo` + # @return [Google::Apis::BigtableadminV2::BackupInfo] + attr_accessor :backup_info + + # Name of the table being created and restored to. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # If exists, the name of the long-running operation that will be used to + # track the post-restore optimization process to optimize the performance of + # the restored table. The metadata type of the long-running operation is + # OptimizeRestoreTableMetadata. The response type is + # Empty. This long-running operation may be + # automatically created by the system if applicable after the + # RestoreTable long-running operation completes successfully. This operation + # may not be created if the table is already optimized or the restore was + # not successful. + # Corresponds to the JSON property `optimizeTableOperationName` + # @return [String] + attr_accessor :optimize_table_operation_name + + # Encapsulates progress related information for a Cloud Bigtable long + # running operation. + # Corresponds to the JSON property `progress` + # @return [Google::Apis::BigtableadminV2::OperationProgress] + attr_accessor :progress + + # The type of the restore source. + # Corresponds to the JSON property `sourceType` + # @return [String] + attr_accessor :source_type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @backup_info = args[:backup_info] if args.key?(:backup_info) + @name = args[:name] if args.key?(:name) + @optimize_table_operation_name = args[:optimize_table_operation_name] if args.key?(:optimize_table_operation_name) + @progress = args[:progress] if args.key?(:progress) + @source_type = args[:source_type] if args.key?(:source_type) + end + end + + # The request for + # RestoreTable. + class RestoreTableRequest + include Google::Apis::Core::Hashable + + # Name of the backup from which to restore. Values are of the form + # `projects//instances//clusters//backups/`. + # Corresponds to the JSON property `backup` + # @return [String] + attr_accessor :backup + + # Required. The id of the table to create and restore to. This + # table must not already exist. The `table_id` appended to + # `parent` forms the full table name of the form + # `projects//instances//tables/`. + # Corresponds to the JSON property `tableId` + # @return [String] + attr_accessor :table_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @backup = args[:backup] if args.key?(:backup) + @table_id = args[:table_id] if args.key?(:table_id) + end + end + # Request message for `SetIamPolicy` method. class SetIamPolicyRequest include Google::Apis::Core::Hashable @@ -1674,6 +2023,11 @@ module Google # @return [String] attr_accessor :name + # Information about a table restore. + # Corresponds to the JSON property `restoreInfo` + # @return [Google::Apis::BigtableadminV2::RestoreInfo] + attr_accessor :restore_info + def initialize(**args) update!(**args) end @@ -1684,6 +2038,7 @@ module Google @column_families = args[:column_families] if args.key?(:column_families) @granularity = args[:granularity] if args.key?(:granularity) @name = args[:name] if args.key?(:name) + @restore_info = args[:restore_info] if args.key?(:restore_info) end end diff --git a/generated/google/apis/bigtableadmin_v2/representations.rb b/generated/google/apis/bigtableadmin_v2/representations.rb index 1913e252a..dc69977a4 100644 --- a/generated/google/apis/bigtableadmin_v2/representations.rb +++ b/generated/google/apis/bigtableadmin_v2/representations.rb @@ -40,6 +40,18 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class Backup + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class BackupInfo + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class Binding class Representation < Google::Apis::Core::JsonRepresentation; end @@ -76,6 +88,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class CreateBackupMetadata + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class CreateClusterMetadata class Representation < Google::Apis::Core::JsonRepresentation; end @@ -172,6 +190,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class ListBackupsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class ListClustersResponse class Representation < Google::Apis::Core::JsonRepresentation; end @@ -232,6 +256,18 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class OperationProgress + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class OptimizeRestoredTableMetadata + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class PartialUpdateInstanceRequest class Representation < Google::Apis::Core::JsonRepresentation; end @@ -244,6 +280,24 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class RestoreInfo + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class RestoreTableMetadata + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class RestoreTableRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class SetIamPolicyRequest class Representation < Google::Apis::Core::JsonRepresentation; end @@ -346,6 +400,29 @@ module Google end end + class Backup + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :end_time, as: 'endTime' + property :expire_time, as: 'expireTime' + property :name, as: 'name' + property :size_bytes, :numeric_string => true, as: 'sizeBytes' + property :source_table, as: 'sourceTable' + property :start_time, as: 'startTime' + property :state, as: 'state' + end + end + + class BackupInfo + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :backup, as: 'backup' + property :end_time, as: 'endTime' + property :source_table, as: 'sourceTable' + property :start_time, as: 'startTime' + end + end + class Binding # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -396,6 +473,16 @@ module Google end end + class CreateBackupMetadata + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :end_time, as: 'endTime' + property :name, as: 'name' + property :source_table, as: 'sourceTable' + property :start_time, as: 'startTime' + end + end + class CreateClusterMetadata # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -544,6 +631,15 @@ module Google end end + class ListBackupsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :backups, as: 'backups', class: Google::Apis::BigtableadminV2::Backup, decorator: Google::Apis::BigtableadminV2::Backup::Representation + + property :next_page_token, as: 'nextPageToken' + end + end + class ListClustersResponse # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -640,6 +736,24 @@ module Google end end + class OperationProgress + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :end_time, as: 'endTime' + property :progress_percent, as: 'progressPercent' + property :start_time, as: 'startTime' + end + end + + class OptimizeRestoredTableMetadata + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :name, as: 'name' + property :progress, as: 'progress', class: Google::Apis::BigtableadminV2::OperationProgress, decorator: Google::Apis::BigtableadminV2::OperationProgress::Representation + + end + end + class PartialUpdateInstanceRequest # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -661,6 +775,36 @@ module Google end end + class RestoreInfo + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :backup_info, as: 'backupInfo', class: Google::Apis::BigtableadminV2::BackupInfo, decorator: Google::Apis::BigtableadminV2::BackupInfo::Representation + + property :source_type, as: 'sourceType' + end + end + + class RestoreTableMetadata + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :backup_info, as: 'backupInfo', class: Google::Apis::BigtableadminV2::BackupInfo, decorator: Google::Apis::BigtableadminV2::BackupInfo::Representation + + property :name, as: 'name' + property :optimize_table_operation_name, as: 'optimizeTableOperationName' + property :progress, as: 'progress', class: Google::Apis::BigtableadminV2::OperationProgress, decorator: Google::Apis::BigtableadminV2::OperationProgress::Representation + + property :source_type, as: 'sourceType' + end + end + + class RestoreTableRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :backup, as: 'backup' + property :table_id, as: 'tableId' + end + end + class SetIamPolicyRequest # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -703,6 +847,8 @@ module Google property :granularity, as: 'granularity' property :name, as: 'name' + property :restore_info, as: 'restoreInfo', class: Google::Apis::BigtableadminV2::RestoreInfo, decorator: Google::Apis::BigtableadminV2::RestoreInfo::Representation + end end diff --git a/generated/google/apis/bigtableadmin_v2/service.rb b/generated/google/apis/bigtableadmin_v2/service.rb index 090d0a503..151ca3719 100644 --- a/generated/google/apis/bigtableadmin_v2/service.rb +++ b/generated/google/apis/bigtableadmin_v2/service.rb @@ -879,6 +879,121 @@ module Google execute_or_queue_command(command, &block) end + # Starts creating a new Cloud Bigtable Backup. The returned backup + # long-running operation can be used to + # track creation of the backup. The + # metadata field type is + # CreateBackupMetadata. The + # response field type is + # Backup, if successful. Cancelling the returned operation will stop the + # creation and delete the backup. + # @param [String] parent + # Required. This must be one of the clusters in the instance in which this + # table is located. The backup will be stored in this cluster. Values are + # of the form `projects/`project`/instances/`instance`/clusters/`cluster``. + # @param [Google::Apis::BigtableadminV2::Backup] backup_object + # @param [String] backup_id + # Required. The id of the backup to be created. The `backup_id` along with + # the parent `parent` are combined as `parent`/backups/`backup_id` to create + # the full backup name, of the form: + # `projects/`project`/instances/`instance`/clusters/`cluster`/backups/`backup_id` + # `. + # This string must be between 1 and 50 characters in length and match the + # regex _a-zA-Z0-9*. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::BigtableadminV2::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::BigtableadminV2::Operation] + # + # @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 create_project_instance_cluster_backup(parent, backup_object = nil, backup_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v2/{+parent}/backups', options) + command.request_representation = Google::Apis::BigtableadminV2::Backup::Representation + command.request_object = backup_object + command.response_representation = Google::Apis::BigtableadminV2::Operation::Representation + command.response_class = Google::Apis::BigtableadminV2::Operation + command.params['parent'] = parent unless parent.nil? + command.query['backupId'] = backup_id unless backup_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes a pending or completed Cloud Bigtable backup. + # @param [String] name + # Required. Name of the backup to delete. + # Values are of the form + # `projects/`project`/instances/`instance`/clusters/`cluster`/backups/`backup``. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::BigtableadminV2::Empty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::BigtableadminV2::Empty] + # + # @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_project_instance_cluster_backup(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v2/{+name}', options) + command.response_representation = Google::Apis::BigtableadminV2::Empty::Representation + command.response_class = Google::Apis::BigtableadminV2::Empty + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets metadata on a pending or completed Cloud Bigtable Backup. + # @param [String] name + # Required. Name of the backup. + # Values are of the form + # `projects/`project`/instances/`instance`/clusters/`cluster`/backups/`backup``. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::BigtableadminV2::Backup] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::BigtableadminV2::Backup] + # + # @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 get_project_instance_cluster_backup(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v2/{+name}', options) + command.response_representation = Google::Apis::BigtableadminV2::Backup::Representation + command.response_class = Google::Apis::BigtableadminV2::Backup + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # Gets the access control policy for a Table resource. # Returns an empty policy if the resource exists but does not have a policy # set. @@ -915,6 +1030,147 @@ module Google execute_or_queue_command(command, &block) end + # Lists Cloud Bigtable backups. Returns both completed and pending + # backups. + # @param [String] parent + # Required. The cluster to list backups from. Values are of the + # form `projects/`project`/instances/`instance`/clusters/`cluster``. + # Use ``cluster` = '-'` to list backups for all clusters in an instance, + # e.g., `projects/`project`/instances/`instance`/clusters/-`. + # @param [String] filter + # A filter expression that filters backups listed in the response. + # The expression must specify the field name, a comparison operator, + # and the value that you want to use for filtering. The value must be a + # string, a number, or a boolean. The comparison operator must be + # <, >, <=, >=, !=, =, or :. Colon ‘:’ represents a HAS operator which is + # roughly synonymous with equality. Filter rules are case insensitive. + # The fields eligible for filtering are: + # * `name` + # * `source_table` + # * `state` + # * `start_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ) + # * `end_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ) + # * `expire_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ) + # * `size_bytes` + # To filter on multiple expressions, provide each separate expression within + # parentheses. By default, each expression is an AND expression. However, + # you can include AND, OR, and NOT expressions explicitly. + # Some examples of using filters are: + # * `name:"exact"` --> The backup's name is the string "exact". + # * `name:howl` --> The backup's name contains the string "howl". + # * `source_table:prod` + # --> The source_table's name contains the string "prod". + # * `state:CREATING` --> The backup is pending creation. + # * `state:READY` --> The backup is fully created and ready for use. + # * `(name:howl) AND (start_time < \"2018-03-28T14:50:00Z\")` + # --> The backup name contains the string "howl" and start_time + # of the backup is before 2018-03-28T14:50:00Z. + # * `size_bytes > 10000000000` --> The backup's size is greater than 10GB + # @param [String] order_by + # An expression for specifying the sort order of the results of the request. + # The string value should specify one or more fields in Backup. The full + # syntax is described at https://aip.dev/132#ordering. + # Fields supported are: + # * name + # * source_table + # * expire_time + # * start_time + # * end_time + # * size_bytes + # * state + # For example, "start_time". The default sorting order is ascending. + # To specify descending order for the field, a suffix " desc" should + # be appended to the field name. For example, "start_time desc". + # Redundant space characters in the syntax are insigificant. + # If order_by is empty, results will be sorted by `start_time` in descending + # order starting from the most recently created backup. + # @param [Fixnum] page_size + # Number of backups to be returned in the response. If 0 or + # less, defaults to the server's maximum allowed page size. + # @param [String] page_token + # If non-empty, `page_token` should contain a + # next_page_token from a + # previous ListBackupsResponse to the same `parent` and with the same + # `filter`. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::BigtableadminV2::ListBackupsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::BigtableadminV2::ListBackupsResponse] + # + # @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_project_instance_cluster_backups(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v2/{+parent}/backups', options) + command.response_representation = Google::Apis::BigtableadminV2::ListBackupsResponse::Representation + command.response_class = Google::Apis::BigtableadminV2::ListBackupsResponse + command.params['parent'] = parent unless parent.nil? + command.query['filter'] = filter unless filter.nil? + command.query['orderBy'] = order_by unless order_by.nil? + command.query['pageSize'] = page_size unless page_size.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? + execute_or_queue_command(command, &block) + end + + # Updates a pending or completed Cloud Bigtable Backup. + # @param [String] name + # A globally unique identifier for the backup which cannot be + # changed. Values are of the form + # `projects/`project`/instances/`instance`/clusters/`cluster`/ + # backups/_a-zA-Z0-9*` + # The final segment of the name must be between 1 and 50 characters + # in length. + # The backup is stored in the cluster identified by the prefix of the backup + # name of the form + # `projects/`project`/instances/`instance`/clusters/`cluster``. + # @param [Google::Apis::BigtableadminV2::Backup] backup_object + # @param [String] update_mask + # Required. A mask specifying which fields (e.g. `expire_time`) in the + # Backup resource should be updated. This mask is relative to the Backup + # resource, not to the request message. The field mask must always be + # specified; this prevents any future fields from being erased accidentally + # by clients that do not know about them. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::BigtableadminV2::Backup] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::BigtableadminV2::Backup] + # + # @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 patch_project_instance_cluster_backup(name, backup_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'v2/{+name}', options) + command.request_representation = Google::Apis::BigtableadminV2::Backup::Representation + command.request_object = backup_object + command.response_representation = Google::Apis::BigtableadminV2::Backup::Representation + command.response_class = Google::Apis::BigtableadminV2::Backup + command.params['name'] = name unless name.nil? + command.query['updateMask'] = update_mask unless update_mask.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # Sets the access control policy on a Table resource. # Replaces any existing policy. # @param [String] resource @@ -1322,6 +1578,48 @@ module Google execute_or_queue_command(command, &block) end + # Create a new table by restoring from a completed backup. The new table + # must be in the same instance as the instance containing the backup. The + # returned table long-running operation can + # be used to track the progress of the operation, and to cancel it. The + # metadata field type is + # RestoreTableMetadata. The + # response type is + # Table, if successful. + # @param [String] parent + # Required. The name of the instance in which to create the restored + # table. This instance must be the parent of the source backup. Values are + # of the form `projects//instances/`. + # @param [Google::Apis::BigtableadminV2::RestoreTableRequest] restore_table_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::BigtableadminV2::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::BigtableadminV2::Operation] + # + # @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 restore_table(parent, restore_table_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v2/{+parent}/tables:restore', options) + command.request_representation = Google::Apis::BigtableadminV2::RestoreTableRequest::Representation + command.request_object = restore_table_request_object + command.response_representation = Google::Apis::BigtableadminV2::Operation::Representation + command.response_class = Google::Apis::BigtableadminV2::Operation + command.params['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # Sets the access control policy on a Table resource. # Replaces any existing policy. # @param [String] resource diff --git a/generated/google/apis/displayvideo_v1.rb b/generated/google/apis/displayvideo_v1.rb index 254df82af..9bccfaf04 100644 --- a/generated/google/apis/displayvideo_v1.rb +++ b/generated/google/apis/displayvideo_v1.rb @@ -26,11 +26,14 @@ module Google # @see https://developers.google.com/display-video/ module DisplayvideoV1 VERSION = 'V1' - REVISION = '20200714' + REVISION = '20200720' # Create, see, edit, and permanently delete your Display & Video 360 entities and reports AUTH_DISPLAY_VIDEO = 'https://www.googleapis.com/auth/display-video' + # Create, see, and edit Display & Video 360 Campaign entities and see billing invoices + AUTH_DISPLAY_VIDEO_MEDIAPLANNING = 'https://www.googleapis.com/auth/display-video-mediaplanning' + # View and manage your reports in DoubleClick Bid Manager AUTH_DOUBLECLICKBIDMANAGER = 'https://www.googleapis.com/auth/doubleclickbidmanager' end diff --git a/generated/google/apis/displayvideo_v1/classes.rb b/generated/google/apis/displayvideo_v1/classes.rb index 5ba2613e2..efef7342d 100644 --- a/generated/google/apis/displayvideo_v1/classes.rb +++ b/generated/google/apis/displayvideo_v1/classes.rb @@ -32,37 +32,29 @@ module Google attr_accessor :display_name # The minimum visible video duration required (in seconds) in order for an - # impression to be recorded. - # You must specify - # minimum_duration, - # minimum_quartile + # impression to be recorded. You must specify minimum_duration, minimum_quartile # or both. If both are specified, an impression meets the metric criteria if # either requirement is met (whichever happens first). # Corresponds to the JSON property `minimumDuration` # @return [String] attr_accessor :minimum_duration - # The minimum visible video duration required, based on the video quartiles, - # in order for an impression to be recorded. - # You must specify - # minimum_duration, - # minimum_quartile - # or both. If both are specified, an impression meets the metric criteria if - # either requirement is met (whichever happens first). + # The minimum visible video duration required, based on the video quartiles, in + # order for an impression to be recorded. You must specify minimum_duration, + # minimum_quartile or both. If both are specified, an impression meets the + # metric criteria if either requirement is met (whichever happens first). # Corresponds to the JSON property `minimumQuartile` # @return [String] attr_accessor :minimum_quartile # Required. The minimum percentage of the video ad's pixels visible on the - # screen in - # order for an impression to be recorded. + # screen in order for an impression to be recorded. # Corresponds to the JSON property `minimumViewability` # @return [String] attr_accessor :minimum_viewability # Required. The minimum percentage of the video ad's volume required in order - # for an - # impression to be recorded. + # for an impression to be recorded. # Corresponds to the JSON property `minimumVolume` # @return [String] attr_accessor :minimum_volume @@ -124,19 +116,17 @@ module Google # @return [Google::Apis::DisplayvideoV1::AdvertiserDataAccessConfig] attr_accessor :data_access_config - # Required. The display name of the advertiser. - # Must be UTF-8 encoded with a maximum size of 240 bytes. + # Required. The display name of the advertiser. Must be UTF-8 encoded with a + # maximum size of 240 bytes. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name # Required. Controls whether or not insertion orders and line items of the - # advertiser can spend their budgets and bid on inventory. - # * Accepted values are `ENTITY_STATUS_ACTIVE` and - # `ENTITY_STATUS_SCHEDULED_FOR_DELETION`. - # * If set to - # `ENTITY_STATUS_SCHEDULED_FOR_DELETION`, the advertiser will be deleted 30 - # days from when it was first scheduled for deletion. + # advertiser can spend their budgets and bid on inventory. * Accepted values are + # `ENTITY_STATUS_ACTIVE` and `ENTITY_STATUS_SCHEDULED_FOR_DELETION`. * If set to + # `ENTITY_STATUS_SCHEDULED_FOR_DELETION`, the advertiser will be deleted 30 days + # from when it was first scheduled for deletion. # Corresponds to the JSON property `entityStatus` # @return [String] attr_accessor :entity_status @@ -230,30 +220,27 @@ module Google attr_accessor :dynamic_creative_enabled alias_method :dynamic_creative_enabled?, :dynamic_creative_enabled - # An ID for configuring campaign monitoring provided by Integral Ad Service - # (IAS). The DV360 system will append an IAS "Campaign Monitor" tag - # containing this ID to the creative tag. + # An ID for configuring campaign monitoring provided by Integral Ad Service (IAS) + # . The DV360 system will append an IAS "Campaign Monitor" tag containing this + # ID to the creative tag. # Corresponds to the JSON property `iasClientId` # @return [Fixnum] attr_accessor :ias_client_id - # Whether or not to use DV360's Online Behavioral Advertising (OBA) - # compliance. - # Warning: Changing OBA settings may cause the audit status of your creatives - # to be reset by some ad exchanges, making them ineligible to serve until - # they are re-approved. + # Whether or not to use DV360's Online Behavioral Advertising (OBA) compliance. + # Warning: Changing OBA settings may cause the audit status of your creatives to + # be reset by some ad exchanges, making them ineligible to serve until they are + # re-approved. # Corresponds to the JSON property `obaComplianceDisabled` # @return [Boolean] attr_accessor :oba_compliance_disabled alias_method :oba_compliance_disabled?, :oba_compliance_disabled - # By setting this field to `true`, you, on behalf of your company, - # authorize Google to use video creatives associated with this Display & - # Video 360 advertiser to provide reporting and features related to the - # advertiser's television campaigns. - # Applicable only when the advertiser has a - # CM hybrid ad server - # configuration. + # By setting this field to `true`, you, on behalf of your company, authorize + # Google to use video creatives associated with this Display & Video 360 + # advertiser to provide reporting and features related to the advertiser's + # television campaigns. Applicable only when the advertiser has a CM hybrid ad + # server configuration. # Corresponds to the JSON property `videoCreativeDataSharingAuthorized` # @return [Boolean] attr_accessor :video_creative_data_sharing_authorized @@ -295,64 +282,36 @@ module Google class AdvertiserGeneralConfig include Google::Apis::Core::Hashable - # Required. Immutable. Advertiser's currency in ISO 4217 format. - # Accepted codes and the currencies they represent are: - # Currency Code : Currency Name - # * `ARS` : Argentine Peso - # * `AUD` : Australian Dollar - # * `BRL` : Brazilian Real - # * `CAD` : Canadian Dollar - # * `CHF` : Swiss Franc - # * `CLP` : Chilean Peso - # * `CNY` : Chinese Yuan - # * `COP` : Colombian Peso - # * `CZK` : Czech Koruna - # * `DKK` : Danish Krone - # * `EGP` : Egyption Pound - # * `EUR` : Euro - # * `GBP` : British Pound - # * `HKD` : Hong Kong Dollar - # * `HUF` : Hungarian Forint - # * `IDR` : Indonesian Rupiah - # * `ILS` : Israeli Shekel - # * `INR` : Indian Rupee - # * `JPY` : Japanese Yen - # * `KRW` : South Korean Won - # * `MXN` : Mexican Pesos - # * `MYR` : Malaysian Ringgit - # * `NGN` : Nigerian Naira - # * `NOK` : Norwegian Krone - # * `NZD` : New Zealand Dollar - # * `PEN` : Peruvian Nuevo Sol - # * `PLN` : Polish Zloty - # * `RON` : New Romanian Leu - # * `RUB` : Russian Ruble - # * `SEK` : Swedish Krona - # * `TRY` : Turkish Lira - # * `TWD` : New Taiwan Dollar - # * `USD` : US Dollar - # * `ZAR` : South African Rand + # Required. Immutable. Advertiser's currency in ISO 4217 format. Accepted codes + # and the currencies they represent are: Currency Code : Currency Name * `ARS` : + # Argentine Peso * `AUD` : Australian Dollar * `BRL` : Brazilian Real * `CAD` : + # Canadian Dollar * `CHF` : Swiss Franc * `CLP` : Chilean Peso * `CNY` : Chinese + # Yuan * `COP` : Colombian Peso * `CZK` : Czech Koruna * `DKK` : Danish Krone * ` + # EGP` : Egyption Pound * `EUR` : Euro * `GBP` : British Pound * `HKD` : Hong + # Kong Dollar * `HUF` : Hungarian Forint * `IDR` : Indonesian Rupiah * `ILS` : + # Israeli Shekel * `INR` : Indian Rupee * `JPY` : Japanese Yen * `KRW` : South + # Korean Won * `MXN` : Mexican Pesos * `MYR` : Malaysian Ringgit * `NGN` : + # Nigerian Naira * `NOK` : Norwegian Krone * `NZD` : New Zealand Dollar * `PEN` : + # Peruvian Nuevo Sol * `PLN` : Polish Zloty * `RON` : New Romanian Leu * `RUB` : + # Russian Ruble * `SEK` : Swedish Krona * `TRY` : Turkish Lira * `TWD` : New + # Taiwan Dollar * `USD` : US Dollar * `ZAR` : South African Rand # Corresponds to the JSON property `currencyCode` # @return [String] attr_accessor :currency_code - # Required. The domain URL of the advertiser's primary website. - # The system will send this information to publishers that require website - # URL to associate a campaign with an advertiser. - # Provide a URL with no path or query string, beginning with `http:` or - # `https:`. - # For example, http://www.example.com + # Required. The domain URL of the advertiser's primary website. The system will + # send this information to publishers that require website URL to associate a + # campaign with an advertiser. Provide a URL with no path or query string, + # beginning with `http:` or `https:`. For example, http://www.example.com # Corresponds to the JSON property `domainUrl` # @return [String] attr_accessor :domain_url - # Output only. The standard TZ database name of the advertiser's time zone. - # For example, `America/New_York`. - # See more at: - # https://en.wikipedia.org/wiki/List_of_tz_database_time_zones - # For CM hybrid advertisers, the time zone is the same as that of the - # associated CM account; for third-party only advertisers, the time zone is - # the same as that of the parent partner. + # Output only. The standard TZ database name of the advertiser's time zone. For + # example, `America/New_York`. See more at: https://en.wikipedia.org/wiki/ + # List_of_tz_database_time_zones For CM hybrid advertisers, the time zone is the + # same as that of the associated CM account; for third-party only advertisers, + # the time zone is the same as that of the parent partner. # Corresponds to the JSON property `timeZone` # @return [String] attr_accessor :time_zone @@ -373,12 +332,10 @@ module Google class AdvertiserSdfConfig include Google::Apis::Core::Hashable - # Whether or not this advertiser overrides the SDF configuration of its - # parent partner. - # By default, an advertiser inherits the SDF configuration from the parent - # partner. To override the partner configuration, set this field to `true` - # and provide the new configuration in - # sdfConfig. + # Whether or not this advertiser overrides the SDF configuration of its parent + # partner. By default, an advertiser inherits the SDF configuration from the + # parent partner. To override the partner configuration, set this field to `true` + # and provide the new configuration in sdfConfig. # Corresponds to the JSON property `overridePartnerSdfConfig` # @return [Boolean] attr_accessor :override_partner_sdf_config @@ -404,8 +361,8 @@ module Google class AdvertiserTargetingConfig include Google::Apis::Core::Hashable - # Whether or not connected TV devices are exempt from viewability targeting - # for all video line items under the advertiser. + # Whether or not connected TV devices are exempt from viewability targeting for + # all video line items under the advertiser. # Corresponds to the JSON property `exemptTvFromViewabilityTargeting` # @return [Boolean] attr_accessor :exempt_tv_from_viewability_targeting @@ -421,25 +378,23 @@ module Google end end - # Represents a targetable age range. This will be populated in the details - # field of an AssignedTargetingOption when - # targeting_type is - # `TARGETING_TYPE_AGE_RANGE`. + # Represents a targetable age range. This will be populated in the details field + # of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AGE_RANGE` + # . class AgeRangeAssignedTargetingOptionDetails include Google::Apis::Core::Hashable # Output only. The age range of an audience. We only support targeting a - # continuous age - # range of an audience. Thus, the age range represented in this field can be - # 1) targeted solely, or, 2) part of a larger continuous age range. The reach - # of a continuous age range targeting can be expanded by also targeting an - # audience of an unknown age. + # continuous age range of an audience. Thus, the age range represented in this + # field can be 1) targeted solely, or, 2) part of a larger continuous age range. + # The reach of a continuous age range targeting can be expanded by also + # targeting an audience of an unknown age. # Corresponds to the JSON property `ageRange` # @return [String] attr_accessor :age_range - # Required. The targeting_option_id of a - # TargetingOption of type `TARGETING_TYPE_AGE_RANGE`. + # Required. The targeting_option_id of a TargetingOption of type ` + # TARGETING_TYPE_AGE_RANGE`. # Corresponds to the JSON property `targetingOptionId` # @return [String] attr_accessor :targeting_option_id @@ -456,9 +411,7 @@ module Google end # Represents a targetable age range. This will be populated in the - # age_range_details field when - # targeting_type is - # `TARGETING_TYPE_AGE_RANGE`. + # age_range_details field when targeting_type is `TARGETING_TYPE_AGE_RANGE`. class AgeRangeTargetingOptionDetails include Google::Apis::Core::Hashable @@ -478,16 +431,14 @@ module Google end # Details for assigned app targeting option. This will be populated in the - # details field of an AssignedTargetingOption when - # targeting_type is - # `TARGETING_TYPE_APP`. + # details field of an AssignedTargetingOption when targeting_type is ` + # TARGETING_TYPE_APP`. class AppAssignedTargetingOptionDetails include Google::Apis::Core::Hashable - # Required. The ID of the app. - # Android's Play store app uses bundle ID, for example - # `com.google.android.gm`. Apple's App store app ID uses 9 digit string, for - # example `422689480`. + # Required. The ID of the app. Android's Play store app uses bundle ID, for + # example `com.google.android.gm`. Apple's App store app ID uses 9 digit string, + # for example `422689480`. # Corresponds to the JSON property `appId` # @return [String] attr_accessor :app_id @@ -515,12 +466,9 @@ module Google end end - # Details for assigned app category targeting option. This will be - # populated in the - # app_category_details field of - # an AssignedTargetingOption when - # targeting_type - # is `TARGETING_TYPE_APP_CATEGORY`. + # Details for assigned app category targeting option. This will be populated in + # the app_category_details field of an AssignedTargetingOption when + # targeting_type is `TARGETING_TYPE_APP_CATEGORY`. class AppCategoryAssignedTargetingOptionDetails include Google::Apis::Core::Hashable @@ -535,9 +483,8 @@ module Google attr_accessor :negative alias_method :negative?, :negative - # Required. The targeting_option_id field when - # targeting_type is - # `TARGETING_TYPE_APP_CATEGORY`. + # Required. The targeting_option_id field when targeting_type is ` + # TARGETING_TYPE_APP_CATEGORY`. # Corresponds to the JSON property `targetingOptionId` # @return [String] attr_accessor :targeting_option_id @@ -557,9 +504,8 @@ module Google # Represents a targetable collection of apps. A collection lets you target # dynamic groups of related apps that are maintained by the platform, for # example `All Apps/Google Play/Games`. This will be populated in the - # app_category_details field when - # targeting_type is - # `TARGETING_TYPE_APP_CATEGORY`. + # app_category_details field when targeting_type is `TARGETING_TYPE_APP_CATEGORY` + # . class AppCategoryTargetingOptionDetails include Google::Apis::Core::Hashable @@ -582,16 +528,14 @@ module Google class Asset include Google::Apis::Core::Hashable - # The asset content. - # For uploaded assets, the content is the serving path. + # The asset content. For uploaded assets, the content is the serving path. # Corresponds to the JSON property `content` # @return [String] attr_accessor :content # Media ID of the uploaded asset. This is a unique identifier for the asset. - # This ID can be passed to other API calls, e.g. - # CreateCreative to associate - # the asset with a creative. + # This ID can be passed to other API calls, e.g. CreateCreative to associate the + # asset with a creative. # Corresponds to the JSON property `mediaId` # @return [Fixnum] attr_accessor :media_id @@ -673,8 +617,7 @@ module Google include Google::Apis::Core::Hashable # Output only. The unique ID of the assigned location. The ID is only unique - # within a - # location list. It may be reused in other contexts. + # within a location list. It may be reused in other contexts. # Corresponds to the JSON property `assignedLocationId` # @return [Fixnum] attr_accessor :assigned_location_id @@ -685,8 +628,7 @@ module Google attr_accessor :name # Required. The ID of the targeting option assigned to the location list. Must - # be of - # type TARGETING_TYPE_GEO_REGION. + # be of type TARGETING_TYPE_GEO_REGION. # Corresponds to the JSON property `targetingOptionId` # @return [String] attr_accessor :targeting_option_id @@ -708,182 +650,151 @@ module Google class AssignedTargetingOption include Google::Apis::Core::Hashable - # Represents a targetable age range. This will be populated in the details - # field of an AssignedTargetingOption when - # targeting_type is - # `TARGETING_TYPE_AGE_RANGE`. + # Represents a targetable age range. This will be populated in the details field + # of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AGE_RANGE` + # . # Corresponds to the JSON property `ageRangeDetails` # @return [Google::Apis::DisplayvideoV1::AgeRangeAssignedTargetingOptionDetails] attr_accessor :age_range_details - # Details for assigned app category targeting option. This will be - # populated in the - # app_category_details field of - # an AssignedTargetingOption when - # targeting_type - # is `TARGETING_TYPE_APP_CATEGORY`. + # Details for assigned app category targeting option. This will be populated in + # the app_category_details field of an AssignedTargetingOption when + # targeting_type is `TARGETING_TYPE_APP_CATEGORY`. # Corresponds to the JSON property `appCategoryDetails` # @return [Google::Apis::DisplayvideoV1::AppCategoryAssignedTargetingOptionDetails] attr_accessor :app_category_details # Details for assigned app targeting option. This will be populated in the - # details field of an AssignedTargetingOption when - # targeting_type is - # `TARGETING_TYPE_APP`. + # details field of an AssignedTargetingOption when targeting_type is ` + # TARGETING_TYPE_APP`. # Corresponds to the JSON property `appDetails` # @return [Google::Apis::DisplayvideoV1::AppAssignedTargetingOptionDetails] attr_accessor :app_details # Output only. The unique ID of the assigned targeting option. The ID is only - # unique - # within a given line item and targeting type. It may be reused in other + # unique within a given line item and targeting type. It may be reused in other # contexts. # Corresponds to the JSON property `assignedTargetingOptionId` # @return [String] attr_accessor :assigned_targeting_option_id # Assigned audience group targeting option details. This will be populated in - # the details field of an AssignedTargetingOption when - # targeting_type is - # `TARGETING_TYPE_AUDIENCE_GROUP`. - # The relation between each group is UNION, except for - # excluded_first_and_third_party_audience_group and + # the details field of an AssignedTargetingOption when targeting_type is ` + # TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, + # except for excluded_first_and_third_party_audience_group and # excluded_google_audience_group, of which COMPLEMENT is UNION'ed with other # groups. # Corresponds to the JSON property `audienceGroupDetails` # @return [Google::Apis::DisplayvideoV1::AudienceGroupAssignedTargetingOptionDetails] attr_accessor :audience_group_details - # Represents an assigned authorized seller status. This will be populated in - # the details field of an AssignedTargetingOption when - # targeting_type is - # `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. + # Represents an assigned authorized seller status. This will be populated in the + # details field of an AssignedTargetingOption when targeting_type is ` + # TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. # Corresponds to the JSON property `authorizedSellerStatusDetails` # @return [Google::Apis::DisplayvideoV1::AuthorizedSellerStatusAssignedTargetingOptionDetails] attr_accessor :authorized_seller_status_details - # Details for assigned browser targeting option. This will be populated in - # the details field of an AssignedTargetingOption when - # targeting_type is - # `TARGETING_TYPE_BROWSER`. + # Details for assigned browser targeting option. This will be populated in the + # details field of an AssignedTargetingOption when targeting_type is ` + # TARGETING_TYPE_BROWSER`. # Corresponds to the JSON property `browserDetails` # @return [Google::Apis::DisplayvideoV1::BrowserAssignedTargetingOptionDetails] attr_accessor :browser_details # Details for assigned carrier and ISP targeting option. This will be populated - # in the details field of an AssignedTargetingOption when - # targeting_type is - # `TARGETING_TYPE_CARRIER_AND_ISP`. + # in the details field of an AssignedTargetingOption when targeting_type is ` + # TARGETING_TYPE_CARRIER_AND_ISP`. # Corresponds to the JSON property `carrierAndIspDetails` # @return [Google::Apis::DisplayvideoV1::CarrierAndIspAssignedTargetingOptionDetails] attr_accessor :carrier_and_isp_details # Assigned category targeting option details. This will be populated in the - # category_details field when - # targeting_type is - # `TARGETING_TYPE_CATEGORY`. + # category_details field when targeting_type is `TARGETING_TYPE_CATEGORY`. # Corresponds to the JSON property `categoryDetails` # @return [Google::Apis::DisplayvideoV1::CategoryAssignedTargetingOptionDetails] attr_accessor :category_details - # Details for assigned channel targeting option. This will be populated in - # the details field of an AssignedTargetingOption when - # targeting_type is - # `TARGETING_TYPE_CHANNEL`. + # Details for assigned channel targeting option. This will be populated in the + # details field of an AssignedTargetingOption when targeting_type is ` + # TARGETING_TYPE_CHANNEL`. # Corresponds to the JSON property `channelDetails` # @return [Google::Apis::DisplayvideoV1::ChannelAssignedTargetingOptionDetails] attr_accessor :channel_details # Assigned content instream position targeting option details. This will be - # populated in the - # content_instream_position_details - # field when - # targeting_type is - # `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`. + # populated in the content_instream_position_details field when targeting_type + # is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`. # Corresponds to the JSON property `contentInstreamPositionDetails` # @return [Google::Apis::DisplayvideoV1::ContentInstreamPositionAssignedTargetingOptionDetails] attr_accessor :content_instream_position_details # Assigned content outstream position targeting option details. This will be - # populated in the - # content_outstream_position_details - # field when - # targeting_type is - # `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`. + # populated in the content_outstream_position_details field when targeting_type + # is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`. # Corresponds to the JSON property `contentOutstreamPositionDetails` # @return [Google::Apis::DisplayvideoV1::ContentOutstreamPositionAssignedTargetingOptionDetails] attr_accessor :content_outstream_position_details # Representation of a segment of time defined on a specific day of the week and - # with a start and end time. - # The time represented by `start_hour` must be before the time represented by - # `end_hour`. + # with a start and end time. The time represented by `start_hour` must be before + # the time represented by `end_hour`. # Corresponds to the JSON property `dayAndTimeDetails` # @return [Google::Apis::DisplayvideoV1::DayAndTimeAssignedTargetingOptionDetails] attr_accessor :day_and_time_details # Assigned device make and model targeting option details. This will be - # populated in the - # device_make_model_details - # field when - # targeting_type is - # `TARGETING_TYPE_DEVICE_MAKE_MODEL`. + # populated in the device_make_model_details field when targeting_type is ` + # TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Corresponds to the JSON property `deviceMakeModelDetails` # @return [Google::Apis::DisplayvideoV1::DeviceMakeModelAssignedTargetingOptionDetails] attr_accessor :device_make_model_details - # Targeting details for device type. This will be - # populated in the details field of an AssignedTargetingOption when - # targeting_type is - # `TARGETING_TYPE_DEVICE_TYPE`. + # Targeting details for device type. This will be populated in the details field + # of an AssignedTargetingOption when targeting_type is ` + # TARGETING_TYPE_DEVICE_TYPE`. # Corresponds to the JSON property `deviceTypeDetails` # @return [Google::Apis::DisplayvideoV1::DeviceTypeAssignedTargetingOptionDetails] attr_accessor :device_type_details - # Targeting details for digital content label. This will be - # populated in the details field of an AssignedTargetingOption when - # targeting_type is - # `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. + # Targeting details for digital content label. This will be populated in the + # details field of an AssignedTargetingOption when targeting_type is ` + # TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Corresponds to the JSON property `digitalContentLabelExclusionDetails` # @return [Google::Apis::DisplayvideoV1::DigitalContentLabelAssignedTargetingOptionDetails] attr_accessor :digital_content_label_exclusion_details - # Assigned environment targeting option details. This will be populated - # in the details field of an AssignedTargetingOption when - # targeting_type is - # `TARGETING_TYPE_ENVIRONMENT`. + # Assigned environment targeting option details. This will be populated in the + # details field of an AssignedTargetingOption when targeting_type is ` + # TARGETING_TYPE_ENVIRONMENT`. # Corresponds to the JSON property `environmentDetails` # @return [Google::Apis::DisplayvideoV1::EnvironmentAssignedTargetingOptionDetails] attr_accessor :environment_details - # Details for assigned exchange targeting option. This will be populated in - # the details field of an AssignedTargetingOption when - # targeting_type is - # `TARGETING_TYPE_EXCHANGE`. + # Details for assigned exchange targeting option. This will be populated in the + # details field of an AssignedTargetingOption when targeting_type is ` + # TARGETING_TYPE_EXCHANGE`. # Corresponds to the JSON property `exchangeDetails` # @return [Google::Apis::DisplayvideoV1::ExchangeAssignedTargetingOptionDetails] attr_accessor :exchange_details - # Details for assigned gender targeting option. This will be populated in - # the details field of an AssignedTargetingOption when - # targeting_type is - # `TARTGETING_TYPE_GENDER`. + # Details for assigned gender targeting option. This will be populated in the + # details field of an AssignedTargetingOption when targeting_type is ` + # TARTGETING_TYPE_GENDER`. # Corresponds to the JSON property `genderDetails` # @return [Google::Apis::DisplayvideoV1::GenderAssignedTargetingOptionDetails] attr_accessor :gender_details # Details for assigned geographic region targeting option. This will be # populated in the details field of an AssignedTargetingOption when - # targeting_type is - # `TARGETING_TYPE_GEO_REGION`. + # targeting_type is `TARGETING_TYPE_GEO_REGION`. # Corresponds to the JSON property `geoRegionDetails` # @return [Google::Apis::DisplayvideoV1::GeoRegionAssignedTargetingOptionDetails] attr_accessor :geo_region_details - # Details for assigned household income targeting option. This will be - # populated in the details field of an AssignedTargetingOption when - # targeting_type is - # `TARGETING_TYPE_HOUSEHOLD_INCOME`. + # Details for assigned household income targeting option. This will be populated + # in the details field of an AssignedTargetingOption when targeting_type is ` + # TARGETING_TYPE_HOUSEHOLD_INCOME`. # Corresponds to the JSON property `householdIncomeDetails` # @return [Google::Apis::DisplayvideoV1::HouseholdIncomeAssignedTargetingOptionDetails] attr_accessor :household_income_details @@ -893,34 +804,30 @@ module Google # @return [String] attr_accessor :inheritance - # Targeting details for inventory source. This will be - # populated in the details field of an AssignedTargetingOption when - # targeting_type is - # `TARGETING_TYPE_INVENTORY_SOURCE`. + # Targeting details for inventory source. This will be populated in the details + # field of an AssignedTargetingOption when targeting_type is ` + # TARGETING_TYPE_INVENTORY_SOURCE`. # Corresponds to the JSON property `inventorySourceDetails` # @return [Google::Apis::DisplayvideoV1::InventorySourceAssignedTargetingOptionDetails] attr_accessor :inventory_source_details - # Targeting details for inventory source group. This will be - # populated in the details field of an AssignedTargetingOption when - # targeting_type is - # `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`. + # Targeting details for inventory source group. This will be populated in the + # details field of an AssignedTargetingOption when targeting_type is ` + # TARGETING_TYPE_INVENTORY_SOURCE_GROUP`. # Corresponds to the JSON property `inventorySourceGroupDetails` # @return [Google::Apis::DisplayvideoV1::InventorySourceGroupAssignedTargetingOptionDetails] attr_accessor :inventory_source_group_details # Details for assigned keyword targeting option. This will be populated in the - # details field of an AssignedTargetingOption when - # targeting_type is - # `TARGETING_TYPE_KEYWORD`. + # details field of an AssignedTargetingOption when targeting_type is ` + # TARGETING_TYPE_KEYWORD`. # Corresponds to the JSON property `keywordDetails` # @return [Google::Apis::DisplayvideoV1::KeywordAssignedTargetingOptionDetails] attr_accessor :keyword_details # Details for assigned language targeting option. This will be populated in the - # details field of an AssignedTargetingOption when - # targeting_type is - # `TARGETING_TYPE_LANGUAGE`. + # details field of an AssignedTargetingOption when targeting_type is ` + # TARGETING_TYPE_LANGUAGE`. # Corresponds to the JSON property `languageDetails` # @return [Google::Apis::DisplayvideoV1::LanguageAssignedTargetingOptionDetails] attr_accessor :language_details @@ -931,69 +838,57 @@ module Google attr_accessor :name # Targeting details for negative keyword list. This will be populated in the - # details field of an AssignedTargetingOption when - # targeting_type is - # `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. + # details field of an AssignedTargetingOption when targeting_type is ` + # TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. # Corresponds to the JSON property `negativeKeywordListDetails` # @return [Google::Apis::DisplayvideoV1::NegativeKeywordListAssignedTargetingOptionDetails] attr_accessor :negative_keyword_list_details - # On screen position targeting option details. This will be - # populated in the - # on_screen_position_details - # field when - # targeting_type is - # `TARGETING_TYPE_ON_SCREEN_POSITION`. + # On screen position targeting option details. This will be populated in the + # on_screen_position_details field when targeting_type is ` + # TARGETING_TYPE_ON_SCREEN_POSITION`. # Corresponds to the JSON property `onScreenPositionDetails` # @return [Google::Apis::DisplayvideoV1::OnScreenPositionAssignedTargetingOptionDetails] attr_accessor :on_screen_position_details - # Assigned operating system targeting option details. This will be - # populated in the - # operating_system_details - # field when - # targeting_type is - # `TARGETING_TYPE_OPERATING_SYSTEM`. + # Assigned operating system targeting option details. This will be populated in + # the operating_system_details field when targeting_type is ` + # TARGETING_TYPE_OPERATING_SYSTEM`. # Corresponds to the JSON property `operatingSystemDetails` # @return [Google::Apis::DisplayvideoV1::OperatingSystemAssignedTargetingOptionDetails] attr_accessor :operating_system_details - # Details for assigned parental status targeting option. This will be - # populated in the details field of an AssignedTargetingOption when - # targeting_type is - # `TARTGETING_TYPE_PARENTAL_STATUS`. + # Details for assigned parental status targeting option. This will be populated + # in the details field of an AssignedTargetingOption when targeting_type is ` + # TARTGETING_TYPE_PARENTAL_STATUS`. # Corresponds to the JSON property `parentalStatusDetails` # @return [Google::Apis::DisplayvideoV1::ParentalStatusAssignedTargetingOptionDetails] attr_accessor :parental_status_details - # Targeting details for proximity location list. This will be - # populated in the details field of an AssignedTargetingOption when - # targeting_type is - # `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`. + # Targeting details for proximity location list. This will be populated in the + # details field of an AssignedTargetingOption when targeting_type is ` + # TARGETING_TYPE_PROXIMITY_LOCATION_LIST`. # Corresponds to the JSON property `proximityLocationListDetails` # @return [Google::Apis::DisplayvideoV1::ProximityLocationListAssignedTargetingOptionDetails] attr_accessor :proximity_location_list_details - # Targeting details for regional location list. This will be - # populated in the details field of an AssignedTargetingOption when - # targeting_type is - # `TARGETING_TYPE_REGIONAL_LOCATION_LIST`. + # Targeting details for regional location list. This will be populated in the + # details field of an AssignedTargetingOption when targeting_type is ` + # TARGETING_TYPE_REGIONAL_LOCATION_LIST`. # Corresponds to the JSON property `regionalLocationListDetails` # @return [Google::Apis::DisplayvideoV1::RegionalLocationListAssignedTargetingOptionDetails] attr_accessor :regional_location_list_details # Targeting details for sensitive category. This will be populated in the - # details field of an AssignedTargetingOption when - # targeting_type is - # `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. + # details field of an AssignedTargetingOption when targeting_type is ` + # TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Corresponds to the JSON property `sensitiveCategoryExclusionDetails` # @return [Google::Apis::DisplayvideoV1::SensitiveCategoryAssignedTargetingOptionDetails] attr_accessor :sensitive_category_exclusion_details # Details for assigned sub-exchange targeting option. This will be populated in - # the details field of an AssignedTargetingOption when - # targeting_type is - # `TARGETING_TYPE_SUB_EXCHANGE`. + # the details field of an AssignedTargetingOption when targeting_type is ` + # TARGETING_TYPE_SUB_EXCHANGE`. # Corresponds to the JSON property `subExchangeDetails` # @return [Google::Apis::DisplayvideoV1::SubExchangeAssignedTargetingOptionDetails] attr_accessor :sub_exchange_details @@ -1003,46 +898,38 @@ module Google # @return [String] attr_accessor :targeting_type - # Assigned third party verifier targeting option details. This will be - # populated in the details field of an AssignedTargetingOption when - # targeting_type is - # `TARGETING_TYPE_THIRD_PARTY_VERIFIER`. + # Assigned third party verifier targeting option details. This will be populated + # in the details field of an AssignedTargetingOption when targeting_type is ` + # TARGETING_TYPE_THIRD_PARTY_VERIFIER`. # Corresponds to the JSON property `thirdPartyVerifierDetails` # @return [Google::Apis::DisplayvideoV1::ThirdPartyVerifierAssignedTargetingOptionDetails] attr_accessor :third_party_verifier_details # Details for assigned URL targeting option. This will be populated in the - # details field of an AssignedTargetingOption when - # targeting_type is - # `TARGETING_TYPE_URL`. + # details field of an AssignedTargetingOption when targeting_type is ` + # TARGETING_TYPE_URL`. # Corresponds to the JSON property `urlDetails` # @return [Google::Apis::DisplayvideoV1::UrlAssignedTargetingOptionDetails] attr_accessor :url_details - # User rewarded content targeting option details. This will be populated in - # the - # user_rewarded_content_details - # field when - # targeting_type is - # `TARGETING_TYPE_USER_REWARDED_CONTENT`. + # User rewarded content targeting option details. This will be populated in the + # user_rewarded_content_details field when targeting_type is ` + # TARGETING_TYPE_USER_REWARDED_CONTENT`. # Corresponds to the JSON property `userRewardedContentDetails` # @return [Google::Apis::DisplayvideoV1::UserRewardedContentAssignedTargetingOptionDetails] attr_accessor :user_rewarded_content_details # Video player size targeting option details. This will be populated in the - # video_player_size_details - # field when targeting_type is - # `TARGETING_TYPE_VIDEO_PLAYER_SIZE`. - # Explicitly targeting all options is not supported. Remove all video player - # size targeting options to achieve this effect. + # video_player_size_details field when targeting_type is ` + # TARGETING_TYPE_VIDEO_PLAYER_SIZE`. Explicitly targeting all options is not + # supported. Remove all video player size targeting options to achieve this + # effect. # Corresponds to the JSON property `videoPlayerSizeDetails` # @return [Google::Apis::DisplayvideoV1::VideoPlayerSizeAssignedTargetingOptionDetails] attr_accessor :video_player_size_details # Assigned viewability targeting option details. This will be populated in the - # viewability_details field of - # an AssignedTargetingOption when - # targeting_type is + # viewability_details field of an AssignedTargetingOption when targeting_type is # `TARGETING_TYPE_VIEWABILITY`. # Corresponds to the JSON property `viewabilityDetails` # @return [Google::Apis::DisplayvideoV1::ViewabilityAssignedTargetingOptionDetails] @@ -1099,53 +986,50 @@ module Google end # Assigned audience group targeting option details. This will be populated in - # the details field of an AssignedTargetingOption when - # targeting_type is - # `TARGETING_TYPE_AUDIENCE_GROUP`. - # The relation between each group is UNION, except for - # excluded_first_and_third_party_audience_group and + # the details field of an AssignedTargetingOption when targeting_type is ` + # TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, + # except for excluded_first_and_third_party_audience_group and # excluded_google_audience_group, of which COMPLEMENT is UNION'ed with other # groups. class AudienceGroupAssignedTargetingOptionDetails include Google::Apis::Core::Hashable - # Details of first and third party audience group. - # All first and third party audience targeting settings are logically ‘OR’ of - # each other. + # Details of first and third party audience group. All first and third party + # audience targeting settings are logically ‘OR’ of each other. # Corresponds to the JSON property `excludedFirstAndThirdPartyAudienceGroup` # @return [Google::Apis::DisplayvideoV1::FirstAndThirdPartyAudienceGroup] attr_accessor :excluded_first_and_third_party_audience_group - # Details of Google audience group. - # All Google audience targeting settings are logically ‘OR’ of each other. + # Details of Google audience group. All Google audience targeting settings are + # logically ‘OR’ of each other. # Corresponds to the JSON property `excludedGoogleAudienceGroup` # @return [Google::Apis::DisplayvideoV1::GoogleAudienceGroup] attr_accessor :excluded_google_audience_group - # Details of combined audience group. - # All combined audience targeting settings are logically ‘OR’ of each other. + # Details of combined audience group. All combined audience targeting settings + # are logically ‘OR’ of each other. # Corresponds to the JSON property `includedCombinedAudienceGroup` # @return [Google::Apis::DisplayvideoV1::CombinedAudienceGroup] attr_accessor :included_combined_audience_group - # Details of custom list group. - # All custom list targeting settings are logically ‘OR’ of each other. + # Details of custom list group. All custom list targeting settings are logically + # ‘OR’ of each other. # Corresponds to the JSON property `includedCustomListGroup` # @return [Google::Apis::DisplayvideoV1::CustomListGroup] attr_accessor :included_custom_list_group - # The first and third party audience ids and recencies of included first - # and third party audience groups. Each first and third party audience group - # contains first and third party audience ids only. - # The relation between each first and third party audience group is - # INTERSECTION, and the result is UNION'ed with other audience groups. - # Repeated groups with same settings will be ignored. + # The first and third party audience ids and recencies of included first and + # third party audience groups. Each first and third party audience group + # contains first and third party audience ids only. The relation between each + # first and third party audience group is INTERSECTION, and the result is UNION' + # ed with other audience groups. Repeated groups with same settings will be + # ignored. # Corresponds to the JSON property `includedFirstAndThirdPartyAudienceGroups` # @return [Array] attr_accessor :included_first_and_third_party_audience_groups - # Details of Google audience group. - # All Google audience targeting settings are logically ‘OR’ of each other. + # Details of Google audience group. All Google audience targeting settings are + # logically ‘OR’ of each other. # Corresponds to the JSON property `includedGoogleAudienceGroup` # @return [Google::Apis::DisplayvideoV1::GoogleAudienceGroup] attr_accessor :included_google_audience_group @@ -1190,10 +1074,9 @@ module Google end end - # Represents an assigned authorized seller status. This will be populated in - # the details field of an AssignedTargetingOption when - # targeting_type is - # `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. + # Represents an assigned authorized seller status. This will be populated in the + # details field of an AssignedTargetingOption when targeting_type is ` + # TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. class AuthorizedSellerStatusAssignedTargetingOptionDetails include Google::Apis::Core::Hashable @@ -1202,8 +1085,8 @@ module Google # @return [String] attr_accessor :authorized_seller_status - # Required. The targeting_option_id of a - # TargetingOption of type `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. + # Required. The targeting_option_id of a TargetingOption of type ` + # TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. # Corresponds to the JSON property `targetingOptionId` # @return [String] attr_accessor :targeting_option_id @@ -1220,10 +1103,8 @@ module Google end # Represents a targetable authorized seller status. This will be populated in - # the - # authorized_seller_status_details - # field when targeting_type is - # `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. + # the authorized_seller_status_details field when targeting_type is ` + # TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. class AuthorizedSellerStatusTargetingOptionDetails include Google::Apis::Core::Hashable @@ -1242,8 +1123,7 @@ module Google end end - # Settings that control the bid strategy. - # Bid strategy determines the bid price. + # Settings that control the bid strategy. Bid strategy determines the bid price. class BiddingStrategy include Google::Apis::Core::Hashable @@ -1276,10 +1156,9 @@ module Google end end - # Details for assigned browser targeting option. This will be populated in - # the details field of an AssignedTargetingOption when - # targeting_type is - # `TARGETING_TYPE_BROWSER`. + # Details for assigned browser targeting option. This will be populated in the + # details field of an AssignedTargetingOption when targeting_type is ` + # TARGETING_TYPE_BROWSER`. class BrowserAssignedTargetingOptionDetails include Google::Apis::Core::Hashable @@ -1296,8 +1175,8 @@ module Google attr_accessor :negative alias_method :negative?, :negative - # Required. The targeting_option_id of a - # TargetingOption of type `TARGETING_TYPE_BROWSER`. + # Required. The targeting_option_id of a TargetingOption of type ` + # TARGETING_TYPE_BROWSER`. # Corresponds to the JSON property `targetingOptionId` # @return [String] attr_accessor :targeting_option_id @@ -1314,10 +1193,8 @@ module Google end end - # Represents a targetable browser. This will be populated in the - # browser_details field when - # targeting_type is - # `TARGETING_TYPE_BROWSER`. + # Represents a targetable browser. This will be populated in the browser_details + # field when targeting_type is `TARGETING_TYPE_BROWSER`. class BrowserTargetingOptionDetails include Google::Apis::Core::Hashable @@ -1336,19 +1213,18 @@ module Google end end - # Request message for - # BulkEditAdvertiserAssignedTargetingOptions. + # Request message for BulkEditAdvertiserAssignedTargetingOptions. class BulkEditAdvertiserAssignedTargetingOptionsRequest include Google::Apis::Core::Hashable - # The assigned targeting options to create in batch, specified as a list of - # `CreateAssignedTargetingOptionsRequest`. + # The assigned targeting options to create in batch, specified as a list of ` + # CreateAssignedTargetingOptionsRequest`. # Corresponds to the JSON property `createRequests` # @return [Array] attr_accessor :create_requests - # The assigned targeting options to delete in batch, specified as a list of - # `DeleteAssignedTargetingOptionsRequest`. + # The assigned targeting options to delete in batch, specified as a list of ` + # DeleteAssignedTargetingOptionsRequest`. # Corresponds to the JSON property `deleteRequests` # @return [Array] attr_accessor :delete_requests @@ -1388,9 +1264,8 @@ module Google class BulkEditAssignedInventorySourcesRequest include Google::Apis::Core::Hashable - # The ID of the advertiser that owns the parent inventory source group. - # The parent partner does not have access to these assigned inventory - # sources. + # The ID of the advertiser that owns the parent inventory source group. The + # parent partner does not have access to these assigned inventory sources. # Corresponds to the JSON property `advertiserId` # @return [Fixnum] attr_accessor :advertiser_id @@ -1402,14 +1277,13 @@ module Google attr_accessor :created_assigned_inventory_sources # The IDs of the assigned inventory sources to delete in bulk, specified as a - # list of - # assigned_inventory_source_ids. + # list of assigned_inventory_source_ids. # Corresponds to the JSON property `deletedAssignedInventorySources` # @return [Array] attr_accessor :deleted_assigned_inventory_sources - # The ID of the partner that owns the inventory source group. - # Only this partner has write access to these assigned inventory sources. + # The ID of the partner that owns the inventory source group. Only this partner + # has write access to these assigned inventory sources. # Corresponds to the JSON property `partnerId` # @return [Fixnum] attr_accessor :partner_id @@ -1478,8 +1352,8 @@ module Google class BulkEditAssignedLocationsResponse include Google::Apis::Core::Hashable - # The list of assigned locations that have been successfully created. - # This list will be absent if empty. + # The list of assigned locations that have been successfully created. This list + # will be absent if empty. # Corresponds to the JSON property `assignedLocations` # @return [Array] attr_accessor :assigned_locations @@ -1494,19 +1368,18 @@ module Google end end - # Request message for - # BulkEditLineItemAssignedTargetingOptions. + # Request message for BulkEditLineItemAssignedTargetingOptions. class BulkEditLineItemAssignedTargetingOptionsRequest include Google::Apis::Core::Hashable - # The assigned targeting options to create in batch, specified as a list of - # `CreateAssignedTargetingOptionsRequest`. + # The assigned targeting options to create in batch, specified as a list of ` + # CreateAssignedTargetingOptionsRequest`. # Corresponds to the JSON property `createRequests` # @return [Array] attr_accessor :create_requests - # The assigned targeting options to delete in batch, specified as a list of - # `DeleteAssignedTargetingOptionsRequest`. + # The assigned targeting options to delete in batch, specified as a list of ` + # DeleteAssignedTargetingOptionsRequest`. # Corresponds to the JSON property `deleteRequests` # @return [Array] attr_accessor :delete_requests @@ -1573,8 +1446,8 @@ module Google class BulkEditNegativeKeywordsResponse include Google::Apis::Core::Hashable - # The list of negative keywords that have been successfully created. - # This list will be absent if empty. + # The list of negative keywords that have been successfully created. This list + # will be absent if empty. # Corresponds to the JSON property `negativeKeywords` # @return [Array] attr_accessor :negative_keywords @@ -1603,8 +1476,7 @@ module Google # @return [Array] attr_accessor :created_sites - # The sites to delete in batch, specified as a list of site - # url_or_app_ids. + # The sites to delete in batch, specified as a list of site url_or_app_ids. # Corresponds to the JSON property `deletedSites` # @return [Array] attr_accessor :deleted_sites @@ -1631,8 +1503,8 @@ module Google class BulkEditSitesResponse include Google::Apis::Core::Hashable - # The list of sites that have been successfully created. - # This list will be absent if empty. + # The list of sites that have been successfully created. This list will be + # absent if empty. # Corresponds to the JSON property `sites` # @return [Array] attr_accessor :sites @@ -1651,20 +1523,16 @@ module Google class BulkListAdvertiserAssignedTargetingOptionsResponse include Google::Apis::Core::Hashable - # The list of assigned targeting options. - # This list will be absent if empty. + # The list of assigned targeting options. This list will be absent if empty. # Corresponds to the JSON property `assignedTargetingOptions` # @return [Array] attr_accessor :assigned_targeting_options - # A token identifying the next page of results. This value should be - # specified as the - # pageToken - # in a subsequent BulkListAdvertiserAssignedTargetingOptionsRequest to - # fetch the next page of results. This token will be absent if there are no - # more - # assigned_targeting_options - # to return. + # A token identifying the next page of results. This value should be specified + # as the pageToken in a subsequent + # BulkListAdvertiserAssignedTargetingOptionsRequest to fetch the next page of + # results. This token will be absent if there are no more + # assigned_targeting_options to return. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -1684,19 +1552,16 @@ module Google class BulkListLineItemAssignedTargetingOptionsResponse include Google::Apis::Core::Hashable - # The list of assigned targeting options. - # This list will be absent if empty. + # The list of assigned targeting options. This list will be absent if empty. # Corresponds to the JSON property `assignedTargetingOptions` # @return [Array] attr_accessor :assigned_targeting_options - # A token identifying the next page of results. This value should be - # specified as the - # pageToken in - # a subsequent BulkListLineItemAssignedTargetingOptionsRequest to fetch - # the next page of results. This token will be absent if there are no more - # assigned_targeting_options - # to return. + # A token identifying the next page of results. This value should be specified + # as the pageToken in a subsequent + # BulkListLineItemAssignedTargetingOptionsRequest to fetch the next page of + # results. This token will be absent if there are no more + # assigned_targeting_options to return. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -1736,25 +1601,22 @@ module Google # @return [Fixnum] attr_accessor :campaign_id - # Required. The display name of the campaign. - # Must be UTF-8 encoded with a maximum size of 240 bytes. + # Required. The display name of the campaign. Must be UTF-8 encoded with a + # maximum size of 240 bytes. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name - # Required. Controls whether or not the insertion orders under this campaign - # can spend their budgets and bid on inventory. - # * Accepted values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_ARCHIVED`, and - # `ENTITY_STATUS_PAUSED`. - # * For - # CreateCampaign method, - # `ENTITY_STATUS_ARCHIVED` is not allowed. + # Required. Controls whether or not the insertion orders under this campaign can + # spend their budgets and bid on inventory. * Accepted values are ` + # ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_ARCHIVED`, and `ENTITY_STATUS_PAUSED`. * + # For CreateCampaign method, `ENTITY_STATUS_ARCHIVED` is not allowed. # Corresponds to the JSON property `entityStatus` # @return [String] attr_accessor :entity_status - # Settings that control the number of times a user may be shown with the same - # ad during a given time period. + # Settings that control the number of times a user may be shown with the same ad + # during a given time period. # Corresponds to the JSON property `frequencyCap` # @return [Google::Apis::DisplayvideoV1::FrequencyCap] attr_accessor :frequency_cap @@ -1797,9 +1659,8 @@ module Google # @return [Google::Apis::DisplayvideoV1::DateRange] attr_accessor :planned_dates - # The amount the campaign is expected to spend for its given - # planned_dates. This will not limit serving, - # but will be used for tracking spend in the DV360 UI. + # The amount the campaign is expected to spend for its given planned_dates. This + # will not limit serving, but will be used for tracking spend in the DV360 UI. # The amount is in micros. Must be greater than or equal to 0. For example, # 500000000 represents 500 standard units of the currency. # Corresponds to the JSON property `plannedSpendAmountMicros` @@ -1843,9 +1704,8 @@ module Google end # Details for assigned carrier and ISP targeting option. This will be populated - # in the details field of an AssignedTargetingOption when - # targeting_type is - # `TARGETING_TYPE_CARRIER_AND_ISP`. + # in the details field of an AssignedTargetingOption when targeting_type is ` + # TARGETING_TYPE_CARRIER_AND_ISP`. class CarrierAndIspAssignedTargetingOptionDetails include Google::Apis::Core::Hashable @@ -1855,15 +1715,15 @@ module Google attr_accessor :display_name # Indicates if this option is being negatively targeted. All assigned carrier - # and ISP targeting options on the same line item must have the same value - # for this field. + # and ISP targeting options on the same line item must have the same value for + # this field. # Corresponds to the JSON property `negative` # @return [Boolean] attr_accessor :negative alias_method :negative?, :negative - # Required. The targeting_option_id of a - # TargetingOption of type `TARGETING_TYPE_CARRIER_AND_ISP`. + # Required. The targeting_option_id of a TargetingOption of type ` + # TARGETING_TYPE_CARRIER_AND_ISP`. # Corresponds to the JSON property `targetingOptionId` # @return [String] attr_accessor :targeting_option_id @@ -1881,10 +1741,8 @@ module Google end # Represents a targetable carrier or ISP. This will be populated in the - # carrier_and_isp_details field of - # a TargetingOption when - # targeting_type is - # `TARGETING_TYPE_CARRIER_AND_ISP`. + # carrier_and_isp_details field of a TargetingOption when targeting_type is ` + # TARGETING_TYPE_CARRIER_AND_ISP`. class CarrierAndIspTargetingOptionDetails include Google::Apis::Core::Hashable @@ -1910,9 +1768,7 @@ module Google end # Assigned category targeting option details. This will be populated in the - # category_details field when - # targeting_type is - # `TARGETING_TYPE_CATEGORY`. + # category_details field when targeting_type is `TARGETING_TYPE_CATEGORY`. class CategoryAssignedTargetingOptionDetails include Google::Apis::Core::Hashable @@ -1927,9 +1783,8 @@ module Google attr_accessor :negative alias_method :negative?, :negative - # Required. The targeting_option_id field when - # targeting_type is - # `TARGETING_TYPE_CATEGORY`. + # Required. The targeting_option_id field when targeting_type is ` + # TARGETING_TYPE_CATEGORY`. # Corresponds to the JSON property `targetingOptionId` # @return [String] attr_accessor :targeting_option_id @@ -1947,9 +1802,8 @@ module Google end # Represents a targetable category. This will be populated in the - # category_details field of a - # TargetingOption when targeting_type is - # `TARGETING_TYPE_CATEGORY`. + # category_details field of a TargetingOption when targeting_type is ` + # TARGETING_TYPE_CATEGORY`. class CategoryTargetingOptionDetails include Google::Apis::Core::Hashable @@ -1982,8 +1836,8 @@ module Google # @return [Fixnum] attr_accessor :channel_id - # Required. The display name of the channel. - # Must be UTF-8 encoded with a maximum length of 240 bytes. + # Required. The display name of the channel. Must be UTF-8 encoded with a + # maximum length of 240 bytes. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name @@ -2012,24 +1866,22 @@ module Google end end - # Details for assigned channel targeting option. This will be populated in - # the details field of an AssignedTargetingOption when - # targeting_type is - # `TARGETING_TYPE_CHANNEL`. + # Details for assigned channel targeting option. This will be populated in the + # details field of an AssignedTargetingOption when targeting_type is ` + # TARGETING_TYPE_CHANNEL`. class ChannelAssignedTargetingOptionDetails include Google::Apis::Core::Hashable - # Required. ID of the channel. Should refer to the channel ID - # field on a - # [Partner-owned channel](partners.channels#Channel.FIELDS.channel_id) or - # [advertiser-owned channel](advertisers.channels#Channel.FIELDS.channel_id) + # Required. ID of the channel. Should refer to the channel ID field on a [ + # Partner-owned channel](partners.channels#Channel.FIELDS.channel_id) or [ + # advertiser-owned channel](advertisers.channels#Channel.FIELDS.channel_id) # resource. # Corresponds to the JSON property `channelId` # @return [Fixnum] attr_accessor :channel_id - # Indicates if this option is being negatively targeted. For advertiser - # level assigned targeting option, this field must be true. + # Indicates if this option is being negatively targeted. For advertiser level + # assigned targeting option, this field must be true. # Corresponds to the JSON property `negative` # @return [Boolean] attr_accessor :negative @@ -2052,8 +1904,7 @@ module Google include Google::Apis::Core::Hashable # Required. Immutable. Account ID of the CM Floodlight configuration linked with - # the DV360 - # advertiser. + # the DV360 advertiser. # Corresponds to the JSON property `cmAccountId` # @return [Fixnum] attr_accessor :cm_account_id @@ -2065,20 +1916,17 @@ module Google attr_accessor :cm_floodlight_config_id # Required. Immutable. By setting this field to `true`, you, on behalf of your - # company, - # authorize the sharing of information from the given Floodlight + # company, authorize the sharing of information from the given Floodlight # configuration to this Display & Video 360 advertiser. # Corresponds to the JSON property `cmFloodlightLinkingAuthorized` # @return [Boolean] attr_accessor :cm_floodlight_linking_authorized alias_method :cm_floodlight_linking_authorized?, :cm_floodlight_linking_authorized - # A list of CM sites whose placements will be synced to DV360 as creatives. - # If absent or empty in - # CreateAdvertiser method, the system - # will automatically create a CM site. - # Removing sites from this list may cause DV360 creatives synced from CM to - # be deleted. At least one site must be specified. + # A list of CM sites whose placements will be synced to DV360 as creatives. If + # absent or empty in CreateAdvertiser method, the system will automatically + # create a CM site. Removing sites from this list may cause DV360 creatives + # synced from CM to be deleted. At least one site must be specified. # Corresponds to the JSON property `cmSyncableSiteIds` # @return [Array] attr_accessor :cm_syncable_site_ids @@ -2150,8 +1998,7 @@ module Google # @return [Fixnum] attr_accessor :combined_audience_id - # Output only. The display name of the combined audience. - # . + # Output only. The display name of the combined audience. . # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name @@ -2173,15 +2020,14 @@ module Google end end - # Details of combined audience group. - # All combined audience targeting settings are logically ‘OR’ of each other. + # Details of combined audience group. All combined audience targeting settings + # are logically ‘OR’ of each other. class CombinedAudienceGroup include Google::Apis::Core::Hashable # Required. All combined audience targeting settings in combined audience group. - # Repeated settings with same id will be ignored. - # The number of combined audience settings should be no more than five, error - # will be thrown otherwise. + # Repeated settings with same id will be ignored. The number of combined + # audience settings should be no more than five, error will be thrown otherwise. # Corresponds to the JSON property `settings` # @return [Array] attr_accessor :settings @@ -2200,8 +2046,8 @@ module Google class CombinedAudienceTargetingSetting include Google::Apis::Core::Hashable - # Required. Combined audience id of combined audience targeting setting. - # This id is combined_audience_id. + # Required. Combined audience id of combined audience targeting setting. This id + # is combined_audience_id. # Corresponds to the JSON property `combinedAudienceId` # @return [Fixnum] attr_accessor :combined_audience_id @@ -2217,11 +2063,8 @@ module Google end # Assigned content instream position targeting option details. This will be - # populated in the - # content_instream_position_details - # field when - # targeting_type is - # `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`. + # populated in the content_instream_position_details field when targeting_type + # is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`. class ContentInstreamPositionAssignedTargetingOptionDetails include Google::Apis::Core::Hashable @@ -2230,9 +2073,8 @@ module Google # @return [String] attr_accessor :content_instream_position - # Required. The targeting_option_id field when - # targeting_type is - # `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`. + # Required. The targeting_option_id field when targeting_type is ` + # TARGETING_TYPE_CONTENT_INSTREAM_POSITION`. # Corresponds to the JSON property `targetingOptionId` # @return [String] attr_accessor :targeting_option_id @@ -2250,9 +2092,8 @@ module Google # Represents a targetable content instream position, which could be used by # video and audio ads. This will be populated in the - # content_instream_position_details - # field when targeting_type is - # `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`. + # content_instream_position_details field when targeting_type is ` + # TARGETING_TYPE_CONTENT_INSTREAM_POSITION`. class ContentInstreamPositionTargetingOptionDetails include Google::Apis::Core::Hashable @@ -2272,11 +2113,8 @@ module Google end # Assigned content outstream position targeting option details. This will be - # populated in the - # content_outstream_position_details - # field when - # targeting_type is - # `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`. + # populated in the content_outstream_position_details field when targeting_type + # is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`. class ContentOutstreamPositionAssignedTargetingOptionDetails include Google::Apis::Core::Hashable @@ -2285,9 +2123,8 @@ module Google # @return [String] attr_accessor :content_outstream_position - # Required. The targeting_option_id field when - # targeting_type is - # `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`. + # Required. The targeting_option_id field when targeting_type is ` + # TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`. # Corresponds to the JSON property `targetingOptionId` # @return [String] attr_accessor :targeting_option_id @@ -2305,9 +2142,8 @@ module Google # Represents a targetable content outstream position, which could be used by # display and video ads. This will be populated in the - # content_outstream_position_details - # field when targeting_type is - # `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`. + # content_outstream_position_details field when targeting_type is ` + # TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`. class ContentOutstreamPositionTargetingOptionDetails include Google::Apis::Core::Hashable @@ -2326,23 +2162,22 @@ module Google end end - # Settings that control how conversions are counted. - # All post-click conversions will be counted. A percentage value can be set - # for post-view conversions counting. + # Settings that control how conversions are counted. All post-click conversions + # will be counted. A percentage value can be set for post-view conversions + # counting. class ConversionCountingConfig include Google::Apis::Core::Hashable - # The Floodlight activity configs used to track conversions. - # The number of conversions counted is the sum of all of the conversions - # counted by all of the Floodlight activity IDs specified in this field. + # The Floodlight activity configs used to track conversions. The number of + # conversions counted is the sum of all of the conversions counted by all of the + # Floodlight activity IDs specified in this field. # Corresponds to the JSON property `floodlightActivityConfigs` # @return [Array] attr_accessor :floodlight_activity_configs # The percentage of post-view conversions to count, in millis (1/1000 of a - # percent). Must be between 0 and 100000 inclusive. - # For example, to track 50% of the post-click conversions, set a value of - # 50000. + # percent). Must be between 0 and 100000 inclusive. For example, to track 50% of + # the post-click conversions, set a value of 50000. # Corresponds to the JSON property `postViewCountPercentageMillis` # @return [Fixnum] attr_accessor :post_view_count_percentage_millis @@ -2387,8 +2222,8 @@ module Google class CreateAssetRequest include Google::Apis::Core::Hashable - # Required. The filename of the asset, including the file extension. - # The filename must be UTF-8 encoded with a maximum size of 240 bytes. + # Required. The filename of the asset, including the file extension. The + # filename must be UTF-8 encoded with a maximum size of 240 bytes. # Corresponds to the JSON property `filename` # @return [String] attr_accessor :filename @@ -2478,10 +2313,10 @@ module Google # @return [Fixnum] attr_accessor :partner_id - # Required. The SDF version of the downloaded file. If set to - # `SDF_VERSION_UNSPECIFIED`, this will default to the version specified by - # the advertiser or partner identified by `root_id`. An advertiser inherits - # its SDF version from its partner unless configured otherwise. + # Required. The SDF version of the downloaded file. If set to ` + # SDF_VERSION_UNSPECIFIED`, this will default to the version specified by the + # advertiser or partner identified by `root_id`. An advertiser inherits its SDF + # version from its partner unless configured otherwise. # Corresponds to the JSON property `version` # @return [String] attr_accessor :version @@ -2505,20 +2340,13 @@ module Google class Creative include Google::Apis::Core::Hashable - # Additional dimensions. - # Applicable when creative_type is one of: - # * `CREATIVE_TYPE_STANDARD` - # * `CREATIVE_TYPE_EXPANDABLE` - # * `CREATIVE_TYPE_NATIVE` - # * `CREATIVE_TYPE_TEMPLATED_APP_INSTALL` - # * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` - # * `CREATIVE_TYPE_LIGHTBOX` - # * `CREATIVE_TYPE_NATIVE_APP_INSTALL` - # * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE` - # * `CREATIVE_TYPE_PUBLISHER_HOSTED` - # If this field is specified, width_pixels and - # height_pixels are both required and must be - # greater than or equal to 0. + # Additional dimensions. Applicable when creative_type is one of: * ` + # CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` * `CREATIVE_TYPE_NATIVE` * + # `CREATIVE_TYPE_TEMPLATED_APP_INSTALL` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * ` + # CREATIVE_TYPE_LIGHTBOX` * `CREATIVE_TYPE_NATIVE_APP_INSTALL` * ` + # CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE` * `CREATIVE_TYPE_PUBLISHER_HOSTED` If + # this field is specified, width_pixels and height_pixels are both required and + # must be greater than or equal to 0. # Corresponds to the JSON property `additionalDimensions` # @return [Array] attr_accessor :additional_dimensions @@ -2533,21 +2361,16 @@ module Google # @return [String] attr_accessor :appended_tag - # Required. Assets associated to this creative. - # Assets can be associated to the creative in one of following roles: - # * `ASSET_ROLE_UNSPECIFIED` - # * `ASSET_ROLE_MAIN` - # * `ASSET_ROLE_BACKUP` - # * `ASSET_ROLE_POLITE_LOAD` + # Required. Assets associated to this creative. Assets can be associated to the + # creative in one of following roles: * `ASSET_ROLE_UNSPECIFIED` * ` + # ASSET_ROLE_MAIN` * `ASSET_ROLE_BACKUP` * `ASSET_ROLE_POLITE_LOAD` # Corresponds to the JSON property `assets` # @return [Array] attr_accessor :assets # Output only. The unique ID of the Campaign Manager placement associated with - # the - # creative. - # This field is only applicable for creatives that are synced from Campaign - # Manager. + # the creative. This field is only applicable for creatives that are synced from + # Campaign Manager. # Corresponds to the JSON property `cmPlacementId` # @return [Fixnum] attr_accessor :cm_placement_id @@ -2557,34 +2380,28 @@ module Google # @return [Google::Apis::DisplayvideoV1::CmTrackingAd] attr_accessor :cm_tracking_ad - # The IDs of companion creatives for a video creative. - # You can assign existing display creatives (with image or HTML5 assets) - # to serve surrounding the publisher's video player. Companions display - # around the video player while the video is playing and remain after the - # video has completed. - # Creatives contain additional dimensions - # can not be companion creatives. - # This field is only supported for following - # creative_type: - # * `CREATIVE_TYPE_AUDIO` - # * `CREATIVE_TYPE_VIDEO` + # The IDs of companion creatives for a video creative. You can assign existing + # display creatives (with image or HTML5 assets) to serve surrounding the + # publisher's video player. Companions display around the video player while the + # video is playing and remain after the video has completed. Creatives contain + # additional dimensions can not be companion creatives. This field is only + # supported for following creative_type: * `CREATIVE_TYPE_AUDIO` * ` + # CREATIVE_TYPE_VIDEO` # Corresponds to the JSON property `companionCreativeIds` # @return [Array] attr_accessor :companion_creative_ids - # Counter events for a rich media creative. - # Counters track the number of times that a user interacts with any part of a - # rich media creative in a specified way (mouse-overs, mouse-outs, clicks, - # taps, data loading, keyboard entries, etc.). - # Any event that can be captured in the creative can be recorded as a - # counter. - # Leave it empty or unset for creatives containing image assets only. + # Counter events for a rich media creative. Counters track the number of times + # that a user interacts with any part of a rich media creative in a specified + # way (mouse-overs, mouse-outs, clicks, taps, data loading, keyboard entries, + # etc.). Any event that can be captured in the creative can be recorded as a + # counter. Leave it empty or unset for creatives containing image assets only. # Corresponds to the JSON property `counterEvents` # @return [Array] attr_accessor :counter_events - # Output only. The timestamp when the creative was created. Assigned by - # the system. + # Output only. The timestamp when the creative was created. Assigned by the + # system. # Corresponds to the JSON property `createTime` # @return [String] attr_accessor :create_time @@ -2610,8 +2427,8 @@ module Google # @return [Google::Apis::DisplayvideoV1::Dimensions] attr_accessor :dimensions - # Required. The display name of the creative. - # Must be UTF-8 encoded with a maximum size of 240 bytes. + # Required. The display name of the creative. Must be UTF-8 encoded with a + # maximum size of 240 bytes. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name @@ -2622,46 +2439,36 @@ module Google attr_accessor :dynamic alias_method :dynamic?, :dynamic - # Required. Controls whether or not the creative can serve. - # Accepted values are: - # * `ENTITY_STATUS_ACTIVE` - # * `ENTITY_STATUS_ARCHIVED` - # * `ENTITY_STATUS_PAUSED` + # Required. Controls whether or not the creative can serve. Accepted values are: + # * `ENTITY_STATUS_ACTIVE` * `ENTITY_STATUS_ARCHIVED` * `ENTITY_STATUS_PAUSED` # Corresponds to the JSON property `entityStatus` # @return [String] attr_accessor :entity_status - # Required. Exit events for this creative. - # An exit (also known as a click tag) is any area in your creative that - # someone can click or tap to open an advertiser's landing page. - # Every creative must include at least one exit. - # You can add an exit to your creative in any of the following ways: - # * Use Google Web Designer's tap area. - # * Define a JavaScript variable called "clickTag". - # * Use the Enabler (Enabler.exit()) to track exits in rich media formats. + # Required. Exit events for this creative. An exit (also known as a click tag) + # is any area in your creative that someone can click or tap to open an + # advertiser's landing page. Every creative must include at least one exit. You + # can add an exit to your creative in any of the following ways: * Use Google + # Web Designer's tap area. * Define a JavaScript variable called "clickTag". * + # Use the Enabler (Enabler.exit()) to track exits in rich media formats. # Corresponds to the JSON property `exitEvents` # @return [Array] attr_accessor :exit_events - # Optional. Indicates the creative will automatically expand on hover. - # Optional and only valid for third-party expandable creatives. - # Third-party expandable creatives are creatives with following hosting - # source: - # * `HOSTING_SOURCE_THIRD_PARTY` - # combined with following creative_type: - # * `CREATIVE_TYPE_EXPANDABLE` + # Optional. Indicates the creative will automatically expand on hover. Optional + # and only valid for third-party expandable creatives. Third-party expandable + # creatives are creatives with following hosting source: * ` + # HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * ` + # CREATIVE_TYPE_EXPANDABLE` # Corresponds to the JSON property `expandOnHover` # @return [Boolean] attr_accessor :expand_on_hover alias_method :expand_on_hover?, :expand_on_hover - # Optional. Specifies the expanding direction of the creative. - # Required and only valid for third-party expandable creatives. - # Third-party expandable creatives are creatives with following hosting - # source: - # * `HOSTING_SOURCE_THIRD_PARTY` - # combined with following creative_type: - # * `CREATIVE_TYPE_EXPANDABLE` + # Optional. Specifies the expanding direction of the creative. Required and only + # valid for third-party expandable creatives. Third-party expandable creatives + # are creatives with following hosting source: * `HOSTING_SOURCE_THIRD_PARTY` + # combined with following creative_type: * `CREATIVE_TYPE_EXPANDABLE` # Corresponds to the JSON property `expandingDirection` # @return [String] attr_accessor :expanding_direction @@ -2672,61 +2479,47 @@ module Google attr_accessor :hosting_source # Output only. Indicates the third-party VAST tag creative requires HTML5 Video - # support. - # Output only and only valid for third-party VAST tag creatives. - # Third-party VAST tag creatives are creatives with following - # hosting_source: - # * `HOSTING_SOURCE_THIRD_PARTY` - # combined with following creative_type: - # * `CREATIVE_TYPE_VIDEO` + # support. Output only and only valid for third-party VAST tag creatives. Third- + # party VAST tag creatives are creatives with following hosting_source: * ` + # HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * ` + # CREATIVE_TYPE_VIDEO` # Corresponds to the JSON property `html5Video` # @return [Boolean] attr_accessor :html5_video alias_method :html5_video?, :html5_video - # Indicates whether Integral Ad Science (IAS) campaign monitoring is enabled. - # To enable this for the creative, make sure the - # Advertiser.creative_config.ias_client_id - # has been set to your IAS client ID. + # Indicates whether Integral Ad Science (IAS) campaign monitoring is enabled. To + # enable this for the creative, make sure the Advertiser.creative_config. + # ias_client_id has been set to your IAS client ID. # Corresponds to the JSON property `iasCampaignMonitoring` # @return [Boolean] attr_accessor :ias_campaign_monitoring alias_method :ias_campaign_monitoring?, :ias_campaign_monitoring - # ID information used to link this creative to an external system. - # Must be UTF-8 encoded with a length of no more than 10,000 characters. + # ID information used to link this creative to an external system. Must be UTF-8 + # encoded with a length of no more than 10,000 characters. # Corresponds to the JSON property `integrationCode` # @return [String] attr_accessor :integration_code - # JavaScript measurement URL from supported third-party verification - # providers (ComScore, DoubleVerify, IAS, Moat). HTML script tags are not - # supported. - # This field is only supported in following - # creative_type: - # * `CREATIVE_TYPE_NATIVE` - # * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` - # * `CREATIVE_TYPE_NATIVE_APP_INSTALL` - # * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE` - # * `CREATIVE_TYPE_NATIVE_VIDEO` + # JavaScript measurement URL from supported third-party verification providers ( + # ComScore, DoubleVerify, IAS, Moat). HTML script tags are not supported. This + # field is only supported in following creative_type: * `CREATIVE_TYPE_NATIVE` * + # `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_APP_INSTALL` * ` + # CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO` # Corresponds to the JSON property `jsTrackerUrl` # @return [String] attr_accessor :js_tracker_url - # Output only. The IDs of the line items this creative is associated with. - # To associate a creative to a line item, use - # LineItem.creative_ids instead. + # Output only. The IDs of the line items this creative is associated with. To + # associate a creative to a line item, use LineItem.creative_ids instead. # Corresponds to the JSON property `lineItemIds` # @return [Array] attr_accessor :line_item_ids - # Output only. Media duration of the creative. - # Applicable when creative_type - # is one of: - # * `CREATIVE_TYPE_VIDEO` - # * `CREATIVE_TYPE_AUDIO` - # * `CREATIVE_TYPE_NATIVE_VIDEO` - # * `CREATIVE_TYPE_PUBLISHER_HOSTED` + # Output only. Media duration of the creative. Applicable when creative_type is + # one of: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_AUDIO` * ` + # CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_PUBLISHER_HOSTED` # Corresponds to the JSON property `mediaDuration` # @return [String] attr_accessor :media_duration @@ -2736,8 +2529,8 @@ module Google # @return [String] attr_accessor :name - # User notes for this creative. - # Must be UTF-8 encoded with a length of no more than 20,000 characters. + # User notes for this creative. Must be UTF-8 encoded with a length of no more + # than 20,000 characters. # Corresponds to the JSON property `notes` # @return [String] attr_accessor :notes @@ -2753,52 +2546,37 @@ module Google attr_accessor :progress_offset # Optional. Indicates that the creative relies on HTML5 to render properly. - # Optional and only valid for third-party tag creatives. - # Third-party tag creatives are creatives with following - # hosting_source: - # * `HOSTING_SOURCE_THIRD_PARTY` - # combined with following creative_type: - # * `CREATIVE_TYPE_STANDARD` - # * `CREATIVE_TYPE_EXPANDABLE` + # Optional and only valid for third-party tag creatives. Third-party tag + # creatives are creatives with following hosting_source: * ` + # HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * ` + # CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` # Corresponds to the JSON property `requireHtml5` # @return [Boolean] attr_accessor :require_html5 alias_method :require_html5?, :require_html5 # Optional. Indicates that the creative requires MRAID (Mobile Rich Media Ad - # Interface - # Definitions system). - # Set this if the creative relies on mobile gestures for interactivity, such - # as swiping or tapping. - # Optional and only valid for third-party tag creatives. - # Third-party tag creatives are creatives with following - # hosting_source: - # * `HOSTING_SOURCE_THIRD_PARTY` - # combined with following creative_type: - # * `CREATIVE_TYPE_STANDARD` - # * `CREATIVE_TYPE_EXPANDABLE` + # Interface Definitions system). Set this if the creative relies on mobile + # gestures for interactivity, such as swiping or tapping. Optional and only + # valid for third-party tag creatives. Third-party tag creatives are creatives + # with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with + # following creative_type: * `CREATIVE_TYPE_STANDARD` * ` + # CREATIVE_TYPE_EXPANDABLE` # Corresponds to the JSON property `requireMraid` # @return [Boolean] attr_accessor :require_mraid alias_method :require_mraid?, :require_mraid # Optional. Indicates that the creative will wait for a return ping for - # attribution. - # Only valid when using a Campaign Manager tracking ad with a third-party ad - # server parameter and the $`DC_DBM_TOKEN` macro. - # Optional and only valid for third-party tag creatives or third-party VAST - # tag creatives. - # Third-party tag creatives are creatives with following - # hosting_source: - # * `HOSTING_SOURCE_THIRD_PARTY` - # combined with following creative_type: - # * `CREATIVE_TYPE_STANDARD` - # * `CREATIVE_TYPE_EXPANDABLE` - # Third-party VAST tag creatives are creatives with following - # hosting_source: - # * `HOSTING_SOURCE_THIRD_PARTY` - # combined with following creative_type: - # * `CREATIVE_TYPE_VIDEO` + # attribution. Only valid when using a Campaign Manager tracking ad with a third- + # party ad server parameter and the $`DC_DBM_TOKEN` macro. Optional and only + # valid for third-party tag creatives or third-party VAST tag creatives. Third- + # party tag creatives are creatives with following hosting_source: * ` + # HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * ` + # CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` Third-party VAST tag + # creatives are creatives with following hosting_source: * ` + # HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * ` + # CREATIVE_TYPE_VIDEO` # Corresponds to the JSON property `requirePingForAttribution` # @return [Boolean] attr_accessor :require_ping_for_attribution @@ -2814,77 +2592,57 @@ module Google # @return [Google::Apis::DisplayvideoV1::AudioVideoOffset] attr_accessor :skip_offset - # Whether the user can choose to skip a video creative. - # This field is only supported for the following - # creative_type: - # * `CREATIVE_TYPE_VIDEO` + # Whether the user can choose to skip a video creative. This field is only + # supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` # Corresponds to the JSON property `skippable` # @return [Boolean] attr_accessor :skippable alias_method :skippable?, :skippable - # Optional. The original third-party tag used for the creative. - # Required and only valid for third-party tag creatives. - # Third-party tag creatives are creatives with following - # hosting_source: - # * `HOSTING_SOURCE_THIRD_PARTY` - # combined with following creative_type: - # * `CREATIVE_TYPE_STANDARD` - # * `CREATIVE_TYPE_EXPANDABLE` + # Optional. The original third-party tag used for the creative. Required and + # only valid for third-party tag creatives. Third-party tag creatives are + # creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` + # combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * ` + # CREATIVE_TYPE_EXPANDABLE` # Corresponds to the JSON property `thirdPartyTag` # @return [String] attr_accessor :third_party_tag - # Tracking URLs from third parties to track interactions with a video - # creative. - # This field is only supported for the following - # creative_type: - # * `CREATIVE_TYPE_AUDIO` - # * `CREATIVE_TYPE_VIDEO` - # * `CREATIVE_TYPE_NATIVE_VIDEO` + # Tracking URLs from third parties to track interactions with a video creative. + # This field is only supported for the following creative_type: * ` + # CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` # Corresponds to the JSON property `thirdPartyUrls` # @return [Array] attr_accessor :third_party_urls - # Timer custom events for a rich media creative. - # Timers track the time during which a user views and interacts with a - # specified part of a rich media creative. - # A creative can have multiple timer events, each timed independently. + # Timer custom events for a rich media creative. Timers track the time during + # which a user views and interacts with a specified part of a rich media + # creative. A creative can have multiple timer events, each timed independently. # Leave it empty or unset for creatives containing image assets only. # Corresponds to the JSON property `timerEvents` # @return [Array] attr_accessor :timer_events # Tracking URLs for analytics providers or third-party ad technology vendors. - # The URLs must start with https (except on inventory that doesn't require - # SSL compliance). - # If using macros in your URL, use only macros supported by Display & Video - # 360. - # Standard URLs only, no IMG or SCRIPT tags. - # This field is only supported in following - # creative_type: - # * `CREATIVE_TYPE_NATIVE` - # * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` - # * `CREATIVE_TYPE_NATIVE_APP_INSTALL` - # * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE` - # * `CREATIVE_TYPE_NATIVE_VIDEO` + # The URLs must start with https (except on inventory that doesn't require SSL + # compliance). If using macros in your URL, use only macros supported by Display + # & Video 360. Standard URLs only, no IMG or SCRIPT tags. This field is only + # supported in following creative_type: * `CREATIVE_TYPE_NATIVE` * ` + # CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_APP_INSTALL` * ` + # CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO` # Corresponds to the JSON property `trackerUrls` # @return [Array] attr_accessor :tracker_urls - # Output only. Audio/Video transcodes. - # Display & Video 360 transcodes the main asset into a number of alternative - # versions that use different file formats or have different properties - # (resolution, audio bit rate, and video bit rate), each designed for - # specific video players or bandwidths. - # These transcodes give a publisher's system more options to choose from for - # each impression on your video and ensures that the appropriate file serves - # based on the viewer’s connection and screen size. - # This field is only supported in following - # creative_type: - # * `CREATIVE_TYPE_VIDEO` - # * `CREATIVE_TYPE_NATIVE_VIDEO` - # * `CREATIVE_TYPE_AUDIO` + # Output only. Audio/Video transcodes. Display & Video 360 transcodes the main + # asset into a number of alternative versions that use different file formats or + # have different properties (resolution, audio bit rate, and video bit rate), + # each designed for specific video players or bandwidths. These transcodes give + # a publisher's system more options to choose from for each impression on your + # video and ensures that the appropriate file serves based on the viewer’s + # connection and screen size. This field is only supported in following + # creative_type: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` * ` + # CREATIVE_TYPE_AUDIO` # Corresponds to the JSON property `transcodes` # @return [Array] attr_accessor :transcodes @@ -2895,32 +2653,26 @@ module Google # @return [Google::Apis::DisplayvideoV1::UniversalAdId] attr_accessor :universal_ad_id - # Output only. The timestamp when the creative was last updated. Assigned by - # the system. + # Output only. The timestamp when the creative was last updated. Assigned by the + # system. # Corresponds to the JSON property `updateTime` # @return [String] attr_accessor :update_time # Optional. The URL of the VAST tag for a third-party VAST tag creative. - # Required and only valid for third-party VAST tag creatives. - # Third-party VAST tag creatives are creatives with following - # hosting_source: - # * `HOSTING_SOURCE_THIRD_PARTY` - # combined with following creative_type: - # * `CREATIVE_TYPE_VIDEO` + # Required and only valid for third-party VAST tag creatives. Third-party VAST + # tag creatives are creatives with following hosting_source: * ` + # HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * ` + # CREATIVE_TYPE_VIDEO` # Corresponds to the JSON property `vastTagUrl` # @return [String] attr_accessor :vast_tag_url # Output only. Indicates the third-party VAST tag creative requires VPAID ( - # Digital Video - # Player-Ad Interface). - # Output only and only valid for third-party VAST tag creatives. - # Third-party VAST tag creatives are creatives with following - # hosting_source: - # * `HOSTING_SOURCE_THIRD_PARTY` - # combined with following creative_type: - # * `CREATIVE_TYPE_VIDEO` + # Digital Video Player-Ad Interface). Output only and only valid for third-party + # VAST tag creatives. Third-party VAST tag creatives are creatives with + # following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with + # following creative_type: * `CREATIVE_TYPE_VIDEO` # Corresponds to the JSON property `vpaid` # @return [Boolean] attr_accessor :vpaid @@ -3021,8 +2773,7 @@ module Google # @return [Fixnum] attr_accessor :custom_list_id - # Output only. The display name of the custom list. - # . + # Output only. The display name of the custom list. . # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name @@ -3044,13 +2795,13 @@ module Google end end - # Details of custom list group. - # All custom list targeting settings are logically ‘OR’ of each other. + # Details of custom list group. All custom list targeting settings are logically + # ‘OR’ of each other. class CustomListGroup include Google::Apis::Core::Hashable - # Required. All custom list targeting settings in custom list group. - # Repeated settings with same id will be ignored. + # Required. All custom list targeting settings in custom list group. Repeated + # settings with same id will be ignored. # Corresponds to the JSON property `settings` # @return [Array] attr_accessor :settings @@ -3069,8 +2820,8 @@ module Google class CustomListTargetingSetting include Google::Apis::Core::Hashable - # Required. Custom id of custom list targeting setting. - # This id is custom_list_id. + # Required. Custom id of custom list targeting setting. This id is + # custom_list_id. # Corresponds to the JSON property `customListId` # @return [Fixnum] attr_accessor :custom_list_id @@ -3087,30 +2838,29 @@ module Google # Represents a whole or partial calendar date, e.g. a birthday. The time of day # and time zone are either specified elsewhere or are not significant. The date - # is relative to the Proleptic Gregorian Calendar. This can represent: - # * A full date, with non-zero year, month and day values - # * A month and day value, with a zero year, e.g. an anniversary - # * A year on its own, with zero month and day values - # * A year and month value, with a zero day, e.g. a credit card expiration date - # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. + # is relative to the Proleptic Gregorian Calendar. This can represent: * A full + # date, with non-zero year, month and day values * A month and day value, with a + # zero year, e.g. an anniversary * A year on its own, with zero month and day + # values * A year and month value, with a zero day, e.g. a credit card + # expiration date Related types are google.type.TimeOfDay and `google.protobuf. + # Timestamp`. class Date include Google::Apis::Core::Hashable - # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 - # if specifying a year by itself or a year and month where the day is not + # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if + # specifying a year by itself or a year and month where the day is not # significant. # Corresponds to the JSON property `day` # @return [Fixnum] attr_accessor :day - # Month of year. Must be from 1 to 12, or 0 if specifying a year without a - # month and day. + # Month of year. Must be from 1 to 12, or 0 if specifying a year without a month + # and day. # Corresponds to the JSON property `month` # @return [Fixnum] attr_accessor :month - # Year of date. Must be from 1 to 9999, or 0 if specifying a date without - # a year. + # Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year. # Corresponds to the JSON property `year` # @return [Fixnum] attr_accessor :year @@ -3133,24 +2883,24 @@ module Google # Represents a whole or partial calendar date, e.g. a birthday. The time of day # and time zone are either specified elsewhere or are not significant. The date - # is relative to the Proleptic Gregorian Calendar. This can represent: - # * A full date, with non-zero year, month and day values - # * A month and day value, with a zero year, e.g. an anniversary - # * A year on its own, with zero month and day values - # * A year and month value, with a zero day, e.g. a credit card expiration date - # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. + # is relative to the Proleptic Gregorian Calendar. This can represent: * A full + # date, with non-zero year, month and day values * A month and day value, with a + # zero year, e.g. an anniversary * A year on its own, with zero month and day + # values * A year and month value, with a zero day, e.g. a credit card + # expiration date Related types are google.type.TimeOfDay and `google.protobuf. + # Timestamp`. # Corresponds to the JSON property `endDate` # @return [Google::Apis::DisplayvideoV1::Date] attr_accessor :end_date # Represents a whole or partial calendar date, e.g. a birthday. The time of day # and time zone are either specified elsewhere or are not significant. The date - # is relative to the Proleptic Gregorian Calendar. This can represent: - # * A full date, with non-zero year, month and day values - # * A month and day value, with a zero year, e.g. an anniversary - # * A year on its own, with zero month and day values - # * A year and month value, with a zero day, e.g. a credit card expiration date - # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. + # is relative to the Proleptic Gregorian Calendar. This can represent: * A full + # date, with non-zero year, month and day values * A month and day value, with a + # zero year, e.g. an anniversary * A year on its own, with zero month and day + # values * A year and month value, with a zero day, e.g. a credit card + # expiration date Related types are google.type.TimeOfDay and `google.protobuf. + # Timestamp`. # Corresponds to the JSON property `startDate` # @return [Google::Apis::DisplayvideoV1::Date] attr_accessor :start_date @@ -3167,9 +2917,8 @@ module Google end # Representation of a segment of time defined on a specific day of the week and - # with a start and end time. - # The time represented by `start_hour` must be before the time represented by - # `end_hour`. + # with a start and end time. The time represented by `start_hour` must be before + # the time represented by `end_hour`. class DayAndTimeAssignedTargetingOptionDetails include Google::Apis::Core::Hashable @@ -3179,22 +2928,19 @@ module Google attr_accessor :day_of_week # Required. The end hour for day and time targeting. Must be between 1 (1 hour - # after - # start of day) and 24 (end of day). + # after start of day) and 24 (end of day). # Corresponds to the JSON property `endHour` # @return [Fixnum] attr_accessor :end_hour # Required. The start hour for day and time targeting. Must be between 0 (start - # of day) - # and 23 (1 hour before end of day). + # of day) and 23 (1 hour before end of day). # Corresponds to the JSON property `startHour` # @return [Fixnum] attr_accessor :start_hour # Required. The mechanism used to determine which timezone to use for this day - # and time - # targeting setting. + # and time targeting setting. # Corresponds to the JSON property `timeZoneResolution` # @return [String] attr_accessor :time_zone_resolution @@ -3239,11 +2985,8 @@ module Google end # Assigned device make and model targeting option details. This will be - # populated in the - # device_make_model_details - # field when - # targeting_type is - # `TARGETING_TYPE_DEVICE_MAKE_MODEL`. + # populated in the device_make_model_details field when targeting_type is ` + # TARGETING_TYPE_DEVICE_MAKE_MODEL`. class DeviceMakeModelAssignedTargetingOptionDetails include Google::Apis::Core::Hashable @@ -3258,9 +3001,8 @@ module Google attr_accessor :negative alias_method :negative?, :negative - # Required. The targeting_option_id field when - # targeting_type is - # `TARGETING_TYPE_DEVICE_MAKE_MODEL`. + # Required. The targeting_option_id field when targeting_type is ` + # TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Corresponds to the JSON property `targetingOptionId` # @return [String] attr_accessor :targeting_option_id @@ -3278,10 +3020,8 @@ module Google end # Represents a targetable device make and model. This will be populated in the - # device_make_model_details - # field of a TargetingOption when - # targeting_type is - # `TARGETING_TYPE_DEVICE_MAKE_MODEL`. + # device_make_model_details field of a TargetingOption when targeting_type is ` + # TARGETING_TYPE_DEVICE_MAKE_MODEL`. class DeviceMakeModelTargetingOptionDetails include Google::Apis::Core::Hashable @@ -3300,10 +3040,9 @@ module Google end end - # Targeting details for device type. This will be - # populated in the details field of an AssignedTargetingOption when - # targeting_type is - # `TARGETING_TYPE_DEVICE_TYPE`. + # Targeting details for device type. This will be populated in the details field + # of an AssignedTargetingOption when targeting_type is ` + # TARGETING_TYPE_DEVICE_TYPE`. class DeviceTypeAssignedTargetingOptionDetails include Google::Apis::Core::Hashable @@ -3329,9 +3068,8 @@ module Google end # Represents a targetable device type. This will be populated in the - # device_type_details field of a - # TargetingOption when targeting_type is - # `TARGETING_TYPE_DEVICE_TYPE`. + # device_type_details field of a TargetingOption when targeting_type is ` + # TARGETING_TYPE_DEVICE_TYPE`. class DeviceTypeTargetingOptionDetails include Google::Apis::Core::Hashable @@ -3350,10 +3088,9 @@ module Google end end - # Targeting details for digital content label. This will be - # populated in the details field of an AssignedTargetingOption when - # targeting_type is - # `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. + # Targeting details for digital content label. This will be populated in the + # details field of an AssignedTargetingOption when targeting_type is ` + # TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. class DigitalContentLabelAssignedTargetingOptionDetails include Google::Apis::Core::Hashable @@ -3379,11 +3116,8 @@ module Google end # Represents a targetable digital content label rating tier. This will be - # populated in the - # digital_content_label_details - # field of the TargetingOption when - # targeting_type is - # `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. + # populated in the digital_content_label_details field of the TargetingOption + # when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. class DigitalContentLabelTargetingOptionDetails include Google::Apis::Core::Hashable @@ -3589,8 +3323,7 @@ module Google class DoubleVerifyVideoViewability include Google::Apis::Core::Hashable - # Target inventory to maximize impressions with 400x300 or greater player - # size. + # Target inventory to maximize impressions with 400x300 or greater player size. # Corresponds to the JSON property `playerImpressionRate` # @return [String] attr_accessor :player_impression_rate @@ -3617,13 +3350,11 @@ module Google end end - # A generic empty message that you can re-use to avoid defining duplicated - # empty messages in your APIs. A typical example is to use it as the request - # or the response type of an API method. For instance: - # service Foo ` - # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); - # ` - # The JSON representation for `Empty` is empty JSON object ````. + # A generic empty message that you can re-use to avoid defining duplicated empty + # messages in your APIs. A typical example is to use it as the request or the + # response type of an API method. For instance: service Foo ` rpc Bar(google. + # protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for + # `Empty` is empty JSON object ````. class Empty include Google::Apis::Core::Hashable @@ -3636,10 +3367,9 @@ module Google end end - # Assigned environment targeting option details. This will be populated - # in the details field of an AssignedTargetingOption when - # targeting_type is - # `TARGETING_TYPE_ENVIRONMENT`. + # Assigned environment targeting option details. This will be populated in the + # details field of an AssignedTargetingOption when targeting_type is ` + # TARGETING_TYPE_ENVIRONMENT`. class EnvironmentAssignedTargetingOptionDetails include Google::Apis::Core::Hashable @@ -3648,9 +3378,9 @@ module Google # @return [String] attr_accessor :environment - # Required. The targeting_option_id of a - # TargetingOption of type `TARGETING_TYPE_ENVIRONMENT` (e.g., "508010" - # for targeting the `ENVIRONMENT_WEB_OPTIMIZED` option). + # Required. The targeting_option_id of a TargetingOption of type ` + # TARGETING_TYPE_ENVIRONMENT` (e.g., "508010" for targeting the ` + # ENVIRONMENT_WEB_OPTIMIZED` option). # Corresponds to the JSON property `targetingOptionId` # @return [String] attr_accessor :targeting_option_id @@ -3667,9 +3397,8 @@ module Google end # Represents a targetable environment. This will be populated in the - # environment_details field of a - # TargetingOption when targeting_type is - # `TARGETING_TYPE_ENVIRONMENT`. + # environment_details field of a TargetingOption when targeting_type is ` + # TARGETING_TYPE_ENVIRONMENT`. class EnvironmentTargetingOptionDetails include Google::Apis::Core::Hashable @@ -3688,15 +3417,14 @@ module Google end end - # Details for assigned exchange targeting option. This will be populated in - # the details field of an AssignedTargetingOption when - # targeting_type is - # `TARGETING_TYPE_EXCHANGE`. + # Details for assigned exchange targeting option. This will be populated in the + # details field of an AssignedTargetingOption when targeting_type is ` + # TARGETING_TYPE_EXCHANGE`. class ExchangeAssignedTargetingOptionDetails include Google::Apis::Core::Hashable - # Required. The targeting_option_id of a - # TargetingOption of type `TARGETING_TYPE_EXCHANGE`. + # Required. The targeting_option_id of a TargetingOption of type ` + # TARGETING_TYPE_EXCHANGE`. # Corresponds to the JSON property `targetingOptionId` # @return [String] attr_accessor :targeting_option_id @@ -3737,10 +3465,8 @@ module Google end # Represents a targetable exchange. This will be populated in the - # exchange_details field - # of a TargetingOption when - # targeting_type is - # `TARGETING_TYPE_EXCHANGE`. + # exchange_details field of a TargetingOption when targeting_type is ` + # TARGETING_TYPE_EXCHANGE`. class ExchangeTargetingOptionDetails include Google::Apis::Core::Hashable @@ -3763,15 +3489,15 @@ module Google class ExitEvent include Google::Apis::Core::Hashable - # The name of the click tag of the exit event. - # The name must be unique within one creative. - # Leave it empty or unset for creatives containing image assets only. + # The name of the click tag of the exit event. The name must be unique within + # one creative. Leave it empty or unset for creatives containing image assets + # only. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # The name used to identify this event in reports. - # Leave it empty or unset for creatives containing image assets only. + # The name used to identify this event in reports. Leave it empty or unset for + # creatives containing image assets only. # Corresponds to the JSON property `reportingName` # @return [String] attr_accessor :reporting_name @@ -3781,10 +3507,8 @@ module Google # @return [String] attr_accessor :type - # Required. The click through URL of the exit event. - # This is required when type is: - # * `EXIT_EVENT_TYPE_DEFAULT` - # * `EXIT_EVENT_TYPE_BACKUP` + # Required. The click through URL of the exit event. This is required when type + # is: * `EXIT_EVENT_TYPE_DEFAULT` * `EXIT_EVENT_TYPE_BACKUP` # Corresponds to the JSON property `url` # @return [String] attr_accessor :url @@ -3802,19 +3526,16 @@ module Google end end - # Describes a first or third party audience list used for targeting. - # First party audiences are created via usage of client data. - # Third party audiences are provided by Third Party data providers and can only - # be licensed to customers. + # Describes a first or third party audience list used for targeting. First party + # audiences are created via usage of client data. Third party audiences are + # provided by Third Party data providers and can only be licensed to customers. class FirstAndThirdPartyAudience include Google::Apis::Core::Hashable # Output only. The estimated audience size for the Display network in the past - # month. - # If the size is less than 1000, the number will be hidden and 0 will be - # returned due to privacy reasons. Otherwise, the number will be rounded off - # to two significant digits. - # Only returned in GET request. + # month. If the size is less than 1000, the number will be hidden and 0 will be + # returned due to privacy reasons. Otherwise, the number will be rounded off to + # two significant digits. Only returned in GET request. # Corresponds to the JSON property `activeDisplayAudienceSize` # @return [Fixnum] attr_accessor :active_display_audience_size @@ -3829,47 +3550,43 @@ module Google # @return [String] attr_accessor :audience_type - # The user-provided description of the audience. - # Only applicable to first party audiences. + # The user-provided description of the audience. Only applicable to first party + # audiences. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # Output only. The estimated audience size for the Display network. - # If the size is less than 1000, the number will be hidden and 0 will be - # returned due to privacy reasons. Otherwise, the number will be rounded off - # to two significant digits. - # Only returned in GET request. + # Output only. The estimated audience size for the Display network. If the size + # is less than 1000, the number will be hidden and 0 will be returned due to + # privacy reasons. Otherwise, the number will be rounded off to two significant + # digits. Only returned in GET request. # Corresponds to the JSON property `displayAudienceSize` # @return [Fixnum] attr_accessor :display_audience_size - # Output only. The estimated desktop audience size in Display network. - # If the size is less than 1000, the number will be hidden and 0 will be - # returned due to privacy reasons. Otherwise, the number will be rounded off - # to two significant digits. - # Only applicable to first party audiences. - # Only returned in GET request. + # Output only. The estimated desktop audience size in Display network. If the + # size is less than 1000, the number will be hidden and 0 will be returned due + # to privacy reasons. Otherwise, the number will be rounded off to two + # significant digits. Only applicable to first party audiences. Only returned in + # GET request. # Corresponds to the JSON property `displayDesktopAudienceSize` # @return [Fixnum] attr_accessor :display_desktop_audience_size - # Output only. The estimated mobile app audience size in Display network. - # If the size is less than 1000, the number will be hidden and 0 will be - # returned due to privacy reasons. Otherwise, the number will be rounded off - # to two significant digits. - # Only applicable to first party audiences. - # Only returned in GET request. + # Output only. The estimated mobile app audience size in Display network. If the + # size is less than 1000, the number will be hidden and 0 will be returned due + # to privacy reasons. Otherwise, the number will be rounded off to two + # significant digits. Only applicable to first party audiences. Only returned in + # GET request. # Corresponds to the JSON property `displayMobileAppAudienceSize` # @return [Fixnum] attr_accessor :display_mobile_app_audience_size - # Output only. The estimated mobile web audience size in Display network. - # If the size is less than 1000, the number will be hidden and 0 will be - # returned due to privacy reasons. Otherwise, the number will be rounded off - # to two significant digits. - # Only applicable to first party audiences. - # Only returned in GET request. + # Output only. The estimated mobile web audience size in Display network. If the + # size is less than 1000, the number will be hidden and 0 will be returned due + # to privacy reasons. Otherwise, the number will be rounded off to two + # significant digits. Only applicable to first party audiences. Only returned in + # GET request. # Corresponds to the JSON property `displayMobileWebAudienceSize` # @return [Fixnum] attr_accessor :display_mobile_web_audience_size @@ -3880,8 +3597,7 @@ module Google attr_accessor :display_name # Output only. The unique ID of the first and third party audience. Assigned by - # the - # system. + # the system. # Corresponds to the JSON property `firstAndThirdPartyAudienceId` # @return [Fixnum] attr_accessor :first_and_third_party_audience_id @@ -3891,19 +3607,16 @@ module Google # @return [String] attr_accessor :first_and_third_party_audience_type - # Output only. The estimated audience size for Gmail network. - # If the size is less than 1000, the number will be hidden and 0 will be - # returned due to privacy reasons. Otherwise, the number will be rounded off - # to two significant digits. - # Only applicable to first party audiences. - # Only returned in GET request. + # Output only. The estimated audience size for Gmail network. If the size is + # less than 1000, the number will be hidden and 0 will be returned due to + # privacy reasons. Otherwise, the number will be rounded off to two significant + # digits. Only applicable to first party audiences. Only returned in GET request. # Corresponds to the JSON property `gmailAudienceSize` # @return [Fixnum] attr_accessor :gmail_audience_size # The duration in days that an entry remains in the audience after the - # qualifying event. - # Only applicable to first party audiences. + # qualifying event. Only applicable to first party audiences. # Corresponds to the JSON property `membershipDurationDays` # @return [Fixnum] attr_accessor :membership_duration_days @@ -3913,12 +3626,10 @@ module Google # @return [String] attr_accessor :name - # Output only. The estimated audience size for YouTube network. - # If the size is less than 1000, the number will be hidden and 0 will be - # returned due to privacy reasons. Otherwise, the number will be rounded off - # to two significant digits. - # Only applicable to first party audiences. - # Only returned in GET request. + # Output only. The estimated audience size for YouTube network. If the size is + # less than 1000, the number will be hidden and 0 will be returned due to + # privacy reasons. Otherwise, the number will be rounded off to two significant + # digits. Only applicable to first party audiences. Only returned in GET request. # Corresponds to the JSON property `youtubeAudienceSize` # @return [Fixnum] attr_accessor :youtube_audience_size @@ -3947,15 +3658,13 @@ module Google end end - # Details of first and third party audience group. - # All first and third party audience targeting settings are logically ‘OR’ of - # each other. + # Details of first and third party audience group. All first and third party + # audience targeting settings are logically ‘OR’ of each other. class FirstAndThirdPartyAudienceGroup include Google::Apis::Core::Hashable # Required. All first and third party audience targeting settings in first and - # third party audience group. - # Repeated settings with same id are not allowed. + # third party audience group. Repeated settings with same id are not allowed. # Corresponds to the JSON property `settings` # @return [Array] attr_accessor :settings @@ -3975,18 +3684,15 @@ module Google include Google::Apis::Core::Hashable # Required. First and third party audience id of the first and third party - # audience - # targeting setting. This id is - # first_and_third_party_audience_id. + # audience targeting setting. This id is first_and_third_party_audience_id. # Corresponds to the JSON property `firstAndThirdPartyAudienceId` # @return [Fixnum] attr_accessor :first_and_third_party_audience_id - # The recency of the first and third party audience targeting setting. - # Only applicable to first party audiences, otherwise - # will be ignored. For more info, refer to - # https://support.google.com/displayvideo/answer/2949947#recency - # When unspecified, no recency limit will be used. + # The recency of the first and third party audience targeting setting. Only + # applicable to first party audiences, otherwise will be ignored. For more info, + # refer to https://support.google.com/displayvideo/answer/2949947#recency When + # unspecified, no recency limit will be used. # Corresponds to the JSON property `recency` # @return [String] attr_accessor :recency @@ -4006,14 +3712,11 @@ module Google class FixedBidStrategy include Google::Apis::Core::Hashable - # The fixed bid amount, in micros of the advertiser's currency. - # For insertion order entity, - # bid_amount_micros should be set as 0. - # For line item entity, - # bid_amount_micros must be greater - # than or equal to billable unit of the given currency and smaller than or - # equal to the upper limit 1000000000. - # For example, 1500000 represents 1.5 standard units of the currency. + # The fixed bid amount, in micros of the advertiser's currency. For insertion + # order entity, bid_amount_micros should be set as 0. For line item entity, + # bid_amount_micros must be greater than or equal to billable unit of the given + # currency and smaller than or equal to the upper limit 1000000000. For example, + # 1500000 represents 1.5 standard units of the currency. # Corresponds to the JSON property `bidAmountMicros` # @return [Fixnum] attr_accessor :bid_amount_micros @@ -4037,26 +3740,19 @@ module Google # @return [Google::Apis::DisplayvideoV1::ActiveViewVideoViewabilityMetricConfig] attr_accessor :active_view_config - # User-defined custom variables owned by the Floodlight group. - # Use custom Floodlight variables to create reporting data that is tailored - # to your unique business needs. Custom Floodlight variables use the keys - # `U1=`, `U2=`, and so on, and can take any values that you choose to pass to - # them. You can use them to track virtually any type of data that you collect - # about your customers, such as the genre of movie that a customer purchases, - # the country to which the item is shipped, and so on. - # Custom Floodlight variables may not be used to pass any data that could be - # used or recognized as personally identifiable information (PII). - # Example: - # `custom_variables ` - # fields ` - # "U1": value ` number_value: 123.4 `, - # "U2": value ` string_value: "MyVariable2" `, - # "U3": value ` string_value: "MyVariable3" ` - # ` - # `` - # Acceptable values for keys are "U1" through "U100", inclusive. String - # values must be less than 64 characters long, and cannot contain the - # following characters: `"<>`. + # User-defined custom variables owned by the Floodlight group. Use custom + # Floodlight variables to create reporting data that is tailored to your unique + # business needs. Custom Floodlight variables use the keys `U1=`, `U2=`, and so + # on, and can take any values that you choose to pass to them. You can use them + # to track virtually any type of data that you collect about your customers, + # such as the genre of movie that a customer purchases, the country to which the + # item is shipped, and so on. Custom Floodlight variables may not be used to + # pass any data that could be used or recognized as personally identifiable + # information (PII). Example: `custom_variables ` fields ` "U1": value ` + # number_value: 123.4 `, "U2": value ` string_value: "MyVariable2" `, "U3": + # value ` string_value: "MyVariable3" ` ` `` Acceptable values for keys are "U1" + # through "U100", inclusive. String values must be less than 64 characters long, + # and cannot contain the following characters: `"<>`. # Corresponds to the JSON property `customVariables` # @return [Hash] attr_accessor :custom_variables @@ -4103,42 +3799,36 @@ module Google end end - # Settings that control the number of times a user may be shown with the same - # ad during a given time period. + # Settings that control the number of times a user may be shown with the same ad + # during a given time period. class FrequencyCap include Google::Apis::Core::Hashable - # The maximum number of times a user may be shown with the same ad - # during this period. Must be greater than 0. - # Applicable when unlimited is `false`. + # The maximum number of times a user may be shown with the same ad during this + # period. Must be greater than 0. Applicable when unlimited is `false`. # Corresponds to the JSON property `maxImpressions` # @return [Fixnum] attr_accessor :max_impressions - # The time unit in which the frequency cap will be applied. - # Applicable when unlimited is `false`. + # The time unit in which the frequency cap will be applied. Applicable when + # unlimited is `false`. # Corresponds to the JSON property `timeUnit` # @return [String] attr_accessor :time_unit - # The number of time_unit the frequency cap will - # last. - # Applicable when unlimited is `false`. - # The following restrictions apply based on the value of - # time_unit: - # * `TIME_UNIT_LIFETIME` - this field is output only and will - # default to 1 - # * `TIME_UNIT_MONTHS` - must be between 1 and 2 - # * `TIME_UNIT_WEEKS` - must be between 1 and 4 - # * `TIME_UNIT_DAYS` - must be between 1 and 6 - # * `TIME_UNIT_HOURS` - must be between 1 and 23 - # * `TIME_UNIT_MINUTES` - must be between 1 and 59 + # The number of time_unit the frequency cap will last. Applicable when unlimited + # is `false`. The following restrictions apply based on the value of time_unit: * + # `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * ` + # TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be + # between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * ` + # TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be + # between 1 and 59 # Corresponds to the JSON property `timeUnitCount` # @return [Fixnum] attr_accessor :time_unit_count - # Whether unlimited frequency capping is applied. When this field is set to - # `true`, the remaining frequency cap fields are not applicable. + # Whether unlimited frequency capping is applied. When this field is set to ` + # true`, the remaining frequency cap fields are not applicable. # Corresponds to the JSON property `unlimited` # @return [Boolean] attr_accessor :unlimited @@ -4157,10 +3847,9 @@ module Google end end - # Details for assigned gender targeting option. This will be populated in - # the details field of an AssignedTargetingOption when - # targeting_type is - # `TARTGETING_TYPE_GENDER`. + # Details for assigned gender targeting option. This will be populated in the + # details field of an AssignedTargetingOption when targeting_type is ` + # TARTGETING_TYPE_GENDER`. class GenderAssignedTargetingOptionDetails include Google::Apis::Core::Hashable @@ -4169,8 +3858,8 @@ module Google # @return [String] attr_accessor :gender - # Required. The targeting_option_id of a - # TargetingOption of type `TARGETING_TYPE_GENDER`. + # Required. The targeting_option_id of a TargetingOption of type ` + # TARGETING_TYPE_GENDER`. # Corresponds to the JSON property `targetingOptionId` # @return [String] attr_accessor :targeting_option_id @@ -4186,10 +3875,8 @@ module Google end end - # Represents a targetable gender. This will be populated in the - # gender_details field of a TargetingOption - # when targeting_type is - # `TARGETING_TYPE_GENDER`. + # Represents a targetable gender. This will be populated in the gender_details + # field of a TargetingOption when targeting_type is `TARGETING_TYPE_GENDER`. class GenderTargetingOptionDetails include Google::Apis::Core::Hashable @@ -4210,8 +3897,7 @@ module Google # Details for assigned geographic region targeting option. This will be # populated in the details field of an AssignedTargetingOption when - # targeting_type is - # `TARGETING_TYPE_GEO_REGION`. + # targeting_type is `TARGETING_TYPE_GEO_REGION`. class GeoRegionAssignedTargetingOptionDetails include Google::Apis::Core::Hashable @@ -4232,8 +3918,8 @@ module Google attr_accessor :negative alias_method :negative?, :negative - # Required. The targeting_option_id of a - # TargetingOption of type `TARGETING_TYPE_GEO_REGION`. + # Required. The targeting_option_id of a TargetingOption of type ` + # TARGETING_TYPE_GEO_REGION`. # Corresponds to the JSON property `targetingOptionId` # @return [String] attr_accessor :targeting_option_id @@ -4252,9 +3938,7 @@ module Google end # Represents a targetable geographic region. This will be populated in the - # geo_region_details field when - # targeting_type is - # `TARGETING_TYPE_GEO_REGION`. + # geo_region_details field when targeting_type is `TARGETING_TYPE_GEO_REGION`. class GeoRegionTargetingOptionDetails include Google::Apis::Core::Hashable @@ -4280,13 +3964,11 @@ module Google end end - # Describes a Google audience resource. - # Includes Google audience lists. + # Describes a Google audience resource. Includes Google audience lists. class GoogleAudience include Google::Apis::Core::Hashable - # Output only. The display name of the Google audience. - # . + # Output only. The display name of the Google audience. . # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name @@ -4296,8 +3978,7 @@ module Google # @return [Fixnum] attr_accessor :google_audience_id - # Output only. The type of Google audience. - # . + # Output only. The type of Google audience. . # Corresponds to the JSON property `googleAudienceType` # @return [String] attr_accessor :google_audience_type @@ -4320,8 +4001,8 @@ module Google end end - # Details of Google audience group. - # All Google audience targeting settings are logically ‘OR’ of each other. + # Details of Google audience group. All Google audience targeting settings are + # logically ‘OR’ of each other. class GoogleAudienceGroup include Google::Apis::Core::Hashable @@ -4345,8 +4026,8 @@ module Google class GoogleAudienceTargetingSetting include Google::Apis::Core::Hashable - # Required. Google audience id of the Google audience targeting setting. - # This id is google_audience_id. + # Required. Google audience id of the Google audience targeting setting. This id + # is google_audience_id. # Corresponds to the JSON property `googleAudienceId` # @return [Fixnum] attr_accessor :google_audience_id @@ -4380,10 +4061,9 @@ module Google end end - # Details for assigned household income targeting option. This will be - # populated in the details field of an AssignedTargetingOption when - # targeting_type is - # `TARGETING_TYPE_HOUSEHOLD_INCOME`. + # Details for assigned household income targeting option. This will be populated + # in the details field of an AssignedTargetingOption when targeting_type is ` + # TARGETING_TYPE_HOUSEHOLD_INCOME`. class HouseholdIncomeAssignedTargetingOptionDetails include Google::Apis::Core::Hashable @@ -4392,8 +4072,8 @@ module Google # @return [String] attr_accessor :household_income - # Required. The targeting_option_id of a - # TargetingOption of type `TARGETING_TYPE_HOUSEHOLD_INCOME`. + # Required. The targeting_option_id of a TargetingOption of type ` + # TARGETING_TYPE_HOUSEHOLD_INCOME`. # Corresponds to the JSON property `targetingOptionId` # @return [String] attr_accessor :targeting_option_id @@ -4410,9 +4090,8 @@ module Google end # Represents a targetable household income. This will be populated in the - # household_income_details field of - # a TargetingOption when targeting_type is - # `TARGETING_TYPE_HOUSEHOLD_INCOME`. + # household_income_details field of a TargetingOption when targeting_type is ` + # TARGETING_TYPE_HOUSEHOLD_INCOME`. class HouseholdIncomeTargetingOptionDetails include Google::Apis::Core::Hashable @@ -4435,50 +4114,38 @@ module Google class IdFilter include Google::Apis::Core::Hashable - # TrueView Ads to download by ID. All IDs must belong to the same - # Advertiser or - # Partner specified in - # CreateSdfDownloadTaskRequest. + # YouTube Ads to download by ID. All IDs must belong to the same Advertiser or + # Partner specified in CreateSdfDownloadTaskRequest. # Corresponds to the JSON property `adGroupAdIds` # @return [Array] attr_accessor :ad_group_ad_ids - # TrueView Ad Groups to download by ID. All IDs must belong to the same - # Advertiser or - # Partner specified in - # CreateSdfDownloadTaskRequest. + # YouTube Ad Groups to download by ID. All IDs must belong to the same + # Advertiser or Partner specified in CreateSdfDownloadTaskRequest. # Corresponds to the JSON property `adGroupIds` # @return [Array] attr_accessor :ad_group_ids - # Campaigns to download by ID. All IDs must belong to the same - # Advertiser or - # Partner specified in - # CreateSdfDownloadTaskRequest. + # Campaigns to download by ID. All IDs must belong to the same Advertiser or + # Partner specified in CreateSdfDownloadTaskRequest. # Corresponds to the JSON property `campaignIds` # @return [Array] attr_accessor :campaign_ids - # Insertion Orders to download by ID. All IDs must belong to the same - # Advertiser or - # Partner specified in - # CreateSdfDownloadTaskRequest. + # Insertion Orders to download by ID. All IDs must belong to the same Advertiser + # or Partner specified in CreateSdfDownloadTaskRequest. # Corresponds to the JSON property `insertionOrderIds` # @return [Array] attr_accessor :insertion_order_ids - # Line Items to download by ID. All IDs must belong to the same - # Advertiser or - # Partner specified in - # CreateSdfDownloadTaskRequest. + # Line Items to download by ID. All IDs must belong to the same Advertiser or + # Partner specified in CreateSdfDownloadTaskRequest. # Corresponds to the JSON property `lineItemIds` # @return [Array] attr_accessor :line_item_ids - # Media Products to download by ID. All IDs must belong to the same - # Advertiser or - # Partner specified in - # CreateSdfDownloadTaskRequest. + # Media Products to download by ID. All IDs must belong to the same Advertiser + # or Partner specified in CreateSdfDownloadTaskRequest. # Corresponds to the JSON property `mediaProductIds` # @return [Array] attr_accessor :media_product_ids @@ -4507,8 +4174,7 @@ module Google # @return [Fixnum] attr_accessor :advertiser_id - # Settings that control the bid strategy. - # Bid strategy determines the bid price. + # Settings that control the bid strategy. Bid strategy determines the bid price. # Corresponds to the JSON property `bidStrategy` # @return [Google::Apis::DisplayvideoV1::BiddingStrategy] attr_accessor :bid_strategy @@ -4524,29 +4190,25 @@ module Google # @return [Fixnum] attr_accessor :campaign_id - # Required. The display name of the insertion order. - # Must be UTF-8 encoded with a maximum size of 240 bytes. + # Required. The display name of the insertion order. Must be UTF-8 encoded with + # a maximum size of 240 bytes. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name - # Required. Controls whether or not the insertion order can spend its budget - # and bid on inventory. - # * For - # CreateInsertionOrder method, - # only `ENTITY_STATUS_DRAFT` is allowed. To activate an insertion order, use - # UpdateInsertionOrder method - # and update the status to `ENTITY_STATUS_ACTIVE` after creation. - # * An insertion order cannot be changed back to `ENTITY_STATUS_DRAFT` status - # from any other status. - # * An insertion order cannot be set to `ENTITY_STATUS_ACTIVE` if its parent - # campaign is not active. + # Required. Controls whether or not the insertion order can spend its budget and + # bid on inventory. * For CreateInsertionOrder method, only `ENTITY_STATUS_DRAFT` + # is allowed. To activate an insertion order, use UpdateInsertionOrder method + # and update the status to `ENTITY_STATUS_ACTIVE` after creation. * An insertion + # order cannot be changed back to `ENTITY_STATUS_DRAFT` status from any other + # status. * An insertion order cannot be set to `ENTITY_STATUS_ACTIVE` if its + # parent campaign is not active. # Corresponds to the JSON property `entityStatus` # @return [String] attr_accessor :entity_status - # Settings that control the number of times a user may be shown with the same - # ad during a given time period. + # Settings that control the number of times a user may be shown with the same ad + # during a given time period. # Corresponds to the JSON property `frequencyCap` # @return [Google::Apis::DisplayvideoV1::FrequencyCap] attr_accessor :frequency_cap @@ -4571,11 +4233,9 @@ module Google # @return [Google::Apis::DisplayvideoV1::Pacing] attr_accessor :pacing - # The partner costs associated with the insertion order. - # If absent or empty in - # CreateInsertionOrder - # method, the newly created insertion order will inherit partner costs from - # the partner settings. + # The partner costs associated with the insertion order. If absent or empty in + # CreateInsertionOrder method, the newly created insertion order will inherit + # partner costs from the partner settings. # Corresponds to the JSON property `partnerCosts` # @return [Array] attr_accessor :partner_costs @@ -4585,8 +4245,8 @@ module Google # @return [Google::Apis::DisplayvideoV1::PerformanceGoal] attr_accessor :performance_goal - # Output only. The timestamp when the insertion order was last updated. - # Assigned by the system. + # Output only. The timestamp when the insertion order was last updated. Assigned + # by the system. # Corresponds to the JSON property `updateTime` # @return [String] attr_accessor :update_time @@ -4618,23 +4278,21 @@ module Google class InsertionOrderBudget include Google::Apis::Core::Hashable - # The type of automation used to manage bid and budget for - # the insertion order. - # If this field is unspecified in creation, the value defaults to - # `INSERTION_ORDER_AUTOMATION_TYPE_NONE`. + # The type of automation used to manage bid and budget for the insertion order. + # If this field is unspecified in creation, the value defaults to ` + # INSERTION_ORDER_AUTOMATION_TYPE_NONE`. # Corresponds to the JSON property `automationType` # @return [String] attr_accessor :automation_type - # Required. The list of budget segments. Use a budget segment to specify - # a specific budget for a given period of time an insertion order is running. + # Required. The list of budget segments. Use a budget segment to specify a + # specific budget for a given period of time an insertion order is running. # Corresponds to the JSON property `budgetSegments` # @return [Array] attr_accessor :budget_segments # Required. Immutable. The budget unit specifies whether the budget is currency - # based or - # impression based. + # based or impression based. # Corresponds to the JSON property `budgetUnit` # @return [String] attr_accessor :budget_unit @@ -4656,15 +4314,13 @@ module Google include Google::Apis::Core::Hashable # Required. The budget amount the insertion order will spend for the given - # date_range. - # The amount is in micros. Must be greater than 0. For example, 500000000 - # represents 500 standard units of the currency. + # date_range. The amount is in micros. Must be greater than 0. For example, + # 500000000 represents 500 standard units of the currency. # Corresponds to the JSON property `budgetAmountMicros` # @return [Fixnum] attr_accessor :budget_amount_micros - # The ID of the campaign budget linked to this insertion order budget - # segment. + # The ID of the campaign budget linked to this insertion order budget segment. # Corresponds to the JSON property `campaignBudgetId` # @return [Fixnum] attr_accessor :campaign_budget_id @@ -4675,9 +4331,8 @@ module Google attr_accessor :date_range # The budget segment description. It can be used to enter Purchase Order - # information for each budget segment and have that information printed on - # the invoices. - # Must be UTF-8 encoded with a length of no more than 80 characters. + # information for each budget segment and have that information printed on the + # invoices. Must be UTF-8 encoded with a length of no more than 80 characters. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description @@ -4791,16 +4446,15 @@ module Google class IntegrationDetails include Google::Apis::Core::Hashable - # Additional details of the entry in string format. - # Must be UTF-8 encoded with a length of no more than 1000 characters. + # Additional details of the entry in string format. Must be UTF-8 encoded with a + # length of no more than 1000 characters. # Corresponds to the JSON property `details` # @return [String] attr_accessor :details - # An external identifier to be associated with the entry. - # The integration code will show up together with the entry in many - # places in the system, for example, reporting. - # Must be UTF-8 encoded with a length of no more than 500 characters. + # An external identifier to be associated with the entry. The integration code + # will show up together with the entry in many places in the system, for example, + # reporting. Must be UTF-8 encoded with a length of no more than 500 characters. # Corresponds to the JSON property `integrationCode` # @return [String] attr_accessor :integration_code @@ -4825,31 +4479,30 @@ module Google # @return [String] attr_accessor :commitment - # The creative requirements of the inventory source. - # Not applicable for auction packages. + # The creative requirements of the inventory source. Not applicable for auction + # packages. # Corresponds to the JSON property `creativeConfigs` # @return [Array] attr_accessor :creative_configs # The ID in the exchange space that uniquely identifies the inventory source. - # Must be unique across buyers within each exchange but not necessarily - # unique across exchanges. + # Must be unique across buyers within each exchange but not necessarily unique + # across exchanges. # Corresponds to the JSON property `dealId` # @return [String] attr_accessor :deal_id - # The delivery method of the inventory source. - # * For non-guaranteed inventory sources, the only acceptable value is - # `INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC`. - # * For guaranteed inventory sources, acceptable values are - # `INVENTORY_SOURCE_DELIVERY_METHOD_TAG` and - # `INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC`. + # The delivery method of the inventory source. * For non-guaranteed inventory + # sources, the only acceptable value is ` + # INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC`. * For guaranteed inventory + # sources, acceptable values are `INVENTORY_SOURCE_DELIVERY_METHOD_TAG` and ` + # INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC`. # Corresponds to the JSON property `deliveryMethod` # @return [String] attr_accessor :delivery_method - # The display name of the inventory source. - # Must be UTF-8 encoded with a maximum size of 240 bytes. + # The display name of the inventory source. Must be UTF-8 encoded with a maximum + # size of 240 bytes. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name @@ -4895,8 +4548,7 @@ module Google attr_accessor :time_range # Output only. The timestamp when the inventory source was last updated. - # Assigned by the - # system. + # Assigned by the system. # Corresponds to the JSON property `updateTime` # @return [String] attr_accessor :update_time @@ -4924,16 +4576,14 @@ module Google end end - # Targeting details for inventory source. This will be - # populated in the details field of an AssignedTargetingOption when - # targeting_type is - # `TARGETING_TYPE_INVENTORY_SOURCE`. + # Targeting details for inventory source. This will be populated in the details + # field of an AssignedTargetingOption when targeting_type is ` + # TARGETING_TYPE_INVENTORY_SOURCE`. class InventorySourceAssignedTargetingOptionDetails include Google::Apis::Core::Hashable - # Required. ID of the inventory source. Should refer to the - # inventory_source_id field of an - # InventorySource resource. + # Required. ID of the inventory source. Should refer to the inventory_source_id + # field of an InventorySource resource. # Corresponds to the JSON property `inventorySourceId` # @return [Fixnum] attr_accessor :inventory_source_id @@ -4972,10 +4622,8 @@ module Google include Google::Apis::Core::Hashable # Inventory Sources to download by ID. All IDs must belong to the same - # Advertiser or - # Partner specified in - # CreateSdfDownloadTaskRequest. Leave empty to download all Inventory - # Sources for the selected Advertiser or Partner. + # Advertiser or Partner specified in CreateSdfDownloadTaskRequest. Leave empty + # to download all Inventory Sources for the selected Advertiser or Partner. # Corresponds to the JSON property `inventorySourceIds` # @return [Array] attr_accessor :inventory_source_ids @@ -4994,8 +4642,8 @@ module Google class InventorySourceGroup include Google::Apis::Core::Hashable - # Required. The display name of the inventory source group. - # Must be UTF-8 encoded with a maximum size of 240 bytes. + # Required. The display name of the inventory source group. Must be UTF-8 + # encoded with a maximum size of 240 bytes. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name @@ -5023,16 +4671,14 @@ module Google end end - # Targeting details for inventory source group. This will be - # populated in the details field of an AssignedTargetingOption when - # targeting_type is - # `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`. + # Targeting details for inventory source group. This will be populated in the + # details field of an AssignedTargetingOption when targeting_type is ` + # TARGETING_TYPE_INVENTORY_SOURCE_GROUP`. class InventorySourceGroupAssignedTargetingOptionDetails include Google::Apis::Core::Hashable # Required. ID of the inventory source group. Should refer to the - # inventory_source_group_id - # field of an InventorySourceGroup resource. + # inventory_source_group_id field of an InventorySourceGroup resource. # Corresponds to the JSON property `inventorySourceGroupId` # @return [Fixnum] attr_accessor :inventory_source_group_id @@ -5051,43 +4697,39 @@ module Google class InventorySourceStatus include Google::Apis::Core::Hashable - # Output only. The configuration status of the inventory source. - # Only applicable for guaranteed inventory sources. - # Acceptable values are `INVENTORY_SOURCE_CONFIG_STATUS_PENDING` and - # `INVENTORY_SOURCE_CONFIG_STATUS_COMPLETED`. - # An inventory source must be configured (fill in the required fields, choose - # creatives, and select a default campaign) before it can serve. + # Output only. The configuration status of the inventory source. Only applicable + # for guaranteed inventory sources. Acceptable values are ` + # INVENTORY_SOURCE_CONFIG_STATUS_PENDING` and ` + # INVENTORY_SOURCE_CONFIG_STATUS_COMPLETED`. An inventory source must be + # configured (fill in the required fields, choose creatives, and select a + # default campaign) before it can serve. # Corresponds to the JSON property `configStatus` # @return [String] attr_accessor :config_status - # The user-provided reason for pausing this inventory source. - # Must not exceed 100 characters. - # Only applicable when entity_status - # is set to `ENTITY_STATUS_PAUSED`. + # The user-provided reason for pausing this inventory source. Must not exceed + # 100 characters. Only applicable when entity_status is set to ` + # ENTITY_STATUS_PAUSED`. # Corresponds to the JSON property `entityPauseReason` # @return [String] attr_accessor :entity_pause_reason - # Whether or not the inventory source is servable. - # Acceptable values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_ARCHIVED`, and - # `ENTITY_STATUS_PAUSED`. + # Whether or not the inventory source is servable. Acceptable values are ` + # ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_ARCHIVED`, and `ENTITY_STATUS_PAUSED`. # Default value is `ENTITY_STATUS_ACTIVE`. # Corresponds to the JSON property `entityStatus` # @return [String] attr_accessor :entity_status # Output only. The seller-provided reason for pausing this inventory source. - # Only applicable for inventory sources synced directly from the - # publishers and when seller_status - # is set to `ENTITY_STATUS_PAUSED`. + # Only applicable for inventory sources synced directly from the publishers and + # when seller_status is set to `ENTITY_STATUS_PAUSED`. # Corresponds to the JSON property `sellerPauseReason` # @return [String] attr_accessor :seller_pause_reason - # Output only. The status set by the seller for the inventory source. - # Only applicable for inventory sources synced directly from the - # publishers. + # Output only. The status set by the seller for the inventory source. Only + # applicable for inventory sources synced directly from the publishers. # Acceptable values are `ENTITY_STATUS_ACTIVE` and `ENTITY_STATUS_PAUSED`. # Corresponds to the JSON property `sellerStatus` # @return [String] @@ -5111,8 +4753,8 @@ module Google class InventorySourceVideoCreativeConfig include Google::Apis::Core::Hashable - # The duration requirements for the video creatives that can be assigned to - # the inventory source. + # The duration requirements for the video creatives that can be assigned to the + # inventory source. # Corresponds to the JSON property `duration` # @return [String] attr_accessor :duration @@ -5128,16 +4770,14 @@ module Google end # Details for assigned keyword targeting option. This will be populated in the - # details field of an AssignedTargetingOption when - # targeting_type is - # `TARGETING_TYPE_KEYWORD`. + # details field of an AssignedTargetingOption when targeting_type is ` + # TARGETING_TYPE_KEYWORD`. class KeywordAssignedTargetingOptionDetails include Google::Apis::Core::Hashable - # Required. The keyword, for example `car insurance`. - # Positive keyword cannot be offensive word. - # Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number - # of characters is 80. Maximum number of words is 10. + # Required. The keyword, for example `car insurance`. Positive keyword cannot be + # offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. + # Maximum number of characters is 80. Maximum number of words is 10. # Corresponds to the JSON property `keyword` # @return [String] attr_accessor :keyword @@ -5160,9 +4800,8 @@ module Google end # Details for assigned language targeting option. This will be populated in the - # details field of an AssignedTargetingOption when - # targeting_type is - # `TARGETING_TYPE_LANGUAGE`. + # details field of an AssignedTargetingOption when targeting_type is ` + # TARGETING_TYPE_LANGUAGE`. class LanguageAssignedTargetingOptionDetails include Google::Apis::Core::Hashable @@ -5171,16 +4810,16 @@ module Google # @return [String] attr_accessor :display_name - # Indicates if this option is being negatively targeted. All assigned - # language targeting options on the same line item must have the same value - # for this field. + # Indicates if this option is being negatively targeted. All assigned language + # targeting options on the same line item must have the same value for this + # field. # Corresponds to the JSON property `negative` # @return [Boolean] attr_accessor :negative alias_method :negative?, :negative - # Required. The targeting_option_id of a - # TargetingOption of type `TARGETING_TYPE_LANGUAGE`. + # Required. The targeting_option_id of a TargetingOption of type ` + # TARGETING_TYPE_LANGUAGE`. # Corresponds to the JSON property `targetingOptionId` # @return [String] attr_accessor :targeting_option_id @@ -5198,9 +4837,7 @@ module Google end # Represents a targetable language. This will be populated in the - # language_details field when - # targeting_type is - # `TARGETING_TYPE_LANGUAGE`. + # language_details field when targeting_type is `TARGETING_TYPE_LANGUAGE`. class LanguageTargetingOptionDetails include Google::Apis::Core::Hashable @@ -5228,8 +4865,7 @@ module Google # @return [Fixnum] attr_accessor :advertiser_id - # Settings that control the bid strategy. - # Bid strategy determines the bid price. + # Settings that control the bid strategy. Bid strategy determines the bid price. # Corresponds to the JSON property `bidStrategy` # @return [Google::Apis::DisplayvideoV1::BiddingStrategy] attr_accessor :bid_strategy @@ -5244,9 +4880,9 @@ module Google # @return [Fixnum] attr_accessor :campaign_id - # Settings that control how conversions are counted. - # All post-click conversions will be counted. A percentage value can be set - # for post-view conversions counting. + # Settings that control how conversions are counted. All post-click conversions + # will be counted. A percentage value can be set for post-view conversions + # counting. # Corresponds to the JSON property `conversionCounting` # @return [Google::Apis::DisplayvideoV1::ConversionCountingConfig] attr_accessor :conversion_counting @@ -5256,22 +4892,19 @@ module Google # @return [Array] attr_accessor :creative_ids - # Required. The display name of the line item. - # Must be UTF-8 encoded with a maximum size of 240 bytes. + # Required. The display name of the line item. Must be UTF-8 encoded with a + # maximum size of 240 bytes. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name - # Required. Controls whether or not the line item can spend its budget and - # bid on inventory. - # * For CreateLineItem method, only - # `ENTITY_STATUS_DRAFT` is allowed. To activate a line item, use - # UpdateLineItem method and update the - # status to `ENTITY_STATUS_ACTIVE` after creation. - # * A line item cannot be changed back to `ENTITY_STATUS_DRAFT` status from - # any other status. - # * If the line item's parent insertion order is not active, the line item - # can't spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`. + # Required. Controls whether or not the line item can spend its budget and bid + # on inventory. * For CreateLineItem method, only `ENTITY_STATUS_DRAFT` is + # allowed. To activate a line item, use UpdateLineItem method and update the + # status to `ENTITY_STATUS_ACTIVE` after creation. * A line item cannot be + # changed back to `ENTITY_STATUS_DRAFT` status from any other status. * If the + # line item's parent insertion order is not active, the line item can't spend + # its budget even if its own status is `ENTITY_STATUS_ACTIVE`. # Corresponds to the JSON property `entityStatus` # @return [String] attr_accessor :entity_status @@ -5281,8 +4914,8 @@ module Google # @return [Google::Apis::DisplayvideoV1::LineItemFlight] attr_accessor :flight - # Settings that control the number of times a user may be shown with the same - # ad during a given time period. + # Settings that control the number of times a user may be shown with the same ad + # during a given time period. # Corresponds to the JSON property `frequencyCap` # @return [Google::Apis::DisplayvideoV1::FrequencyCap] attr_accessor :frequency_cap @@ -5323,10 +4956,9 @@ module Google # @return [Google::Apis::DisplayvideoV1::Pacing] attr_accessor :pacing - # The partner costs associated with the line item. - # If absent or empty in CreateLineItem - # method, the newly created line item will inherit partner costs from its - # parent insertion order. + # The partner costs associated with the line item. If absent or empty in + # CreateLineItem method, the newly created line item will inherit partner costs + # from its parent insertion order. # Corresponds to the JSON property `partnerCosts` # @return [Array] attr_accessor :partner_costs @@ -5375,33 +5007,29 @@ module Google class LineItemBudget include Google::Apis::Core::Hashable - # Required. The type of the budget allocation. - # `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when - # automatic budget allocation is enabled for the parent insertion order. + # Required. The type of the budget allocation. ` + # LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic + # budget allocation is enabled for the parent insertion order. # Corresponds to the JSON property `budgetAllocationType` # @return [String] attr_accessor :budget_allocation_type - # Output only. The budget unit specifies whether the budget is currency based - # or impression based. This value is inherited from the parent insertion - # order. + # Output only. The budget unit specifies whether the budget is currency based or + # impression based. This value is inherited from the parent insertion order. # Corresponds to the JSON property `budgetUnit` # @return [String] attr_accessor :budget_unit # The maximum budget amount the line item will spend. Must be greater than 0. - # When budget_allocation_type is: - # * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable - # and is set by the system. - # * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if - # budget_unit is: - # - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount - # to spend, in micros of the advertiser's currency. For example, 1500000 - # represents 1.5 standard units of the currency. - # - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number - # of impressions to serve. - # * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not - # applicable and will be ignored by the system. + # When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, + # this field is immutable and is set by the system. * ` + # LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - ` + # BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, + # in micros of the advertiser's currency. For example, 1500000 represents 1.5 + # standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field + # represents the maximum number of impressions to serve. * ` + # LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and + # will be ignored by the system. # Corresponds to the JSON property `maxAmount` # @return [Fixnum] attr_accessor :max_amount @@ -5443,24 +5071,19 @@ module Google end end - # Response message for - # ListAdvertiserAssignedTargetingOptions. + # Response message for ListAdvertiserAssignedTargetingOptions. class ListAdvertiserAssignedTargetingOptionsResponse include Google::Apis::Core::Hashable - # The list of assigned targeting options. - # This list will be absent if empty. + # The list of assigned targeting options. This list will be absent if empty. # Corresponds to the JSON property `assignedTargetingOptions` # @return [Array] attr_accessor :assigned_targeting_options - # A token identifying the next page of results. This value should be - # specified as the - # pageToken in a - # subsequent ListAdvertiserAssignedTargetingOptionsRequest to fetch the - # next page of results. This token will be absent if there are no more - # assigned_targeting_options - # to return. + # A token identifying the next page of results. This value should be specified + # as the pageToken in a subsequent ListAdvertiserAssignedTargetingOptionsRequest + # to fetch the next page of results. This token will be absent if there are no + # more assigned_targeting_options to return. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -5480,17 +5103,14 @@ module Google class ListAdvertisersResponse include Google::Apis::Core::Hashable - # The list of advertisers. - # This list will be absent if empty. + # The list of advertisers. This list will be absent if empty. # Corresponds to the JSON property `advertisers` # @return [Array] attr_accessor :advertisers - # A token to retrieve the next page of results. - # Pass this value in the - # page_token - # field in the subsequent call to `ListAdvertisers` method to retrieve the - # next page of results. + # A token to retrieve the next page of results. Pass this value in the + # page_token field in the subsequent call to `ListAdvertisers` method to + # retrieve the next page of results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -5506,22 +5126,19 @@ module Google end end - # Response message for - # AssignedInventorySourceService.ListAssignedInventorySources. + # Response message for AssignedInventorySourceService. + # ListAssignedInventorySources. class ListAssignedInventorySourcesResponse include Google::Apis::Core::Hashable - # The list of assigned inventory sources. - # This list will be absent if empty. + # The list of assigned inventory sources. This list will be absent if empty. # Corresponds to the JSON property `assignedInventorySources` # @return [Array] attr_accessor :assigned_inventory_sources - # A token to retrieve the next page of results. - # Pass this value in the - # page_token field - # in the subsequent call to `ListAssignedInventorySources` method to - # retrieve the next page of results. + # A token to retrieve the next page of results. Pass this value in the + # page_token field in the subsequent call to `ListAssignedInventorySources` + # method to retrieve the next page of results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -5537,21 +5154,17 @@ module Google end end - # Response message for - # AssignedLocationService.ListAssignedLocations. + # Response message for AssignedLocationService.ListAssignedLocations. class ListAssignedLocationsResponse include Google::Apis::Core::Hashable - # The list of assigned locations. - # This list will be absent if empty. + # The list of assigned locations. This list will be absent if empty. # Corresponds to the JSON property `assignedLocations` # @return [Array] attr_accessor :assigned_locations - # A token to retrieve the next page of results. - # Pass this value in the - # page_token field - # in the subsequent call to `ListAssignedLocations` method to + # A token to retrieve the next page of results. Pass this value in the + # page_token field in the subsequent call to `ListAssignedLocations` method to # retrieve the next page of results. # Corresponds to the JSON property `nextPageToken` # @return [String] @@ -5572,16 +5185,14 @@ module Google class ListCampaignsResponse include Google::Apis::Core::Hashable - # The list of campaigns. - # This list will be absent if empty. + # The list of campaigns. This list will be absent if empty. # Corresponds to the JSON property `campaigns` # @return [Array] attr_accessor :campaigns - # A token to retrieve the next page of results. - # Pass this value in the page_token field - # in the subsequent call to `ListCampaigns` method to retrieve the next page - # of results. + # A token to retrieve the next page of results. Pass this value in the + # page_token field in the subsequent call to `ListCampaigns` method to retrieve + # the next page of results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -5601,16 +5212,14 @@ module Google class ListChannelsResponse include Google::Apis::Core::Hashable - # The list of channels. - # This list will be absent if empty. + # The list of channels. This list will be absent if empty. # Corresponds to the JSON property `channels` # @return [Array] attr_accessor :channels - # A token to retrieve the next page of results. - # Pass this value in the page_token field - # in the subsequent call to `ListChannels` method to retrieve the next page - # of results. + # A token to retrieve the next page of results. Pass this value in the + # page_token field in the subsequent call to `ListChannels` method to retrieve + # the next page of results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -5630,17 +5239,14 @@ module Google class ListCombinedAudiencesResponse include Google::Apis::Core::Hashable - # The list of combined audiences. - # This list will be absent if empty. + # The list of combined audiences. This list will be absent if empty. # Corresponds to the JSON property `combinedAudiences` # @return [Array] attr_accessor :combined_audiences - # A token to retrieve the next page of results. - # Pass this value in the - # page_token - # field in the subsequent call to `ListCombinedAudiences` method to retrieve - # the next page of results. + # A token to retrieve the next page of results. Pass this value in the + # page_token field in the subsequent call to `ListCombinedAudiences` method to + # retrieve the next page of results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -5660,17 +5266,15 @@ module Google class ListCreativesResponse include Google::Apis::Core::Hashable - # The list of creatives. - # This list will be absent if empty. + # The list of creatives. This list will be absent if empty. # Corresponds to the JSON property `creatives` # @return [Array] attr_accessor :creatives - # A token to retrieve the next page of results. - # Pass this value in the page_token field - # in the subsequent call to `ListCreativesRequest` method to retrieve the - # next page of results. - # If this field is null, it means this is the last page. + # A token to retrieve the next page of results. Pass this value in the + # page_token field in the subsequent call to `ListCreativesRequest` method to + # retrieve the next page of results. If this field is null, it means this is the + # last page. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -5690,17 +5294,14 @@ module Google class ListCustomListsResponse include Google::Apis::Core::Hashable - # The list of custom lists. - # This list will be absent if empty. + # The list of custom lists. This list will be absent if empty. # Corresponds to the JSON property `customLists` # @return [Array] attr_accessor :custom_lists - # A token to retrieve the next page of results. - # Pass this value in the - # page_token - # field in the subsequent call to `ListCustomLists` method to retrieve the - # next page of results. + # A token to retrieve the next page of results. Pass this value in the + # page_token field in the subsequent call to `ListCustomLists` method to + # retrieve the next page of results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -5720,18 +5321,15 @@ module Google class ListFirstAndThirdPartyAudiencesResponse include Google::Apis::Core::Hashable - # The list of first and third party audiences. Audience size properties will - # not be included. - # This list will be absent if empty. + # The list of first and third party audiences. Audience size properties will not + # be included. This list will be absent if empty. # Corresponds to the JSON property `firstAndThirdPartyAudiences` # @return [Array] attr_accessor :first_and_third_party_audiences - # A token to retrieve the next page of results. - # Pass this value in the - # page_token - # field in the subsequent call to `ListFirstAndThirdPartyAudiences` method to - # retrieve the next page of results. + # A token to retrieve the next page of results. Pass this value in the + # page_token field in the subsequent call to `ListFirstAndThirdPartyAudiences` + # method to retrieve the next page of results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -5751,17 +5349,14 @@ module Google class ListGoogleAudiencesResponse include Google::Apis::Core::Hashable - # The list of Google audiences. - # This list will be absent if empty. + # The list of Google audiences. This list will be absent if empty. # Corresponds to the JSON property `googleAudiences` # @return [Array] attr_accessor :google_audiences - # A token to retrieve the next page of results. - # Pass this value in the - # page_token - # field in the subsequent call to `ListGoogleAudiences` method to retrieve - # the next page of results. + # A token to retrieve the next page of results. Pass this value in the + # page_token field in the subsequent call to `ListGoogleAudiences` method to + # retrieve the next page of results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -5781,16 +5376,14 @@ module Google class ListInsertionOrdersResponse include Google::Apis::Core::Hashable - # The list of insertion orders. - # This list will be absent if empty. + # The list of insertion orders. This list will be absent if empty. # Corresponds to the JSON property `insertionOrders` # @return [Array] attr_accessor :insertion_orders - # A token to retrieve the next page of results. - # Pass this value in the page_token - # field in the subsequent call to `ListInsertionOrders` method to retrieve - # the next page of results. + # A token to retrieve the next page of results. Pass this value in the + # page_token field in the subsequent call to `ListInsertionOrders` method to + # retrieve the next page of results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -5810,17 +5403,14 @@ module Google class ListInventorySourceGroupsResponse include Google::Apis::Core::Hashable - # The list of inventory source groups. - # This list will be absent if empty. + # The list of inventory source groups. This list will be absent if empty. # Corresponds to the JSON property `inventorySourceGroups` # @return [Array] attr_accessor :inventory_source_groups - # A token to retrieve the next page of results. - # Pass this value in the - # page_token - # field in the subsequent call to `ListInventorySourceGroups` method to - # retrieve the next page of results. + # A token to retrieve the next page of results. Pass this value in the + # page_token field in the subsequent call to `ListInventorySourceGroups` method + # to retrieve the next page of results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -5840,17 +5430,14 @@ module Google class ListInventorySourcesResponse include Google::Apis::Core::Hashable - # The list of inventory sources. - # This list will be absent if empty. + # The list of inventory sources. This list will be absent if empty. # Corresponds to the JSON property `inventorySources` # @return [Array] attr_accessor :inventory_sources - # A token to retrieve the next page of results. - # Pass this value in the - # page_token - # field in the subsequent call to `ListInventorySources` method to retrieve - # the next page of results. + # A token to retrieve the next page of results. Pass this value in the + # page_token field in the subsequent call to `ListInventorySources` method to + # retrieve the next page of results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -5866,24 +5453,19 @@ module Google end end - # Response message for - # ListLineItemAssignedTargetingOptions. + # Response message for ListLineItemAssignedTargetingOptions. class ListLineItemAssignedTargetingOptionsResponse include Google::Apis::Core::Hashable - # The list of assigned targeting options. - # This list will be absent if empty. + # The list of assigned targeting options. This list will be absent if empty. # Corresponds to the JSON property `assignedTargetingOptions` # @return [Array] attr_accessor :assigned_targeting_options - # A token identifying the next page of results. This value should be - # specified as the - # pageToken in a - # subsequent ListLineItemAssignedTargetingOptionsRequest to fetch the - # next page of results. This token will be absent if there are no more - # assigned_targeting_options - # to return. + # A token identifying the next page of results. This value should be specified + # as the pageToken in a subsequent ListLineItemAssignedTargetingOptionsRequest + # to fetch the next page of results. This token will be absent if there are no + # more assigned_targeting_options to return. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -5903,17 +5485,14 @@ module Google class ListLineItemsResponse include Google::Apis::Core::Hashable - # The list of line items. - # This list will be absent if empty. + # The list of line items. This list will be absent if empty. # Corresponds to the JSON property `lineItems` # @return [Array] attr_accessor :line_items - # A token to retrieve the next page of results. - # Pass this value in the - # page_token - # field in the subsequent call to `ListLineItems` method to retrieve the - # next page of results. + # A token to retrieve the next page of results. Pass this value in the + # page_token field in the subsequent call to `ListLineItems` method to retrieve + # the next page of results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -5933,17 +5512,14 @@ module Google class ListLocationListsResponse include Google::Apis::Core::Hashable - # The list of location lists. - # This list will be absent if empty. + # The list of location lists. This list will be absent if empty. # Corresponds to the JSON property `locationLists` # @return [Array] attr_accessor :location_lists - # A token to retrieve the next page of results. - # Pass this value in the - # page_token - # field in the subsequent call to `ListLocationLists` method to retrieve the - # next page of results. + # A token to retrieve the next page of results. Pass this value in the + # page_token field in the subsequent call to `ListLocationLists` method to + # retrieve the next page of results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -5963,17 +5539,14 @@ module Google class ListNegativeKeywordListsResponse include Google::Apis::Core::Hashable - # The list of negative keyword lists. - # This list will be absent if empty. + # The list of negative keyword lists. This list will be absent if empty. # Corresponds to the JSON property `negativeKeywordLists` # @return [Array] attr_accessor :negative_keyword_lists - # A token to retrieve the next page of results. - # Pass this value in the - # page_token - # field in the subsequent call to `ListNegativeKeywordLists` method to - # retrieve the next page of results. + # A token to retrieve the next page of results. Pass this value in the + # page_token field in the subsequent call to `ListNegativeKeywordLists` method + # to retrieve the next page of results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -5993,16 +5566,14 @@ module Google class ListNegativeKeywordsResponse include Google::Apis::Core::Hashable - # The list of negative keywords. - # This list will be absent if empty. + # The list of negative keywords. This list will be absent if empty. # Corresponds to the JSON property `negativeKeywords` # @return [Array] attr_accessor :negative_keywords - # A token to retrieve the next page of results. - # Pass this value in the page_token - # field in the subsequent call to `ListNegativeKeywords` method to retrieve - # the next page of results. + # A token to retrieve the next page of results. Pass this value in the + # page_token field in the subsequent call to `ListNegativeKeywords` method to + # retrieve the next page of results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -6022,16 +5593,14 @@ module Google class ListSitesResponse include Google::Apis::Core::Hashable - # A token to retrieve the next page of results. - # Pass this value in the page_token field - # in the subsequent call to `ListSites` method to retrieve the next page - # of results. + # A token to retrieve the next page of results. Pass this value in the + # page_token field in the subsequent call to `ListSites` method to retrieve the + # next page of results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token - # The list of sites. - # This list will be absent if empty. + # The list of sites. This list will be absent if empty. # Corresponds to the JSON property `sites` # @return [Array] attr_accessor :sites @@ -6047,22 +5616,18 @@ module Google end end - # Response message for - # ListTargetingOptions. + # Response message for ListTargetingOptions. class ListTargetingOptionsResponse include Google::Apis::Core::Hashable - # A token to retrieve the next page of results. - # Pass this value in the - # page_token - # field in the subsequent call to `ListTargetingOptions` method to retrieve - # the next page of results. + # A token to retrieve the next page of results. Pass this value in the + # page_token field in the subsequent call to `ListTargetingOptions` method to + # retrieve the next page of results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token - # The list of targeting options. - # This list will be absent if empty. + # The list of targeting options. This list will be absent if empty. # Corresponds to the JSON property `targetingOptions` # @return [Array] attr_accessor :targeting_options @@ -6088,8 +5653,8 @@ module Google # @return [Fixnum] attr_accessor :advertiser_id - # Required. The display name of the location list. - # Must be UTF-8 encoded with a maximum size of 240 bytes. + # Required. The display name of the location list. Must be UTF-8 encoded with a + # maximum size of 240 bytes. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name @@ -6135,8 +5700,8 @@ module Google # @return [Fixnum] attr_accessor :click_days - # Lookback window, in days, from the last time a given user viewed one of - # your ads. + # Lookback window, in days, from the last time a given user viewed one of your + # ads. # Corresponds to the JSON property `impressionDays` # @return [Fixnum] attr_accessor :impression_days @@ -6159,16 +5724,15 @@ module Google # The maximum average CPM that may be bid, in micros of the advertiser's # currency. Must be greater than or equal to a billable unit of the given - # currency. - # For example, 1500000 represents 1.5 standard units of the currency. + # currency. For example, 1500000 represents 1.5 standard units of the currency. # Corresponds to the JSON property `maxAverageCpmBidAmountMicros` # @return [Fixnum] attr_accessor :max_average_cpm_bid_amount_micros - # Required. The type of the performance goal that the bidding strategy - # tries to minimize while spending the full budget. - # `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for - # this strategy. + # Required. The type of the performance goal that the bidding strategy tries to + # minimize while spending the full budget. ` + # BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this + # strategy. # Corresponds to the JSON property `performanceGoalType` # @return [String] attr_accessor :performance_goal_type @@ -6193,18 +5757,17 @@ module Google # @return [String] attr_accessor :currency_code - # Number of nano (10^-9) units of the amount. - # The value must be between -999,999,999 and +999,999,999 inclusive. - # If `units` is positive, `nanos` must be positive or zero. - # If `units` is zero, `nanos` can be positive, zero, or negative. - # If `units` is negative, `nanos` must be negative or zero. - # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. + # Number of nano (10^-9) units of the amount. The value must be between -999,999, + # 999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be + # positive or zero. If `units` is zero, `nanos` can be positive, zero, or + # negative. If `units` is negative, `nanos` must be negative or zero. For + # example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. # Corresponds to the JSON property `nanos` # @return [Fixnum] attr_accessor :nanos - # The whole units of the amount. - # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. + # The whole units of the amount. For example if `currencyCode` is `"USD"`, then + # 1 unit is one US dollar. # Corresponds to the JSON property `units` # @return [Fixnum] attr_accessor :units @@ -6226,12 +5789,11 @@ module Google include Google::Apis::Core::Hashable # Required. Immutable. The negatively targeted keyword, for example `car - # insurance`. - # Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number - # of characters is 80. Maximum number of words is 10. - # Valid characters are restricted to ASCII characters only. The only - # URL-escaping permitted is for representing whitespace between words. - # Leading or trailing whitespace is ignored. + # insurance`. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum + # number of characters is 80. Maximum number of words is 10. Valid characters + # are restricted to ASCII characters only. The only URL-escaping permitted is + # for representing whitespace between words. Leading or trailing whitespace is + # ignored. # Corresponds to the JSON property `keywordValue` # @return [String] attr_accessor :keyword_value @@ -6262,8 +5824,8 @@ module Google # @return [Fixnum] attr_accessor :advertiser_id - # Required. The display name of the negative keyword list. - # Must be UTF-8 encoded with a maximum size of 255 bytes. + # Required. The display name of the negative keyword list. Must be UTF-8 encoded + # with a maximum size of 255 bytes. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name @@ -6293,15 +5855,13 @@ module Google end # Targeting details for negative keyword list. This will be populated in the - # details field of an AssignedTargetingOption when - # targeting_type is - # `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. + # details field of an AssignedTargetingOption when targeting_type is ` + # TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. class NegativeKeywordListAssignedTargetingOptionDetails include Google::Apis::Core::Hashable # Required. ID of the negative keyword list. Should refer to the - # negative_keyword_list_id - # field of a NegativeKeywordList resource. + # negative_keyword_list_id field of a NegativeKeywordList resource. # Corresponds to the JSON property `negativeKeywordListId` # @return [Fixnum] attr_accessor :negative_keyword_list_id @@ -6320,10 +5880,8 @@ module Google class ObaIcon include Google::Apis::Core::Hashable - # Required. The click tracking URL of the OBA icon. - # Only URLs of the following domains are allowed: - # * https://info.evidon.com - # * https://l.betrad.com + # Required. The click tracking URL of the OBA icon. Only URLs of the following + # domains are allowed: * https://info.evidon.com * https://l.betrad.com # Corresponds to the JSON property `clickTrackingUrl` # @return [String] attr_accessor :click_tracking_url @@ -6333,10 +5891,8 @@ module Google # @return [Google::Apis::DisplayvideoV1::Dimensions] attr_accessor :dimensions - # Required. The landing page URL of the OBA icon. - # Only URLs of the following domains are allowed: - # * https://info.evidon.com - # * https://l.betrad.com + # Required. The landing page URL of the OBA icon. Only URLs of the following + # domains are allowed: * https://info.evidon.com * https://l.betrad.com # Corresponds to the JSON property `landingPageUrl` # @return [String] attr_accessor :landing_page_url @@ -6361,10 +5917,8 @@ module Google # @return [String] attr_accessor :resource_url - # Required. The view tracking URL of the OBA icon. - # Only URLs of the following domains are allowed: - # * https://info.evidon.com - # * https://l.betrad.com + # Required. The view tracking URL of the OBA icon. Only URLs of the following + # domains are allowed: * https://info.evidon.com * https://l.betrad.com # Corresponds to the JSON property `viewTrackingUrl` # @return [String] attr_accessor :view_tracking_url @@ -6386,12 +5940,9 @@ module Google end end - # On screen position targeting option details. This will be - # populated in the - # on_screen_position_details - # field when - # targeting_type is - # `TARGETING_TYPE_ON_SCREEN_POSITION`. + # On screen position targeting option details. This will be populated in the + # on_screen_position_details field when targeting_type is ` + # TARGETING_TYPE_ON_SCREEN_POSITION`. class OnScreenPositionAssignedTargetingOptionDetails include Google::Apis::Core::Hashable @@ -6400,9 +5951,8 @@ module Google # @return [String] attr_accessor :on_screen_position - # Required. The targeting_option_id field when - # targeting_type is - # `TARGETING_TYPE_ON_SCREEN_POSITION`. + # Required. The targeting_option_id field when targeting_type is ` + # TARGETING_TYPE_ON_SCREEN_POSITION`. # Corresponds to the JSON property `targetingOptionId` # @return [String] attr_accessor :targeting_option_id @@ -6418,12 +5968,9 @@ module Google end end - # Represents a targetable on screen position, which could be used by display - # and video ads. This will be populated in the - # on_screen_position_details - # field when - # targeting_type is - # `TARGETING_TYPE_ON_SCREEN_POSITION`. + # Represents a targetable on screen position, which could be used by display and + # video ads. This will be populated in the on_screen_position_details field when + # targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`. class OnScreenPositionTargetingOptionDetails include Google::Apis::Core::Hashable @@ -6442,12 +5989,9 @@ module Google end end - # Assigned operating system targeting option details. This will be - # populated in the - # operating_system_details - # field when - # targeting_type is - # `TARGETING_TYPE_OPERATING_SYSTEM`. + # Assigned operating system targeting option details. This will be populated in + # the operating_system_details field when targeting_type is ` + # TARGETING_TYPE_OPERATING_SYSTEM`. class OperatingSystemAssignedTargetingOptionDetails include Google::Apis::Core::Hashable @@ -6462,10 +6006,8 @@ module Google attr_accessor :negative alias_method :negative?, :negative - # Required. The targeting option ID populated in - # targeting_option_id field when - # targeting_type is - # `TARGETING_TYPE_OPERATING_SYSTEM`. + # Required. The targeting option ID populated in targeting_option_id field when + # targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`. # Corresponds to the JSON property `targetingOptionId` # @return [String] attr_accessor :targeting_option_id @@ -6483,10 +6025,8 @@ module Google end # Represents a targetable operating system. This will be populated in the - # operating_system_details field - # of a TargetingOption when - # targeting_type is - # `TARGETING_TYPE_OPERATING_SYSTEM`. + # operating_system_details field of a TargetingOption when targeting_type is ` + # TARGETING_TYPE_OPERATING_SYSTEM`. class OperatingSystemTargetingOptionDetails include Google::Apis::Core::Hashable @@ -6510,47 +6050,45 @@ module Google class Operation include Google::Apis::Core::Hashable - # If the value is `false`, it means the operation is still in progress. - # If `true`, the operation is completed, and either `error` or `response` is - # available. + # If the value is `false`, it means the operation is still in progress. If `true` + # , the operation is completed, and either `error` or `response` is available. # Corresponds to the JSON property `done` # @return [Boolean] attr_accessor :done alias_method :done?, :done - # The `Status` type defines a logical error model that is suitable for - # different programming environments, including REST APIs and RPC APIs. It is - # used by [gRPC](https://github.com/grpc). Each `Status` message contains - # three pieces of data: error code, error message, and error details. - # You can find out more about this error model and how to work with it in the - # [API Design Guide](https://cloud.google.com/apis/design/errors). + # The `Status` type defines a logical error model that is suitable for different + # programming environments, including REST APIs and RPC APIs. It is used by [ + # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of + # data: error code, error message, and error details. You can find out more + # about this error model and how to work with it in the [API Design Guide](https: + # //cloud.google.com/apis/design/errors). # Corresponds to the JSON property `error` # @return [Google::Apis::DisplayvideoV1::Status] attr_accessor :error - # Service-specific metadata associated with the operation. It typically - # contains progress information and common metadata such as create time. - # Some services might not provide such metadata. Any method that returns a - # long-running operation should document the metadata type, if any. + # Service-specific metadata associated with the operation. It typically contains + # progress information and common metadata such as create time. Some services + # might not provide such metadata. Any method that returns a long-running + # operation should document the metadata type, if any. # Corresponds to the JSON property `metadata` # @return [Hash] attr_accessor :metadata # 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 be a resource name ending with `operations/`unique_id``. + # originally returns it. If you use the default HTTP mapping, the `name` should + # be a resource name ending with `operations/`unique_id``. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # The normal response of the operation in case of success. If the original - # method returns no data on success, such as `Delete`, the response is - # `google.protobuf.Empty`. If the original method is standard - # `Get`/`Create`/`Update`, the response should be the resource. For other - # methods, the response should have the type `XxxResponse`, where `Xxx` - # is the original method name. For example, if the original method name - # is `TakeSnapshot()`, the inferred response type is - # `TakeSnapshotResponse`. + # The normal response of the operation in case of success. If the original + # method returns no data on success, such as `Delete`, the response is `google. + # protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, + # the response should be the resource. For other methods, the response should + # have the type `XxxResponse`, where `Xxx` is the original method name. For + # example, if the original method name is `TakeSnapshot()`, the inferred + # response type is `TakeSnapshotResponse`. # Corresponds to the JSON property `response` # @return [Hash] attr_accessor :response @@ -6573,39 +6111,36 @@ module Google class Pacing include Google::Apis::Core::Hashable - # Maximum number of impressions to serve every day. - # Applicable when the budget is impression based. Must be greater than 0. + # Maximum number of impressions to serve every day. Applicable when the budget + # is impression based. Must be greater than 0. # Corresponds to the JSON property `dailyMaxImpressions` # @return [Fixnum] attr_accessor :daily_max_impressions - # Maximum currency amount to spend every day in micros of - # advertiser's currency. - # Applicable when the budget is currency based. Must be greater than 0. - # For example, for 1.5 standard unit of the currency, set this field to - # 1500000. - # The value assigned will be rounded to whole billable units for the - # relevant currency by the following rules: any positive value less than a - # single billable unit will be rounded up to one billable unit and any - # value larger than a single billable unit will be rounded down to the - # nearest billable value. For example, if the currency's billable unit is - # 0.01, and this field is set to 10257770, it will round down to 10250000, - # a value of 10.25. If set to 505, it will round up to 10000, a value of - # 0.01. + # Maximum currency amount to spend every day in micros of advertiser's currency. + # Applicable when the budget is currency based. Must be greater than 0. For + # example, for 1.5 standard unit of the currency, set this field to 1500000. The + # value assigned will be rounded to whole billable units for the relevant + # currency by the following rules: any positive value less than a single + # billable unit will be rounded up to one billable unit and any value larger + # than a single billable unit will be rounded down to the nearest billable value. + # For example, if the currency's billable unit is 0.01, and this field is set + # to 10257770, it will round down to 10250000, a value of 10.25. If set to 505, + # it will round up to 10000, a value of 0.01. # Corresponds to the JSON property `dailyMaxMicros` # @return [Fixnum] attr_accessor :daily_max_micros - # Required. The time period in which the pacing budget will be spent. - # When automatic budget allocation is enabled at the insertion order via - # auto_budget_allocation, this - # field is output only and defaults to `PACING_PERIOD_FLIGHT`. + # Required. The time period in which the pacing budget will be spent. When + # automatic budget allocation is enabled at the insertion order via + # auto_budget_allocation, this field is output only and defaults to ` + # PACING_PERIOD_FLIGHT`. # Corresponds to the JSON property `pacingPeriod` # @return [String] attr_accessor :pacing_period - # Required. The type of pacing that defines how the budget amount will be - # spent across the pacing_period. + # Required. The type of pacing that defines how the budget amount will be spent + # across the pacing_period. # Corresponds to the JSON property `pacingType` # @return [String] attr_accessor :pacing_type @@ -6633,9 +6168,8 @@ module Google # @return [Array] attr_accessor :file_type - # The IDs of the specified filter type. This is used to filter entities to - # fetch. If filter type is not `FILTER_TYPE_NONE`, at least one ID must be - # specified. + # The IDs of the specified filter type. This is used to filter entities to fetch. + # If filter type is not `FILTER_TYPE_NONE`, at least one ID must be specified. # Corresponds to the JSON property `filterIds` # @return [Array] attr_accessor :filter_ids @@ -6657,10 +6191,9 @@ module Google end end - # Details for assigned parental status targeting option. This will be - # populated in the details field of an AssignedTargetingOption when - # targeting_type is - # `TARTGETING_TYPE_PARENTAL_STATUS`. + # Details for assigned parental status targeting option. This will be populated + # in the details field of an AssignedTargetingOption when targeting_type is ` + # TARTGETING_TYPE_PARENTAL_STATUS`. class ParentalStatusAssignedTargetingOptionDetails include Google::Apis::Core::Hashable @@ -6669,8 +6202,8 @@ module Google # @return [String] attr_accessor :parental_status - # Required. The targeting_option_id of a - # TargetingOption of type `TARGETING_TYPE_PARENTAL_STATUS`. + # Required. The targeting_option_id of a TargetingOption of type ` + # TARGETING_TYPE_PARENTAL_STATUS`. # Corresponds to the JSON property `targetingOptionId` # @return [String] attr_accessor :targeting_option_id @@ -6687,9 +6220,8 @@ module Google end # Represents a targetable parental status. This will be populated in the - # parental_status_details field of a - # TargetingOption when targeting_type is - # `TARGETING_TYPE_PARENTAL_STATUS`. + # parental_status_details field of a TargetingOption when targeting_type is ` + # TARGETING_TYPE_PARENTAL_STATUS`. class ParentalStatusTargetingOptionDetails include Google::Apis::Core::Hashable @@ -6708,12 +6240,11 @@ module Google end end - # Settings that control a partner cost. - # A partner cost is any type of expense involved in running a campaign, other - # than the costs of purchasing impressions (which is called the media cost) - # and using third-party audience segment data (data fee). Some examples of - # partner costs include the fees for using DV360, a third-party ad server, - # or a third-party ad serving verification service. + # Settings that control a partner cost. A partner cost is any type of expense + # involved in running a campaign, other than the costs of purchasing impressions + # (which is called the media cost) and using third-party audience segment data ( + # data fee). Some examples of partner costs include the fees for using DV360, a + # third-party ad server, or a third-party ad serving verification service. class PartnerCost include Google::Apis::Core::Hashable @@ -6722,18 +6253,16 @@ module Google # @return [String] attr_accessor :cost_type - # The CPM fee amount in micros of advertiser's currency. - # Applicable when the fee_type is - # `PARTNER_FEE_TYPE_CPM_FEE`. Must be greater than or equal to 0. - # For example, for 1.5 standard unit of the advertiser's currency, set - # this field to 1500000. + # The CPM fee amount in micros of advertiser's currency. Applicable when the + # fee_type is `PARTNER_FEE_TYPE_CPM_FEE`. Must be greater than or equal to 0. + # For example, for 1.5 standard unit of the advertiser's currency, set this + # field to 1500000. # Corresponds to the JSON property `feeAmount` # @return [Fixnum] attr_accessor :fee_amount - # The media fee percentage in millis (1/1000 of a percent). - # Applicable when the fee_type is - # `PARTNER_FEE_TYPE_MEDIA_FEE`. Must be greater than or equal to 0. + # The media fee percentage in millis (1/1000 of a percent). Applicable when the + # fee_type is `PARTNER_FEE_TYPE_MEDIA_FEE`. Must be greater than or equal to 0. # For example: 100 represents 0.1%. # Corresponds to the JSON property `feePercentageMillis` # @return [Fixnum] @@ -6744,12 +6273,9 @@ module Google # @return [String] attr_accessor :fee_type - # The invoice type for this partner cost. - # * Required when cost_type is one of: - # - `PARTNER_COST_TYPE_ADLOOX` - # - `PARTNER_COST_TYPE_DOUBLE_VERIFY` - # - `PARTNER_COST_TYPE_INTEGRAL_AD_SCIENCE`. - # * Output only for other types. + # The invoice type for this partner cost. * Required when cost_type is one of: - + # `PARTNER_COST_TYPE_ADLOOX` - `PARTNER_COST_TYPE_DOUBLE_VERIFY` - ` + # PARTNER_COST_TYPE_INTEGRAL_AD_SCIENCE`. * Output only for other types. # Corresponds to the JSON property `invoiceType` # @return [String] attr_accessor :invoice_type @@ -6772,20 +6298,17 @@ module Google class PartnerRevenueModel include Google::Apis::Core::Hashable - # Required. The markup amount of the partner revenue model. - # Must be greater than or equal to 0. - # * When the markup_type is set to be - # `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`, this field represents the CPM - # markup in micros of advertiser's currency. For example, 1500000 - # represents 1.5 standard units of the currency. - # * When the markup_type is set to be - # `PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP`, this field - # represents the media cost percent markup in millis. For example, - # 100 represents 0.1% (decimal 0.001). - # * When the markup_type is set to be - # `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`, this field - # represents the total media cost percent markup in millis. For example, - # 100 represents 0.1% (decimal 0.001). + # Required. The markup amount of the partner revenue model. Must be greater than + # or equal to 0. * When the markup_type is set to be ` + # PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`, this field represents the CPM markup + # in micros of advertiser's currency. For example, 1500000 represents 1.5 + # standard units of the currency. * When the markup_type is set to be ` + # PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP`, this field represents + # the media cost percent markup in millis. For example, 100 represents 0.1% ( + # decimal 0.001). * When the markup_type is set to be ` + # PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`, this field + # represents the total media cost percent markup in millis. For example, 100 + # represents 0.1% (decimal 0.001). # Corresponds to the JSON property `markupAmount` # @return [Fixnum] attr_accessor :markup_amount @@ -6810,33 +6333,26 @@ module Google class PerformanceGoal include Google::Apis::Core::Hashable - # The goal amount, in micros of the advertiser's currency. - # Applicable when - # performance_goal_type is one of: - # * `PERFORMANCE_GOAL_TYPE_CPM` - # * `PERFORMANCE_GOAL_TYPE_CPC` - # * `PERFORMANCE_GOAL_TYPE_CPA` - # * `PERFORMANCE_GOAL_TYPE_CPIAVC` - # For example 1500000 represents 1.5 standard units of the currency. + # The goal amount, in micros of the advertiser's currency. Applicable when + # performance_goal_type is one of: * `PERFORMANCE_GOAL_TYPE_CPM` * ` + # PERFORMANCE_GOAL_TYPE_CPC` * `PERFORMANCE_GOAL_TYPE_CPA` * ` + # PERFORMANCE_GOAL_TYPE_CPIAVC` For example 1500000 represents 1.5 standard + # units of the currency. # Corresponds to the JSON property `performanceGoalAmountMicros` # @return [Fixnum] attr_accessor :performance_goal_amount_micros - # The decimal representation of the goal percentage in micros. - # Applicable when - # performance_goal_type is one of: - # * `PERFORMANCE_GOAL_TYPE_CTR` - # * `PERFORMANCE_GOAL_TYPE_VIEWABILITY` - # For example, 70000 represents 7% (decimal 0.07). + # The decimal representation of the goal percentage in micros. Applicable when + # performance_goal_type is one of: * `PERFORMANCE_GOAL_TYPE_CTR` * ` + # PERFORMANCE_GOAL_TYPE_VIEWABILITY` For example, 70000 represents 7% (decimal 0. + # 07). # Corresponds to the JSON property `performanceGoalPercentageMicros` # @return [Fixnum] attr_accessor :performance_goal_percentage_micros - # A key performance indicator (KPI) string, which can be empty. - # Must be UTF-8 encoded with a length of no more than 100 characters. - # Applicable when - # performance_goal_type is set to - # `PERFORMANCE_GOAL_TYPE_OTHER`. + # A key performance indicator (KPI) string, which can be empty. Must be UTF-8 + # encoded with a length of no more than 100 characters. Applicable when + # performance_goal_type is set to `PERFORMANCE_GOAL_TYPE_OTHER`. # Corresponds to the JSON property `performanceGoalString` # @return [String] attr_accessor :performance_goal_string @@ -6866,55 +6382,41 @@ module Google # The maximum average CPM that may be bid, in micros of the advertiser's # currency. Must be greater than or equal to a billable unit of the given - # currency. Not applicable when - # performance_goal_type - # is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. - # For example, 1500000 represents 1.5 standard units of the currency. + # currency. Not applicable when performance_goal_type is set to ` + # BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. For example, 1500000 + # represents 1.5 standard units of the currency. # Corresponds to the JSON property `maxAverageCpmBidAmountMicros` # @return [Fixnum] attr_accessor :max_average_cpm_bid_amount_micros - # Required. The performance goal the bidding strategy will attempt to - # meet or beat, in micros of the advertiser's currency or in micro of the - # ROAS (Return On Advertising Spend) value which is also based on - # advertiser's currency. Must be greater than or equal to a billable unit of - # the given currency and smaller or equal to upper bounds. Each - # performance_goal_type - # has its upper bound: - # * when - # performance_goal_type - # is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, - # upper bound is 10000.00 USD. - # * when - # performance_goal_type - # is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, - # upper bound is 1000.00 USD. - # * when - # performance_goal_type - # is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is - # 1000.00 USD. - # * when - # performance_goal_type - # is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`, upper bound is - # 1000.00 and lower bound is 0.01. - # Example: If set to - # `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will - # be based on the probability that each available impression will be - # viewable. For example, if viewable CPM target is $2 and an impression is - # 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2). - # For example, 1500000 represents 1.5 standard units of the currency or ROAS - # value. + # Required. The performance goal the bidding strategy will attempt to meet or + # beat, in micros of the advertiser's currency or in micro of the ROAS (Return + # On Advertising Spend) value which is also based on advertiser's currency. Must + # be greater than or equal to a billable unit of the given currency and smaller + # or equal to upper bounds. Each performance_goal_type has its upper bound: * + # when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, + # upper bound is 10000.00 USD. * when performance_goal_type is ` + # BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, upper bound is 1000.00 USD. * + # when performance_goal_type is ` + # BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is 1000.00 + # USD. * when performance_goal_type is ` + # BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`, upper bound is 1000.00 + # and lower bound is 0.01. Example: If set to ` + # BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will be + # based on the probability that each available impression will be viewable. For + # example, if viewable CPM target is $2 and an impression is 40% likely to be + # viewable, the bid price will be $0.80 CPM (40% of $2). For example, 1500000 + # represents 1.5 standard units of the currency or ROAS value. # Corresponds to the JSON property `performanceGoalAmountMicros` # @return [Fixnum] attr_accessor :performance_goal_amount_micros - # Required. The type of the performance goal that the bidding strategy - # will try to meet or beat. - # For line item level usage, the value must be one of: - # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` - # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` - # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` - # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. + # Required. The type of the performance goal that the bidding strategy will try + # to meet or beat. For line item level usage, the value must be one of: * ` + # BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * ` + # BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * ` + # BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` * ` + # BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. # Corresponds to the JSON property `performanceGoalType` # @return [String] attr_accessor :performance_goal_type @@ -6931,28 +6433,24 @@ module Google end end - # Targeting details for proximity location list. This will be - # populated in the details field of an AssignedTargetingOption when - # targeting_type is - # `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`. + # Targeting details for proximity location list. This will be populated in the + # details field of an AssignedTargetingOption when targeting_type is ` + # TARGETING_TYPE_PROXIMITY_LOCATION_LIST`. class ProximityLocationListAssignedTargetingOptionDetails include Google::Apis::Core::Hashable # Required. ID of the proximity location list. Should refer to the - # location_list_id field of a - # LocationList resource whose type is - # `TARGETING_LOCATION_TYPE_PROXIMITY`. + # location_list_id field of a LocationList resource whose type is ` + # TARGETING_LOCATION_TYPE_PROXIMITY`. # Corresponds to the JSON property `proximityLocationListId` # @return [Fixnum] attr_accessor :proximity_location_list_id - # Required. Radius range for proximity location list. - # This represents the size of the area around a chosen location that will be - # targeted. - # `All` proximity location targeting under a single line item must have the - # same radius range value. Set this value to match any existing targeting. - # If updated, this field will change the radius range for all proximity - # targeting under the line item. + # Required. Radius range for proximity location list. This represents the size + # of the area around a chosen location that will be targeted. `All` proximity + # location targeting under a single line item must have the same radius range + # value. Set this value to match any existing targeting. If updated, this field + # will change the radius range for all proximity targeting under the line item. # Corresponds to the JSON property `proximityRadiusRange` # @return [String] attr_accessor :proximity_radius_range @@ -6997,10 +6495,8 @@ module Google class RateDetails include Google::Apis::Core::Hashable - # The rate type. - # Acceptable values are `INVENTORY_SOURCE_RATE_TYPE_CPM_FIXED`, - # `INVENTORY_SOURCE_RATE_TYPE_CPM_FLOOR`, and - # `INVENTORY_SOURCE_RATE_TYPE_CPD`. + # The rate type. Acceptable values are `INVENTORY_SOURCE_RATE_TYPE_CPM_FIXED`, ` + # INVENTORY_SOURCE_RATE_TYPE_CPM_FLOOR`, and `INVENTORY_SOURCE_RATE_TYPE_CPD`. # Corresponds to the JSON property `inventorySourceRateType` # @return [String] attr_accessor :inventory_source_rate_type @@ -7015,8 +6511,8 @@ module Google # @return [Google::Apis::DisplayvideoV1::Money] attr_accessor :rate - # Required for guaranteed inventory sources. - # The number of impressions guaranteed by the seller. + # Required for guaranteed inventory sources. The number of impressions + # guaranteed by the seller. # Corresponds to the JSON property `unitsPurchased` # @return [Fixnum] attr_accessor :units_purchased @@ -7034,10 +6530,9 @@ module Google end end - # Targeting details for regional location list. This will be - # populated in the details field of an AssignedTargetingOption when - # targeting_type is - # `TARGETING_TYPE_REGIONAL_LOCATION_LIST`. + # Targeting details for regional location list. This will be populated in the + # details field of an AssignedTargetingOption when targeting_type is ` + # TARGETING_TYPE_REGIONAL_LOCATION_LIST`. class RegionalLocationListAssignedTargetingOptionDetails include Google::Apis::Core::Hashable @@ -7048,8 +6543,8 @@ module Google alias_method :negative?, :negative # Required. ID of the regional location list. Should refer to the - # location_list_id field of a - # LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`. + # location_list_id field of a LocationList resource whose type is ` + # TARGETING_LOCATION_TYPE_REGIONAL`. # Corresponds to the JSON property `regionalLocationListId` # @return [Fixnum] attr_accessor :regional_location_list_id @@ -7069,10 +6564,8 @@ module Google class ReviewStatusInfo include Google::Apis::Core::Hashable - # Represents the basic approval needed for a creative to begin serving. - # Summary of - # creative_and_landing_page_review_status - # and + # Represents the basic approval needed for a creative to begin serving. Summary + # of creative_and_landing_page_review_status and # content_and_policy_review_status. # Corresponds to the JSON property `approvalStatus` # @return [String] @@ -7116,8 +6609,8 @@ module Google class SdfConfig include Google::Apis::Core::Hashable - # An administrator email address to which the SDF processing status reports - # will be sent. + # An administrator email address to which the SDF processing status reports will + # be sent. # Corresponds to the JSON property `adminEmail` # @return [String] attr_accessor :admin_email @@ -7138,17 +6631,15 @@ module Google end end - # Type for the response returned - # by [SdfDownloadTaskService.CreateSdfDownloadTask]. + # Type for the response returned by [SdfDownloadTaskService. + # CreateSdfDownloadTask]. class SdfDownloadTask include Google::Apis::Core::Hashable - # A resource name to be used in - # media.download to Download the prepared - # files. Resource names have the format - # `download/sdfdownloadtasks/media/`media_id``. `media_id` will be made - # available by the long running operation service once the task status is - # done. + # A resource name to be used in media.download to Download the prepared files. + # Resource names have the format `download/sdfdownloadtasks/media/`media_id``. ` + # media_id` will be made available by the long running operation service once + # the task status is done. # Corresponds to the JSON property `resourceName` # @return [String] attr_accessor :resource_name @@ -7163,8 +6654,8 @@ module Google end end - # Type for the metadata returned - # by [SdfDownloadTaskService.CreateSdfDownloadTask]. + # Type for the metadata returned by [SdfDownloadTaskService. + # CreateSdfDownloadTask]. class SdfDownloadTaskMetadata include Google::Apis::Core::Hashable @@ -7196,9 +6687,8 @@ module Google end # Targeting details for sensitive category. This will be populated in the - # details field of an AssignedTargetingOption when - # targeting_type is - # `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. + # details field of an AssignedTargetingOption when targeting_type is ` + # TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. class SensitiveCategoryAssignedTargetingOptionDetails include Google::Apis::Core::Hashable @@ -7223,11 +6713,8 @@ module Google end end - # Represents a targetable sensitive category. This will be - # populated in the - # sensitive_category_details - # field of the TargetingOption when - # targeting_type is + # Represents a targetable sensitive category. This will be populated in the + # sensitive_category_details field of the TargetingOption when targeting_type is # `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. class SensitiveCategoryTargetingOptionDetails include Google::Apis::Core::Hashable @@ -7256,8 +6743,8 @@ module Google # @return [String] attr_accessor :name - # Required. The URL or app ID of the site. - # Must be UTF-8 encoded with a maximum length of 240 bytes. + # Required. The URL or app ID of the site. Must be UTF-8 encoded with a maximum + # length of 240 bytes. # Corresponds to the JSON property `urlOrAppId` # @return [String] attr_accessor :url_or_app_id @@ -7273,12 +6760,12 @@ module Google end end - # The `Status` type defines a logical error model that is suitable for - # different programming environments, including REST APIs and RPC APIs. It is - # used by [gRPC](https://github.com/grpc). Each `Status` message contains - # three pieces of data: error code, error message, and error details. - # You can find out more about this error model and how to work with it in the - # [API Design Guide](https://cloud.google.com/apis/design/errors). + # The `Status` type defines a logical error model that is suitable for different + # programming environments, including REST APIs and RPC APIs. It is used by [ + # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of + # data: error code, error message, and error details. You can find out more + # about this error model and how to work with it in the [API Design Guide](https: + # //cloud.google.com/apis/design/errors). class Status include Google::Apis::Core::Hashable @@ -7287,15 +6774,15 @@ module Google # @return [Fixnum] attr_accessor :code - # A list of messages that carry the error details. There is a common set of + # A list of messages that carry the error details. There is a common set of # message types for APIs to use. # Corresponds to the JSON property `details` # @return [Array>] attr_accessor :details - # A developer-facing error message, which should be in English. Any - # user-facing error message should be localized and sent in the - # google.rpc.Status.details field, or localized by the client. + # A developer-facing error message, which should be in English. Any user-facing + # error message should be localized and sent in the google.rpc.Status.details + # field, or localized by the client. # Corresponds to the JSON property `message` # @return [String] attr_accessor :message @@ -7313,14 +6800,13 @@ module Google end # Details for assigned sub-exchange targeting option. This will be populated in - # the details field of an AssignedTargetingOption when - # targeting_type is - # `TARGETING_TYPE_SUB_EXCHANGE`. + # the details field of an AssignedTargetingOption when targeting_type is ` + # TARGETING_TYPE_SUB_EXCHANGE`. class SubExchangeAssignedTargetingOptionDetails include Google::Apis::Core::Hashable - # Required. The targeting_option_id of a - # TargetingOption of type `TARGETING_TYPE_SUB_EXCHANGE`. + # Required. The targeting_option_id of a TargetingOption of type ` + # TARGETING_TYPE_SUB_EXCHANGE`. # Corresponds to the JSON property `targetingOptionId` # @return [String] attr_accessor :targeting_option_id @@ -7336,10 +6822,8 @@ module Google end # Represents a targetable sub-exchange. This will be populated in the - # sub_exchange_details field - # of a TargetingOption when - # targeting_type is - # `TARGETING_TYPE_SUB_EXCHANGE`. + # sub_exchange_details field of a TargetingOption when targeting_type is ` + # TARGETING_TYPE_SUB_EXCHANGE`. class SubExchangeTargetingOptionDetails include Google::Apis::Core::Hashable @@ -7358,15 +6842,12 @@ module Google end end - # Represents a single targeting option, which is a targetable concept in - # DV360. + # Represents a single targeting option, which is a targetable concept in DV360. class TargetingOption include Google::Apis::Core::Hashable # Represents a targetable age range. This will be populated in the - # age_range_details field when - # targeting_type is - # `TARGETING_TYPE_AGE_RANGE`. + # age_range_details field when targeting_type is `TARGETING_TYPE_AGE_RANGE`. # Corresponds to the JSON property `ageRangeDetails` # @return [Google::Apis::DisplayvideoV1::AgeRangeTargetingOptionDetails] attr_accessor :age_range_details @@ -7374,137 +6855,111 @@ module Google # Represents a targetable collection of apps. A collection lets you target # dynamic groups of related apps that are maintained by the platform, for # example `All Apps/Google Play/Games`. This will be populated in the - # app_category_details field when - # targeting_type is - # `TARGETING_TYPE_APP_CATEGORY`. + # app_category_details field when targeting_type is `TARGETING_TYPE_APP_CATEGORY` + # . # Corresponds to the JSON property `appCategoryDetails` # @return [Google::Apis::DisplayvideoV1::AppCategoryTargetingOptionDetails] attr_accessor :app_category_details # Represents a targetable authorized seller status. This will be populated in - # the - # authorized_seller_status_details - # field when targeting_type is - # `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. + # the authorized_seller_status_details field when targeting_type is ` + # TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. # Corresponds to the JSON property `authorizedSellerStatusDetails` # @return [Google::Apis::DisplayvideoV1::AuthorizedSellerStatusTargetingOptionDetails] attr_accessor :authorized_seller_status_details - # Represents a targetable browser. This will be populated in the - # browser_details field when - # targeting_type is - # `TARGETING_TYPE_BROWSER`. + # Represents a targetable browser. This will be populated in the browser_details + # field when targeting_type is `TARGETING_TYPE_BROWSER`. # Corresponds to the JSON property `browserDetails` # @return [Google::Apis::DisplayvideoV1::BrowserTargetingOptionDetails] attr_accessor :browser_details # Represents a targetable carrier or ISP. This will be populated in the - # carrier_and_isp_details field of - # a TargetingOption when - # targeting_type is - # `TARGETING_TYPE_CARRIER_AND_ISP`. + # carrier_and_isp_details field of a TargetingOption when targeting_type is ` + # TARGETING_TYPE_CARRIER_AND_ISP`. # Corresponds to the JSON property `carrierAndIspDetails` # @return [Google::Apis::DisplayvideoV1::CarrierAndIspTargetingOptionDetails] attr_accessor :carrier_and_isp_details # Represents a targetable category. This will be populated in the - # category_details field of a - # TargetingOption when targeting_type is - # `TARGETING_TYPE_CATEGORY`. + # category_details field of a TargetingOption when targeting_type is ` + # TARGETING_TYPE_CATEGORY`. # Corresponds to the JSON property `categoryDetails` # @return [Google::Apis::DisplayvideoV1::CategoryTargetingOptionDetails] attr_accessor :category_details # Represents a targetable content instream position, which could be used by # video and audio ads. This will be populated in the - # content_instream_position_details - # field when targeting_type is - # `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`. + # content_instream_position_details field when targeting_type is ` + # TARGETING_TYPE_CONTENT_INSTREAM_POSITION`. # Corresponds to the JSON property `contentInstreamPositionDetails` # @return [Google::Apis::DisplayvideoV1::ContentInstreamPositionTargetingOptionDetails] attr_accessor :content_instream_position_details # Represents a targetable content outstream position, which could be used by # display and video ads. This will be populated in the - # content_outstream_position_details - # field when targeting_type is - # `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`. + # content_outstream_position_details field when targeting_type is ` + # TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`. # Corresponds to the JSON property `contentOutstreamPositionDetails` # @return [Google::Apis::DisplayvideoV1::ContentOutstreamPositionTargetingOptionDetails] attr_accessor :content_outstream_position_details # Represents a targetable device make and model. This will be populated in the - # device_make_model_details - # field of a TargetingOption when - # targeting_type is - # `TARGETING_TYPE_DEVICE_MAKE_MODEL`. + # device_make_model_details field of a TargetingOption when targeting_type is ` + # TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Corresponds to the JSON property `deviceMakeModelDetails` # @return [Google::Apis::DisplayvideoV1::DeviceMakeModelTargetingOptionDetails] attr_accessor :device_make_model_details # Represents a targetable device type. This will be populated in the - # device_type_details field of a - # TargetingOption when targeting_type is - # `TARGETING_TYPE_DEVICE_TYPE`. + # device_type_details field of a TargetingOption when targeting_type is ` + # TARGETING_TYPE_DEVICE_TYPE`. # Corresponds to the JSON property `deviceTypeDetails` # @return [Google::Apis::DisplayvideoV1::DeviceTypeTargetingOptionDetails] attr_accessor :device_type_details # Represents a targetable digital content label rating tier. This will be - # populated in the - # digital_content_label_details - # field of the TargetingOption when - # targeting_type is - # `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. + # populated in the digital_content_label_details field of the TargetingOption + # when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Corresponds to the JSON property `digitalContentLabelDetails` # @return [Google::Apis::DisplayvideoV1::DigitalContentLabelTargetingOptionDetails] attr_accessor :digital_content_label_details # Represents a targetable environment. This will be populated in the - # environment_details field of a - # TargetingOption when targeting_type is - # `TARGETING_TYPE_ENVIRONMENT`. + # environment_details field of a TargetingOption when targeting_type is ` + # TARGETING_TYPE_ENVIRONMENT`. # Corresponds to the JSON property `environmentDetails` # @return [Google::Apis::DisplayvideoV1::EnvironmentTargetingOptionDetails] attr_accessor :environment_details # Represents a targetable exchange. This will be populated in the - # exchange_details field - # of a TargetingOption when - # targeting_type is - # `TARGETING_TYPE_EXCHANGE`. + # exchange_details field of a TargetingOption when targeting_type is ` + # TARGETING_TYPE_EXCHANGE`. # Corresponds to the JSON property `exchangeDetails` # @return [Google::Apis::DisplayvideoV1::ExchangeTargetingOptionDetails] attr_accessor :exchange_details - # Represents a targetable gender. This will be populated in the - # gender_details field of a TargetingOption - # when targeting_type is - # `TARGETING_TYPE_GENDER`. + # Represents a targetable gender. This will be populated in the gender_details + # field of a TargetingOption when targeting_type is `TARGETING_TYPE_GENDER`. # Corresponds to the JSON property `genderDetails` # @return [Google::Apis::DisplayvideoV1::GenderTargetingOptionDetails] attr_accessor :gender_details # Represents a targetable geographic region. This will be populated in the - # geo_region_details field when - # targeting_type is - # `TARGETING_TYPE_GEO_REGION`. + # geo_region_details field when targeting_type is `TARGETING_TYPE_GEO_REGION`. # Corresponds to the JSON property `geoRegionDetails` # @return [Google::Apis::DisplayvideoV1::GeoRegionTargetingOptionDetails] attr_accessor :geo_region_details # Represents a targetable household income. This will be populated in the - # household_income_details field of - # a TargetingOption when targeting_type is - # `TARGETING_TYPE_HOUSEHOLD_INCOME`. + # household_income_details field of a TargetingOption when targeting_type is ` + # TARGETING_TYPE_HOUSEHOLD_INCOME`. # Corresponds to the JSON property `householdIncomeDetails` # @return [Google::Apis::DisplayvideoV1::HouseholdIncomeTargetingOptionDetails] attr_accessor :household_income_details # Represents a targetable language. This will be populated in the - # language_details field when - # targeting_type is - # `TARGETING_TYPE_LANGUAGE`. + # language_details field when targeting_type is `TARGETING_TYPE_LANGUAGE`. # Corresponds to the JSON property `languageDetails` # @return [Google::Apis::DisplayvideoV1::LanguageTargetingOptionDetails] attr_accessor :language_details @@ -7514,54 +6969,43 @@ module Google # @return [String] attr_accessor :name - # Represents a targetable on screen position, which could be used by display - # and video ads. This will be populated in the - # on_screen_position_details - # field when - # targeting_type is - # `TARGETING_TYPE_ON_SCREEN_POSITION`. + # Represents a targetable on screen position, which could be used by display and + # video ads. This will be populated in the on_screen_position_details field when + # targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`. # Corresponds to the JSON property `onScreenPositionDetails` # @return [Google::Apis::DisplayvideoV1::OnScreenPositionTargetingOptionDetails] attr_accessor :on_screen_position_details # Represents a targetable operating system. This will be populated in the - # operating_system_details field - # of a TargetingOption when - # targeting_type is - # `TARGETING_TYPE_OPERATING_SYSTEM`. + # operating_system_details field of a TargetingOption when targeting_type is ` + # TARGETING_TYPE_OPERATING_SYSTEM`. # Corresponds to the JSON property `operatingSystemDetails` # @return [Google::Apis::DisplayvideoV1::OperatingSystemTargetingOptionDetails] attr_accessor :operating_system_details # Represents a targetable parental status. This will be populated in the - # parental_status_details field of a - # TargetingOption when targeting_type is - # `TARGETING_TYPE_PARENTAL_STATUS`. + # parental_status_details field of a TargetingOption when targeting_type is ` + # TARGETING_TYPE_PARENTAL_STATUS`. # Corresponds to the JSON property `parentalStatusDetails` # @return [Google::Apis::DisplayvideoV1::ParentalStatusTargetingOptionDetails] attr_accessor :parental_status_details - # Represents a targetable sensitive category. This will be - # populated in the - # sensitive_category_details - # field of the TargetingOption when - # targeting_type is + # Represents a targetable sensitive category. This will be populated in the + # sensitive_category_details field of the TargetingOption when targeting_type is # `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Corresponds to the JSON property `sensitiveCategoryDetails` # @return [Google::Apis::DisplayvideoV1::SensitiveCategoryTargetingOptionDetails] attr_accessor :sensitive_category_details # Represents a targetable sub-exchange. This will be populated in the - # sub_exchange_details field - # of a TargetingOption when - # targeting_type is - # `TARGETING_TYPE_SUB_EXCHANGE`. + # sub_exchange_details field of a TargetingOption when targeting_type is ` + # TARGETING_TYPE_SUB_EXCHANGE`. # Corresponds to the JSON property `subExchangeDetails` # @return [Google::Apis::DisplayvideoV1::SubExchangeTargetingOptionDetails] attr_accessor :sub_exchange_details - # Output only. A unique identifier for this targeting option. The tuple - # ``targeting_type`, `targeting_option_id`` will be unique. + # Output only. A unique identifier for this targeting option. The tuple `` + # targeting_type`, `targeting_option_id`` will be unique. # Corresponds to the JSON property `targetingOptionId` # @return [String] attr_accessor :targeting_option_id @@ -7572,27 +7016,22 @@ module Google attr_accessor :targeting_type # Represents a targetable user rewarded content status for video ads only. This - # will be populated in the - # user_rewarded_content_details - # field when - # targeting_type is - # `TARGETING_TYPE_USER_REWARDED_CONTENT`. + # will be populated in the user_rewarded_content_details field when + # targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`. # Corresponds to the JSON property `userRewardedContentDetails` # @return [Google::Apis::DisplayvideoV1::UserRewardedContentTargetingOptionDetails] attr_accessor :user_rewarded_content_details # Represents a targetable video player size. This will be populated in the - # video_player_size_details - # field when targeting_type is - # `TARGETING_TYPE_VIDEO_PLAYER_SIZE`. + # video_player_size_details field when targeting_type is ` + # TARGETING_TYPE_VIDEO_PLAYER_SIZE`. # Corresponds to the JSON property `videoPlayerSizeDetails` # @return [Google::Apis::DisplayvideoV1::VideoPlayerSizeTargetingOptionDetails] attr_accessor :video_player_size_details # Represents a targetable viewability. This will be populated in the - # viewability_details field of a - # TargetingOption when targeting_type is - # `TARGETING_TYPE_VIEWABILITY`. + # viewability_details field of a TargetingOption when targeting_type is ` + # TARGETING_TYPE_VIEWABILITY`. # Corresponds to the JSON property `viewabilityDetails` # @return [Google::Apis::DisplayvideoV1::ViewabilityTargetingOptionDetails] attr_accessor :viewability_details @@ -7638,8 +7077,8 @@ module Google class ThirdPartyOnlyConfig include Google::Apis::Core::Hashable - # Whether or not order ID reporting for pixels is enabled. - # This value cannot be changed once set to `true`. + # Whether or not order ID reporting for pixels is enabled. This value cannot be + # changed once set to `true`. # Corresponds to the JSON property `pixelOrderIdReportingEnabled` # @return [Boolean] attr_accessor :pixel_order_id_reporting_enabled @@ -7665,9 +7104,9 @@ module Google # @return [String] attr_accessor :type - # Tracking URL used to track the interaction. - # Provide a URL with optional path or query string, beginning with `https:`. - # For example, https://www.example.com/path + # Tracking URL used to track the interaction. Provide a URL with optional path + # or query string, beginning with `https:`. For example, https://www.example.com/ + # path # Corresponds to the JSON property `url` # @return [String] attr_accessor :url @@ -7683,10 +7122,9 @@ module Google end end - # Assigned third party verifier targeting option details. This will be - # populated in the details field of an AssignedTargetingOption when - # targeting_type is - # `TARGETING_TYPE_THIRD_PARTY_VERIFIER`. + # Assigned third party verifier targeting option details. This will be populated + # in the details field of an AssignedTargetingOption when targeting_type is ` + # TARGETING_TYPE_THIRD_PARTY_VERIFIER`. class ThirdPartyVerifierAssignedTargetingOptionDetails include Google::Apis::Core::Hashable @@ -7777,15 +7215,13 @@ module Google attr_accessor :floodlight_activity_id # Required. The number of days after an ad has been clicked in which a - # conversion may be counted. - # Must be between 0 and 90 inclusive. + # conversion may be counted. Must be between 0 and 90 inclusive. # Corresponds to the JSON property `postClickLookbackWindowDays` # @return [Fixnum] attr_accessor :post_click_lookback_window_days - # Required. The number of days after an ad has been viewed in which a - # conversion may be counted. - # Must be between 0 and 90 inclusive. + # Required. The number of days after an ad has been viewed in which a conversion + # may be counted. Must be between 0 and 90 inclusive. # Corresponds to the JSON property `postViewLookbackWindowDays` # @return [Fixnum] attr_accessor :post_view_lookback_window_days @@ -7806,8 +7242,8 @@ module Google class Transcode include Google::Apis::Core::Hashable - # The bit rate for the audio stream of the transcoded video, or the bit rate - # for the transcoded audio, in kilobits per second. + # The bit rate for the audio stream of the transcoded video, or the bit rate for + # the transcoded audio, in kilobits per second. # Corresponds to the JSON property `audioBitRateKbps` # @return [Fixnum] attr_accessor :audio_bit_rate_kbps @@ -7899,9 +7335,8 @@ module Google end # Details for assigned URL targeting option. This will be populated in the - # details field of an AssignedTargetingOption when - # targeting_type is - # `TARGETING_TYPE_URL`. + # details field of an AssignedTargetingOption when targeting_type is ` + # TARGETING_TYPE_URL`. class UrlAssignedTargetingOptionDetails include Google::Apis::Core::Hashable @@ -7911,10 +7346,10 @@ module Google attr_accessor :negative alias_method :negative?, :negative - # Required. The URL, for example `example.com`. - # DV360 supports two levels of subdirectory targeting, for example - # `www.example.com/one-subdirectory-level/second-level`, and five levels of - # subdomain targeting, for example `five.four.three.two.one.example.com`. + # Required. The URL, for example `example.com`. DV360 supports two levels of + # subdirectory targeting, for example `www.example.com/one-subdirectory-level/ + # second-level`, and five levels of subdomain targeting, for example `five.four. + # three.two.one.example.com`. # Corresponds to the JSON property `url` # @return [String] attr_accessor :url @@ -7930,18 +7365,14 @@ module Google end end - # User rewarded content targeting option details. This will be populated in - # the - # user_rewarded_content_details - # field when - # targeting_type is - # `TARGETING_TYPE_USER_REWARDED_CONTENT`. + # User rewarded content targeting option details. This will be populated in the + # user_rewarded_content_details field when targeting_type is ` + # TARGETING_TYPE_USER_REWARDED_CONTENT`. class UserRewardedContentAssignedTargetingOptionDetails include Google::Apis::Core::Hashable - # Required. The targeting_option_id field when - # targeting_type is - # `TARGETING_TYPE_USER_REWARDED_CONTENT`. + # Required. The targeting_option_id field when targeting_type is ` + # TARGETING_TYPE_USER_REWARDED_CONTENT`. # Corresponds to the JSON property `targetingOptionId` # @return [String] attr_accessor :targeting_option_id @@ -7963,11 +7394,8 @@ module Google end # Represents a targetable user rewarded content status for video ads only. This - # will be populated in the - # user_rewarded_content_details - # field when - # targeting_type is - # `TARGETING_TYPE_USER_REWARDED_CONTENT`. + # will be populated in the user_rewarded_content_details field when + # targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`. class UserRewardedContentTargetingOptionDetails include Google::Apis::Core::Hashable @@ -7987,17 +7415,15 @@ module Google end # Video player size targeting option details. This will be populated in the - # video_player_size_details - # field when targeting_type is - # `TARGETING_TYPE_VIDEO_PLAYER_SIZE`. - # Explicitly targeting all options is not supported. Remove all video player - # size targeting options to achieve this effect. + # video_player_size_details field when targeting_type is ` + # TARGETING_TYPE_VIDEO_PLAYER_SIZE`. Explicitly targeting all options is not + # supported. Remove all video player size targeting options to achieve this + # effect. class VideoPlayerSizeAssignedTargetingOptionDetails include Google::Apis::Core::Hashable - # Required. The targeting_option_id field when - # targeting_type is - # `TARGETING_TYPE_VIDEO_PLAYER_SIZE`. + # Required. The targeting_option_id field when targeting_type is ` + # TARGETING_TYPE_VIDEO_PLAYER_SIZE`. # Corresponds to the JSON property `targetingOptionId` # @return [String] attr_accessor :targeting_option_id @@ -8019,9 +7445,8 @@ module Google end # Represents a targetable video player size. This will be populated in the - # video_player_size_details - # field when targeting_type is - # `TARGETING_TYPE_VIDEO_PLAYER_SIZE`. + # video_player_size_details field when targeting_type is ` + # TARGETING_TYPE_VIDEO_PLAYER_SIZE`. class VideoPlayerSizeTargetingOptionDetails include Google::Apis::Core::Hashable @@ -8041,16 +7466,14 @@ module Google end # Assigned viewability targeting option details. This will be populated in the - # viewability_details field of - # an AssignedTargetingOption when - # targeting_type is + # viewability_details field of an AssignedTargetingOption when targeting_type is # `TARGETING_TYPE_VIEWABILITY`. class ViewabilityAssignedTargetingOptionDetails include Google::Apis::Core::Hashable - # Required. The targeting_option_id of a - # TargetingOption of type `TARGETING_TYPE_VIEWABILITY` (e.g., "509010" - # for targeting the `VIEWABILITY_10_PERCENT_OR_MORE` option). + # Required. The targeting_option_id of a TargetingOption of type ` + # TARGETING_TYPE_VIEWABILITY` (e.g., "509010" for targeting the ` + # VIEWABILITY_10_PERCENT_OR_MORE` option). # Corresponds to the JSON property `targetingOptionId` # @return [String] attr_accessor :targeting_option_id @@ -8072,9 +7495,8 @@ module Google end # Represents a targetable viewability. This will be populated in the - # viewability_details field of a - # TargetingOption when targeting_type is - # `TARGETING_TYPE_VIEWABILITY`. + # viewability_details field of a TargetingOption when targeting_type is ` + # TARGETING_TYPE_VIEWABILITY`. class ViewabilityTargetingOptionDetails include Google::Apis::Core::Hashable diff --git a/generated/google/apis/displayvideo_v1/service.rb b/generated/google/apis/displayvideo_v1/service.rb index 2e1ac2649..251a2e658 100644 --- a/generated/google/apis/displayvideo_v1/service.rb +++ b/generated/google/apis/displayvideo_v1/service.rb @@ -48,10 +48,10 @@ module Google @batch_path = 'batch' end - # Bulk edits targeting options under a single advertiser. - # The operation will delete the assigned targeting options provided in - # BulkEditAdvertiserAssignedTargetingOptionsRequest.delete_requests and - # then create the assigned targeting options provided in + # Bulk edits targeting options under a single advertiser. The operation will + # delete the assigned targeting options provided in + # BulkEditAdvertiserAssignedTargetingOptionsRequest.delete_requests and then + # create the assigned targeting options provided in # BulkEditAdvertiserAssignedTargetingOptionsRequest.create_requests . # @param [Fixnum] advertiser_id # Required. The ID of the advertiser. @@ -89,37 +89,27 @@ module Google # @param [Fixnum] advertiser_id # Required. The ID of the advertiser the line item belongs to. # @param [String] filter - # Allows filtering by assigned targeting option properties. - # Supported syntax: - # * Filter expressions are made up of one or more restrictions. - # * Restrictions can be combined by the logical operator `OR`.. - # * A restriction has the form of ``field` `operator` `value``. - # * The operator must be `EQUALS (=)`. - # * Supported fields: - # - `targetingType` - # Examples: - # * targetingType with value TARGETING_TYPE_CHANNEL - # `targetingType="TARGETING_TYPE_CHANNEL"` - # The length of this field should be no more than 500 characters. + # Allows filtering by assigned targeting option properties. Supported syntax: * + # Filter expressions are made up of one or more restrictions. * Restrictions can + # be combined by the logical operator `OR`.. * A restriction has the form of `` + # field` `operator` `value``. * The operator must be `EQUALS (=)`. * Supported + # fields: - `targetingType` Examples: * targetingType with value + # TARGETING_TYPE_CHANNEL `targetingType="TARGETING_TYPE_CHANNEL"` The length of + # this field should be no more than 500 characters. # @param [String] order_by - # Field by which to sort the list. - # Acceptable values are: - # * `targetingType` (default) - # The default sorting order is ascending. To specify descending order for - # a field, a suffix "desc" should be added to the field name. Example: - # `targetingType desc`. + # Field by which to sort the list. Acceptable values are: * `targetingType` ( + # default) The default sorting order is ascending. To specify descending order + # for a field, a suffix "desc" should be added to the field name. Example: ` + # targetingType desc`. # @param [Fixnum] page_size - # Requested page size. - # The size must be an integer between `1` and `5000`. If unspecified, - # the default is '5000'. Returns error code `INVALID_ARGUMENT` if an invalid - # value is specified. + # Requested page size. The size must be an integer between `1` and `5000`. If + # unspecified, the default is '5000'. Returns error code `INVALID_ARGUMENT` if + # an invalid value is specified. # @param [String] page_token - # A token that lets the client fetch the next page of results. - # Typically, this is the value of - # next_page_token - # returned from the previous call to - # `BulkListAdvertiserAssignedTargetingOptions` method. - # If not specified, the first page of results will be returned. + # A token that lets the client fetch the next page of results. Typically, this + # is the value of next_page_token returned from the previous call to ` + # BulkListAdvertiserAssignedTargetingOptions` method. If not specified, the + # first page of results will be returned. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -151,8 +141,7 @@ module Google execute_or_queue_command(command, &block) end - # Creates a new advertiser. - # Returns the newly created advertiser if successful. + # Creates a new advertiser. Returns the newly created advertiser if successful. # This method can take up to 180 seconds to complete. # @param [Google::Apis::DisplayvideoV1::Advertiser] advertiser_object # @param [String] fields @@ -183,10 +172,9 @@ module Google execute_or_queue_command(command, &block) end - # Deletes an advertiser. - # Deleting an advertiser will delete all of its child resources, for example, - # campaigns, insertion orders and line items. - # A deleted advertiser cannot be recovered. + # Deletes an advertiser. Deleting an advertiser will delete all of its child + # resources, for example, campaigns, insertion orders and line items. A deleted + # advertiser cannot be recovered. # @param [Fixnum] advertiser_id # The ID of the advertiser we need to delete. # @param [String] fields @@ -246,46 +234,34 @@ module Google execute_or_queue_command(command, &block) end - # Lists advertisers that are accessible to the current user. - # The order is defined by the order_by - # parameter. - # A single partner_id is required. - # Cross-partner listing is not supported. + # Lists advertisers that are accessible to the current user. The order is + # defined by the order_by parameter. A single partner_id is required. Cross- + # partner listing is not supported. # @param [String] filter - # Allows filtering by advertiser properties. - # Supported syntax: - # * Filter expressions are made up of one or more restrictions. - # * Restrictions can be combined by `AND` or `OR` logical operators. A - # sequence of restrictions implicitly uses `AND`. - # * A restriction has the form of ``field` `operator` `value``. - # * The operator must be `EQUALS (=)`. - # * Supported fields: - # - `entityStatus` - # Examples: - # * All active advertisers under a partner: - # `entityStatus="ENTITY_STATUS_ACTIVE"` - # The length of this field should be no more than 500 characters. + # Allows filtering by advertiser properties. Supported syntax: * Filter + # expressions are made up of one or more restrictions. * Restrictions can be + # combined by `AND` or `OR` logical operators. A sequence of restrictions + # implicitly uses `AND`. * A restriction has the form of ``field` `operator` ` + # value``. * The operator must be `EQUALS (=)`. * Supported fields: - ` + # entityStatus` Examples: * All active advertisers under a partner: ` + # entityStatus="ENTITY_STATUS_ACTIVE"` The length of this field should be no + # more than 500 characters. # @param [String] order_by - # Field by which to sort the list. - # Acceptable values are: - # * `displayName` (default) - # * `entityStatus` - # The default sorting order is ascending. To specify descending order for - # a field, a suffix "desc" should be added to the field name. For example, - # `displayName desc`. + # Field by which to sort the list. Acceptable values are: * `displayName` ( + # default) * `entityStatus` The default sorting order is ascending. To specify + # descending order for a field, a suffix "desc" should be added to the field + # name. For example, `displayName desc`. # @param [Fixnum] page_size # Requested page size. Must be between `1` and `100`. If unspecified will # default to `100`. # @param [String] page_token - # A token identifying a page of results the server should return. - # Typically, this is the value of - # next_page_token - # returned from the previous call to `ListAdvertisers` method. - # If not specified, the first page of results will be returned. + # A token identifying a page of results the server should return. Typically, + # this is the value of next_page_token returned from the previous call to ` + # ListAdvertisers` method. If not specified, the first page of results will be + # returned. # @param [Fixnum] partner_id # Required. The ID of the partner that the fetched advertisers should all belong - # to. - # The system only supports listing advertisers for one partner at a time. + # to. The system only supports listing advertisers for one partner at a time. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -317,8 +293,7 @@ module Google execute_or_queue_command(command, &block) end - # Updates an existing advertiser. - # Returns the updated advertiser if successful. + # Updates an existing advertiser. Returns the updated advertiser if successful. # @param [Fixnum] advertiser_id # Output only. The unique ID of the advertiser. Assigned by the system. # @param [Google::Apis::DisplayvideoV1::Advertiser] advertiser_object @@ -354,10 +329,9 @@ module Google execute_or_queue_command(command, &block) end - # Uploads an asset. - # Returns the ID of the newly uploaded asset if successful. - # The asset file size should be no more than 10 MB for images, 200 MB for - # ZIP files, and 1 GB for videos. + # Uploads an asset. Returns the ID of the newly uploaded asset if successful. + # The asset file size should be no more than 10 MB for images, 200 MB for ZIP + # files, and 1 GB for videos. # @param [Fixnum] advertiser_id # Required. The ID of the advertiser this asset belongs to. # @param [Google::Apis::DisplayvideoV1::CreateAssetRequest] create_asset_request_object @@ -400,8 +374,7 @@ module Google execute_or_queue_command(command, &block) end - # Creates a new campaign. - # Returns the newly created campaign if successful. + # Creates a new campaign. Returns the newly created campaign if successful. # @param [Fixnum] advertiser_id # Output only. The unique ID of the advertiser the campaign belongs to. # @param [Google::Apis::DisplayvideoV1::Campaign] campaign_object @@ -434,10 +407,9 @@ module Google execute_or_queue_command(command, &block) end - # Permanently deletes a campaign. A deleted campaign cannot be recovered. - # The campaign should be archived first, i.e. set - # entity_status to `ENTITY_STATUS_ARCHIVED`, to be - # able to delete it. + # Permanently deletes a campaign. A deleted campaign cannot be recovered. The + # campaign should be archived first, i.e. set entity_status to ` + # ENTITY_STATUS_ARCHIVED`, to be able to delete it. # @param [Fixnum] advertiser_id # The ID of the advertiser this campaign belongs to. # @param [Fixnum] campaign_id @@ -503,47 +475,34 @@ module Google execute_or_queue_command(command, &block) end - # Lists campaigns in an advertiser. - # The order is defined by the order_by - # parameter. - # If a filter by - # entity_status is not specified, campaigns with - # `ENTITY_STATUS_ARCHIVED` will not be included in the results. + # Lists campaigns in an advertiser. The order is defined by the order_by + # parameter. If a filter by entity_status is not specified, campaigns with ` + # ENTITY_STATUS_ARCHIVED` will not be included in the results. # @param [Fixnum] advertiser_id # The ID of the advertiser to list campaigns for. # @param [String] filter - # Allows filtering by campaign properties. - # Supported syntax: - # * Filter expressions are made up of one or more restrictions. - # * Restrictions can be combined by `AND` or `OR` logical operators. A - # sequence of restrictions implicitly uses `AND`. - # * A restriction has the form of ``field` `operator` `value``. - # * The operator must be `EQUALS (=)`. - # * Supported fields: - # - `entityStatus` - # Examples: - # * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` campaigns under an - # advertiser: - # `(entityStatus="ENTITY_STATUS_ACTIVE" OR - # entityStatus="ENTITY_STATUS_PAUSED")` - # The length of this field should be no more than 500 characters. + # Allows filtering by campaign properties. Supported syntax: * Filter + # expressions are made up of one or more restrictions. * Restrictions can be + # combined by `AND` or `OR` logical operators. A sequence of restrictions + # implicitly uses `AND`. * A restriction has the form of ``field` `operator` ` + # value``. * The operator must be `EQUALS (=)`. * Supported fields: - ` + # entityStatus` Examples: * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` + # campaigns under an advertiser: `(entityStatus="ENTITY_STATUS_ACTIVE" OR + # entityStatus="ENTITY_STATUS_PAUSED")` The length of this field should be no + # more than 500 characters. # @param [String] order_by - # Field by which to sort the list. - # Acceptable values are: - # * `displayName` (default) - # * `entityStatus` - # The default sorting order is ascending. To specify descending order for - # a field, a suffix "desc" should be added to the field name. Example: - # `displayName desc`. + # Field by which to sort the list. Acceptable values are: * `displayName` ( + # default) * `entityStatus` The default sorting order is ascending. To specify + # descending order for a field, a suffix "desc" should be added to the field + # name. Example: `displayName desc`. # @param [Fixnum] page_size # Requested page size. Must be between `1` and `100`. If unspecified will # default to `100`. # @param [String] page_token - # A token identifying a page of results the server should return. - # Typically, this is the value of - # next_page_token returned from the - # previous call to `ListCampaigns` method. If not specified, the first page - # of results will be returned. + # A token identifying a page of results the server should return. Typically, + # this is the value of next_page_token returned from the previous call to ` + # ListCampaigns` method. If not specified, the first page of results will be + # returned. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -575,8 +534,7 @@ module Google execute_or_queue_command(command, &block) end - # Updates an existing campaign. - # Returns the updated campaign if successful. + # Updates an existing campaign. Returns the updated campaign if successful. # @param [Fixnum] advertiser_id # Output only. The unique ID of the advertiser the campaign belongs to. # @param [Fixnum] campaign_id @@ -691,36 +649,26 @@ module Google # @param [Fixnum] advertiser_id # The ID of the advertiser that owns the channels. # @param [String] filter - # Allows filtering by channel fields. - # Supported syntax: - # * Filter expressions for channel currently can only contain at most one - # * restriction. - # * A restriction has the form of ``field` `operator` `value``. - # * The operator must be `CONTAINS (:)`. - # * Supported fields: - # - `displayName` - # Examples: - # * All channels for which the display name contains "google": - # `displayName : "google"`. - # The length of this field should be no more than 500 characters. + # Allows filtering by channel fields. Supported syntax: * Filter expressions for + # channel currently can only contain at most one * restriction. * A restriction + # has the form of ``field` `operator` `value``. * The operator must be `CONTAINS + # (:)`. * Supported fields: - `displayName` Examples: * All channels for which + # the display name contains "google": `displayName : "google"`. The length of + # this field should be no more than 500 characters. # @param [String] order_by - # Field by which to sort the list. - # Acceptable values are: - # * `displayName` (default) - # * `channelId` - # The default sorting order is ascending. To specify descending order for a - # field, a suffix " desc" should be added to the field name. Example: - # `displayName desc`. + # Field by which to sort the list. Acceptable values are: * `displayName` ( + # default) * `channelId` The default sorting order is ascending. To specify + # descending order for a field, a suffix " desc" should be added to the field + # name. Example: `displayName desc`. # @param [Fixnum] page_size # Requested page size. Must be between `1` and `100`. If unspecified will - # default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value - # is specified. + # default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is + # specified. # @param [String] page_token - # A token identifying a page of results the server should return. - # Typically, this is the value of - # next_page_token returned from the - # previous call to `ListChannels` method. If not specified, the first page - # of results will be returned. + # A token identifying a page of results the server should return. Typically, + # this is the value of next_page_token returned from the previous call to ` + # ListChannels` method. If not specified, the first page of results will be + # returned. # @param [Fixnum] partner_id # The ID of the partner that owns the channels. # @param [String] fields @@ -797,9 +745,8 @@ module Google execute_or_queue_command(command, &block) end - # Bulk edits sites under a single channel. - # The operation will delete the sites provided in - # BulkEditSitesRequest.deleted_sites and then create the sites + # Bulk edits sites under a single channel. The operation will delete the sites + # provided in BulkEditSitesRequest.deleted_sites and then create the sites # provided in BulkEditSitesRequest.created_sites. # @param [Fixnum] advertiser_id # The ID of the advertiser that owns the parent channel. @@ -920,34 +867,25 @@ module Google # @param [Fixnum] channel_id # Required. The ID of the parent channel to which the requested sites belong. # @param [String] filter - # Allows filtering by site fields. - # Supported syntax: - # * Filter expressions for site currently can only contain at most one - # * restriction. - # * A restriction has the form of ``field` `operator` `value``. - # * The operator must be `CONTAINS (:)`. - # * Supported fields: - # - `urlOrAppId` - # Examples: - # * All sites for which the URL or app ID contains "google": - # `urlOrAppId : "google"` + # Allows filtering by site fields. Supported syntax: * Filter expressions for + # site currently can only contain at most one * restriction. * A restriction has + # the form of ``field` `operator` `value``. * The operator must be `CONTAINS (:)` + # . * Supported fields: - `urlOrAppId` Examples: * All sites for which the URL + # or app ID contains "google": `urlOrAppId : "google"` # @param [String] order_by - # Field by which to sort the list. - # Acceptable values are: - # * `urlOrAppId` (default) - # The default sorting order is ascending. To specify descending order for a - # field, a suffix " desc" should be added to the field name. Example: - # `urlOrAppId desc`. + # Field by which to sort the list. Acceptable values are: * `urlOrAppId` ( + # default) The default sorting order is ascending. To specify descending order + # for a field, a suffix " desc" should be added to the field name. Example: ` + # urlOrAppId desc`. # @param [Fixnum] page_size # Requested page size. Must be between `1` and `100`. If unspecified will - # default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value - # is specified. + # default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is + # specified. # @param [String] page_token - # A token identifying a page of results the server should return. - # Typically, this is the value of - # next_page_token returned from the - # previous call to `ListSites` method. If not specified, the first page - # of results will be returned. + # A token identifying a page of results the server should return. Typically, + # this is the value of next_page_token returned from the previous call to ` + # ListSites` method. If not specified, the first page of results will be + # returned. # @param [Fixnum] partner_id # The ID of the partner that owns the parent channel. # @param [String] fields @@ -983,8 +921,7 @@ module Google execute_or_queue_command(command, &block) end - # Creates a new creative. - # Returns the newly created creative if successful. + # Creates a new creative. Returns the newly created creative if successful. # @param [Fixnum] advertiser_id # Output only. The unique ID of the advertiser the creative belongs to. # @param [Google::Apis::DisplayvideoV1::Creative] creative_object @@ -1017,11 +954,9 @@ module Google execute_or_queue_command(command, &block) end - # Deletes a creative. - # Returns error code `NOT_FOUND` if the creative does not exist. - # The creative should be archived first, i.e. set - # entity_status to `ENTITY_STATUS_ARCHIVED`, before - # it can be deleted. + # Deletes a creative. Returns error code `NOT_FOUND` if the creative does not + # exist. The creative should be archived first, i.e. set entity_status to ` + # ENTITY_STATUS_ARCHIVED`, before it can be deleted. # @param [Fixnum] advertiser_id # The ID of the advertiser this creative belongs to. # @param [Fixnum] creative_id @@ -1087,81 +1022,55 @@ module Google execute_or_queue_command(command, &block) end - # Lists creatives in an advertiser. - # The order is defined by the order_by - # parameter. - # If a filter by - # entity_status is not specified, creatives with - # `ENTITY_STATUS_ARCHIVED` will not be included in the results. + # Lists creatives in an advertiser. The order is defined by the order_by + # parameter. If a filter by entity_status is not specified, creatives with ` + # ENTITY_STATUS_ARCHIVED` will not be included in the results. # @param [Fixnum] advertiser_id # Required. The ID of the advertiser to list creatives for. # @param [String] filter - # Allows filtering by creative properties. - # Supported syntax: - # * Filter expressions are made up of one or more restrictions. - # * Restriction for the same field must be combined by `OR`. - # * Restriction for different fields must be combined by `AND`. - # * Between `(` and `)` there can only be restrictions combined by `OR` - # for the same field. - # * A restriction has the form of ``field` `operator` `value``. - # * The operator must be `EQUALS (=)` for the following fields: - # - `entityStatus` - # - `creativeType`. - # - `dimensions` - # - `minDuration` - # - `maxDuration` - # - `approvalStatus` - # - `exchangeReviewStatus` - # - `dynamic` - # - `creativeId` - # * The operator must be `HAS (:)` for the following fields: - # - `lineItemIds` - # * For `entityStatus`, `minDuration`, `maxDuration`, and `dynamic` there may - # be at most one restriction. - # * For `dimensions`, the value is in the form of `"`width`x`height`"`. - # * For `exchangeReviewStatus`, the value is in the form of - # ``exchange`-`reviewStatus``. - # * For `minDuration` and `maxDuration`, the value is in the form of - # `"`duration`s"`. Only seconds are supported with millisecond granularity. - # * There may be multiple `lineItemIds` restrictions in order to search - # against multiple possible line item IDs. - # * There may be multiple `creativeId` restrictions in order to search - # against multiple possible creative IDs. - # Examples: - # * All native creatives: `creativeType="CREATIVE_TYPE_NATIVE"` - # * All active creatives with 300x400 or 50x100 dimensions: - # `entityStatus="ENTITY_STATUS_ACTIVE" AND (dimensions="300x400" - # OR dimensions="50x100")` - # * All dynamic creatives that are approved by AdX or - # AppNexus, with a minimum duration of 5 seconds and 200ms. - # `dynamic="true" AND minDuration="5.2s" AND - # (exchangeReviewStatus="EXCHANGE_GOOGLE_AD_MANAGER-REVIEW_STATUS_APPROVED" - # OR exchangeReviewStatus="EXCHANGE_APPNEXUS-REVIEW_STATUS_APPROVED")` - # * All video creatives that are associated with line item ID 1 or 2: - # `creativeType="CREATIVE_TYPE_VIDEO" AND (lineItemIds:1 OR lineItemIds:2)` - # * Find creatives by multiple creative IDs: - # `creativeId=1 OR creativeId=2` - # The length of this field should be no more than 500 characters. + # Allows filtering by creative properties. Supported syntax: * Filter + # expressions are made up of one or more restrictions. * Restriction for the + # same field must be combined by `OR`. * Restriction for different fields must + # be combined by `AND`. * Between `(` and `)` there can only be restrictions + # combined by `OR` for the same field. * A restriction has the form of ``field` ` + # operator` `value``. * The operator must be `EQUALS (=)` for the following + # fields: - `entityStatus` - `creativeType`. - `dimensions` - `minDuration` - ` + # maxDuration` - `approvalStatus` - `exchangeReviewStatus` - `dynamic` - ` + # creativeId` * The operator must be `HAS (:)` for the following fields: - ` + # lineItemIds` * For `entityStatus`, `minDuration`, `maxDuration`, and `dynamic` + # there may be at most one restriction. * For `dimensions`, the value is in the + # form of `"`width`x`height`"`. * For `exchangeReviewStatus`, the value is in + # the form of ``exchange`-`reviewStatus``. * For `minDuration` and `maxDuration`, + # the value is in the form of `"`duration`s"`. Only seconds are supported with + # millisecond granularity. * There may be multiple `lineItemIds` restrictions in + # order to search against multiple possible line item IDs. * There may be + # multiple `creativeId` restrictions in order to search against multiple + # possible creative IDs. Examples: * All native creatives: `creativeType=" + # CREATIVE_TYPE_NATIVE"` * All active creatives with 300x400 or 50x100 + # dimensions: `entityStatus="ENTITY_STATUS_ACTIVE" AND (dimensions="300x400" OR + # dimensions="50x100")` * All dynamic creatives that are approved by AdX or + # AppNexus, with a minimum duration of 5 seconds and 200ms. `dynamic="true" AND + # minDuration="5.2s" AND (exchangeReviewStatus="EXCHANGE_GOOGLE_AD_MANAGER- + # REVIEW_STATUS_APPROVED" OR exchangeReviewStatus="EXCHANGE_APPNEXUS- + # REVIEW_STATUS_APPROVED")` * All video creatives that are associated with line + # item ID 1 or 2: `creativeType="CREATIVE_TYPE_VIDEO" AND (lineItemIds:1 OR + # lineItemIds:2)` * Find creatives by multiple creative IDs: `creativeId=1 OR + # creativeId=2` The length of this field should be no more than 500 characters. # @param [String] order_by - # Field by which to sort the list. - # Acceptable values are: - # * `creativeId` (default) - # * `createTime` - # * `mediaDuration` - # * `dimensions` (sorts by width first, then by height) - # The default sorting order is ascending. To specify descending order for - # a field, a suffix "desc" should be added to the field name. - # Example: `createTime desc`. + # Field by which to sort the list. Acceptable values are: * `creativeId` ( + # default) * `createTime` * `mediaDuration` * `dimensions` (sorts by width first, + # then by height) The default sorting order is ascending. To specify descending + # order for a field, a suffix "desc" should be added to the field name. Example: + # `createTime desc`. # @param [Fixnum] page_size # Requested page size. Must be between `1` and `100`. If unspecified will - # default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value - # is specified. + # default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is + # specified. # @param [String] page_token - # A token identifying a page of results the server should return. - # Typically, this is the value of - # next_page_token - # returned from the previous call to `ListCreatives` method. - # If not specified, the first page of results will be returned. + # A token identifying a page of results the server should return. Typically, + # this is the value of next_page_token returned from the previous call to ` + # ListCreatives` method. If not specified, the first page of results will be + # returned. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1193,8 +1102,7 @@ module Google execute_or_queue_command(command, &block) end - # Updates an existing creative. - # Returns the updated creative if successful. + # Updates an existing creative. Returns the updated creative if successful. # @param [Fixnum] advertiser_id # Output only. The unique ID of the advertiser the creative belongs to. # @param [Fixnum] creative_id @@ -1233,8 +1141,8 @@ module Google execute_or_queue_command(command, &block) end - # Creates a new insertion order. - # Returns the newly created insertion order if successful. + # Creates a new insertion order. Returns the newly created insertion order if + # successful. # @param [Fixnum] advertiser_id # Output only. The unique ID of the advertiser the insertion order belongs to. # @param [Google::Apis::DisplayvideoV1::InsertionOrder] insertion_order_object @@ -1267,11 +1175,9 @@ module Google execute_or_queue_command(command, &block) end - # Deletes an insertion order. - # Returns error code `NOT_FOUND` if the insertion order does not exist. - # The insertion order should be archived first, i.e. set - # entity_status to `ENTITY_STATUS_ARCHIVED`, - # to be able to delete it. + # Deletes an insertion order. Returns error code `NOT_FOUND` if the insertion + # order does not exist. The insertion order should be archived first, i.e. set + # entity_status to `ENTITY_STATUS_ARCHIVED`, to be able to delete it. # @param [Fixnum] advertiser_id # The ID of the advertiser this insertion order belongs to. # @param [Fixnum] insertion_order_id @@ -1304,8 +1210,8 @@ module Google execute_or_queue_command(command, &block) end - # Gets an insertion order. - # Returns error code `NOT_FOUND` if the insertion order does not exist. + # Gets an insertion order. Returns error code `NOT_FOUND` if the insertion order + # does not exist. # @param [Fixnum] advertiser_id # Required. The ID of the advertiser this insertion order belongs to. # @param [Fixnum] insertion_order_id @@ -1338,50 +1244,36 @@ module Google execute_or_queue_command(command, &block) end - # Lists insertion orders in an advertiser. - # The order is defined by the order_by - # parameter. - # If a filter by - # entity_status is not specified, insertion - # orders with `ENTITY_STATUS_ARCHIVED` will not be included in the results. + # Lists insertion orders in an advertiser. The order is defined by the order_by + # parameter. If a filter by entity_status is not specified, insertion orders + # with `ENTITY_STATUS_ARCHIVED` will not be included in the results. # @param [Fixnum] advertiser_id # Required. The ID of the advertiser to list insertion orders for. # @param [String] filter - # Allows filtering by insertion order properties. - # Supported syntax: - # * Filter expressions are made up of one or more restrictions. - # * Restrictions can be combined by `AND` or `OR` logical operators. A - # sequence of restrictions implicitly uses `AND`. - # * A restriction has the form of ``field` `operator` `value``. - # * The operator must be `EQUALS (=)`. - # * Supported fields: - # - `campaignId` - # - `entityStatus` - # Examples: - # * All insertion orders under a campaign: `campaignId="1234"` - # * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` insertion orders - # under an advertiser: - # `(entityStatus="ENTITY_STATUS_ACTIVE" OR - # entityStatus="ENTITY_STATUS_PAUSED")` - # The length of this field should be no more than 500 characters. + # Allows filtering by insertion order properties. Supported syntax: * Filter + # expressions are made up of one or more restrictions. * Restrictions can be + # combined by `AND` or `OR` logical operators. A sequence of restrictions + # implicitly uses `AND`. * A restriction has the form of ``field` `operator` ` + # value``. * The operator must be `EQUALS (=)`. * Supported fields: - ` + # campaignId` - `entityStatus` Examples: * All insertion orders under a campaign: + # `campaignId="1234"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` + # insertion orders under an advertiser: `(entityStatus="ENTITY_STATUS_ACTIVE" OR + # entityStatus="ENTITY_STATUS_PAUSED")` The length of this field should be no + # more than 500 characters. # @param [String] order_by - # Field by which to sort the list. - # Acceptable values are: - # * "displayName" (default) - # * "entityStatus" - # The default sorting order is ascending. To specify descending order for - # a field, a suffix "desc" should be added to the field name. Example: - # `displayName desc`. + # Field by which to sort the list. Acceptable values are: * "displayName" ( + # default) * "entityStatus" The default sorting order is ascending. To specify + # descending order for a field, a suffix "desc" should be added to the field + # name. Example: `displayName desc`. # @param [Fixnum] page_size # Requested page size. Must be between `1` and `100`. If unspecified will - # default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value - # is specified. + # default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is + # specified. # @param [String] page_token - # A token identifying a page of results the server should return. - # Typically, this is the value of - # next_page_token returned - # from the previous call to `ListInsertionOrders` method. If not specified, - # the first page of results will be returned. + # A token identifying a page of results the server should return. Typically, + # this is the value of next_page_token returned from the previous call to ` + # ListInsertionOrders` method. If not specified, the first page of results will + # be returned. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1413,8 +1305,8 @@ module Google execute_or_queue_command(command, &block) end - # Updates an existing insertion order. - # Returns the updated insertion order if successful. + # Updates an existing insertion order. Returns the updated insertion order if + # successful. # @param [Fixnum] advertiser_id # Output only. The unique ID of the advertiser the insertion order belongs to. # @param [Fixnum] insertion_order_id @@ -1453,10 +1345,10 @@ module Google execute_or_queue_command(command, &block) end - # Bulk edits targeting options under a single line item. - # The operation will delete the assigned targeting options provided in - # BulkEditLineItemAssignedTargetingOptionsRequest.delete_requests and - # then create the assigned targeting options provided in + # Bulk edits targeting options under a single line item. The operation will + # delete the assigned targeting options provided in + # BulkEditLineItemAssignedTargetingOptionsRequest.delete_requests and then + # create the assigned targeting options provided in # BulkEditLineItemAssignedTargetingOptionsRequest.create_requests . # @param [Fixnum] advertiser_id # Required. The ID of the advertiser the line item belongs to. @@ -1499,44 +1391,32 @@ module Google # @param [Fixnum] line_item_id # Required. The ID of the line item to list assigned targeting options for. # @param [String] filter - # Allows filtering by assigned targeting option properties. - # Supported syntax: - # * Filter expressions are made up of one or more restrictions. - # * Restrictions can be combined by the logical operator `OR` on the same - # field. - # * A restriction has the form of ``field` `operator` `value``. - # * The operator must be `EQUALS (=)`. - # * Supported fields: - # - `targetingType` - # - `inheritance` - # Examples: - # * AssignedTargetingOptions of targeting type - # TARGETING_TYPE_PROXIMITY_LOCATION_LIST or TARGETING_TYPE_CHANNEL - # `targetingType="TARGETING_TYPE_PROXIMITY_LOCATION_LIST" OR - # targetingType="TARGETING_TYPE_CHANNEL"` - # * AssignedTargetingOptions with inheritance status of NOT_INHERITED or - # INHERITED_FROM_PARTNER - # `inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` - # The length of this field should be no more than 500 characters. + # Allows filtering by assigned targeting option properties. Supported syntax: * + # Filter expressions are made up of one or more restrictions. * Restrictions can + # be combined by the logical operator `OR` on the same field. * A restriction + # has the form of ``field` `operator` `value``. * The operator must be `EQUALS (= + # )`. * Supported fields: - `targetingType` - `inheritance` Examples: * + # AssignedTargetingOptions of targeting type + # TARGETING_TYPE_PROXIMITY_LOCATION_LIST or TARGETING_TYPE_CHANNEL ` + # targetingType="TARGETING_TYPE_PROXIMITY_LOCATION_LIST" OR targetingType=" + # TARGETING_TYPE_CHANNEL"` * AssignedTargetingOptions with inheritance status of + # NOT_INHERITED or INHERITED_FROM_PARTNER `inheritance="NOT_INHERITED" OR + # inheritance="INHERITED_FROM_PARTNER"` The length of this field should be no + # more than 500 characters. # @param [String] order_by - # Field by which to sort the list. - # Acceptable values are: - # * `targetingType` (default) - # The default sorting order is ascending. To specify descending order for - # a field, a suffix "desc" should be added to the field name. Example: - # `targetingType desc`. + # Field by which to sort the list. Acceptable values are: * `targetingType` ( + # default) The default sorting order is ascending. To specify descending order + # for a field, a suffix "desc" should be added to the field name. Example: ` + # targetingType desc`. # @param [Fixnum] page_size - # Requested page size. - # The size must be an integer between `1` and `5000`. If unspecified, - # the default is '5000'. Returns error code `INVALID_ARGUMENT` if an invalid - # value is specified. + # Requested page size. The size must be an integer between `1` and `5000`. If + # unspecified, the default is '5000'. Returns error code `INVALID_ARGUMENT` if + # an invalid value is specified. # @param [String] page_token - # A token that lets the client fetch the next page of results. - # Typically, this is the value of - # next_page_token - # returned from the previous call to - # `BulkListLineItemAssignedTargetingOptions` method. - # If not specified, the first page of results will be returned. + # A token that lets the client fetch the next page of results. Typically, this + # is the value of next_page_token returned from the previous call to ` + # BulkListLineItemAssignedTargetingOptions` method. If not specified, the first + # page of results will be returned. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1569,8 +1449,7 @@ module Google execute_or_queue_command(command, &block) end - # Creates a new line item. - # Returns the newly created line item if successful. + # Creates a new line item. Returns the newly created line item if successful. # @param [Fixnum] advertiser_id # Output only. The unique ID of the advertiser the line item belongs to. # @param [Google::Apis::DisplayvideoV1::LineItem] line_item_object @@ -1603,11 +1482,9 @@ module Google execute_or_queue_command(command, &block) end - # Deletes a line item. - # Returns error code `NOT_FOUND` if the line item does not exist. - # The line item should be archived first, i.e. set - # entity_status to `ENTITY_STATUS_ARCHIVED`, to be - # able to delete it. + # Deletes a line item. Returns error code `NOT_FOUND` if the line item does not + # exist. The line item should be archived first, i.e. set entity_status to ` + # ENTITY_STATUS_ARCHIVED`, to be able to delete it. # @param [Fixnum] advertiser_id # The ID of the advertiser this line item belongs to. # @param [Fixnum] line_item_id @@ -1673,54 +1550,38 @@ module Google execute_or_queue_command(command, &block) end - # Lists line items in an advertiser. - # The order is defined by the order_by - # parameter. - # If a filter by - # entity_status is not specified, line items with - # `ENTITY_STATUS_ARCHIVED` will not be included in the results. + # Lists line items in an advertiser. The order is defined by the order_by + # parameter. If a filter by entity_status is not specified, line items with ` + # ENTITY_STATUS_ARCHIVED` will not be included in the results. # @param [Fixnum] advertiser_id # Required. The ID of the advertiser to list line items for. # @param [String] filter - # Allows filtering by line item properties. - # Supported syntax: - # * Filter expressions are made up of one or more restrictions. - # * Restrictions can be combined by `AND` or `OR` logical operators. A - # sequence of restrictions implicitly uses `AND`. - # * A restriction has the form of ``field` `operator` `value``. - # * The operator must be `EQUALS (=)`. - # * Supported fields: - # - `campaignId` - # - `insertionOrderId` - # - `entityStatus` - # - `lineItemType` - # Examples: - # * All line items under an insertion order: `insertionOrderId="1234"` - # * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` - # and `LINE_ITEM_TYPE_DISPLAY_DEFAULT` line items under an advertiser: - # `(entityStatus="ENTITY_STATUS_ACTIVE" OR - # entityStatus="ENTITY_STATUS_PAUSED") AND - # lineItemType="LINE_ITEM_TYPE_DISPLAY_DEFAULT"` - # The length of this field should be no more than 500 characters. + # Allows filtering by line item properties. Supported syntax: * Filter + # expressions are made up of one or more restrictions. * Restrictions can be + # combined by `AND` or `OR` logical operators. A sequence of restrictions + # implicitly uses `AND`. * A restriction has the form of ``field` `operator` ` + # value``. * The operator must be `EQUALS (=)`. * Supported fields: - ` + # campaignId` - `insertionOrderId` - `entityStatus` - `lineItemType` Examples: * + # All line items under an insertion order: `insertionOrderId="1234"` * All ` + # ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` and ` + # LINE_ITEM_TYPE_DISPLAY_DEFAULT` line items under an advertiser: `(entityStatus= + # "ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND + # lineItemType="LINE_ITEM_TYPE_DISPLAY_DEFAULT"` The length of this field should + # be no more than 500 characters. # @param [String] order_by - # Field by which to sort the list. - # Acceptable values are: - # * "displayName" (default) - # * "entityStatus" - # * “flight.dateRange.endDate” - # The default sorting order is ascending. To specify descending order for - # a field, a suffix "desc" should be added to the field name. Example: - # `displayName desc`. + # Field by which to sort the list. Acceptable values are: * "displayName" ( + # default) * "entityStatus" * “flight.dateRange.endDate” The default sorting + # order is ascending. To specify descending order for a field, a suffix "desc" + # should be added to the field name. Example: `displayName desc`. # @param [Fixnum] page_size # Requested page size. Must be between `1` and `100`. If unspecified will - # default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value - # is specified. + # default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is + # specified. # @param [String] page_token - # A token identifying a page of results the server should return. - # Typically, this is the value of - # next_page_token - # returned from the previous call to `ListLineItems` method. - # If not specified, the first page of results will be returned. + # A token identifying a page of results the server should return. Typically, + # this is the value of next_page_token returned from the previous call to ` + # ListLineItems` method. If not specified, the first page of results will be + # returned. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1752,8 +1613,7 @@ module Google execute_or_queue_command(command, &block) end - # Updates an existing line item. - # Returns the updated line item if successful. + # Updates an existing line item. Returns the updated line item if successful. # @param [Fixnum] advertiser_id # Output only. The unique ID of the advertiser the line item belongs to. # @param [Fixnum] line_item_id @@ -1792,8 +1652,8 @@ module Google execute_or_queue_command(command, &block) end - # Assigns a targeting option to a line item. - # Returns the assigned targeting option if successful. + # Assigns a targeting option to a line item. Returns the assigned targeting + # option if successful. # @param [Fixnum] advertiser_id # Required. The ID of the advertiser the line item belongs to. # @param [Fixnum] line_item_id @@ -1919,39 +1779,30 @@ module Google # @param [String] targeting_type # Required. Identifies the type of assigned targeting options to list. # @param [String] filter - # Allows filtering by assigned targeting option properties. - # Supported syntax: - # * Filter expressions are made up of one or more restrictions. - # * Restrictions can be combined by the logical operator `OR`. - # * A restriction has the form of ``field` `operator` `value``. - # * The operator must be `EQUALS (=)`. - # * Supported fields: - # - `assignedTargetingOptionId` - # - `inheritance` - # Examples: - # * AssignedTargetingOptions with ID 1 or 2 - # `assignedTargetingOptionId="1" OR assignedTargetingOptionId="2"` - # * AssignedTargetingOptions with inheritance status of NOT_INHERITED or - # INHERITED_FROM_PARTNER - # `inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` - # The length of this field should be no more than 500 characters. + # Allows filtering by assigned targeting option properties. Supported syntax: * + # Filter expressions are made up of one or more restrictions. * Restrictions can + # be combined by the logical operator `OR`. * A restriction has the form of `` + # field` `operator` `value``. * The operator must be `EQUALS (=)`. * Supported + # fields: - `assignedTargetingOptionId` - `inheritance` Examples: * + # AssignedTargetingOptions with ID 1 or 2 `assignedTargetingOptionId="1" OR + # assignedTargetingOptionId="2"` * AssignedTargetingOptions with inheritance + # status of NOT_INHERITED or INHERITED_FROM_PARTNER `inheritance="NOT_INHERITED" + # OR inheritance="INHERITED_FROM_PARTNER"` The length of this field should be no + # more than 500 characters. # @param [String] order_by - # Field by which to sort the list. - # Acceptable values are: - # * `assignedTargetingOptionId` (default) - # The default sorting order is ascending. To specify descending order for - # a field, a suffix "desc" should be added to the field name. Example: - # `assignedTargetingOptionId desc`. + # Field by which to sort the list. Acceptable values are: * ` + # assignedTargetingOptionId` (default) The default sorting order is ascending. + # To specify descending order for a field, a suffix "desc" should be added to + # the field name. Example: `assignedTargetingOptionId desc`. # @param [Fixnum] page_size # Requested page size. Must be between `1` and `100`. If unspecified will - # default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value - # is specified. + # default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is + # specified. # @param [String] page_token - # A token identifying a page of results the server should return. - # Typically, this is the value of - # next_page_token - # returned from the previous call to `ListLineItemAssignedTargetingOptions` - # method. If not specified, the first page of results will be returned. + # A token identifying a page of results the server should return. Typically, + # this is the value of next_page_token returned from the previous call to ` + # ListLineItemAssignedTargetingOptions` method. If not specified, the first page + # of results will be returned. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2058,38 +1909,27 @@ module Google # Required. The ID of the DV360 advertiser to which the fetched location lists # belong. # @param [String] filter - # Allows filtering by location list fields. - # Supported syntax: - # * Filter expressions are made up of one or more restrictions. - # * Restrictions can be combined by `AND` or `OR` logical operators. A - # sequence of restrictions implicitly uses `AND`. - # * A restriction has the form of ``field` `operator` `value``. - # * The operator must be `EQUALS (=)`. - # * Supported fields: - # - `locationType` - # Examples: - # * All regional location list: - # `locationType="TARGETING_LOCATION_TYPE_REGIONAL"` - # * All proximity location list: - # `locationType="TARGETING_LOCATION_TYPE_PROXIMITY"` + # Allows filtering by location list fields. Supported syntax: * Filter + # expressions are made up of one or more restrictions. * Restrictions can be + # combined by `AND` or `OR` logical operators. A sequence of restrictions + # implicitly uses `AND`. * A restriction has the form of ``field` `operator` ` + # value``. * The operator must be `EQUALS (=)`. * Supported fields: - ` + # locationType` Examples: * All regional location list: `locationType=" + # TARGETING_LOCATION_TYPE_REGIONAL"` * All proximity location list: ` + # locationType="TARGETING_LOCATION_TYPE_PROXIMITY"` # @param [String] order_by - # Field by which to sort the list. - # Acceptable values are: - # * `locationListId` (default) - # * `displayName` - # The default sorting order is ascending. To specify descending order for - # a field, a suffix "desc" should be added to the field name. Example: - # `displayName desc`. + # Field by which to sort the list. Acceptable values are: * `locationListId` ( + # default) * `displayName` The default sorting order is ascending. To specify + # descending order for a field, a suffix "desc" should be added to the field + # name. Example: `displayName desc`. # @param [Fixnum] page_size - # Requested page size. Must be between `1` and `100`. - # Defaults to `100` if not set. Returns error code `INVALID_ARGUMENT` if an - # invalid value is specified. + # Requested page size. Must be between `1` and `100`. Defaults to `100` if not + # set. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. # @param [String] page_token - # A token identifying a page of results the server should return. - # Typically, this is the value of - # next_page_token - # returned from the previous call to `ListLocationLists` method. - # If not specified, the first page of results will be returned. + # A token identifying a page of results the server should return. Typically, + # this is the value of next_page_token returned from the previous call to ` + # ListLocationLists` method. If not specified, the first page of results will be + # returned. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2160,12 +2000,11 @@ module Google execute_or_queue_command(command, &block) end - # Bulk edits multiple assignments between locations and a single location - # list. + # Bulk edits multiple assignments between locations and a single location list. # The operation will delete the assigned locations provided in - # BulkEditAssignedLocationsRequest.deleted_assigned_locations and then - # create the assigned locations provided in - # BulkEditAssignedLocationsRequest.created_assigned_locations. + # BulkEditAssignedLocationsRequest.deleted_assigned_locations and then create + # the assigned locations provided in BulkEditAssignedLocationsRequest. + # created_assigned_locations. # @param [Fixnum] advertiser_id # Required. The ID of the DV360 advertiser to which the location list belongs. # @param [Fixnum] location_list_id @@ -2279,32 +2118,26 @@ module Google # @param [Fixnum] location_list_id # Required. The ID of the location list to which these assignments are assigned. # @param [String] filter - # Allows filtering by location list assignment fields. - # Supported syntax: - # * Filter expressions are made up of one or more restrictions. - # * Restrictions can be combined by the logical operator `OR`. - # * A restriction has the form of ``field` `operator` `value``. - # * The operator must be `EQUALS (=)`. - # * Supported fields: - # - `assignedLocationId` - # The length of this field should be no more than 500 characters. + # Allows filtering by location list assignment fields. Supported syntax: * + # Filter expressions are made up of one or more restrictions. * Restrictions can + # be combined by the logical operator `OR`. * A restriction has the form of `` + # field` `operator` `value``. * The operator must be `EQUALS (=)`. * Supported + # fields: - `assignedLocationId` The length of this field should be no more than + # 500 characters. # @param [String] order_by - # Field by which to sort the list. - # Acceptable values are: - # * `assignedLocationId` (default) - # The default sorting order is ascending. To specify descending order for a - # field, a suffix " desc" should be added to the field name. Example: - # `assignedLocationId desc`. + # Field by which to sort the list. Acceptable values are: * `assignedLocationId` + # (default) The default sorting order is ascending. To specify descending order + # for a field, a suffix " desc" should be added to the field name. Example: ` + # assignedLocationId desc`. # @param [Fixnum] page_size # Requested page size. Must be between `1` and `100`. If unspecified will - # default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value - # is specified. + # default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is + # specified. # @param [String] page_token - # A token identifying a page of results the server should return. - # Typically, this is the value of - # next_page_token - # returned from the previous call to `ListAssignedLocations` - # method. If not specified, the first page of results will be returned. + # A token identifying a page of results the server should return. Typically, + # this is the value of next_page_token returned from the previous call to ` + # ListAssignedLocations` method. If not specified, the first page of results + # will be returned. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2341,8 +2174,7 @@ module Google # keyword list if successful. # @param [Fixnum] advertiser_id # Required. The ID of the DV360 advertiser to which the negative keyword list - # will - # belong. + # will belong. # @param [Google::Apis::DisplayvideoV1::NegativeKeywordList] negative_keyword_list_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -2373,8 +2205,8 @@ module Google execute_or_queue_command(command, &block) end - # Deletes a negative keyword list given an advertiser ID and a negative - # keyword list ID. + # Deletes a negative keyword list given an advertiser ID and a negative keyword + # list ID. # @param [Fixnum] advertiser_id # Required. The ID of the DV360 advertiser to which the negative keyword list # belongs. @@ -2412,8 +2244,7 @@ module Google # list ID. # @param [Fixnum] advertiser_id # Required. The ID of the DV360 advertiser to which the fetched negative keyword - # list - # belongs. + # list belongs. # @param [Fixnum] negative_keyword_list_id # Required. The ID of the negative keyword list to fetch. # @param [String] fields @@ -2447,18 +2278,15 @@ module Google # Lists negative keyword lists based on a given advertiser id. # @param [Fixnum] advertiser_id # Required. The ID of the DV360 advertiser to which the fetched negative keyword - # lists - # belong. + # lists belong. # @param [Fixnum] page_size - # Requested page size. Must be between `1` and `100`. - # Defaults to `100` if not set. Returns error code `INVALID_ARGUMENT` if an - # invalid value is specified. + # Requested page size. Must be between `1` and `100`. Defaults to `100` if not + # set. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. # @param [String] page_token - # A token identifying a page of results the server should return. - # Typically, this is the value of - # next_page_token - # returned from the previous call to `ListNegativeKeywordLists` method. - # If not specified, the first page of results will be returned. + # A token identifying a page of results the server should return. Typically, + # this is the value of next_page_token returned from the previous call to ` + # ListNegativeKeywordLists` method. If not specified, the first page of results + # will be returned. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2488,8 +2316,8 @@ module Google execute_or_queue_command(command, &block) end - # Updates a negative keyword list. Returns the updated negative keyword list - # if successful. + # Updates a negative keyword list. Returns the updated negative keyword list if + # successful. # @param [Fixnum] advertiser_id # Required. The ID of the DV360 advertiser to which the negative keyword list # belongs. @@ -2530,21 +2358,18 @@ module Google execute_or_queue_command(command, &block) end - # Bulk edits negative keywords in a single negative keyword list. - # The operation will delete the negative keywords provided in - # BulkEditNegativeKeywordsRequest.deleted_negative_keywords and then - # create the negative keywords provided in - # BulkEditNegativeKeywordsRequest.created_negative_keywords. - # This operation is guaranteed to be atomic and will never result in a - # partial success or partial failure. + # Bulk edits negative keywords in a single negative keyword list. The operation + # will delete the negative keywords provided in BulkEditNegativeKeywordsRequest. + # deleted_negative_keywords and then create the negative keywords provided in + # BulkEditNegativeKeywordsRequest.created_negative_keywords. This operation is + # guaranteed to be atomic and will never result in a partial success or partial + # failure. # @param [Fixnum] advertiser_id # Required. The ID of the DV360 advertiser to which the parent negative keyword - # list - # belongs. + # list belongs. # @param [Fixnum] negative_keyword_list_id # Required. The ID of the parent negative keyword list to which the negative - # keywords - # belong. + # keywords belong. # @param [Google::Apis::DisplayvideoV1::BulkEditNegativeKeywordsRequest] bulk_edit_negative_keywords_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -2579,12 +2404,10 @@ module Google # Creates a negative keyword in a negative keyword list. # @param [Fixnum] advertiser_id # Required. The ID of the DV360 advertiser to which the parent negative keyword - # list - # belongs. + # list belongs. # @param [Fixnum] negative_keyword_list_id # Required. The ID of the parent negative keyword list in which the negative - # keyword - # will be created. + # keyword will be created. # @param [Google::Apis::DisplayvideoV1::NegativeKeyword] negative_keyword_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -2619,12 +2442,10 @@ module Google # Deletes a negative keyword from a negative keyword list. # @param [Fixnum] advertiser_id # Required. The ID of the DV360 advertiser to which the parent negative keyword - # list - # belongs. + # list belongs. # @param [Fixnum] negative_keyword_list_id # Required. The ID of the parent negative keyword list to which the negative - # keyword - # belongs. + # keyword belongs. # @param [String] keyword_value # Required. The keyword value of the negative keyword to delete. # @param [String] fields @@ -2659,42 +2480,31 @@ module Google # Lists negative keywords in a negative keyword list. # @param [Fixnum] advertiser_id # Required. The ID of the DV360 advertiser to which the parent negative keyword - # list - # belongs. + # list belongs. # @param [Fixnum] negative_keyword_list_id # Required. The ID of the parent negative keyword list to which the requested - # negative - # keywords belong. + # negative keywords belong. # @param [String] filter - # Allows filtering by negative keyword fields. - # Supported syntax: - # * Filter expressions for negative keyword currently can only contain at - # most one - # * restriction. - # * A restriction has the form of ``field` `operator` `value``. - # * The operator must be `CONTAINS (:)`. - # * Supported fields: - # - `keywordValue` - # Examples: - # * All negative keywords for which the keyword value contains "google": - # `keywordValue : "google"` + # Allows filtering by negative keyword fields. Supported syntax: * Filter + # expressions for negative keyword currently can only contain at most one * + # restriction. * A restriction has the form of ``field` `operator` `value``. * + # The operator must be `CONTAINS (:)`. * Supported fields: - `keywordValue` + # Examples: * All negative keywords for which the keyword value contains "google" + # : `keywordValue : "google"` # @param [String] order_by - # Field by which to sort the list. - # Acceptable values are: - # * `keywordValue` (default) - # The default sorting order is ascending. To specify descending order for a - # field, a suffix " desc" should be added to the field name. Example: - # `keywordValue desc`. + # Field by which to sort the list. Acceptable values are: * `keywordValue` ( + # default) The default sorting order is ascending. To specify descending order + # for a field, a suffix " desc" should be added to the field name. Example: ` + # keywordValue desc`. # @param [Fixnum] page_size # Requested page size. Must be between `1` and `100`. If unspecified will - # default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value - # is specified. + # default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is + # specified. # @param [String] page_token - # A token identifying a page of results the server should return. - # Typically, this is the value of - # next_page_token returned - # from the previous call to `ListNegativeKeywords` method. If not specified, - # the first page of results will be returned. + # A token identifying a page of results the server should return. Typically, + # this is the value of next_page_token returned from the previous call to ` + # ListNegativeKeywords` method. If not specified, the first page of results will + # be returned. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2727,8 +2537,8 @@ module Google execute_or_queue_command(command, &block) end - # Assigns a targeting option to an advertiser. - # Returns the assigned targeting option if successful. + # Assigns a targeting option to an advertiser. Returns the assigned targeting + # option if successful. # @param [Fixnum] advertiser_id # Required. The ID of the advertiser. # @param [String] targeting_type @@ -2843,35 +2653,27 @@ module Google # @param [String] targeting_type # Required. Identifies the type of assigned targeting options to list. # @param [String] filter - # Allows filtering by assigned targeting option properties. - # Supported syntax: - # * Filter expressions are made up of one or more restrictions. - # * Restrictions can be combined by the logical operator `OR`. - # * A restriction has the form of ``field` `operator` `value``. - # * The operator must be `EQUALS (=)`. - # * Supported fields: - # - `assignedTargetingOptionId` - # Examples: - # * AssignedTargetingOption with ID 123456 - # `assignedTargetingOptionId="123456"` - # The length of this field should be no more than 500 characters. + # Allows filtering by assigned targeting option properties. Supported syntax: * + # Filter expressions are made up of one or more restrictions. * Restrictions can + # be combined by the logical operator `OR`. * A restriction has the form of `` + # field` `operator` `value``. * The operator must be `EQUALS (=)`. * Supported + # fields: - `assignedTargetingOptionId` Examples: * AssignedTargetingOption with + # ID 123456 `assignedTargetingOptionId="123456"` The length of this field should + # be no more than 500 characters. # @param [String] order_by - # Field by which to sort the list. - # Acceptable values are: - # * `assignedTargetingOptionId` (default) - # The default sorting order is ascending. To specify descending order for - # a field, a suffix "desc" should be added to the field name. Example: - # `assignedTargetingOptionId desc`. + # Field by which to sort the list. Acceptable values are: * ` + # assignedTargetingOptionId` (default) The default sorting order is ascending. + # To specify descending order for a field, a suffix "desc" should be added to + # the field name. Example: `assignedTargetingOptionId desc`. # @param [Fixnum] page_size # Requested page size. Must be between `1` and `100`. If unspecified will - # default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value - # is specified. + # default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is + # specified. # @param [String] page_token - # A token identifying a page of results the server should return. - # Typically, this is the value of - # next_page_token - # returned from the previous call to `ListAdvertiserAssignedTargetingOptions` - # method. If not specified, the first page of results will be returned. + # A token identifying a page of results the server should return. Typically, + # this is the value of next_page_token returned from the previous call to ` + # ListAdvertiserAssignedTargetingOptions` method. If not specified, the first + # page of results will be returned. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2908,8 +2710,7 @@ module Google # @param [Fixnum] combined_audience_id # Required. The ID of the combined audience to fetch. # @param [Fixnum] advertiser_id - # The ID of the advertiser that has access to the fetched combined - # audience. + # The ID of the advertiser that has access to the fetched combined audience. # @param [Fixnum] partner_id # The ID of the partner that has access to the fetched combined audience. # @param [String] fields @@ -2941,43 +2742,31 @@ module Google execute_or_queue_command(command, &block) end - # Lists combined audiences. - # The order is defined by the - # order_by parameter. + # Lists combined audiences. The order is defined by the order_by parameter. # @param [Fixnum] advertiser_id - # The ID of the advertiser that has access to the fetched combined - # audiences. + # The ID of the advertiser that has access to the fetched combined audiences. # @param [String] filter - # Allows filtering by combined audience fields. - # Supported syntax: - # * Filter expressions for combined audiences currently can only contain at - # most one restriction. - # * A restriction has the form of ``field` `operator` `value``. - # * The operator must be `CONTAINS (:)`. - # * Supported fields: - # - `displayName` - # Examples: - # * All combined audiences for which the display name contains "Google": - # `displayName : "Google"`. - # The length of this field should be no more than 500 characters. + # Allows filtering by combined audience fields. Supported syntax: * Filter + # expressions for combined audiences currently can only contain at most one + # restriction. * A restriction has the form of ``field` `operator` `value``. * + # The operator must be `CONTAINS (:)`. * Supported fields: - `displayName` + # Examples: * All combined audiences for which the display name contains "Google" + # : `displayName : "Google"`. The length of this field should be no more than + # 500 characters. # @param [String] order_by - # Field by which to sort the list. - # Acceptable values are: - # * `combinedAudienceId` (default) - # * `displayName` - # The default sorting order is ascending. To specify descending order for - # a field, a suffix "desc" should be added to the field name. Example: - # `displayName desc`. + # Field by which to sort the list. Acceptable values are: * `combinedAudienceId` + # (default) * `displayName` The default sorting order is ascending. To specify + # descending order for a field, a suffix "desc" should be added to the field + # name. Example: `displayName desc`. # @param [Fixnum] page_size # Requested page size. Must be between `1` and `100`. If unspecified will - # default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value - # is specified. + # default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is + # specified. # @param [String] page_token - # A token identifying a page of results the server should return. - # Typically, this is the value of - # next_page_token - # returned from the previous call to `ListCombinedAudiences` method. - # If not specified, the first page of results will be returned. + # A token identifying a page of results the server should return. Typically, + # this is the value of next_page_token returned from the previous call to ` + # ListCombinedAudiences` method. If not specified, the first page of results + # will be returned. # @param [Fixnum] partner_id # The ID of the partner that has access to the fetched combined audiences. # @param [String] fields @@ -3016,8 +2805,7 @@ module Google # @param [Fixnum] custom_list_id # Required. The ID of the custom list to fetch. # @param [Fixnum] advertiser_id - # The ID of the DV360 advertiser that has access to the fetched custom - # lists. + # The ID of the DV360 advertiser that has access to the fetched custom lists. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -3046,43 +2834,30 @@ module Google execute_or_queue_command(command, &block) end - # Lists custom lists. - # The order is defined by the order_by - # parameter. + # Lists custom lists. The order is defined by the order_by parameter. # @param [Fixnum] advertiser_id - # The ID of the DV360 advertiser that has access to the fetched custom - # lists. + # The ID of the DV360 advertiser that has access to the fetched custom lists. # @param [String] filter - # Allows filtering by custom list fields. - # Supported syntax: - # * Filter expressions for custom lists currently can only contain at - # most one restriction. - # * A restriction has the form of ``field` `operator` `value``. - # * The operator must be `CONTAINS (:)`. - # * Supported fields: - # - `displayName` - # Examples: - # * All custom lists for which the display name contains "Google": - # `displayName : "Google"`. + # Allows filtering by custom list fields. Supported syntax: * Filter expressions + # for custom lists currently can only contain at most one restriction. * A + # restriction has the form of ``field` `operator` `value``. * The operator must + # be `CONTAINS (:)`. * Supported fields: - `displayName` Examples: * All custom + # lists for which the display name contains "Google": `displayName : "Google"`. # The length of this field should be no more than 500 characters. # @param [String] order_by - # Field by which to sort the list. - # Acceptable values are: - # * `customListId` (default) - # * `displayName` - # The default sorting order is ascending. To specify descending order for - # a field, a suffix "desc" should be added to the field name. Example: - # `displayName desc`. + # Field by which to sort the list. Acceptable values are: * `customListId` ( + # default) * `displayName` The default sorting order is ascending. To specify + # descending order for a field, a suffix "desc" should be added to the field + # name. Example: `displayName desc`. # @param [Fixnum] page_size # Requested page size. Must be between `1` and `100`. If unspecified will - # default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value - # is specified. + # default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is + # specified. # @param [String] page_token - # A token identifying a page of results the server should return. - # Typically, this is the value of - # next_page_token - # returned from the previous call to `ListCustomLists` method. - # If not specified, the first page of results will be returned. + # A token identifying a page of results the server should return. Typically, + # this is the value of next_page_token returned from the previous call to ` + # ListCustomLists` method. If not specified, the first page of results will be + # returned. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -3118,11 +2893,11 @@ module Google # @param [Fixnum] first_and_third_party_audience_id # Required. The ID of the first and third party audience to fetch. # @param [Fixnum] advertiser_id - # The ID of the advertiser that has access to the fetched first and - # third party audience. + # The ID of the advertiser that has access to the fetched first and third party + # audience. # @param [Fixnum] partner_id - # The ID of the partner that has access to the fetched first and - # third party audience. + # The ID of the partner that has access to the fetched first and third party + # audience. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -3152,46 +2927,36 @@ module Google execute_or_queue_command(command, &block) end - # Lists first and third party audiences. - # The order is defined by the - # order_by parameter. + # Lists first and third party audiences. The order is defined by the order_by + # parameter. # @param [Fixnum] advertiser_id - # The ID of the advertiser that has access to the fetched first and - # third party audiences. + # The ID of the advertiser that has access to the fetched first and third party + # audiences. # @param [String] filter - # Allows filtering by first and third party audience fields. - # Supported syntax: - # * Filter expressions for first and third party audiences currently can - # only contain at most one restriction. - # * A restriction has the form of ``field` `operator` `value``. - # * The operator must be `CONTAINS (:)`. - # * Supported fields: - # - `displayName` - # Examples: - # * All first and third party audiences for which the display name contains - # "Google": `displayName : "Google"`. - # The length of this field should be no more than 500 characters. + # Allows filtering by first and third party audience fields. Supported syntax: * + # Filter expressions for first and third party audiences currently can only + # contain at most one restriction. * A restriction has the form of ``field` ` + # operator` `value``. * The operator must be `CONTAINS (:)`. * Supported fields: + # - `displayName` Examples: * All first and third party audiences for which the + # display name contains "Google": `displayName : "Google"`. The length of this + # field should be no more than 500 characters. # @param [String] order_by - # Field by which to sort the list. - # Acceptable values are: - # * `firstAndThirdPartyAudienceId` (default) - # * `displayName` - # The default sorting order is ascending. To specify descending order for - # a field, a suffix "desc" should be added to the field name. Example: - # `displayName desc`. + # Field by which to sort the list. Acceptable values are: * ` + # firstAndThirdPartyAudienceId` (default) * `displayName` The default sorting + # order is ascending. To specify descending order for a field, a suffix "desc" + # should be added to the field name. Example: `displayName desc`. # @param [Fixnum] page_size # Requested page size. Must be between `1` and `100`. If unspecified will - # default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value - # is specified. + # default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is + # specified. # @param [String] page_token - # A token identifying a page of results the server should return. - # Typically, this is the value of - # next_page_token - # returned from the previous call to `ListFirstAndThirdPartyAudiences` - # method. If not specified, the first page of results will be returned. + # A token identifying a page of results the server should return. Typically, + # this is the value of next_page_token returned from the previous call to ` + # ListFirstAndThirdPartyAudiences` method. If not specified, the first page of + # results will be returned. # @param [Fixnum] partner_id - # The ID of the partner that has access to the fetched first and - # third party audiences. + # The ID of the partner that has access to the fetched first and third party + # audiences. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -3257,8 +3022,8 @@ module Google execute_or_queue_command(command, &block) end - # Updates an existing Floodlight group. - # Returns the updated Floodlight group if successful. + # Updates an existing Floodlight group. Returns the updated Floodlight group if + # successful. # @param [Fixnum] floodlight_group_id # Output only. The unique ID of the Floodlight group. Assigned by the system. # @param [Google::Apis::DisplayvideoV1::FloodlightGroup] floodlight_group_object @@ -3333,42 +3098,31 @@ module Google execute_or_queue_command(command, &block) end - # Lists Google audiences. - # The order is defined by the order_by - # parameter. + # Lists Google audiences. The order is defined by the order_by parameter. # @param [Fixnum] advertiser_id # The ID of the advertiser that has access to the fetched Google audiences. # @param [String] filter - # Allows filtering by Google audience fields. - # Supported syntax: - # * Filter expressions for Google audiences currently can only contain at - # most one restriction. - # * A restriction has the form of ``field` `operator` `value``. - # * The operator must be `CONTAINS (:)`. - # * Supported fields: - # - `displayName` - # Examples: - # * All Google audiences for which the display name contains "Google": - # `displayName : "Google"`. - # The length of this field should be no more than 500 characters. + # Allows filtering by Google audience fields. Supported syntax: * Filter + # expressions for Google audiences currently can only contain at most one + # restriction. * A restriction has the form of ``field` `operator` `value``. * + # The operator must be `CONTAINS (:)`. * Supported fields: - `displayName` + # Examples: * All Google audiences for which the display name contains "Google": + # `displayName : "Google"`. The length of this field should be no more than 500 + # characters. # @param [String] order_by - # Field by which to sort the list. - # Acceptable values are: - # * `googleAudienceId` (default) - # * `displayName` - # The default sorting order is ascending. To specify descending order for - # a field, a suffix "desc" should be added to the field name. Example: - # `displayName desc`. + # Field by which to sort the list. Acceptable values are: * `googleAudienceId` ( + # default) * `displayName` The default sorting order is ascending. To specify + # descending order for a field, a suffix "desc" should be added to the field + # name. Example: `displayName desc`. # @param [Fixnum] page_size # Requested page size. Must be between `1` and `100`. If unspecified will - # default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value - # is specified. + # default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is + # specified. # @param [String] page_token - # A token identifying a page of results the server should return. - # Typically, this is the value of - # next_page_token - # returned from the previous call to `ListGoogleAudiences` method. - # If not specified, the first page of results will be returned. + # A token identifying a page of results the server should return. Typically, + # this is the value of next_page_token returned from the previous call to ` + # ListGoogleAudiences` method. If not specified, the first page of results will + # be returned. # @param [Fixnum] partner_id # The ID of the partner that has access to the fetched Google audiences. # @param [String] fields @@ -3407,13 +3161,12 @@ module Google # source group if successful. # @param [Google::Apis::DisplayvideoV1::InventorySourceGroup] inventory_source_group_object # @param [Fixnum] advertiser_id - # The ID of the advertiser that owns the inventory source group. - # The parent partner will not have access to this group. + # The ID of the advertiser that owns the inventory source group. The parent + # partner will not have access to this group. # @param [Fixnum] partner_id - # The ID of the partner that owns the inventory source group. - # Only this partner will have write access to this group. Only advertisers - # to which this group is explicitly shared will have read access to this - # group. + # The ID of the partner that owns the inventory source group. Only this partner + # will have write access to this group. Only advertisers to which this group is + # explicitly shared will have read access to this group. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -3448,11 +3201,11 @@ module Google # @param [Fixnum] inventory_source_group_id # Required. The ID of the inventory source group to delete. # @param [Fixnum] advertiser_id - # The ID of the advertiser that owns the inventory source group. - # The parent partner does not have access to this group. + # The ID of the advertiser that owns the inventory source group. The parent + # partner does not have access to this group. # @param [Fixnum] partner_id - # The ID of the partner that owns the inventory source group. - # Only this partner has write access to this group. + # The ID of the partner that owns the inventory source group. Only this partner + # has write access to this group. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -3486,12 +3239,12 @@ module Google # @param [Fixnum] inventory_source_group_id # Required. The ID of the inventory source group to fetch. # @param [Fixnum] advertiser_id - # The ID of the advertiser that has access to the inventory source group. - # If an inventory source group is partner-owned, only advertisers to which - # the group is explicitly shared can access the group. + # The ID of the advertiser that has access to the inventory source group. If an + # inventory source group is partner-owned, only advertisers to which the group + # is explicitly shared can access the group. # @param [Fixnum] partner_id - # The ID of the partner that has access to the inventory source group. - # A partner cannot access an advertiser-owned inventory source group. + # The ID of the partner that has access to the inventory source group. A partner + # cannot access an advertiser-owned inventory source group. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -3521,43 +3274,35 @@ module Google execute_or_queue_command(command, &block) end - # Lists inventory source groups that are accessible to the current user. - # The order is defined by the - # order_by parameter. + # Lists inventory source groups that are accessible to the current user. The + # order is defined by the order_by parameter. # @param [Fixnum] advertiser_id - # The ID of the advertiser that has access to the inventory source group. - # If an inventory source group is partner-owned, only advertisers to which - # the group is explicitly shared can access the group. + # The ID of the advertiser that has access to the inventory source group. If an + # inventory source group is partner-owned, only advertisers to which the group + # is explicitly shared can access the group. # @param [String] filter - # Allows filtering by inventory source group properties. - # Supported syntax: - # * Filter expressions are made up of one or more restrictions. - # * Restrictions can be combined by the logical operator `OR`. - # * A restriction has the form of ``field` `operator` `value``. - # * The operator must be `EQUALS (=)`. - # * Supported fields: - # - `inventorySourceGroupId` - # The length of this field should be no more than 500 characters. + # Allows filtering by inventory source group properties. Supported syntax: * + # Filter expressions are made up of one or more restrictions. * Restrictions can + # be combined by the logical operator `OR`. * A restriction has the form of `` + # field` `operator` `value``. * The operator must be `EQUALS (=)`. * Supported + # fields: - `inventorySourceGroupId` The length of this field should be no more + # than 500 characters. # @param [String] order_by - # Field by which to sort the list. - # Acceptable values are: - # * `displayName` (default) - # * `inventorySourceGroupId` - # The default sorting order is ascending. To specify descending order for - # a field, a suffix "desc" should be added to the field name. For example, - # `displayName desc`. + # Field by which to sort the list. Acceptable values are: * `displayName` ( + # default) * `inventorySourceGroupId` The default sorting order is ascending. To + # specify descending order for a field, a suffix "desc" should be added to the + # field name. For example, `displayName desc`. # @param [Fixnum] page_size # Requested page size. Must be between `1` and `100`. If unspecified will # default to `100`. # @param [String] page_token - # A token identifying a page of results the server should return. - # Typically, this is the value of - # next_page_token - # returned from the previous call to `ListInventorySources` method. - # If not specified, the first page of results will be returned. + # A token identifying a page of results the server should return. Typically, + # this is the value of next_page_token returned from the previous call to ` + # ListInventorySources` method. If not specified, the first page of results will + # be returned. # @param [Fixnum] partner_id - # The ID of the partner that has access to the inventory source group. - # A partner cannot access advertiser-owned inventory source groups. + # The ID of the partner that has access to the inventory source group. A partner + # cannot access advertiser-owned inventory source groups. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -3590,18 +3335,18 @@ module Google execute_or_queue_command(command, &block) end - # Updates an inventory source group. Returns the updated inventory source - # group if successful. + # Updates an inventory source group. Returns the updated inventory source group + # if successful. # @param [Fixnum] inventory_source_group_id # Output only. The unique ID of the inventory source group. Assigned by the # system. # @param [Google::Apis::DisplayvideoV1::InventorySourceGroup] inventory_source_group_object # @param [Fixnum] advertiser_id - # The ID of the advertiser that owns the inventory source group. - # The parent partner does not have access to this group. + # The ID of the advertiser that owns the inventory source group. The parent + # partner does not have access to this group. # @param [Fixnum] partner_id - # The ID of the partner that owns the inventory source group. - # Only this partner has write access to this group. + # The ID of the partner that owns the inventory source group. Only this partner + # has write access to this group. # @param [String] update_mask # Required. The mask to control which fields to update. # @param [String] fields @@ -3637,11 +3382,11 @@ module Google end # Bulk edits multiple assignments between inventory sources and a single - # inventory source group. - # The operation will delete the assigned inventory sources provided in - # BulkEditAssignedInventorySourcesRequest.deleted_assigned_inventory_sources - # and then create the assigned inventory sources provided in - # BulkEditAssignedInventorySourcesRequest.created_assigned_inventory_sources. + # inventory source group. The operation will delete the assigned inventory + # sources provided in BulkEditAssignedInventorySourcesRequest. + # deleted_assigned_inventory_sources and then create the assigned inventory + # sources provided in BulkEditAssignedInventorySourcesRequest. + # created_assigned_inventory_sources. # @param [Fixnum] inventory_source_group_id # Required. The ID of the inventory source group to which the assignments are # assigned. @@ -3682,13 +3427,11 @@ module Google # assigned. # @param [Google::Apis::DisplayvideoV1::AssignedInventorySource] assigned_inventory_source_object # @param [Fixnum] advertiser_id - # The ID of the advertiser that owns the parent inventory source group. - # The parent partner will not have access to this assigned inventory - # source. + # The ID of the advertiser that owns the parent inventory source group. The + # parent partner will not have access to this assigned inventory source. # @param [Fixnum] partner_id - # The ID of the partner that owns the parent inventory source group. - # Only this partner will have write access to this assigned inventory - # source. + # The ID of the partner that owns the parent inventory source group. Only this + # partner will have write access to this assigned inventory source. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -3728,12 +3471,11 @@ module Google # @param [Fixnum] assigned_inventory_source_id # Required. The ID of the assigned inventory source to delete. # @param [Fixnum] advertiser_id - # The ID of the advertiser that owns the parent inventory source group. - # The parent partner does not have access to this assigned inventory - # source. + # The ID of the advertiser that owns the parent inventory source group. The + # parent partner does not have access to this assigned inventory source. # @param [Fixnum] partner_id - # The ID of the partner that owns the parent inventory source group. - # Only this partner has write access to this assigned inventory source. + # The ID of the partner that owns the parent inventory source group. Only this + # partner has write access to this assigned inventory source. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -3769,41 +3511,34 @@ module Google # Required. The ID of the inventory source group to which these assignments are # assigned. # @param [Fixnum] advertiser_id - # The ID of the advertiser that has access to the assignment. - # If the parent inventory source group is partner-owned, only advertisers - # to which the parent group is explicitly shared can access the assigned - # inventory source. + # The ID of the advertiser that has access to the assignment. If the parent + # inventory source group is partner-owned, only advertisers to which the parent + # group is explicitly shared can access the assigned inventory source. # @param [String] filter - # Allows filtering by assigned inventory source fields. - # Supported syntax: - # * Filter expressions are made up of one or more restrictions. - # * Restrictions can be combined by the logical operator `OR`. - # * A restriction has the form of ``field` `operator` `value``. - # * The operator must be `EQUALS (=)`. - # * Supported fields: - # - `assignedInventorySourceId` - # The length of this field should be no more than 500 characters. + # Allows filtering by assigned inventory source fields. Supported syntax: * + # Filter expressions are made up of one or more restrictions. * Restrictions can + # be combined by the logical operator `OR`. * A restriction has the form of `` + # field` `operator` `value``. * The operator must be `EQUALS (=)`. * Supported + # fields: - `assignedInventorySourceId` The length of this field should be no + # more than 500 characters. # @param [String] order_by - # Field by which to sort the list. - # Acceptable values are: - # * `assignedInventorySourceId` (default) - # The default sorting order is ascending. To specify descending order for a - # field, a suffix " desc" should be added to the field name. Example: - # `assignedInventorySourceId desc`. + # Field by which to sort the list. Acceptable values are: * ` + # assignedInventorySourceId` (default) The default sorting order is ascending. + # To specify descending order for a field, a suffix " desc" should be added to + # the field name. Example: `assignedInventorySourceId desc`. # @param [Fixnum] page_size # Requested page size. Must be between `1` and `100`. If unspecified will - # default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value - # is specified. + # default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is + # specified. # @param [String] page_token - # A token identifying a page of results the server should return. - # Typically, this is the value of - # next_page_token - # returned from the previous call to `ListAssignedInventorySources` - # method. If not specified, the first page of results will be returned. + # A token identifying a page of results the server should return. Typically, + # this is the value of next_page_token returned from the previous call to ` + # ListAssignedInventorySources` method. If not specified, the first page of + # results will be returned. # @param [Fixnum] partner_id - # The ID of the partner that has access to the assignment. - # If the parent inventory source group is advertiser-owned, the assignment - # cannot be accessed via a partner. + # The ID of the partner that has access to the assignment. If the parent + # inventory source group is advertiser-owned, the assignment cannot be accessed + # via a partner. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -3841,8 +3576,8 @@ module Google # @param [Fixnum] inventory_source_id # Required. The ID of the inventory source to fetch. # @param [Fixnum] partner_id - # Required. The ID of the DV360 partner to which the fetched inventory source - # is permissioned. + # Required. The ID of the DV360 partner to which the fetched inventory source is + # permissioned. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -3871,51 +3606,37 @@ module Google execute_or_queue_command(command, &block) end - # Lists inventory sources that are accessible to the current user. - # The order is defined by the - # order_by parameter. - # If a filter by - # entity_status is not - # specified, inventory sources with entity status `ENTITY_STATUS_ARCHIVED` - # will not be included in the results. + # Lists inventory sources that are accessible to the current user. The order is + # defined by the order_by parameter. If a filter by entity_status is not + # specified, inventory sources with entity status `ENTITY_STATUS_ARCHIVED` will + # not be included in the results. # @param [Fixnum] advertiser_id # The ID of the advertiser that has access to the inventory source. # @param [String] filter - # Allows filtering by inventory source properties. - # Supported syntax: - # * Filter expressions are made up of one or more restrictions. - # * Restrictions can be combined by `AND` or `OR` logical operators. A - # sequence of restrictions implicitly uses `AND`. - # * A restriction has the form of ``field` `operator` `value``. - # * The operator must be `EQUALS (=)`. - # * Supported fields: - # - `status.entityStatus` - # - `commitment` - # - `deliveryMethod` - # - `rateDetails.rateType` - # - `exchange` - # Examples: - # * All active inventory sources: - # `status.entityStatus="ENTITY_STATUS_ACTIVE"` - # * Inventory sources belonging to Google Ad Manager or Rubicon exchanges: - # `exchange="EXCHANGE_GOOGLE_AD_MANAGER" OR exchange="EXCHANGE_RUBICON"` - # The length of this field should be no more than 500 characters. + # Allows filtering by inventory source properties. Supported syntax: * Filter + # expressions are made up of one or more restrictions. * Restrictions can be + # combined by `AND` or `OR` logical operators. A sequence of restrictions + # implicitly uses `AND`. * A restriction has the form of ``field` `operator` ` + # value``. * The operator must be `EQUALS (=)`. * Supported fields: - `status. + # entityStatus` - `commitment` - `deliveryMethod` - `rateDetails.rateType` - ` + # exchange` Examples: * All active inventory sources: `status.entityStatus=" + # ENTITY_STATUS_ACTIVE"` * Inventory sources belonging to Google Ad Manager or + # Rubicon exchanges: `exchange="EXCHANGE_GOOGLE_AD_MANAGER" OR exchange=" + # EXCHANGE_RUBICON"` The length of this field should be no more than 500 + # characters. # @param [String] order_by - # Field by which to sort the list. - # Acceptable values are: - # * `displayName` (default) - # The default sorting order is ascending. To specify descending order for - # a field, a suffix "desc" should be added to the field name. For example, - # `displayName desc`. + # Field by which to sort the list. Acceptable values are: * `displayName` ( + # default) The default sorting order is ascending. To specify descending order + # for a field, a suffix "desc" should be added to the field name. For example, ` + # displayName desc`. # @param [Fixnum] page_size # Requested page size. Must be between `1` and `100`. If unspecified will # default to `100`. # @param [String] page_token - # A token identifying a page of results the server should return. - # Typically, this is the value of - # next_page_token - # returned from the previous call to `ListInventorySources` method. - # If not specified, the first page of results will be returned. + # A token identifying a page of results the server should return. Typically, + # this is the value of next_page_token returned from the previous call to ` + # ListInventorySources` method. If not specified, the first page of results will + # be returned. # @param [Fixnum] partner_id # The ID of the partner that has access to the inventory source. # @param [String] fields @@ -3951,12 +3672,10 @@ module Google end # Downloads media. Download is supported on the URI `/download/`resource_name=**` - # ?alt=media.` - # **Note**: Download requests will not be successful without including `alt= - # media` query string. + # ?alt=media.` **Note**: Download requests will not be successful without + # including `alt=media` query string. # @param [String] resource_name - # Name of the media that is being downloaded. See - # ReadRequest.resource_name. + # Name of the media that is being downloaded. See ReadRequest.resource_name. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -4069,36 +3788,26 @@ module Google # @param [Fixnum] advertiser_id # The ID of the advertiser that owns the channels. # @param [String] filter - # Allows filtering by channel fields. - # Supported syntax: - # * Filter expressions for channel currently can only contain at most one - # * restriction. - # * A restriction has the form of ``field` `operator` `value``. - # * The operator must be `CONTAINS (:)`. - # * Supported fields: - # - `displayName` - # Examples: - # * All channels for which the display name contains "google": - # `displayName : "google"`. - # The length of this field should be no more than 500 characters. + # Allows filtering by channel fields. Supported syntax: * Filter expressions for + # channel currently can only contain at most one * restriction. * A restriction + # has the form of ``field` `operator` `value``. * The operator must be `CONTAINS + # (:)`. * Supported fields: - `displayName` Examples: * All channels for which + # the display name contains "google": `displayName : "google"`. The length of + # this field should be no more than 500 characters. # @param [String] order_by - # Field by which to sort the list. - # Acceptable values are: - # * `displayName` (default) - # * `channelId` - # The default sorting order is ascending. To specify descending order for a - # field, a suffix " desc" should be added to the field name. Example: - # `displayName desc`. + # Field by which to sort the list. Acceptable values are: * `displayName` ( + # default) * `channelId` The default sorting order is ascending. To specify + # descending order for a field, a suffix " desc" should be added to the field + # name. Example: `displayName desc`. # @param [Fixnum] page_size # Requested page size. Must be between `1` and `100`. If unspecified will - # default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value - # is specified. + # default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is + # specified. # @param [String] page_token - # A token identifying a page of results the server should return. - # Typically, this is the value of - # next_page_token returned from the - # previous call to `ListChannels` method. If not specified, the first page - # of results will be returned. + # A token identifying a page of results the server should return. Typically, + # this is the value of next_page_token returned from the previous call to ` + # ListChannels` method. If not specified, the first page of results will be + # returned. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -4173,9 +3882,8 @@ module Google execute_or_queue_command(command, &block) end - # Bulk edits sites under a single channel. - # The operation will delete the sites provided in - # BulkEditSitesRequest.deleted_sites and then create the sites + # Bulk edits sites under a single channel. The operation will delete the sites + # provided in BulkEditSitesRequest.deleted_sites and then create the sites # provided in BulkEditSitesRequest.created_sites. # @param [Fixnum] partner_id # The ID of the partner that owns the parent channel. @@ -4298,34 +4006,25 @@ module Google # @param [Fixnum] advertiser_id # The ID of the advertiser that owns the parent channel. # @param [String] filter - # Allows filtering by site fields. - # Supported syntax: - # * Filter expressions for site currently can only contain at most one - # * restriction. - # * A restriction has the form of ``field` `operator` `value``. - # * The operator must be `CONTAINS (:)`. - # * Supported fields: - # - `urlOrAppId` - # Examples: - # * All sites for which the URL or app ID contains "google": - # `urlOrAppId : "google"` + # Allows filtering by site fields. Supported syntax: * Filter expressions for + # site currently can only contain at most one * restriction. * A restriction has + # the form of ``field` `operator` `value``. * The operator must be `CONTAINS (:)` + # . * Supported fields: - `urlOrAppId` Examples: * All sites for which the URL + # or app ID contains "google": `urlOrAppId : "google"` # @param [String] order_by - # Field by which to sort the list. - # Acceptable values are: - # * `urlOrAppId` (default) - # The default sorting order is ascending. To specify descending order for a - # field, a suffix " desc" should be added to the field name. Example: - # `urlOrAppId desc`. + # Field by which to sort the list. Acceptable values are: * `urlOrAppId` ( + # default) The default sorting order is ascending. To specify descending order + # for a field, a suffix " desc" should be added to the field name. Example: ` + # urlOrAppId desc`. # @param [Fixnum] page_size # Requested page size. Must be between `1` and `100`. If unspecified will - # default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value - # is specified. + # default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is + # specified. # @param [String] page_token - # A token identifying a page of results the server should return. - # Typically, this is the value of - # next_page_token returned from the - # previous call to `ListSites` method. If not specified, the first page - # of results will be returned. + # A token identifying a page of results the server should return. Typically, + # this is the value of next_page_token returned from the previous call to ` + # ListSites` method. If not specified, the first page of results will be + # returned. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -4359,21 +4058,13 @@ module Google execute_or_queue_command(command, &block) end - # Creates an SDF Download Task. Returns an - # Operation. - # An SDF Download Task is a long-running, asynchronous operation. The - # metadata type of this operation is - # SdfDownloadTaskMetadata. If the request is successful, the - # response type of the operation is - # SdfDownloadTask. The response will not include the download files, - # which must be retrieved with - # media.download. The state of - # operation can be retrieved with - # sdfdownloadtask.operations.get. - # Any errors can be found in the - # error.message. Note - # that error.details is expected to be - # empty. + # Creates an SDF Download Task. Returns an Operation. An SDF Download Task is a + # long-running, asynchronous operation. The metadata type of this operation is + # SdfDownloadTaskMetadata. If the request is successful, the response type of + # the operation is SdfDownloadTask. The response will not include the download + # files, which must be retrieved with media.download. The state of operation can + # be retrieved with sdfdownloadtask.operations.get. Any errors can be found in + # the error.message. Note that error.details is expected to be empty. # @param [Google::Apis::DisplayvideoV1::CreateSdfDownloadTaskRequest] create_sdf_download_task_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -4476,32 +4167,26 @@ module Google # @param [Fixnum] advertiser_id # Required. The Advertiser this request is being made in the context of. # @param [String] filter - # Allows filtering by targeting option properties. - # Supported syntax: - # * Filter expressions are made up of one or more restrictions. - # * Restrictions can be combined by `OR` logical operators. - # * A restriction has the form of ``field` `operator` `value``. - # * The operator must be "=" (equal sign). - # * Supported fields: - # - `targetingOptionId` - # The length of this field should be no more than 500 characters. + # Allows filtering by targeting option properties. Supported syntax: * Filter + # expressions are made up of one or more restrictions. * Restrictions can be + # combined by `OR` logical operators. * A restriction has the form of ``field` ` + # operator` `value``. * The operator must be "=" (equal sign). * Supported + # fields: - `targetingOptionId` The length of this field should be no more than + # 500 characters. # @param [String] order_by - # Field by which to sort the list. - # Acceptable values are: - # * `targetingOptionId` (default) - # The default sorting order is ascending. To specify descending order for - # a field, a suffix "desc" should be added to the field name. - # Example: `targetingOptionId desc`. + # Field by which to sort the list. Acceptable values are: * `targetingOptionId` ( + # default) The default sorting order is ascending. To specify descending order + # for a field, a suffix "desc" should be added to the field name. Example: ` + # targetingOptionId desc`. # @param [Fixnum] page_size # Requested page size. Must be between `1` and `100`. If unspecified will - # default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value - # is specified. + # default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is + # specified. # @param [String] page_token - # A token identifying a page of results the server should return. - # Typically, this is the value of - # next_page_token - # returned from the previous call to `ListTargetingOptions` method. - # If not specified, the first page of results will be returned. + # A token identifying a page of results the server should return. Typically, + # this is the value of next_page_token returned from the previous call to ` + # ListTargetingOptions` method. If not specified, the first page of results will + # be returned. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user diff --git a/generated/google/apis/gmailpostmastertools_v1beta1.rb b/generated/google/apis/gmailpostmastertools_v1beta1.rb index 304c0ab6b..fee53a62e 100644 --- a/generated/google/apis/gmailpostmastertools_v1beta1.rb +++ b/generated/google/apis/gmailpostmastertools_v1beta1.rb @@ -27,7 +27,10 @@ module Google # @see https://developers.google.com/gmail/postmaster module GmailpostmastertoolsV1beta1 VERSION = 'V1beta1' - REVISION = '20200629' + REVISION = '20200719' + + # See email traffic metrics for the domains you have registered in Gmail Postmaster Tools + AUTH_POSTMASTER_READONLY = 'https://www.googleapis.com/auth/postmaster.readonly' end end end diff --git a/generated/google/apis/people_v1.rb b/generated/google/apis/people_v1.rb index 06daa076a..49d938ef0 100644 --- a/generated/google/apis/people_v1.rb +++ b/generated/google/apis/people_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/people/ module PeopleV1 VERSION = 'V1' - REVISION = '20200624' + REVISION = '20200720' # See, edit, download, and permanently delete your contacts AUTH_CONTACTS = 'https://www.googleapis.com/auth/contacts' diff --git a/generated/google/apis/people_v1/classes.rb b/generated/google/apis/people_v1/classes.rb index f7e32b897..92292755e 100644 --- a/generated/google/apis/people_v1/classes.rb +++ b/generated/google/apis/people_v1/classes.rb @@ -54,8 +54,8 @@ module Google # @return [String] attr_accessor :formatted_type - # The unstructured value of the address. If this is not set by the user it - # will be automatically constructed from structured values. + # The unstructured value of the address. If this is not set by the user it will + # be automatically constructed from structured values. # Corresponds to the JSON property `formattedValue` # @return [String] attr_accessor :formatted_value @@ -86,10 +86,7 @@ module Google attr_accessor :street_address # The type of the address. The type can be custom or one of these predefined - # values: - # * `home` - # * `work` - # * `other` + # values: * `home` * `work` * `other` # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -191,19 +188,19 @@ module Google end # A person's birthday. At least one of the `date` and `text` fields are - # specified. The `date` and `text` fields typically represent the same - # date, but are not guaranteed to. + # specified. The `date` and `text` fields typically represent the same date, but + # are not guaranteed to. class Birthday include Google::Apis::Core::Hashable # Represents a whole or partial calendar date, e.g. a birthday. The time of day # and time zone are either specified elsewhere or are not significant. The date - # is relative to the Proleptic Gregorian Calendar. This can represent: - # * A full date, with non-zero year, month and day values - # * A month and day value, with a zero year, e.g. an anniversary - # * A year on its own, with zero month and day values - # * A year and month value, with a zero day, e.g. a credit card expiration date - # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. + # is relative to the Proleptic Gregorian Calendar. This can represent: * A full + # date, with non-zero year, month and day values * A month and day value, with a + # zero year, e.g. an anniversary * A year on its own, with zero month and day + # values * A year and month value, with a zero day, e.g. a credit card + # expiration date Related types are google.type.TimeOfDay and `google.protobuf. + # Timestamp`. # Corresponds to the JSON property `date` # @return [Google::Apis::PeopleV1::Date] attr_accessor :date @@ -230,8 +227,7 @@ module Google end end - # **DEPRECATED**: No data will be returned - # A person's bragging rights. + # **DEPRECATED**: No data will be returned A person's bragging rights. class BraggingRights include Google::Apis::Core::Hashable @@ -260,15 +256,15 @@ module Google class ContactGroup include Google::Apis::Core::Hashable - # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the - # resource. Used for web cache validation. + # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. + # Used for web cache validation. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # Output only. The name translated and formatted in the viewer's account locale - # or the `Accept-Language` HTTP header locale for system groups names. - # Group names set by the owner are the same as name. + # or the `Accept-Language` HTTP header locale for system groups names. Group + # names set by the owner are the same as name. # Corresponds to the JSON property `formattedName` # @return [String] attr_accessor :formatted_name @@ -279,17 +275,15 @@ module Google attr_accessor :group_type # Output only. The total number of contacts in the group irrespective of max - # members in - # specified in the request. + # members in specified in the request. # Corresponds to the JSON property `memberCount` # @return [Fixnum] attr_accessor :member_count # Output only. The list of contact person resource names that are members of the - # contact - # group. The field is not populated for LIST requests and can only be updated - # through the - # [ModifyContactGroupMembers](/people/api/rest/v1/contactgroups/members/modify). + # contact group. The field is not populated for LIST requests and can only be + # updated through the [ModifyContactGroupMembers](/people/api/rest/v1/ + # contactgroups/members/modify). # Corresponds to the JSON property `memberResourceNames` # @return [Array] attr_accessor :member_resource_names @@ -299,8 +293,8 @@ module Google # @return [Google::Apis::PeopleV1::ContactGroupMetadata] attr_accessor :metadata - # The contact group name set by the group owner or a system provided name - # for system groups. + # The contact group name set by the group owner or a system provided name for + # system groups. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -338,11 +332,11 @@ module Google attr_accessor :contact_group_id # The resource name for the contact group, assigned by the server. An ASCII - # string, in the form of `contactGroups/`contact_group_id``. - # Only contact_group_resource_name can be used for modifying memberships. - # Any contact group membership can be removed, but only user group or - # "myContacts" or "starred" system groups memberships can be added. A - # contact must always have at least one contact group membership. + # string, in the form of `contactGroups/`contact_group_id``. Only + # contact_group_resource_name can be used for modifying memberships. Any contact + # group membership can be removed, but only user group or "myContacts" or " + # starred" system groups memberships can be added. A contact must always have at + # least one contact group membership. # Corresponds to the JSON property `contactGroupResourceName` # @return [String] attr_accessor :contact_group_resource_name @@ -363,9 +357,8 @@ module Google include Google::Apis::Core::Hashable # Output only. True if the contact group resource has been deleted. Populated - # only for - # [`ListContactGroups`](/people/api/rest/v1/contactgroups/list) requests - # that include a sync token. + # only for [`ListContactGroups`](/people/api/rest/v1/contactgroups/list) + # requests that include a sync token. # Corresponds to the JSON property `deleted` # @return [Boolean] attr_accessor :deleted @@ -401,12 +394,12 @@ module Google # @return [String] attr_accessor :requested_resource_name - # The `Status` type defines a logical error model that is suitable for - # different programming environments, including REST APIs and RPC APIs. It is - # used by [gRPC](https://github.com/grpc). Each `Status` message contains - # three pieces of data: error code, error message, and error details. - # You can find out more about this error model and how to work with it in the - # [API Design Guide](https://cloud.google.com/apis/design/errors). + # The `Status` type defines a logical error model that is suitable for different + # programming environments, including REST APIs and RPC APIs. It is used by [ + # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of + # data: error code, error message, and error details. You can find out more + # about this error model and how to work with it in the [API Design Guide](https: + # //cloud.google.com/apis/design/errors). # Corresponds to the JSON property `status` # @return [Google::Apis::PeopleV1::Status] attr_accessor :status @@ -428,52 +421,25 @@ module Google include Google::Apis::Core::Hashable # Required. A field mask to restrict which fields are copied into the new - # contact. - # Valid values are: - # * emailAddresses - # * names - # * phoneNumbers + # contact. Valid values are: * emailAddresses * names * phoneNumbers # Corresponds to the JSON property `copyMask` # @return [String] attr_accessor :copy_mask # Optional. A field mask to restrict which fields on the person are returned. - # Multiple - # fields can be specified by separating them with commas. Defaults to the - # copy mask with metadata and membership fields if not set. Valid values are: - # * addresses - # * ageRanges - # * biographies - # * birthdays - # * coverPhotos - # * emailAddresses - # * events - # * genders - # * imClients - # * interests - # * locales - # * memberships - # * metadata - # * names - # * nicknames - # * occupations - # * organizations - # * phoneNumbers - # * photos - # * relations - # * residences - # * sipAddresses - # * skills - # * urls - # * userDefined + # Multiple fields can be specified by separating them with commas. Defaults to + # the copy mask with metadata and membership fields if not set. Valid values are: + # * addresses * ageRanges * biographies * birthdays * coverPhotos * + # emailAddresses * events * genders * imClients * interests * locales * + # memberships * metadata * names * nicknames * occupations * organizations * + # phoneNumbers * photos * relations * residences * sipAddresses * skills * urls * + # userDefined # Corresponds to the JSON property `readMask` # @return [String] attr_accessor :read_mask - # Optional. A mask of what source types to return. Defaults to - # ReadSourceType.CONTACT and - # ReadSourceType.PROFILE if not - # set. + # Optional. A mask of what source types to return. Defaults to ReadSourceType. + # CONTACT and ReadSourceType.PROFILE if not set. # Corresponds to the JSON property `sources` # @return [Array] attr_accessor :sources @@ -490,13 +456,13 @@ module Google end end - # A person's cover photo. A large image shown on the person's - # profile page that represents who they are or what they care about. + # A person's cover photo. A large image shown on the person's profile page that + # represents who they are or what they care about. class CoverPhoto include Google::Apis::Core::Hashable - # True if the cover photo is the default cover photo; - # false if the cover photo is a user-provided cover photo. + # True if the cover photo is the default cover photo; false if the cover photo + # is a user-provided cover photo. # Corresponds to the JSON property `default` # @return [Boolean] attr_accessor :default @@ -545,30 +511,29 @@ module Google # Represents a whole or partial calendar date, e.g. a birthday. The time of day # and time zone are either specified elsewhere or are not significant. The date - # is relative to the Proleptic Gregorian Calendar. This can represent: - # * A full date, with non-zero year, month and day values - # * A month and day value, with a zero year, e.g. an anniversary - # * A year on its own, with zero month and day values - # * A year and month value, with a zero day, e.g. a credit card expiration date - # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. + # is relative to the Proleptic Gregorian Calendar. This can represent: * A full + # date, with non-zero year, month and day values * A month and day value, with a + # zero year, e.g. an anniversary * A year on its own, with zero month and day + # values * A year and month value, with a zero day, e.g. a credit card + # expiration date Related types are google.type.TimeOfDay and `google.protobuf. + # Timestamp`. class Date include Google::Apis::Core::Hashable - # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 - # if specifying a year by itself or a year and month where the day is not + # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if + # specifying a year by itself or a year and month where the day is not # significant. # Corresponds to the JSON property `day` # @return [Fixnum] attr_accessor :day - # Month of year. Must be from 1 to 12, or 0 if specifying a year without a - # month and day. + # Month of year. Must be from 1 to 12, or 0 if specifying a year without a month + # and day. # Corresponds to the JSON property `month` # @return [Fixnum] attr_accessor :month - # Year of date. Must be from 1 to 9999, or 0 if specifying a date without - # a year. + # Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year. # Corresponds to the JSON property `year` # @return [Fixnum] attr_accessor :year @@ -590,10 +555,9 @@ module Google include Google::Apis::Core::Hashable # Information about a person merged from various data sources such as the - # authenticated user's contacts and profile data. - # Most fields can have multiple items. The items in a field have no guaranteed - # order, but each non-empty field is guaranteed to have exactly one field with - # `metadata.primary` set to true. + # authenticated user's contacts and profile data. Most fields can have multiple + # items. The items in a field have no guaranteed order, but each non-empty field + # is guaranteed to have exactly one field with `metadata.primary` set to true. # Corresponds to the JSON property `person` # @return [Google::Apis::PeopleV1::Person] attr_accessor :person @@ -649,10 +613,7 @@ module Google attr_accessor :metadata # The type of the email address. The type can be custom or one of these - # predefined values: - # * `home` - # * `work` - # * `other` + # predefined values: * `home` * `work` * `other` # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -676,13 +637,11 @@ module Google end end - # A generic empty message that you can re-use to avoid defining duplicated - # empty messages in your APIs. A typical example is to use it as the request - # or the response type of an API method. For instance: - # service Foo ` - # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); - # ` - # The JSON representation for `Empty` is empty JSON object ````. + # A generic empty message that you can re-use to avoid defining duplicated empty + # messages in your APIs. A typical example is to use it as the request or the + # response type of an API method. For instance: service Foo ` rpc Bar(google. + # protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for + # `Empty` is empty JSON object ````. class Empty include Google::Apis::Core::Hashable @@ -701,18 +660,18 @@ module Google # Represents a whole or partial calendar date, e.g. a birthday. The time of day # and time zone are either specified elsewhere or are not significant. The date - # is relative to the Proleptic Gregorian Calendar. This can represent: - # * A full date, with non-zero year, month and day values - # * A month and day value, with a zero year, e.g. an anniversary - # * A year on its own, with zero month and day values - # * A year and month value, with a zero day, e.g. a credit card expiration date - # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. + # is relative to the Proleptic Gregorian Calendar. This can represent: * A full + # date, with non-zero year, month and day values * A month and day value, with a + # zero year, e.g. an anniversary * A year on its own, with zero month and day + # values * A year and month value, with a zero day, e.g. a credit card + # expiration date Related types are google.type.TimeOfDay and `google.protobuf. + # Timestamp`. # Corresponds to the JSON property `date` # @return [Google::Apis::PeopleV1::Date] attr_accessor :date - # Output only. The type of the event translated and formatted in the - # viewer's account locale or the `Accept-Language` HTTP header locale. + # Output only. The type of the event translated and formatted in the viewer's + # account locale or the `Accept-Language` HTTP header locale. # Corresponds to the JSON property `formattedType` # @return [String] attr_accessor :formatted_type @@ -723,9 +682,7 @@ module Google attr_accessor :metadata # The type of the event. The type can be custom or one of these predefined - # values: - # * `anniversary` - # * `other` + # values: * `anniversary` * `other` # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -760,9 +717,8 @@ module Google attr_accessor :source # Output only. True if the field is verified; false if the field is unverified. - # A - # verified field is typically a name, email address, phone number, or - # website that has been confirmed to be owned by the person. + # A verified field is typically a name, email address, phone number, or website + # that has been confirmed to be owned by the person. # Corresponds to the JSON property `verified` # @return [Boolean] attr_accessor :verified @@ -809,19 +765,15 @@ module Google class Gender include Google::Apis::Core::Hashable - # The type of pronouns that should be used to address the person. The value - # can be custom or one of these predefined values: - # * `male` - # * `female` - # * `other` + # The type of pronouns that should be used to address the person. The value can + # be custom or one of these predefined values: * `male` * `female` * `other` # Corresponds to the JSON property `addressMeAs` # @return [String] attr_accessor :address_me_as # Output only. The value of the gender translated and formatted in the viewer's - # account - # locale or the `Accept-Language` HTTP header locale. Unspecified or custom - # value are not localized. + # account locale or the `Accept-Language` HTTP header locale. Unspecified or + # custom value are not localized. # Corresponds to the JSON property `formattedValue` # @return [String] attr_accessor :formatted_value @@ -831,11 +783,8 @@ module Google # @return [Google::Apis::PeopleV1::FieldMetadata] attr_accessor :metadata - # The gender for the person. The gender can be custom or one of these - # predefined values: - # * `male` - # * `female` - # * `unspecified` + # The gender for the person. The gender can be custom or one of these predefined + # values: * `male` * `female` * `unspecified` # Corresponds to the JSON property `value` # @return [String] attr_accessor :value @@ -882,8 +831,8 @@ module Google # @return [String] attr_accessor :formatted_protocol - # Output only. The type of the IM client translated and formatted in the - # viewer's account locale or the `Accept-Language` HTTP header locale. + # Output only. The type of the IM client translated and formatted in the viewer' + # s account locale or the `Accept-Language` HTTP header locale. # Corresponds to the JSON property `formattedType` # @return [String] attr_accessor :formatted_type @@ -894,25 +843,14 @@ module Google attr_accessor :metadata # The protocol of the IM client. The protocol can be custom or one of these - # predefined values: - # * `aim` - # * `msn` - # * `yahoo` - # * `skype` - # * `qq` - # * `googleTalk` - # * `icq` - # * `jabber` - # * `netMeeting` + # predefined values: * `aim` * `msn` * `yahoo` * `skype` * `qq` * `googleTalk` * + # `icq` * `jabber` * `netMeeting` # Corresponds to the JSON property `protocol` # @return [String] attr_accessor :protocol - # The type of the IM client. The type can be custom or one of these - # predefined values: - # * `home` - # * `work` - # * `other` + # The type of the IM client. The type can be custom or one of these predefined + # values: * `home` * `work` * `other` # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -971,15 +909,14 @@ module Google # @return [Array] attr_accessor :connections - # A token, which can be sent as `page_token` to retrieve the next page. - # If this field is omitted, there are no subsequent pages. + # A token, which can be sent as `page_token` to retrieve the next page. If this + # field is omitted, there are no subsequent pages. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token - # A token, which can be sent as `sync_token` to retrieve changes since the - # last request. Request must set `request_sync_token` to return the sync - # token. + # A token, which can be sent as `sync_token` to retrieve changes since the last + # request. Request must set `request_sync_token` to return the sync token. # Corresponds to the JSON property `nextSyncToken` # @return [String] attr_accessor :next_sync_token @@ -989,8 +926,8 @@ module Google # @return [Fixnum] attr_accessor :total_items - # **DEPRECATED** (Please use totalItems) - # The total number of people in the list without pagination. + # **DEPRECATED** (Please use totalItems) The total number of people in the list + # without pagination. # Corresponds to the JSON property `totalPeople` # @return [Fixnum] attr_accessor :total_people @@ -1013,8 +950,7 @@ module Google class ListContactGroupsResponse include Google::Apis::Core::Hashable - # The list of contact groups. Members of the contact groups are not - # populated. + # The list of contact groups. Members of the contact groups are not populated. # Corresponds to the JSON property `contactGroups` # @return [Array] attr_accessor :contact_groups @@ -1051,15 +987,14 @@ module Google class ListDirectoryPeopleResponse include Google::Apis::Core::Hashable - # A token, which can be sent as `page_token` to retrieve the next page. - # If this field is omitted, there are no subsequent pages. + # A token, which can be sent as `page_token` to retrieve the next page. If this + # field is omitted, there are no subsequent pages. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token - # A token, which can be sent as `sync_token` to retrieve changes since the - # last request. Request must set `request_sync_token` to return the sync - # token. + # A token, which can be sent as `sync_token` to retrieve changes since the last + # request. Request must set `request_sync_token` to return the sync token. # Corresponds to the JSON property `nextSyncToken` # @return [String] attr_accessor :next_sync_token @@ -1085,22 +1020,21 @@ module Google class ListOtherContactsResponse include Google::Apis::Core::Hashable - # A token, which can be sent as `page_token` to retrieve the next page. - # If this field is omitted, there are no subsequent pages. + # A token, which can be sent as `page_token` to retrieve the next page. If this + # field is omitted, there are no subsequent pages. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token - # A token, which can be sent as `sync_token` to retrieve changes since the - # last request. Request must set `request_sync_token` to return the sync - # token. + # A token, which can be sent as `sync_token` to retrieve changes since the last + # request. Request must set `request_sync_token` to return the sync token. # Corresponds to the JSON property `nextSyncToken` # @return [String] attr_accessor :next_sync_token # The list of "Other contacts" returned as Person resources. "Other contacts" - # support a limited subset of fields. See - # ListOtherContactsRequest.request_mask for more detailed information. + # support a limited subset of fields. See ListOtherContactsRequest.request_mask + # for more detailed information. # Corresponds to the JSON property `otherContacts` # @return [Array] attr_accessor :other_contacts @@ -1126,8 +1060,8 @@ module Google # @return [Google::Apis::PeopleV1::FieldMetadata] attr_accessor :metadata - # The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47) - # language tag representing the locale. + # The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47) language tag + # representing the locale. # Corresponds to the JSON property `value` # @return [String] attr_accessor :value @@ -1176,19 +1110,19 @@ module Google end # A request to modify an existing contact group's members. Contacts can be - # removed from any group but they can only be added to a user group or - # "myContacts" or "starred" system groups. + # removed from any group but they can only be added to a user group or " + # myContacts" or "starred" system groups. class ModifyContactGroupMembersRequest include Google::Apis::Core::Hashable - # Optional. The resource names of the contact people to add in the form of - # `people/`person_id``. + # Optional. The resource names of the contact people to add in the form of ` + # people/`person_id``. # Corresponds to the JSON property `resourceNamesToAdd` # @return [Array] attr_accessor :resource_names_to_add - # Optional. The resource names of the contact people to remove in the form of - # `people/`person_id``. + # Optional. The resource names of the contact people to remove in the form of ` + # people/`person_id``. # Corresponds to the JSON property `resourceNamesToRemove` # @return [Array] attr_accessor :resource_names_to_remove @@ -1208,8 +1142,8 @@ module Google class ModifyContactGroupMembersResponse include Google::Apis::Core::Hashable - # The contact people resource names that cannot be removed from their - # last contact group. + # The contact people resource names that cannot be removed from their last + # contact group. # Corresponds to the JSON property `canNotRemoveLastContactGroupResourceNames` # @return [Array] attr_accessor :can_not_remove_last_contact_group_resource_names @@ -1241,8 +1175,8 @@ module Google attr_accessor :display_name # Output only. The display name with the last name first formatted according to - # the locale specified by the viewer's account or the - # `Accept-Language` HTTP header. + # the locale specified by the viewer's account or the `Accept-Language` HTTP + # header. # Corresponds to the JSON property `displayNameLastFirst` # @return [String] attr_accessor :display_name_last_first @@ -1392,13 +1326,12 @@ module Google end end - # A person's past or current organization. Overlapping date ranges are - # permitted. + # A person's past or current organization. Overlapping date ranges are permitted. class Organization include Google::Apis::Core::Hashable - # True if the organization is the person's current organization; - # false if the organization is a past organization. + # True if the organization is the person's current organization; false if the + # organization is a past organization. # Corresponds to the JSON property `current` # @return [Boolean] attr_accessor :current @@ -1409,20 +1342,19 @@ module Google # @return [String] attr_accessor :department - # The domain name associated with the organization; for example, - # `google.com`. + # The domain name associated with the organization; for example, `google.com`. # Corresponds to the JSON property `domain` # @return [String] attr_accessor :domain # Represents a whole or partial calendar date, e.g. a birthday. The time of day # and time zone are either specified elsewhere or are not significant. The date - # is relative to the Proleptic Gregorian Calendar. This can represent: - # * A full date, with non-zero year, month and day values - # * A month and day value, with a zero year, e.g. an anniversary - # * A year on its own, with zero month and day values - # * A year and month value, with a zero day, e.g. a credit card expiration date - # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. + # is relative to the Proleptic Gregorian Calendar. This can represent: * A full + # date, with non-zero year, month and day values * A month and day value, with a + # zero year, e.g. an anniversary * A year on its own, with zero month and day + # values * A year and month value, with a zero day, e.g. a credit card + # expiration date Related types are google.type.TimeOfDay and `google.protobuf. + # Timestamp`. # Corresponds to the JSON property `endDate` # @return [Google::Apis::PeopleV1::Date] attr_accessor :end_date @@ -1460,12 +1392,12 @@ module Google # Represents a whole or partial calendar date, e.g. a birthday. The time of day # and time zone are either specified elsewhere or are not significant. The date - # is relative to the Proleptic Gregorian Calendar. This can represent: - # * A full date, with non-zero year, month and day values - # * A month and day value, with a zero year, e.g. an anniversary - # * A year on its own, with zero month and day values - # * A year and month value, with a zero day, e.g. a credit card expiration date - # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. + # is relative to the Proleptic Gregorian Calendar. This can represent: * A full + # date, with non-zero year, month and day values * A month and day value, with a + # zero year, e.g. an anniversary * A year on its own, with zero month and day + # values * A year and month value, with a zero day, e.g. a credit card + # expiration date Related types are google.type.TimeOfDay and `google.protobuf. + # Timestamp`. # Corresponds to the JSON property `startDate` # @return [Google::Apis::PeopleV1::Date] attr_accessor :start_date @@ -1481,10 +1413,8 @@ module Google # @return [String] attr_accessor :title - # The type of the organization. The type can be custom or one of these - # predefined values: - # * `work` - # * `school` + # The type of the organization. The type can be custom or one of these + # predefined values: * `work` * `school` # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -1513,10 +1443,9 @@ module Google end # Information about a person merged from various data sources such as the - # authenticated user's contacts and profile data. - # Most fields can have multiple items. The items in a field have no guaranteed - # order, but each non-empty field is guaranteed to have exactly one field with - # `metadata.primary` set to true. + # authenticated user's contacts and profile data. Most fields can have multiple + # items. The items in a field have no guaranteed order, but each non-empty field + # is guaranteed to have exactly one field with `metadata.primary` set to true. class Person include Google::Apis::Core::Hashable @@ -1525,8 +1454,8 @@ module Google # @return [Array] attr_accessor :addresses - # Output only. **DEPRECATED** (Please use `person.ageRanges` instead) - # The person's age range. + # Output only. **DEPRECATED** (Please use `person.ageRanges` instead) The person' + # s age range. # Corresponds to the JSON property `ageRange` # @return [String] attr_accessor :age_range @@ -1546,8 +1475,7 @@ module Google # @return [Array] attr_accessor :birthdays - # **DEPRECATED**: No data will be returned - # The person's bragging rights. + # **DEPRECATED**: No data will be returned The person's bragging rights. # Corresponds to the JSON property `braggingRights` # @return [Array] attr_accessor :bragging_rights @@ -1562,8 +1490,8 @@ module Google # @return [Array] attr_accessor :email_addresses - # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the - # resource. Used for web cache validation. + # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. + # Used for web cache validation. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag @@ -1643,14 +1571,14 @@ module Google # @return [Array] attr_accessor :relations - # Output only. **DEPRECATED**: No data will be returned - # The person's relationship interests. + # Output only. **DEPRECATED**: No data will be returned The person's + # relationship interests. # Corresponds to the JSON property `relationshipInterests` # @return [Array] attr_accessor :relationship_interests - # Output only. **DEPRECATED**: No data will be returned - # The person's relationship statuses. + # Output only. **DEPRECATED**: No data will be returned The person's + # relationship statuses. # Corresponds to the JSON property `relationshipStatuses` # @return [Array] attr_accessor :relationship_statuses @@ -1660,9 +1588,8 @@ module Google # @return [Array] attr_accessor :residences - # The resource name for the person, assigned by the server. An ASCII string - # with a max length of 27 characters, in the form of - # `people/`person_id``. + # The resource name for the person, assigned by the server. An ASCII string with + # a max length of 27 characters, in the form of `people/`person_id``. # Corresponds to the JSON property `resourceName` # @return [String] attr_accessor :resource_name @@ -1677,8 +1604,7 @@ module Google # @return [Array] attr_accessor :skills - # Output only. **DEPRECATED**: No data will be returned - # The person's taglines. + # Output only. **DEPRECATED**: No data will be returned The person's taglines. # Corresponds to the JSON property `taglines` # @return [Array] attr_accessor :taglines @@ -1739,9 +1665,9 @@ module Google class PersonMetadata include Google::Apis::Core::Hashable - # Output only. True if the person resource has been deleted. Populated only for - # [`connections.list`](/people/api/rest/v1/people.connections/list) requests - # that include a sync token. + # Output only. True if the person resource has been deleted. Populated only for [ + # `connections.list`](/people/api/rest/v1/people.connections/list) requests that + # include a sync token. # Corresponds to the JSON property `deleted` # @return [Boolean] attr_accessor :deleted @@ -1752,19 +1678,17 @@ module Google # @return [Array] attr_accessor :linked_people_resource_names - # Output only. **DEPRECATED** (Please use - # `person.metadata.sources.profileMetadata.objectType` instead) - # The type of the person object. + # Output only. **DEPRECATED** (Please use `person.metadata.sources. + # profileMetadata.objectType` instead) The type of the person object. # Corresponds to the JSON property `objectType` # @return [String] attr_accessor :object_type # Output only. Any former resource names this person has had. Populated only for # [`connections.list`](/people/api/rest/v1/people.connections/list) requests - # that include a sync token. - # The resource name may change when adding or removing fields that link a - # contact and profile such as a verified email, verified phone number, or - # profile URL. + # that include a sync token. The resource name may change when adding or + # removing fields that link a contact and profile such as a verified email, + # verified phone number, or profile URL. # Corresponds to the JSON property `previousResourceNames` # @return [Array] attr_accessor :previous_resource_names @@ -1792,37 +1716,34 @@ module Google class PersonResponse include Google::Apis::Core::Hashable - # **DEPRECATED** (Please use status instead) - # [HTTP 1.1 status code] - # (http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html). + # **DEPRECATED** (Please use status instead) [HTTP 1.1 status code] (http://www. + # w3.org/Protocols/rfc2616/rfc2616-sec10.html). # Corresponds to the JSON property `httpStatusCode` # @return [Fixnum] attr_accessor :http_status_code # Information about a person merged from various data sources such as the - # authenticated user's contacts and profile data. - # Most fields can have multiple items. The items in a field have no guaranteed - # order, but each non-empty field is guaranteed to have exactly one field with - # `metadata.primary` set to true. + # authenticated user's contacts and profile data. Most fields can have multiple + # items. The items in a field have no guaranteed order, but each non-empty field + # is guaranteed to have exactly one field with `metadata.primary` set to true. # Corresponds to the JSON property `person` # @return [Google::Apis::PeopleV1::Person] attr_accessor :person - # The original requested resource name. May be different than the resource - # name on the returned person. - # The resource name can change when adding or removing fields that link a - # contact and profile such as a verified email, verified phone number, or a - # profile URL. + # The original requested resource name. May be different than the resource name + # on the returned person. The resource name can change when adding or removing + # fields that link a contact and profile such as a verified email, verified + # phone number, or a profile URL. # Corresponds to the JSON property `requestedResourceName` # @return [String] attr_accessor :requested_resource_name - # The `Status` type defines a logical error model that is suitable for - # different programming environments, including REST APIs and RPC APIs. It is - # used by [gRPC](https://github.com/grpc). Each `Status` message contains - # three pieces of data: error code, error message, and error details. - # You can find out more about this error model and how to work with it in the - # [API Design Guide](https://cloud.google.com/apis/design/errors). + # The `Status` type defines a logical error model that is suitable for different + # programming environments, including REST APIs and RPC APIs. It is used by [ + # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of + # data: error code, error message, and error details. You can find out more + # about this error model and how to work with it in the [API Design Guide](https: + # //cloud.google.com/apis/design/errors). # Corresponds to the JSON property `status` # @return [Google::Apis::PeopleV1::Status] attr_accessor :status @@ -1844,9 +1765,8 @@ module Google class PhoneNumber include Google::Apis::Core::Hashable - # Output only. The canonicalized [ITU-T - # E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf) - # form of the phone number. + # Output only. The canonicalized [ITU-T E.164](https://law.resource.org/pub/us/ + # cfr/ibr/004/itu-t.E.164.1.2008.pdf) form of the phone number. # Corresponds to the JSON property `canonicalForm` # @return [String] attr_accessor :canonical_form @@ -1863,19 +1783,9 @@ module Google attr_accessor :metadata # The type of the phone number. The type can be custom or one of these - # predefined values: - # * `home` - # * `work` - # * `mobile` - # * `homeFax` - # * `workFax` - # * `otherFax` - # * `pager` - # * `workMobile` - # * `workPager` - # * `main` - # * `googleVoice` - # * `other` + # predefined values: * `home` * `work` * `mobile` * `homeFax` * `workFax` * ` + # otherFax` * `pager` * `workMobile` * `workPager` * `main` * `googleVoice` * ` + # other` # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -1899,13 +1809,13 @@ module Google end end - # A person's photo. A picture shown next to the person's name to - # help others recognize the person. + # A person's photo. A picture shown next to the person's name to help others + # recognize the person. class Photo include Google::Apis::Core::Hashable - # True if the photo is a default photo; - # false if the photo is a user-provided photo. + # True if the photo is a default photo; false if the photo is a user-provided + # photo. # Corresponds to the JSON property `default` # @return [Boolean] attr_accessor :default @@ -1918,9 +1828,8 @@ module Google # The URL of the photo. You can change the desired size by appending a query # parameter `sz=`size`` at the end of the url, where `size` is the size in - # pixels. Example: - # https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/ - # 00gzXvDBYqw/s100/photo.jpg?sz=50 + # pixels. Example: https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/ + # AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50 # Corresponds to the JSON property `url` # @return [String] attr_accessor :url @@ -1983,21 +1892,9 @@ module Google attr_accessor :person # The person's relation to the other person. The type can be custom or one of - # these predefined values: - # * `spouse` - # * `child` - # * `mother` - # * `father` - # * `parent` - # * `brother` - # * `sister` - # * `friend` - # * `relative` - # * `domesticPartner` - # * `manager` - # * `assistant` - # * `referredBy` - # * `partner` + # these predefined values: * `spouse` * `child` * `mother` * `father` * `parent` + # * `brother` * `sister` * `friend` * `relative` * `domesticPartner` * `manager` + # * `assistant` * `referredBy` * `partner` # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -2015,14 +1912,13 @@ module Google end end - # **DEPRECATED**: No data will be returned - # A person's relationship interest . + # **DEPRECATED**: No data will be returned A person's relationship interest . class RelationshipInterest include Google::Apis::Core::Hashable # Output only. The value of the relationship interest translated and formatted - # in the viewer's account locale or the locale specified in the - # Accept-Language HTTP header. + # in the viewer's account locale or the locale specified in the Accept-Language + # HTTP header. # Corresponds to the JSON property `formattedValue` # @return [String] attr_accessor :formatted_value @@ -2032,12 +1928,9 @@ module Google # @return [Google::Apis::PeopleV1::FieldMetadata] attr_accessor :metadata - # The kind of relationship the person is looking for. The value can be custom - # or one of these predefined values: - # * `friend` - # * `date` - # * `relationship` - # * `networking` + # The kind of relationship the person is looking for. The value can be custom or + # one of these predefined values: * `friend` * `date` * `relationship` * ` + # networking` # Corresponds to the JSON property `value` # @return [String] attr_accessor :value @@ -2054,8 +1947,7 @@ module Google end end - # **DEPRECATED**: No data will be returned - # A person's relationship status. + # **DEPRECATED**: No data will be returned A person's relationship status. class RelationshipStatus include Google::Apis::Core::Hashable @@ -2070,17 +1962,10 @@ module Google # @return [Google::Apis::PeopleV1::FieldMetadata] attr_accessor :metadata - # The relationship status. The value can be custom or one of these - # predefined values: - # * `single` - # * `inARelationship` - # * `engaged` - # * `married` - # * `itsComplicated` - # * `openRelationship` - # * `widowed` - # * `inDomesticPartnership` - # * `inCivilUnion` + # The relationship status. The value can be custom or one of these predefined + # values: * `single` * `inARelationship` * `engaged` * `married` * ` + # itsComplicated` * `openRelationship` * `widowed` * `inDomesticPartnership` * ` + # inCivilUnion` # Corresponds to the JSON property `value` # @return [String] attr_accessor :value @@ -2101,8 +1986,8 @@ module Google class Residence include Google::Apis::Core::Hashable - # True if the residence is the person's current residence; - # false if the residence is a past residence. + # True if the residence is the person's current residence; false if the + # residence is a past residence. # Corresponds to the JSON property `current` # @return [Boolean] attr_accessor :current @@ -2135,8 +2020,8 @@ module Google class SearchDirectoryPeopleResponse include Google::Apis::Core::Hashable - # A token, which can be sent as `page_token` to retrieve the next page. - # If this field is omitted, there are no subsequent pages. + # A token, which can be sent as `page_token` to retrieve the next page. If this + # field is omitted, there are no subsequent pages. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -2180,18 +2065,13 @@ module Google attr_accessor :metadata # The type of the SIP address. The type can be custom or or one of these - # predefined values: - # * `home` - # * `work` - # * `mobile` - # * `other` + # predefined values: * `home` * `work` * `mobile` * `other` # Corresponds to the JSON property `type` # @return [String] attr_accessor :type - # The SIP address in the - # [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI - # format. + # The SIP address in the [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261# + # section-19.1) SIP URI format. # Corresponds to the JSON property `value` # @return [String] attr_accessor :value @@ -2238,9 +2118,8 @@ module Google class Source include Google::Apis::Core::Hashable - # **Only populated in `person.metadata.sources`.** - # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the - # source. Used for web cache validation. + # **Only populated in `person.metadata.sources`.** The [HTTP entity tag](https:// + # en.wikipedia.org/wiki/HTTP_ETag) of the source. Used for web cache validation. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag @@ -2260,8 +2139,8 @@ module Google # @return [String] attr_accessor :type - # Output only. **Only populated in `person.metadata.sources`.** - # Last update timestamp of this source. + # Output only. **Only populated in `person.metadata.sources`.** Last update + # timestamp of this source. # Corresponds to the JSON property `updateTime` # @return [String] attr_accessor :update_time @@ -2280,12 +2159,12 @@ module Google end end - # The `Status` type defines a logical error model that is suitable for - # different programming environments, including REST APIs and RPC APIs. It is - # used by [gRPC](https://github.com/grpc). Each `Status` message contains - # three pieces of data: error code, error message, and error details. - # You can find out more about this error model and how to work with it in the - # [API Design Guide](https://cloud.google.com/apis/design/errors). + # The `Status` type defines a logical error model that is suitable for different + # programming environments, including REST APIs and RPC APIs. It is used by [ + # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of + # data: error code, error message, and error details. You can find out more + # about this error model and how to work with it in the [API Design Guide](https: + # //cloud.google.com/apis/design/errors). class Status include Google::Apis::Core::Hashable @@ -2294,15 +2173,15 @@ module Google # @return [Fixnum] attr_accessor :code - # A list of messages that carry the error details. There is a common set of + # A list of messages that carry the error details. There is a common set of # message types for APIs to use. # Corresponds to the JSON property `details` # @return [Array>] attr_accessor :details - # A developer-facing error message, which should be in English. Any - # user-facing error message should be localized and sent in the - # google.rpc.Status.details field, or localized by the client. + # A developer-facing error message, which should be in English. Any user-facing + # error message should be localized and sent in the google.rpc.Status.details + # field, or localized by the client. # Corresponds to the JSON property `message` # @return [String] attr_accessor :message @@ -2319,8 +2198,8 @@ module Google end end - # **DEPRECATED**: No data will be returned - # A brief one-line description of the person. + # **DEPRECATED**: No data will be returned A brief one-line description of the + # person. class Tagline include Google::Apis::Core::Hashable @@ -2345,8 +2224,8 @@ module Google end end - # A request to update an existing user contact group. All updated fields will - # be replaced. + # A request to update an existing user contact group. All updated fields will be + # replaced. class UpdateContactGroupRequest include Google::Apis::Core::Hashable @@ -2365,40 +2244,18 @@ module Google end end - # A request to update an existing contact's photo. - # All requests must have a valid photo format: JPEG or PNG. + # A request to update an existing contact's photo. All requests must have a + # valid photo format: JPEG or PNG. class UpdateContactPhotoRequest include Google::Apis::Core::Hashable # Optional. A field mask to restrict which fields on the person are returned. - # Multiple - # fields can be specified by separating them with commas. Defaults to empty - # if not set, which will skip the post mutate get. Valid values are: - # * addresses - # * ageRanges - # * biographies - # * birthdays - # * coverPhotos - # * emailAddresses - # * events - # * genders - # * imClients - # * interests - # * locales - # * memberships - # * metadata - # * names - # * nicknames - # * occupations - # * organizations - # * phoneNumbers - # * photos - # * relations - # * residences - # * sipAddresses - # * skills - # * urls - # * userDefined + # Multiple fields can be specified by separating them with commas. Defaults to + # empty if not set, which will skip the post mutate get. Valid values are: * + # addresses * ageRanges * biographies * birthdays * coverPhotos * emailAddresses + # * events * genders * imClients * interests * locales * memberships * metadata * + # names * nicknames * occupations * organizations * phoneNumbers * photos * + # relations * residences * sipAddresses * skills * urls * userDefined # Corresponds to the JSON property `personFields` # @return [String] attr_accessor :person_fields @@ -2409,10 +2266,8 @@ module Google # @return [String] attr_accessor :photo_bytes - # Optional. A mask of what source types to return. Defaults to - # ReadSourceType.CONTACT and - # ReadSourceType.PROFILE if not - # set. + # Optional. A mask of what source types to return. Defaults to ReadSourceType. + # CONTACT and ReadSourceType.PROFILE if not set. # Corresponds to the JSON property `sources` # @return [Array] attr_accessor :sources @@ -2434,10 +2289,9 @@ module Google include Google::Apis::Core::Hashable # Information about a person merged from various data sources such as the - # authenticated user's contacts and profile data. - # Most fields can have multiple items. The items in a field have no guaranteed - # order, but each non-empty field is guaranteed to have exactly one field with - # `metadata.primary` set to true. + # authenticated user's contacts and profile data. Most fields can have multiple + # items. The items in a field have no guaranteed order, but each non-empty field + # is guaranteed to have exactly one field with `metadata.primary` set to true. # Corresponds to the JSON property `person` # @return [Google::Apis::PeopleV1::Person] attr_accessor :person @@ -2467,17 +2321,9 @@ module Google # @return [Google::Apis::PeopleV1::FieldMetadata] attr_accessor :metadata - # The type of the URL. The type can be custom or one of these predefined - # values: - # * `home` - # * `work` - # * `blog` - # * `profile` - # * `homePage` - # * `ftp` - # * `reservations` - # * `appInstallPage`: website for a Google+ application. - # * `other` + # The type of the URL. The type can be custom or one of these predefined values: + # * `home` * `work` * `blog` * `profile` * `homePage` * `ftp` * `reservations` * + # `appInstallPage`: website for a Google+ application. * `other` # Corresponds to the JSON property `type` # @return [String] attr_accessor :type diff --git a/generated/google/apis/people_v1/service.rb b/generated/google/apis/people_v1/service.rb index f334f7299..8c28833d0 100644 --- a/generated/google/apis/people_v1/service.rb +++ b/generated/google/apis/people_v1/service.rb @@ -47,12 +47,11 @@ module Google @batch_path = 'batch' end - # Get a list of contact groups owned by the authenticated user by specifying - # a list of contact group resource names. + # Get a list of contact groups owned by the authenticated user by specifying a + # list of contact group resource names. # @param [Fixnum] max_members # Optional. Specifies the maximum number of members to return for each group. - # Defaults - # to 0 if not set, which will return zero members. + # Defaults to 0 if not set, which will return zero members. # @param [Array, String] resource_names # Required. The resource names of the contact groups to get. # @param [String] fields @@ -113,8 +112,8 @@ module Google execute_or_queue_command(command, &block) end - # Delete an existing contact group owned by the authenticated user by - # specifying a contact group resource name. + # Delete an existing contact group owned by the authenticated user by specifying + # a contact group resource name. # @param [String] resource_name # Required. The resource name of the contact group to delete. # @param [Boolean] delete_contacts @@ -147,14 +146,13 @@ module Google execute_or_queue_command(command, &block) end - # Get a specific contact group owned by the authenticated user by specifying - # a contact group resource name. + # Get a specific contact group owned by the authenticated user by specifying a + # contact group resource name. # @param [String] resource_name # Required. The resource name of the contact group to get. # @param [Fixnum] max_members # Optional. Specifies the maximum number of members to return. Defaults to 0 if - # not - # set, which will return zero members. + # not set, which will return zero members. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -187,12 +185,11 @@ module Google # contact groups are not populated. # @param [Fixnum] page_size # Optional. The maximum number of resources to return. Valid values are between - # 1 and - # 1000, inclusive. Defaults to 30 if not set or set to 0. + # 1 and 1000, inclusive. Defaults to 30 if not set or set to 0. # @param [String] page_token - # Optional. The next_page_token value returned from a previous call to - # [ListContactGroups](/people/api/rest/v1/contactgroups/list). - # Requests the next page of resources. + # Optional. The next_page_token value returned from a previous call to [ + # ListContactGroups](/people/api/rest/v1/contactgroups/list). Requests the next + # page of resources. # @param [String] sync_token # Optional. A sync token, returned by a previous call to `contactgroups.list`. # Only resources changed since the sync token was created will be returned. @@ -225,8 +222,7 @@ module Google execute_or_queue_command(command, &block) end - # Update the name of an existing contact group owned by the authenticated - # user. + # Update the name of an existing contact group owned by the authenticated user. # @param [String] resource_name # The resource name for the contact group, assigned by the server. An ASCII # string, in the form of `contactGroups/`contact_group_id``. @@ -260,10 +256,10 @@ module Google execute_or_queue_command(command, &block) end - # Modify the members of a contact group owned by the authenticated user. - # The only system contact groups that can have members added are - # `contactGroups/myContacts` and `contactGroups/starred`. Other system - # contact groups are deprecated and can only have contacts removed. + # Modify the members of a contact group owned by the authenticated user. The + # only system contact groups that can have members added are `contactGroups/ + # myContacts` and `contactGroups/starred`. Other system contact groups are + # deprecated and can only have contacts removed. # @param [String] resource_name # Required. The resource name of the contact group to modify. # @param [Google::Apis::PeopleV1::ModifyContactGroupMembersRequest] modify_contact_group_members_request_object @@ -329,37 +325,32 @@ module Google execute_or_queue_command(command, &block) end - # List all "Other contacts", that is contacts that are not in a contact - # group. "Other contacts" are typically auto created contacts from - # interactions. + # List all "Other contacts", that is contacts that are not in a contact group. " + # Other contacts" are typically auto created contacts from interactions. # @param [Fixnum] page_size # Optional. The number of "Other contacts" to include in the response. Valid - # values are - # between 1 and 1000, inclusive. Defaults to 100 if not set or set to 0. + # values are between 1 and 1000, inclusive. Defaults to 100 if not set or set to + # 0. # @param [String] page_token # Optional. A page token, received from a previous `ListOtherContacts` call. - # Provide this to retrieve the subsequent page. - # When paginating, all other parameters provided to `ListOtherContacts` - # must match the call that provided the page token. + # Provide this to retrieve the subsequent page. When paginating, all other + # parameters provided to `ListOtherContacts` must match the call that provided + # the page token. # @param [String] read_mask # Required. A field mask to restrict which fields on each person are returned. - # Multiple - # fields can be specified by separating them with commas. Valid values are: - # * emailAddresses - # * names - # * phoneNumbers + # Multiple fields can be specified by separating them with commas. Valid values + # are: * emailAddresses * names * phoneNumbers # @param [Boolean] request_sync_token # Optional. Whether the response should include `next_sync_token`, which can be - # used to - # get all changes since the last request. For subsequent sync requests use - # the `sync_token` param instead. Initial sync requests that specify - # `request_sync_token` have an additional rate limit. + # used to get all changes since the last request. For subsequent sync requests + # use the `sync_token` param instead. Initial sync requests that specify ` + # request_sync_token` have an additional rate limit. # @param [String] sync_token # Optional. A sync token, received from a previous `ListOtherContacts` call. # Provide this to retrieve only the resources changed since the last request. - # Sync requests that specify `sync_token` have an additional rate limit. - # When syncing, all other parameters provided to `ListOtherContacts` - # must match the call that provided the sync token. + # Sync requests that specify `sync_token` have an additional rate limit. When + # syncing, all other parameters provided to `ListOtherContacts` must match the + # call that provided the sync token. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -395,39 +386,15 @@ module Google # @param [Google::Apis::PeopleV1::Person] person_object # @param [String] person_fields # Required. A field mask to restrict which fields on each person are returned. - # Multiple - # fields can be specified by separating them with commas. Defaults to all - # fields if not set. Valid values are: - # * addresses - # * ageRanges - # * biographies - # * birthdays - # * coverPhotos - # * emailAddresses - # * events - # * genders - # * imClients - # * interests - # * locales - # * memberships - # * metadata - # * names - # * nicknames - # * occupations - # * organizations - # * phoneNumbers - # * photos - # * relations - # * residences - # * sipAddresses - # * skills - # * urls - # * userDefined + # Multiple fields can be specified by separating them with commas. Defaults to + # all fields if not set. Valid values are: * addresses * ageRanges * biographies + # * birthdays * coverPhotos * emailAddresses * events * genders * imClients * + # interests * locales * memberships * metadata * names * nicknames * occupations + # * organizations * phoneNumbers * photos * relations * residences * + # sipAddresses * skills * urls * userDefined # @param [Array, String] sources - # Optional. A mask of what source types to return. Defaults to - # ReadSourceType.CONTACT and - # ReadSourceType.PROFILE if not - # set. + # Optional. A mask of what source types to return. Defaults to ReadSourceType. + # CONTACT and ReadSourceType.PROFILE if not set. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -493,39 +460,15 @@ module Google # Required. The resource name of the contact whose photo will be deleted. # @param [String] person_fields # Optional. A field mask to restrict which fields on the person are returned. - # Multiple - # fields can be specified by separating them with commas. Defaults to empty - # if not set, which will skip the post mutate get. Valid values are: - # * addresses - # * ageRanges - # * biographies - # * birthdays - # * coverPhotos - # * emailAddresses - # * events - # * genders - # * imClients - # * interests - # * locales - # * memberships - # * metadata - # * names - # * nicknames - # * occupations - # * organizations - # * phoneNumbers - # * photos - # * relations - # * residences - # * sipAddresses - # * skills - # * urls - # * userDefined + # Multiple fields can be specified by separating them with commas. Defaults to + # empty if not set, which will skip the post mutate get. Valid values are: * + # addresses * ageRanges * biographies * birthdays * coverPhotos * emailAddresses + # * events * genders * imClients * interests * locales * memberships * metadata * + # names * nicknames * occupations * organizations * phoneNumbers * photos * + # relations * residences * sipAddresses * skills * urls * userDefined # @param [Array, String] sources - # Optional. A mask of what source types to return. Defaults to - # ReadSourceType.CONTACT and - # ReadSourceType.PROFILE if not - # set. + # Optional. A mask of what source types to return. Defaults to ReadSourceType. + # CONTACT and ReadSourceType.PROFILE if not set. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -555,57 +498,31 @@ module Google execute_or_queue_command(command, &block) end - # Provides information about a person by specifying a resource name. Use - # `people/me` to indicate the authenticated user. - # The request throws a 400 error if 'personFields' is not specified. + # Provides information about a person by specifying a resource name. Use `people/ + # me` to indicate the authenticated user. The request throws a 400 error if ' + # personFields' is not specified. # @param [String] resource_name - # Required. The resource name of the person to provide information about. - # - To get information about the authenticated user, specify `people/me`. - # - To get information about a google account, specify - # `people/`account_id``. - # - To get information about a contact, specify the resource name that - # identifies the contact as returned by - # [`people.connections.list`](/people/api/rest/v1/people.connections/list). + # Required. The resource name of the person to provide information about. - To + # get information about the authenticated user, specify `people/me`. - To get + # information about a google account, specify `people/`account_id``. - To get + # information about a contact, specify the resource name that identifies the + # contact as returned by [`people.connections.list`](/people/api/rest/v1/people. + # connections/list). # @param [String] person_fields # Required. A field mask to restrict which fields on the person are returned. - # Multiple - # fields can be specified by separating them with commas. Valid values are: - # * addresses - # * ageRanges - # * biographies - # * birthdays - # * coverPhotos - # * emailAddresses - # * events - # * genders - # * imClients - # * interests - # * locales - # * memberships - # * metadata - # * names - # * nicknames - # * occupations - # * organizations - # * phoneNumbers - # * photos - # * relations - # * residences - # * sipAddresses - # * skills - # * urls - # * userDefined + # Multiple fields can be specified by separating them with commas. Valid values + # are: * addresses * ageRanges * biographies * birthdays * coverPhotos * + # emailAddresses * events * genders * imClients * interests * locales * + # memberships * metadata * names * nicknames * occupations * organizations * + # phoneNumbers * photos * relations * residences * sipAddresses * skills * urls * + # userDefined # @param [String] request_mask_include_field # Required. Comma-separated list of person fields to be included in the response. - # Each - # path should start with `person.`: for example, `person.names` or - # `person.photos`. + # Each path should start with `person.`: for example, `person.names` or `person. + # photos`. # @param [Array, String] sources - # Optional. A mask of what source types to return. Defaults to - # ReadSourceType.PROFILE - # and - # ReadSourceType.CONTACT - # if not set. + # Optional. A mask of what source types to return. Defaults to ReadSourceType. + # PROFILE and ReadSourceType.CONTACT if not set. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -636,59 +553,31 @@ module Google execute_or_queue_command(command, &block) end - # Provides information about a list of specific people by specifying a list - # of requested resource names. Use `people/me` to indicate the authenticated - # user. + # Provides information about a list of specific people by specifying a list of + # requested resource names. Use `people/me` to indicate the authenticated user. # The request throws a 400 error if 'personFields' is not specified. # @param [String] person_fields # Required. A field mask to restrict which fields on each person are returned. - # Multiple - # fields can be specified by separating them with commas. Valid values are: - # * addresses - # * ageRanges - # * biographies - # * birthdays - # * coverPhotos - # * emailAddresses - # * events - # * genders - # * imClients - # * interests - # * locales - # * memberships - # * metadata - # * names - # * nicknames - # * occupations - # * organizations - # * phoneNumbers - # * photos - # * relations - # * residences - # * sipAddresses - # * skills - # * urls - # * userDefined + # Multiple fields can be specified by separating them with commas. Valid values + # are: * addresses * ageRanges * biographies * birthdays * coverPhotos * + # emailAddresses * events * genders * imClients * interests * locales * + # memberships * metadata * names * nicknames * occupations * organizations * + # phoneNumbers * photos * relations * residences * sipAddresses * skills * urls * + # userDefined # @param [String] request_mask_include_field # Required. Comma-separated list of person fields to be included in the response. - # Each - # path should start with `person.`: for example, `person.names` or - # `person.photos`. + # Each path should start with `person.`: for example, `person.names` or `person. + # photos`. # @param [Array, String] resource_names - # Required. The resource names of the people to provide information about. - # - To get information about the authenticated user, specify `people/me`. - # - To get information about a google account, specify - # `people/`account_id``. - # - To get information about a contact, specify the resource name that - # identifies the contact as returned by - # [`people.connections.list`](/people/api/rest/v1/people.connections/list). - # You can include up to 50 resource names in one request. + # Required. The resource names of the people to provide information about. - To + # get information about the authenticated user, specify `people/me`. - To get + # information about a google account, specify `people/`account_id``. - To get + # information about a contact, specify the resource name that identifies the + # contact as returned by [`people.connections.list`](/people/api/rest/v1/people. + # connections/list). You can include up to 50 resource names in one request. # @param [Array, String] sources - # Optional. A mask of what source types to return. Defaults to - # ReadSourceType.CONTACT - # and - # ReadSourceType.PROFILE - # if not set. + # Optional. A mask of what source types to return. Defaults to ReadSourceType. + # CONTACT and ReadSourceType.PROFILE if not set. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -723,57 +612,34 @@ module Google # user's domain directory. # @param [Array, String] merge_sources # Optional. Additional data to merge into the directory sources if they are - # connected - # through verified join keys such as email addresses or phone numbers. + # connected through verified join keys such as email addresses or phone numbers. # @param [Fixnum] page_size # Optional. The number of people to include in the response. Valid values are # between 1 and 1000, inclusive. Defaults to 100 if not set or set to 0. # @param [String] page_token # Optional. A page token, received from a previous `ListDirectoryPeople` call. - # Provide this to retrieve the subsequent page. - # When paginating, all other parameters provided to `ListDirectoryPeople` - # must match the call that provided the page token. + # Provide this to retrieve the subsequent page. When paginating, all other + # parameters provided to `ListDirectoryPeople` must match the call that provided + # the page token. # @param [String] read_mask # Required. A field mask to restrict which fields on each person are returned. - # Multiple - # fields can be specified by separating them with commas. Valid values are: - # * addresses - # * ageRanges - # * biographies - # * birthdays - # * coverPhotos - # * emailAddresses - # * events - # * genders - # * imClients - # * interests - # * locales - # * memberships - # * metadata - # * names - # * nicknames - # * occupations - # * organizations - # * phoneNumbers - # * photos - # * relations - # * residences - # * sipAddresses - # * skills - # * urls - # * userDefined + # Multiple fields can be specified by separating them with commas. Valid values + # are: * addresses * ageRanges * biographies * birthdays * coverPhotos * + # emailAddresses * events * genders * imClients * interests * locales * + # memberships * metadata * names * nicknames * occupations * organizations * + # phoneNumbers * photos * relations * residences * sipAddresses * skills * urls * + # userDefined # @param [Boolean] request_sync_token # Optional. Whether the response should include `next_sync_token`, which can be - # used to - # get all changes since the last request. For subsequent sync requests use - # the `sync_token` param instead. + # used to get all changes since the last request. For subsequent sync requests + # use the `sync_token` param instead. # @param [Array, String] sources # Required. Directory sources to return. # @param [String] sync_token # Optional. A sync token, received from a previous `ListDirectoryPeople` call. # Provide this to retrieve only the resources changed since the last request. - # When syncing, all other parameters provided to `ListDirectoryPeople` - # must match the call that provided the sync token. + # When syncing, all other parameters provided to `ListDirectoryPeople` must + # match the call that provided the sync token. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -811,48 +677,26 @@ module Google # user's domain directory that match the search query. # @param [Array, String] merge_sources # Optional. Additional data to merge into the directory sources if they are - # connected - # through verified join keys such as email addresses or phone numbers. + # connected through verified join keys such as email addresses or phone numbers. # @param [Fixnum] page_size # Optional. The number of people to include in the response. Valid values are # between 1 and 500, inclusive. Defaults to 100 if not set or set to 0. # @param [String] page_token # Optional. A page token, received from a previous `SearchDirectoryPeople` call. - # Provide this to retrieve the subsequent page. - # When paginating, all other parameters provided to `SearchDirectoryPeople` - # must match the call that provided the page token. + # Provide this to retrieve the subsequent page. When paginating, all other + # parameters provided to `SearchDirectoryPeople` must match the call that + # provided the page token. # @param [String] query # Required. Prefix query that matches fields in the person. Does NOT use the # read_mask for determining what fields to match. # @param [String] read_mask # Required. A field mask to restrict which fields on each person are returned. - # Multiple - # fields can be specified by separating them with commas. Valid values are: - # * addresses - # * ageRanges - # * biographies - # * birthdays - # * coverPhotos - # * emailAddresses - # * events - # * genders - # * imClients - # * interests - # * locales - # * memberships - # * metadata - # * names - # * nicknames - # * occupations - # * organizations - # * phoneNumbers - # * photos - # * relations - # * residences - # * sipAddresses - # * skills - # * urls - # * userDefined + # Multiple fields can be specified by separating them with commas. Valid values + # are: * addresses * ageRanges * biographies * birthdays * coverPhotos * + # emailAddresses * events * genders * imClients * interests * locales * + # memberships * metadata * names * nicknames * occupations * organizations * + # phoneNumbers * photos * relations * residences * sipAddresses * skills * urls * + # userDefined # @param [Array, String] sources # Required. Directory sources to return. # @param [String] fields @@ -887,81 +731,36 @@ module Google execute_or_queue_command(command, &block) end - # Update contact data for an existing contact person. Any non-contact data - # will not be modified. - # The request throws a 400 error if `updatePersonFields` is not specified. - # The request throws a 400 error if `person.metadata.sources` is not - # specified for the contact to be updated. - # The request throws a 400 error with an error with reason - # `"failedPrecondition"` if `person.metadata.sources.etag` is different than - # the contact's etag, which indicates the contact has changed since its data - # was read. Clients should get the latest person and re-apply their updates - # to the latest person. + # Update contact data for an existing contact person. Any non-contact data will + # not be modified. The request throws a 400 error if `updatePersonFields` is not + # specified. The request throws a 400 error if `person.metadata.sources` is not + # specified for the contact to be updated. The request throws a 400 error with + # an error with reason `"failedPrecondition"` if `person.metadata.sources.etag` + # is different than the contact's etag, which indicates the contact has changed + # since its data was read. Clients should get the latest person and re-apply + # their updates to the latest person. # @param [String] resource_name - # The resource name for the person, assigned by the server. An ASCII string - # with a max length of 27 characters, in the form of - # `people/`person_id``. + # The resource name for the person, assigned by the server. An ASCII string with + # a max length of 27 characters, in the form of `people/`person_id``. # @param [Google::Apis::PeopleV1::Person] person_object # @param [String] person_fields # Optional. A field mask to restrict which fields on each person are returned. - # Multiple - # fields can be specified by separating them with commas. Defaults to all - # fields if not set. Valid values are: - # * addresses - # * ageRanges - # * biographies - # * birthdays - # * coverPhotos - # * emailAddresses - # * events - # * genders - # * imClients - # * interests - # * locales - # * memberships - # * metadata - # * names - # * nicknames - # * occupations - # * organizations - # * phoneNumbers - # * photos - # * relations - # * residences - # * sipAddresses - # * skills - # * urls - # * userDefined + # Multiple fields can be specified by separating them with commas. Defaults to + # all fields if not set. Valid values are: * addresses * ageRanges * biographies + # * birthdays * coverPhotos * emailAddresses * events * genders * imClients * + # interests * locales * memberships * metadata * names * nicknames * occupations + # * organizations * phoneNumbers * photos * relations * residences * + # sipAddresses * skills * urls * userDefined # @param [Array, String] sources - # Optional. A mask of what source types to return. Defaults to - # ReadSourceType.CONTACT and - # ReadSourceType.PROFILE if not - # set. + # Optional. A mask of what source types to return. Defaults to ReadSourceType. + # CONTACT and ReadSourceType.PROFILE if not set. # @param [String] update_person_fields # Required. A field mask to restrict which fields on the person are updated. - # Multiple - # fields can be specified by separating them with commas. - # All updated fields will be replaced. Valid values are: - # * addresses - # * biographies - # * birthdays - # * emailAddresses - # * events - # * genders - # * imClients - # * interests - # * locales - # * memberships - # * names - # * nicknames - # * occupations - # * organizations - # * phoneNumbers - # * relations - # * residences - # * sipAddresses - # * urls - # * userDefined + # Multiple fields can be specified by separating them with commas. All updated + # fields will be replaced. Valid values are: * addresses * biographies * + # birthdays * emailAddresses * events * genders * imClients * interests * + # locales * memberships * names * nicknames * occupations * organizations * + # phoneNumbers * relations * residences * sipAddresses * urls * userDefined # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1027,75 +826,48 @@ module Google execute_or_queue_command(command, &block) end - # Provides a list of the authenticated user's contacts. - # The request throws a 400 error if 'personFields' is not specified. + # Provides a list of the authenticated user's contacts. The request throws a 400 + # error if 'personFields' is not specified. # @param [String] resource_name # Required. The resource name to return connections for. Only `people/me` is # valid. # @param [Fixnum] page_size # Optional. The number of connections to include in the response. Valid values - # are - # between 1 and 1000, inclusive. Defaults to 100 if not set or set to 0. + # are between 1 and 1000, inclusive. Defaults to 100 if not set or set to 0. # @param [String] page_token # Optional. A page token, received from a previous `ListConnections` call. - # Provide this to retrieve the subsequent page. - # When paginating, all other parameters provided to `ListConnections` - # must match the call that provided the page token. + # Provide this to retrieve the subsequent page. When paginating, all other + # parameters provided to `ListConnections` must match the call that provided the + # page token. # @param [String] person_fields # Required. A field mask to restrict which fields on each person are returned. - # Multiple - # fields can be specified by separating them with commas. Valid values are: - # * addresses - # * ageRanges - # * biographies - # * birthdays - # * coverPhotos - # * emailAddresses - # * events - # * genders - # * imClients - # * interests - # * locales - # * memberships - # * metadata - # * names - # * nicknames - # * occupations - # * organizations - # * phoneNumbers - # * photos - # * relations - # * residences - # * sipAddresses - # * skills - # * urls - # * userDefined + # Multiple fields can be specified by separating them with commas. Valid values + # are: * addresses * ageRanges * biographies * birthdays * coverPhotos * + # emailAddresses * events * genders * imClients * interests * locales * + # memberships * metadata * names * nicknames * occupations * organizations * + # phoneNumbers * photos * relations * residences * sipAddresses * skills * urls * + # userDefined # @param [String] request_mask_include_field # Required. Comma-separated list of person fields to be included in the response. - # Each - # path should start with `person.`: for example, `person.names` or - # `person.photos`. + # Each path should start with `person.`: for example, `person.names` or `person. + # photos`. # @param [Boolean] request_sync_token # Optional. Whether the response should include `next_sync_token`, which can be - # used to - # get all changes since the last request. For subsequent sync requests use - # the `sync_token` param instead. Initial sync requests that specify - # `request_sync_token` have an additional rate limit. + # used to get all changes since the last request. For subsequent sync requests + # use the `sync_token` param instead. Initial sync requests that specify ` + # request_sync_token` have an additional rate limit. # @param [String] sort_order - # Optional. The order in which the connections should be sorted. Defaults to - # `LAST_MODIFIED_ASCENDING`. + # Optional. The order in which the connections should be sorted. Defaults to ` + # LAST_MODIFIED_ASCENDING`. # @param [Array, String] sources - # Optional. A mask of what source types to return. Defaults to - # ReadSourceType.CONTACT - # and - # ReadSourceType.PROFILE if not - # set. + # Optional. A mask of what source types to return. Defaults to ReadSourceType. + # CONTACT and ReadSourceType.PROFILE if not set. # @param [String] sync_token # Optional. A sync token, received from a previous `ListConnections` call. # Provide this to retrieve only the resources changed since the last request. - # Sync requests that specify `sync_token` have an additional rate limit. - # When syncing, all other parameters provided to `ListConnections` - # must match the call that provided the sync token. + # Sync requests that specify `sync_token` have an additional rate limit. When + # syncing, all other parameters provided to `ListConnections` must match the + # call that provided the sync token. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user diff --git a/generated/google/apis/realtimebidding_v1.rb b/generated/google/apis/realtimebidding_v1.rb index 444a7ae3b..4ea1c7e3d 100644 --- a/generated/google/apis/realtimebidding_v1.rb +++ b/generated/google/apis/realtimebidding_v1.rb @@ -28,7 +28,7 @@ module Google # @see https://developers.google.com/authorized-buyers/apis/realtimebidding/reference/rest/ module RealtimebiddingV1 VERSION = 'V1' - REVISION = '20200713' + REVISION = '20200720' # Manage your Ad Exchange buyer account configuration AUTH_ADEXCHANGE_BUYER = 'https://www.googleapis.com/auth/adexchange.buyer' diff --git a/generated/google/apis/serviceconsumermanagement_v1.rb b/generated/google/apis/serviceconsumermanagement_v1.rb index 09a8daaa9..f55e10fd6 100644 --- a/generated/google/apis/serviceconsumermanagement_v1.rb +++ b/generated/google/apis/serviceconsumermanagement_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/service-consumer-management/docs/overview module ServiceconsumermanagementV1 VERSION = 'V1' - REVISION = '20200711' + REVISION = '20200719' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/serviceconsumermanagement_v1/classes.rb b/generated/google/apis/serviceconsumermanagement_v1/classes.rb index 06a8acd4a..478d6b4ae 100644 --- a/generated/google/apis/serviceconsumermanagement_v1/classes.rb +++ b/generated/google/apis/serviceconsumermanagement_v1/classes.rb @@ -790,7 +790,7 @@ module Google class CreateTenancyUnitRequest include Google::Apis::Core::Hashable - # Optional service producer-provided identifier of the tenancy unit. + # Optional. Optional service producer-provided identifier of the tenancy unit. # Must be no longer than 40 characters and preferably URI friendly. # If it isn't provided, a UID for the tenancy unit is automatically # generated. The identifier must be unique across a managed service. diff --git a/generated/google/apis/serviceconsumermanagement_v1/service.rb b/generated/google/apis/serviceconsumermanagement_v1/service.rb index 1046a3a1e..96ce8a359 100644 --- a/generated/google/apis/serviceconsumermanagement_v1/service.rb +++ b/generated/google/apis/serviceconsumermanagement_v1/service.rb @@ -207,17 +207,18 @@ module Google # services/`service` # `service` the name of a service, for example 'service.googleapis.com'. # @param [Fixnum] page_size - # The maximum number of results returned by this request. Currently, the + # Optional. The maximum number of results returned by this request. Currently, + # the # default maximum is set to 1000. If `page_size` isn't provided or the size # provided is a number larger than 1000, it's automatically set to 1000. - # Optional. # @param [String] page_token - # The continuation token, which is used to page through large result sets. + # Optional. The continuation token, which is used to page through large result + # sets. # To get the next page of results, set this parameter to the value of # `nextPageToken` from the previous response. - # Optional. # @param [String] query - # Set a query ``expression`` for querying tenancy units. Your ``expression`` + # Optional. Set a query ``expression`` for querying tenancy units. Your `` + # expression`` # must be in the format: `field_name=literal_string`. The `field_name` is the # name of the field you want to compare. Supported fields are # `tenant_resources.tag` and `tenant_resources.resource`. @@ -229,7 +230,6 @@ module Google # Multiple expressions can be joined with `AND`s. Tenancy units must match # all expressions to be included in the result set. For example, # `tenant_resources.tag=xyz AND tenant_resources.resource=projects/123456` - # Optional. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user diff --git a/generated/google/apis/spanner_v1.rb b/generated/google/apis/spanner_v1.rb index efcc1418e..5ecbbb72b 100644 --- a/generated/google/apis/spanner_v1.rb +++ b/generated/google/apis/spanner_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/spanner/ module SpannerV1 VERSION = 'V1' - REVISION = '20200623' + REVISION = '20200709' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/webfonts_v1.rb b/generated/google/apis/webfonts_v1.rb index f151d2f44..a594a611e 100644 --- a/generated/google/apis/webfonts_v1.rb +++ b/generated/google/apis/webfonts_v1.rb @@ -27,7 +27,7 @@ module Google # @see https://developers.google.com/fonts/docs/developer_api module WebfontsV1 VERSION = 'V1' - REVISION = '20200622' + REVISION = '20200720' end end end diff --git a/generated/google/apis/webfonts_v1/service.rb b/generated/google/apis/webfonts_v1/service.rb index a649d9311..0a10c7a4a 100644 --- a/generated/google/apis/webfonts_v1/service.rb +++ b/generated/google/apis/webfonts_v1/service.rb @@ -45,8 +45,8 @@ module Google attr_accessor :quota_user def initialize - super('https://www.googleapis.com/', '') - @batch_path = 'batch/webfonts/v1' + super('https://webfonts.googleapis.com/', '') + @batch_path = 'batch' end # Retrieves the list of fonts currently served by the Google Fonts Developer diff --git a/generated/google/apis/youtube_partner_v1.rb b/generated/google/apis/youtube_partner_v1.rb index 993be1ce4..e2f919d6c 100644 --- a/generated/google/apis/youtube_partner_v1.rb +++ b/generated/google/apis/youtube_partner_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://devsite.googleplex.com/youtube/partner/docs/v1/ module YoutubePartnerV1 VERSION = 'V1' - REVISION = '20200707' + REVISION = '20200720' # View and manage your assets and associated content on YouTube AUTH_YOUTUBEPARTNER = 'https://www.googleapis.com/auth/youtubepartner' diff --git a/generated/google/apis/youtube_partner_v1/classes.rb b/generated/google/apis/youtube_partner_v1/classes.rb index 6e0d68e76..f25640756 100644 --- a/generated/google/apis/youtube_partner_v1/classes.rb +++ b/generated/google/apis/youtube_partner_v1/classes.rb @@ -26,8 +26,8 @@ module Google class AdBreak include Google::Apis::Core::Hashable - # The time of the ad break specified as the number of seconds after the start - # of the video when the break occurs. + # The time of the ad break specified as the number of seconds after the start of + # the video when the break occurs. # Corresponds to the JSON property `midrollSeconds` # @return [Fixnum] attr_accessor :midroll_seconds @@ -52,11 +52,10 @@ module Google class Asset include Google::Apis::Core::Hashable - # A list of asset IDs that can be used to refer to the asset. The list - # contains values if the asset represents multiple constituent assets that - # have been merged. In that case, any of the asset IDs originally assigned to - # the constituent assets could be used to update the master, or synthesized, - # asset. + # A list of asset IDs that can be used to refer to the asset. The list contains + # values if the asset represents multiple constituent assets that have been + # merged. In that case, any of the asset IDs originally assigned to the + # constituent assets could be used to update the master, or synthesized, asset. # Corresponds to the JSON property `aliasId` # @return [Array] attr_accessor :alias_id @@ -66,8 +65,8 @@ module Google # @return [String] attr_accessor :id - # The type of the API resource. For asset resources, the value - # is youtubePartner#asset. + # The type of the API resource. For asset resources, the value is youtubePartner# + # asset. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -77,9 +76,8 @@ module Google # @return [Array] attr_accessor :label - # The matchPolicy object contains information about the asset's - # match policy, which YouTube applies to user-uploaded videos that match the - # asset. + # The matchPolicy object contains information about the asset's match policy, + # which YouTube applies to user-uploaded videos that match the asset. # Corresponds to the JSON property `matchPolicy` # @return [Google::Apis::YoutubePartnerV1::AssetMatchPolicy] attr_accessor :match_policy @@ -94,9 +92,9 @@ module Google # @return [Google::Apis::YoutubePartnerV1::AssetMatchPolicy] attr_accessor :match_policy_mine - # The metadata object contains information that identifies and - # describes the asset. This information could be used to search for the asset - # or to eliminate duplication within YouTube's database. + # The metadata object contains information that identifies and describes the + # asset. This information could be used to search for the asset or to eliminate + # duplication within YouTube's database. # Corresponds to the JSON property `metadata` # @return [Google::Apis::YoutubePartnerV1::Metadata] attr_accessor :metadata @@ -111,15 +109,15 @@ module Google # @return [Google::Apis::YoutubePartnerV1::Metadata] attr_accessor :metadata_mine - # The ownership object identifies an asset's owners and provides - # additional details about their ownership, such as the territories where - # they own the asset. + # The ownership object identifies an asset's owners and provides additional + # details about their ownership, such as the territories where they own the + # asset. # Corresponds to the JSON property `ownership` # @return [Google::Apis::YoutubePartnerV1::RightsOwnership] attr_accessor :ownership - # The ownershipConflicts object contains information about the - # asset's ownership conflicts. + # The ownershipConflicts object contains information about the asset's ownership + # conflicts. # Corresponds to the JSON property `ownershipConflicts` # @return [Google::Apis::YoutubePartnerV1::OwnershipConflicts] attr_accessor :ownership_conflicts @@ -139,16 +137,15 @@ module Google # @return [String] attr_accessor :status - # The date and time the asset was created. The value is specified in RFC 3339 - # (YYYY-MM-DDThh:mm:ss.000Z) format. + # The date and time the asset was created. The value is specified in RFC 3339 ( + # YYYY-MM-DDThh:mm:ss.000Z) format. # Corresponds to the JSON property `timeCreated` # @return [String] attr_accessor :time_created - # The asset's type. This value determines the metadata fields that you can - # set for the asset. In addition, certain API functions may only be supported - # for specific types of assets. For example, composition assets may have more + # The asset's type. This value determines the metadata fields that you can set + # for the asset. In addition, certain API functions may only be supported for + # specific types of assets. For example, composition assets may have more # complex ownership data than other types of assets. # Corresponds to the JSON property `type` # @return [String] @@ -184,8 +181,8 @@ module Google class AssetLabel include Google::Apis::Core::Hashable - # The type of the API resource. For assetLabel resources, this - # value is youtubePartner#assetLabel. + # The type of the API resource. For assetLabel resources, this value is + # youtubePartner#assetLabel. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -210,14 +207,13 @@ module Google class AssetLabelListResponse include Google::Apis::Core::Hashable - # A list of assetLabel resources that match the request - # criteria. + # A list of assetLabel resources that match the request criteria. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items - # The type of the API response. For this operation, the value is - # youtubePartner#assetLabelList. + # The type of the API response. For this operation, the value is youtubePartner# + # assetLabelList. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -237,13 +233,13 @@ module Google class AssetListResponse include Google::Apis::Core::Hashable - # A list of asset resources that match the request criteria. + # A list of asset resources that match the request criteria. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items - # The type of the API response. For this operation, the value is - # youtubePartner#assetList. + # The type of the API response. For this operation, the value is youtubePartner# + # assetList. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -263,22 +259,21 @@ module Google class AssetMatchPolicy include Google::Apis::Core::Hashable - # The type of the API resource. Value: - # youtubePartner#assetMatchPolicy. + # The type of the API resource. Value: youtubePartner#assetMatchPolicy. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # A value that uniquely identifies the Policy resource that - # YouTube applies to user-uploaded videos that match the asset. + # A value that uniquely identifies the Policy resource that YouTube applies to + # user-uploaded videos that match the asset. # Corresponds to the JSON property `policyId` # @return [String] attr_accessor :policy_id # A list of rules that collectively define the policy that the content owner # wants to apply to user-uploaded videos that match the asset. Each rule - # specifies the action that YouTube should take and may optionally specify - # the conditions under which that action is enforced. + # specifies the action that YouTube should take and may optionally specify the + # conditions under which that action is enforced. # Corresponds to the JSON property `rules` # @return [Array] attr_accessor :rules @@ -310,8 +305,8 @@ module Google # @return [String] attr_accessor :id - # The type of the API resource. For this resource, the value is - # youtubePartner#assetRelationship. + # The type of the API resource. For this resource, the value is youtubePartner# + # assetRelationship. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -338,26 +333,24 @@ module Google class AssetRelationshipListResponse include Google::Apis::Core::Hashable - # A list of assetRelationship resources that match the request - # criteria. + # A list of assetRelationship resources that match the request criteria. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items - # The type of the API response. For this operation, the value is - # youtubePartner#assetRelationshipList. + # The type of the API response. For this operation, the value is youtubePartner# + # assetRelationshipList. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # The token that can be used as the value of the pageToken - # parameter to retrieve the next page of results. + # The token that can be used as the value of the pageToken parameter to retrieve + # the next page of results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token - # The pageInfo object encapsulates paging information for the - # result set. + # The pageInfo object encapsulates paging information for the result set. # Corresponds to the JSON property `pageInfo` # @return [Google::Apis::YoutubePartnerV1::PageInfo] attr_accessor :page_info @@ -384,20 +377,19 @@ module Google # @return [Array] attr_accessor :items - # The type of the API response. For this operation, the value is - # youtubePartner#assetSnippetList. + # The type of the API response. For this operation, the value is youtubePartner# + # assetSnippetList. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # The token that can be used as the value of the pageToken - # parameter to retrieve the next page of results. + # The token that can be used as the value of the pageToken parameter to retrieve + # the next page of results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token - # The pageInfo object encapsulates paging information for the - # result set. + # The pageInfo object encapsulates paging information for the result set. # Corresponds to the JSON property `pageInfo` # @return [Google::Apis::YoutubePartnerV1::PageInfo] attr_accessor :page_info @@ -419,8 +411,8 @@ module Google class AssetShare include Google::Apis::Core::Hashable - # The type of the API resource. For this resource, the value is - # youtubePartner#assetShare. + # The type of the API resource. For this resource, the value is youtubePartner# + # assetShare. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -451,25 +443,24 @@ module Google class AssetShareListResponse include Google::Apis::Core::Hashable - # An assetShare resource that matches the request criteria. + # An assetShare resource that matches the request criteria. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items - # The type of the API response. For this operation, the value is - # youtubePartner#assetShareList. + # The type of the API response. For this operation, the value is youtubePartner# + # assetShareList. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # The token that can be used as the value of the pageToken - # parameter to retrieve the next page of results. + # The token that can be used as the value of the pageToken parameter to retrieve + # the next page of results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token - # The pageInfo object encapsulates paging information for the - # result set. + # The pageInfo object encapsulates paging information for the result set. # Corresponds to the JSON property `pageInfo` # @return [Google::Apis::YoutubePartnerV1::PageInfo] attr_accessor :page_info @@ -511,15 +502,14 @@ module Google # @return [String] attr_accessor :iswc - # The type of the API resource. For this operation, the value is - # youtubePartner#assetSnippet. + # The type of the API resource. For this operation, the value is youtubePartner# + # assetSnippet. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # The date and time the asset was created. The value is specified in RFC 3339 - # (YYYY-MM-DDThh:mm:ss.000Z) format. + # The date and time the asset was created. The value is specified in RFC 3339 ( + # YYYY-MM-DDThh:mm:ss.000Z) format. # Corresponds to the JSON property `timeCreated` # @return [String] attr_accessor :time_created @@ -530,7 +520,7 @@ module Google attr_accessor :title # The asset's type. This value determines which metadata fields might be - # included in the metadata object. + # included in the metadata object. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -566,25 +556,23 @@ module Google # @return [String] attr_accessor :blob_id - # Read handle passed from Bigstore -> Scotty for a GCS download. - # This is a signed, serialized blobstore2.ReadHandle proto which must never - # be set outside of Bigstore, and is not applicable to non-GCS media - # downloads. + # Read handle passed from Bigstore -> Scotty for a GCS download. This is a + # signed, serialized blobstore2.ReadHandle proto which must never be set outside + # of Bigstore, and is not applicable to non-GCS media downloads. # Corresponds to the JSON property `downloadReadHandle` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :download_read_handle - # The blob read token. Needed to read blobs that have not been - # replicated. Might not be available until the final call. + # The blob read token. Needed to read blobs that have not been replicated. Might + # not be available until the final call. # Corresponds to the JSON property `readToken` # @return [String] attr_accessor :read_token - # Metadata passed from Blobstore -> Scotty for a new GCS upload. - # This is a signed, serialized blobstore2.BlobMetadataContainer proto which - # must never be consumed outside of Bigstore, and is not applicable to - # non-GCS media uploads. + # Metadata passed from Blobstore -> Scotty for a new GCS upload. This is a + # signed, serialized blobstore2.BlobMetadataContainer proto which must never be + # consumed outside of Bigstore, and is not applicable to non-GCS media uploads. # Corresponds to the JSON property `uploadMetadataContainer` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -608,8 +596,8 @@ module Google class Campaign include Google::Apis::Core::Hashable - # The campaignData object contains details like the campaign's - # start and end dates, target and source. + # The campaignData object contains details like the campaign's start and end + # dates, target and source. # Corresponds to the JSON property `campaignData` # @return [Google::Apis::YoutubePartnerV1::CampaignData] attr_accessor :campaign_data @@ -619,8 +607,8 @@ module Google # @return [String] attr_accessor :id - # The type of the API resource. For campaign resources, this - # value is youtubePartner#campaign. + # The type of the API resource. For campaign resources, this value is + # youtubePartner#campaign. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -659,8 +647,8 @@ module Google class CampaignData include Google::Apis::Core::Hashable - # The campaignSource object contains information about the - # assets for which the campaign will generate links. + # The campaignSource object contains information about the assets for which the + # campaign will generate links. # Corresponds to the JSON property `campaignSource` # @return [Google::Apis::YoutubePartnerV1::CampaignSource] attr_accessor :campaign_source @@ -676,8 +664,8 @@ module Google # @return [String] attr_accessor :name - # A list of videos or channels that will be linked to from claimed videos - # that are included in the campaign. + # A list of videos or channels that will be linked to from claimed videos that + # are included in the campaign. # Corresponds to the JSON property `promotedContent` # @return [Array] attr_accessor :promoted_content @@ -711,8 +699,8 @@ module Google # @return [Array] attr_accessor :items - # The type of the API response. For this operation, the value is - # youtubePartner#campaignList. + # The type of the API response. For this operation, the value is youtubePartner# + # campaignList. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -782,9 +770,9 @@ module Google class Claim include Google::Apis::Core::Hashable - # The applied policy for the viewing owner on the claim. This might not be - # the same as the final claim policy on the video as it does not consider - # other partners' policy of the same claim. + # The applied policy for the viewing owner on the claim. This might not be the + # same as the final claim policy on the video as it does not consider other + # partners' policy of the same claim. # Corresponds to the JSON property `appliedPolicy` # @return [Google::Apis::YoutubePartnerV1::Policy] attr_accessor :applied_policy @@ -802,8 +790,8 @@ module Google attr_accessor :block_outside_ownership alias_method :block_outside_ownership?, :block_outside_ownership - # This value indicates whether the claim covers the audio, video, or - # audiovisual portion of the claimed content. + # This value indicates whether the claim covers the audio, video, or audiovisual + # portion of the claimed content. # Corresponds to the JSON property `contentType` # @return [String] attr_accessor :content_type @@ -819,14 +807,14 @@ module Google attr_accessor :is_partner_uploaded alias_method :is_partner_uploaded?, :is_partner_uploaded - # The type of the API resource. For claim resources, this value - # is youtubePartner#claim. + # The type of the API resource. For claim resources, this value is + # youtubePartner#claim. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # If this claim was auto-generated based on a provided reference, this - # section will provide details of the match that generated the claim. + # If this claim was auto-generated based on a provided reference, this section + # will provide details of the match that generated the claim. # Corresponds to the JSON property `matchInfo` # @return [Google::Apis::YoutubePartnerV1::MatchInfo] attr_accessor :match_info @@ -842,8 +830,8 @@ module Google attr_accessor :policy # The claim's status. When updating a claim, you can update its status from - # active to inactive to effectively release the - # claim, but the API does not support other updates to a claim's status. + # active to inactive to effectively release the claim, but the API does not + # support other updates to a claim's status. # Corresponds to the JSON property `status` # @return [String] attr_accessor :status @@ -885,8 +873,8 @@ module Google class ClaimEvent include Google::Apis::Core::Hashable - # The type of the API resource. For claimEvent resources, this - # value is youtubePartner#claimEvent. + # The type of the API resource. For claimEvent resources, this value is + # youtubePartner#claimEvent. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -945,8 +933,8 @@ module Google # @return [String] attr_accessor :id - # The type of the API resource. For claimHistory resources, this - # value is youtubePartner#claimHistory. + # The type of the API resource. For claimHistory resources, this value is + # youtubePartner#claimHistory. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -978,26 +966,25 @@ module Google # @return [Array] attr_accessor :items - # The type of the API response. For this operation, the value is - # youtubePartner#claimList. + # The type of the API response. For this operation, the value is youtubePartner# + # claimList. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # The token that can be used as the value of the pageToken - # parameter to retrieve the next page in the result set. + # The token that can be used as the value of the pageToken parameter to retrieve + # the next page in the result set. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token - # The pageInfo object encapsulates paging information for the - # result set. + # The pageInfo object encapsulates paging information for the result set. # Corresponds to the JSON property `pageInfo` # @return [Google::Apis::YoutubePartnerV1::PageInfo] attr_accessor :page_info - # The token that can be used as the value of the pageToken - # parameter to retrieve the previous page in the result set. + # The token that can be used as the value of the pageToken parameter to retrieve + # the previous page in the result set. # Corresponds to the JSON property `previousPageToken` # @return [String] attr_accessor :previous_page_token @@ -1025,26 +1012,25 @@ module Google # @return [Array] attr_accessor :items - # The type of the API response. For this operation, the value is - # youtubePartner#claimSnippetList. + # The type of the API response. For this operation, the value is youtubePartner# + # claimSnippetList. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # The token that can be used as the value of the pageToken - # parameter to retrieve the next page in the result set. + # The token that can be used as the value of the pageToken parameter to retrieve + # the next page in the result set. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token - # The pageInfo object encapsulates paging information for the - # result set. + # The pageInfo object encapsulates paging information for the result set. # Corresponds to the JSON property `pageInfo` # @return [Google::Apis::YoutubePartnerV1::PageInfo] attr_accessor :page_info - # The token that can be used as the value of the pageToken - # parameter to retrieve the previous page in the result set. + # The token that can be used as the value of the pageToken parameter to retrieve + # the previous page in the result set. # Corresponds to the JSON property `previousPageToken` # @return [String] attr_accessor :previous_page_token @@ -1073,8 +1059,8 @@ module Google # @return [String] attr_accessor :asset_id - # This value indicates whether the claim covers the audio, video, or - # audiovisual portion of the claimed content. + # This value indicates whether the claim covers the audio, video, or audiovisual + # portion of the claimed content. # Corresponds to the JSON property `contentType` # @return [String] attr_accessor :content_type @@ -1090,8 +1076,8 @@ module Google attr_accessor :is_partner_uploaded alias_method :is_partner_uploaded?, :is_partner_uploaded - # The type of the API resource. For this operation, the value is - # youtubePartner#claimSnippet. + # The type of the API resource. For this operation, the value is youtubePartner# + # claimSnippet. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -1160,17 +1146,16 @@ module Google end end - # A sequence of media data references representing composite data. - # Introduced to support Bigstore composite objects. For details, visit - # http://go/bigstore-composites. + # A sequence of media data references representing composite data. Introduced to + # support Bigstore composite objects. For details, visit http://go/bigstore- + # composites. class CompositeMedia include Google::Apis::Core::Hashable - # Blobstore v1 reference, set if reference_type is BLOBSTORE_REF - # This should be the byte representation of a blobstore.BlobRef. - # Since Blobstore is deprecating v1, use blobstore2_info instead. - # For now, any v2 blob will also be represented in this field as - # v1 BlobRef. + # Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be + # the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating + # v1, use blobstore2_info instead. For now, any v2 blob will also be represented + # in this field as v1 BlobRef. # Corresponds to the JSON property `blobRef` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -1181,12 +1166,12 @@ module Google # @return [Google::Apis::YoutubePartnerV1::Blobstore2Info] attr_accessor :blobstore2_info - # A binary data reference for a media download. Serves as a - # technology-agnostic binary reference in some Google infrastructure. - # This value is a serialized storage_cosmo.BinaryReference proto. Storing - # it as bytes is a hack to get around the fact that the cosmo proto - # (as well as others it includes) doesn't support JavaScript. This - # prevents us from including the actual type of this field. + # A binary data reference for a media download. Serves as a technology-agnostic + # binary reference in some Google infrastructure. This value is a serialized + # storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get + # around the fact that the cosmo proto (as well as others it includes) doesn't + # support JavaScript. This prevents us from including the actual type of this + # field. # Corresponds to the JSON property `cosmoBinaryReference` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -1214,9 +1199,9 @@ module Google # @return [String] attr_accessor :md5_hash - # This is a copy of the tech.blob.ObjectId proto, which could not - # be used directly here due to transitive closure issues with - # JavaScript support; see http://b/8801763. + # This is a copy of the tech.blob.ObjectId proto, which could not be used + # directly here due to transitive closure issues with JavaScript support; see + # http://b/8801763. # Corresponds to the JSON property `objectId` # @return [Google::Apis::YoutubePartnerV1::ObjectIdProp] attr_accessor :object_id_prop @@ -1261,9 +1246,9 @@ module Google class Conditions include Google::Apis::Core::Hashable - # This match condition specifies whether the user- or partner-uploaded - # content needs to match the audio, video or audiovisual content of a - # reference file for the rule to apply. + # This match condition specifies whether the user- or partner-uploaded content + # needs to match the audio, video or audiovisual content of a reference file for + # the rule to apply. # Corresponds to the JSON property `contentMatchType` # @return [Array] attr_accessor :content_match_type @@ -1274,29 +1259,27 @@ module Google # @return [Array] attr_accessor :match_duration - # This match condition specifies a percentage of the user- or - # partner-uploaded content that needs to match a reference file for the rule - # to apply. + # This match condition specifies a percentage of the user- or partner-uploaded + # content that needs to match a reference file for the rule to apply. # Corresponds to the JSON property `matchPercent` # @return [Array] attr_accessor :match_percent - # This match condition indicates that the reference must be a certain - # duration for the rule to apply. + # This match condition indicates that the reference must be a certain duration + # for the rule to apply. # Corresponds to the JSON property `referenceDuration` # @return [Array] attr_accessor :reference_duration # This match condition indicates that the specified percentage of a reference - # file must match the user- or partner-uploaded content for the rule to - # apply. + # file must match the user- or partner-uploaded content for the rule to apply. # Corresponds to the JSON property `referencePercent` # @return [Array] attr_accessor :reference_percent - # This watch condition specifies where users are (or or not) allowed to watch - # (or listen to) an asset. YouTube determines whether the condition is - # satisfied based on the user's location. + # This watch condition specifies where users are (or or not) allowed to watch ( + # or listen to) an asset. YouTube determines whether the condition is satisfied + # based on the user's location. # Corresponds to the JSON property `requiredTerritories` # @return [Google::Apis::YoutubePartnerV1::TerritoryCondition] attr_accessor :required_territories @@ -1356,8 +1339,8 @@ module Google # @return [String] attr_accessor :display_name - # The email address(es) to which YouTube sends claim dispute notifications - # and possible claim notifications. + # The email address(es) to which YouTube sends claim dispute notifications and + # possible claim notifications. # Corresponds to the JSON property `disputeNotificationEmails` # @return [Array] attr_accessor :dispute_notification_emails @@ -1373,7 +1356,7 @@ module Google attr_accessor :id # The type of the API resource. For content owner resources, the value is - # youtubePartner#contentOwner. + # youtubePartner#contentOwner. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -1409,8 +1392,8 @@ module Google # @return [Array] attr_accessor :items - # The type of the API response. For this operation, the value is - # youtubePartner#contentOwnerList. + # The type of the API response. For this operation, the value is youtubePartner# + # contentOwnerList. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -1428,9 +1411,9 @@ module Google # Detailed Content-Type information from Scotty. The Content-Type of the media # will typically be filled in by the header or Scotty's best_guess, but this - # extended information provides the backend with more information so that it - # can make a better decision if needed. This is only used on media upload - # requests from Scotty. + # extended information provides the backend with more information so that it can + # make a better decision if needed. This is only used on media upload requests + # from Scotty. class ContentTypeInfo include Google::Apis::Core::Hashable @@ -1439,27 +1422,27 @@ module Google # @return [String] attr_accessor :best_guess - # The content type of the file derived by looking at specific - # bytes (i.e. "magic bytes") of the actual file. + # The content type of the file derived by looking at specific bytes (i.e. "magic + # bytes") of the actual file. # Corresponds to the JSON property `fromBytes` # @return [String] attr_accessor :from_bytes - # The content type of the file derived from the file extension of - # the original file name used by the client. + # The content type of the file derived from the file extension of the original + # file name used by the client. # Corresponds to the JSON property `fromFileName` # @return [String] attr_accessor :from_file_name - # The content type of the file as specified in the request headers, - # multipart headers, or RUPIO start request. + # The content type of the file as specified in the request headers, multipart + # headers, or RUPIO start request. # Corresponds to the JSON property `fromHeader` # @return [String] attr_accessor :from_header - # The content type of the file derived from the file extension of the - # URL path. The URL path is assumed to represent a file name (which - # is typically only true for agents that are providing a REST API). + # The content type of the file derived from the file extension of the URL path. + # The URL path is assumed to represent a file name (which is typically only true + # for agents that are providing a REST API). # Corresponds to the JSON property `fromUrlPath` # @return [String] attr_accessor :from_url_path @@ -1487,11 +1470,8 @@ module Google # @return [Array] attr_accessor :ad_formats - # A list of ISO - # 3166-1 alpha-2 country codes that identify the countries where ads are - # enabled. + # A list of ISO 3166-1 alpha-2 country codes that identify the countries where + # ads are enabled. # Corresponds to the JSON property `territories` # @return [Array] attr_accessor :territories @@ -1511,50 +1491,38 @@ module Google class CuepointSettings include Google::Apis::Core::Hashable - # The cuepoint's type. See the Getting - # started guide for an explanation of the different types of cuepoints. - # Also see the Life of a - # broadcast document for best practices about inserting cuepoints during - # your broadcast. + # The cuepoint's type. See the Getting started guide for an explanation of the + # different types of cuepoints. Also see the Life of a broadcast document for + # best practices about inserting cuepoints during your broadcast. # Corresponds to the JSON property `cueType` # @return [String] attr_accessor :cue_type # The cuepoint's duration, in seconds. This value must be specified if the - # cueType is ad and is - # ignored otherwise. + # cueType is ad and is ignored otherwise. # Corresponds to the JSON property `durationSecs` # @return [Fixnum] attr_accessor :duration_secs - # This value specifies a point in time in the video when viewers should see - # an ad or in-stream - # slate. The property value identifies a time offset, in milliseconds, - # from the beginning of the monitor stream. Though measured in milliseconds, - # the value is actually an approximation, and YouTube will insert the - # cuepoint as closely as possible to that time. You should not specify a - # value for this parameter if your broadcast does not have a monitor - # stream.

This - # property's default value is 0, which indicates that the - # cuepoint should be inserted as soon as possible. If your broadcast stream - # is not delayed, then 0 is also the only valid value. However, - # if your broadcast stream is delayed, then the property value can specify - # the time when the cuepoint should be inserted. See the Getting - # started guide for more details.

Note: If your - # broadcast had a testing phase, the offset is measured from the time that - # the testing phase began. + # This value specifies a point in time in the video when viewers should see an + # ad or in-stream slate. The property value identifies a time offset, in + # milliseconds, from the beginning of the monitor stream. Though measured in + # milliseconds, the value is actually an approximation, and YouTube will insert + # the cuepoint as closely as possible to that time. You should not specify a + # value for this parameter if your broadcast does not have a monitor stream. + # This property's default value is 0, which indicates that the cuepoint should + # be inserted as soon as possible. If your broadcast stream is not delayed, then + # 0 is also the only valid value. However, if your broadcast stream is delayed, + # then the property value can specify the time when the cuepoint should be + # inserted. See the Getting started guide for more details. *Note:* If your + # broadcast had a testing phase, the offset is measured from the time that the + # testing phase began. # Corresponds to the JSON property `offsetTimeMs` # @return [Fixnum] attr_accessor :offset_time_ms # This value specifies the wall clock time at which the cuepoint should be - # inserted. The value is specified in ISO 8601 - # (YYYY-MM-DDThh:mm:ss.sssZ) format. + # inserted. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sssZ) format. # Corresponds to the JSON property `walltime` # @return [String] attr_accessor :walltime @@ -1576,14 +1544,13 @@ module Google class Date include Google::Apis::Core::Hashable - # The date's day. The value should be an integer between 1 and - # 31. Note that some day-month combinations are not valid. + # The date's day. The value should be an integer between 1 and 31. Note that + # some day-month combinations are not valid. # Corresponds to the JSON property `day` # @return [Fixnum] attr_accessor :day - # The date's month. The value should be an integer between 1 and - # 12. + # The date's month. The value should be an integer between 1 and 12. # Corresponds to the JSON property `month` # @return [Fixnum] attr_accessor :month @@ -1605,27 +1572,26 @@ module Google end end - # Backend response for a Diff get checksums response. - # For details on the Scotty Diff protocol, - # visit http://go/scotty-diff-protocol. + # Backend response for a Diff get checksums response. For details on the Scotty + # Diff protocol, visit http://go/scotty-diff-protocol. class DiffChecksumsResponse include Google::Apis::Core::Hashable - # A sequence of media data references representing composite data. - # Introduced to support Bigstore composite objects. For details, visit - # http://go/bigstore-composites. + # A sequence of media data references representing composite data. Introduced to + # support Bigstore composite objects. For details, visit http://go/bigstore- + # composites. # Corresponds to the JSON property `checksumsLocation` # @return [Google::Apis::YoutubePartnerV1::CompositeMedia] attr_accessor :checksums_location - # The chunk size of checksums. Must be a multiple of 256KB. + # The chunk size of checksums. Must be a multiple of 256KB. # Corresponds to the JSON property `chunkSizeBytes` # @return [Fixnum] attr_accessor :chunk_size_bytes - # A sequence of media data references representing composite data. - # Introduced to support Bigstore composite objects. For details, visit - # http://go/bigstore-composites. + # A sequence of media data references representing composite data. Introduced to + # support Bigstore composite objects. For details, visit http://go/bigstore- + # composites. # Corresponds to the JSON property `objectLocation` # @return [Google::Apis::YoutubePartnerV1::CompositeMedia] attr_accessor :object_location @@ -1654,15 +1620,14 @@ module Google end end - # Backend response for a Diff download response. - # For details on the Scotty Diff protocol, - # visit http://go/scotty-diff-protocol. + # Backend response for a Diff download response. For details on the Scotty Diff + # protocol, visit http://go/scotty-diff-protocol. class DiffDownloadResponse include Google::Apis::Core::Hashable - # A sequence of media data references representing composite data. - # Introduced to support Bigstore composite objects. For details, visit - # http://go/bigstore-composites. + # A sequence of media data references representing composite data. Introduced to + # support Bigstore composite objects. For details, visit http://go/bigstore- + # composites. # Corresponds to the JSON property `objectLocation` # @return [Google::Apis::YoutubePartnerV1::CompositeMedia] attr_accessor :object_location @@ -1677,29 +1642,27 @@ module Google end end - # A Diff upload request. - # For details on the Scotty Diff protocol, - # visit http://go/scotty-diff-protocol. + # A Diff upload request. For details on the Scotty Diff protocol, visit http:// + # go/scotty-diff-protocol. class DiffUploadRequest include Google::Apis::Core::Hashable - # A sequence of media data references representing composite data. - # Introduced to support Bigstore composite objects. For details, visit - # http://go/bigstore-composites. + # A sequence of media data references representing composite data. Introduced to + # support Bigstore composite objects. For details, visit http://go/bigstore- + # composites. # Corresponds to the JSON property `checksumsInfo` # @return [Google::Apis::YoutubePartnerV1::CompositeMedia] attr_accessor :checksums_info - # A sequence of media data references representing composite data. - # Introduced to support Bigstore composite objects. For details, visit - # http://go/bigstore-composites. + # A sequence of media data references representing composite data. Introduced to + # support Bigstore composite objects. For details, visit http://go/bigstore- + # composites. # Corresponds to the JSON property `objectInfo` # @return [Google::Apis::YoutubePartnerV1::CompositeMedia] attr_accessor :object_info - # The object version of the object that is the base version the incoming - # diff script will be applied to. - # This field will always be filled in. + # The object version of the object that is the base version the incoming diff + # script will be applied to. This field will always be filled in. # Corresponds to the JSON property `objectVersion` # @return [String] attr_accessor :object_version @@ -1716,23 +1679,22 @@ module Google end end - # Backend response for a Diff upload request. - # For details on the Scotty Diff protocol, - # visit http://go/scotty-diff-protocol. + # Backend response for a Diff upload request. For details on the Scotty Diff + # protocol, visit http://go/scotty-diff-protocol. class DiffUploadResponse include Google::Apis::Core::Hashable - # The object version of the object at the server. Must be included in the - # end notification response. - # The version in the end notification response must correspond to the new - # version of the object that is now stored at the server, after the upload. + # The object version of the object at the server. Must be included in the end + # notification response. The version in the end notification response must + # correspond to the new version of the object that is now stored at the server, + # after the upload. # Corresponds to the JSON property `objectVersion` # @return [String] attr_accessor :object_version - # A sequence of media data references representing composite data. - # Introduced to support Bigstore composite objects. For details, visit - # http://go/bigstore-composites. + # A sequence of media data references representing composite data. Introduced to + # support Bigstore composite objects. For details, visit http://go/bigstore- + # composites. # Corresponds to the JSON property `originalObject` # @return [Google::Apis::YoutubePartnerV1::CompositeMedia] attr_accessor :original_object @@ -1748,9 +1710,8 @@ module Google end end - # Backend response for a Diff get version response. - # For details on the Scotty Diff protocol, - # visit http://go/scotty-diff-protocol. + # Backend response for a Diff get version response. For details on the Scotty + # Diff protocol, visit http://go/scotty-diff-protocol. class DiffVersionResponse include Google::Apis::Core::Hashable @@ -1780,16 +1741,16 @@ module Google include Google::Apis::Core::Hashable # A boolean to be returned in the response to Scotty. Allows/disallows gzip - # encoding of the payload content when the server thinks it's - # advantageous (hence, does not guarantee compression) which allows - # Scotty to GZip the response to the client. + # encoding of the payload content when the server thinks it's advantageous ( + # hence, does not guarantee compression) which allows Scotty to GZip the + # response to the client. # Corresponds to the JSON property `allowGzipCompression` # @return [Boolean] attr_accessor :allow_gzip_compression alias_method :allow_gzip_compression?, :allow_gzip_compression - # Determining whether or not Apiary should skip the inclusion - # of any Content-Range header on its response to Scotty. + # Determining whether or not Apiary should skip the inclusion of any Content- + # Range header on its response to Scotty. # Corresponds to the JSON property `ignoreRange` # @return [Boolean] attr_accessor :ignore_range @@ -1806,13 +1767,11 @@ module Google end end - # A generic empty message that you can re-use to avoid defining duplicated - # empty messages in your APIs. A typical example is to use it as the request - # or the response type of an API method. For instance: - # service Foo ` - # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); - # ` - # The JSON representation for `Empty` is empty JSON object ````. + # A generic empty message that you can re-use to avoid defining duplicated empty + # messages in your APIs. A typical example is to use it as the request or the + # response type of an API method. For instance: service Foo ` rpc Bar(google. + # protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for + # `Empty` is empty JSON object ````. class Empty include Google::Apis::Core::Hashable @@ -1829,18 +1788,16 @@ module Google class ExcludedInterval include Google::Apis::Core::Hashable - # The end (inclusive) time in seconds of the time window. The value can be - # any value greater than low. If high is greater - # than the length of the reference, the interval between low and - # the end of the reference will be excluded. Every interval must specify a - # value for this field. + # The end (inclusive) time in seconds of the time window. The value can be any + # value greater than low. If high is greater than the length of the reference, + # the interval between low and the end of the reference will be excluded. Every + # interval must specify a value for this field. # Corresponds to the JSON property `high` # @return [Float] attr_accessor :high - # The start (inclusive) time in seconds of the time window. The value can be - # any value between 0 and high. Every interval must - # specify a value for this field. + # The start (inclusive) time in seconds of the time window. The value can be any + # value between 0 and high. Every interval must specify a value for this field. # Corresponds to the JSON property `low` # @return [Float] attr_accessor :low @@ -1851,8 +1808,7 @@ module Google attr_accessor :origin # The date and time that the exclusion was created. The value is specified in - # RFC 3339 - # (YYYY-MM-DDThh:mm:ss.000Z) format. + # RFC 3339 (YYYY-MM-DDThh:mm:ss.000Z) format. # Corresponds to the JSON property `timeCreated` # @return [String] attr_accessor :time_created @@ -1874,14 +1830,14 @@ module Google class IntervalCondition include Google::Apis::Core::Hashable - # The maximum (inclusive) allowed value for the condition to be satisfied. - # The default value is ∞. + # The maximum (inclusive) allowed value for the condition to be satisfied. The + # default value is ∞. # Corresponds to the JSON property `high` # @return [Float] attr_accessor :high - # The minimum (inclusive) allowed value for the condition to be satisfied. - # The default value is -∞. + # The minimum (inclusive) allowed value for the condition to be satisfied. The + # default value is -∞. # Corresponds to the JSON property `low` # @return [Float] attr_accessor :low @@ -1901,8 +1857,8 @@ module Google class LiveCuepoint include Google::Apis::Core::Hashable - # The ID that YouTube assigns to uniquely identify the broadcast into which - # the cuepoint is being inserted. + # The ID that YouTube assigns to uniquely identify the broadcast into which the + # cuepoint is being inserted. # Corresponds to the JSON property `broadcastId` # @return [String] attr_accessor :broadcast_id @@ -1912,14 +1868,13 @@ module Google # @return [String] attr_accessor :id - # The type of the API resource. For liveCuepoint resources, the - # value is youtubePartner#liveCuepoint. + # The type of the API resource. For liveCuepoint resources, the value is + # youtubePartner#liveCuepoint. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # The settings object defines the cuepoint's - # settings. + # The *settings* object defines the cuepoint's settings. # Corresponds to the JSON property `settings` # @return [Google::Apis::YoutubePartnerV1::CuepointSettings] attr_accessor :settings @@ -1941,20 +1896,17 @@ module Google class LongestMatch include Google::Apis::Core::Hashable - # The duration of the longest match between the reference and the user - # video. + # The duration of the longest match between the reference and the user video. # Corresponds to the JSON property `durationSecs` # @return [Fixnum] attr_accessor :duration_secs - # The offset in seconds into the reference at which the longest match - # began. + # The offset in seconds into the reference at which the longest match began. # Corresponds to the JSON property `referenceOffset` # @return [Fixnum] attr_accessor :reference_offset - # The offset in seconds into the user video at which the longest match - # began. + # The offset in seconds into the user video at which the longest match began. # Corresponds to the JSON property `userVideoOffset` # @return [Fixnum] attr_accessor :user_video_offset @@ -1980,25 +1932,24 @@ module Google # @return [Google::Apis::YoutubePartnerV1::LongestMatch] attr_accessor :longest_match - # Details about each match segment. Each item in the list contains - # information about one match segment associated with the claim. It is - # possible to have multiple match segments. For example, if the audio and - # video content of an uploaded video match that of a reference video, there - # would be two match segments. One segment would describe the audio match - # and the other would describe the video match. + # Details about each match segment. Each item in the list contains information + # about one match segment associated with the claim. It is possible to have + # multiple match segments. For example, if the audio and video content of an + # uploaded video match that of a reference video, there would be two match + # segments. One segment would describe the audio match and the other would + # describe the video match. # Corresponds to the JSON property `matchSegments` # @return [Array] attr_accessor :match_segments - # The reference ID that - # generated this match. + # The reference ID that generated this match. # Corresponds to the JSON property `referenceId` # @return [String] attr_accessor :reference_id - # Details of the total amount of reference and user video content which - # matched each other. Note these two values may differ if either the - # reference or the user video contains a loop. + # Details of the total amount of reference and user video content which matched + # each other. Note these two values may differ if either the reference or the + # user video contains a loop. # Corresponds to the JSON property `totalMatch` # @return [Google::Apis::YoutubePartnerV1::TotalMatch] attr_accessor :total_match @@ -2020,27 +1971,26 @@ module Google class MatchSegment include Google::Apis::Core::Hashable - # Identifies the manner in which the claimed video matches the reference - # video. + # Identifies the manner in which the claimed video matches the reference video. # Corresponds to the JSON property `channel` # @return [String] attr_accessor :channel - # On insert operation of manual claims, the manual_segment - # object contains information about the specific portion of the video that is - # claimed to be matching. + # On insert operation of manual claims, the manual_segment object contains + # information about the specific portion of the video that is claimed to be + # matching. # Corresponds to the JSON property `manual_segment` # @return [Google::Apis::YoutubePartnerV1::Segment2] attr_accessor :manual_segment - # The reference_segment object contains information about the - # matched portion of the reference content. + # The reference_segment object contains information about the matched portion of + # the reference content. # Corresponds to the JSON property `reference_segment` # @return [Google::Apis::YoutubePartnerV1::Segment] attr_accessor :reference_segment - # The video_segment object contains information about the - # matched portion of the claimed video. + # The video_segment object contains information about the matched portion of the + # claimed video. # Corresponds to the JSON property `video_segment` # @return [Google::Apis::YoutubePartnerV1::Segment] attr_accessor :video_segment @@ -2062,10 +2012,9 @@ module Google class Media include Google::Apis::Core::Hashable - # Deprecated, use one of explicit hash type fields instead. - # Algorithm used for calculating the hash. - # As of 2011/01/21, "MD5" is the only possible value for this field. - # New values may be added at any time. + # Deprecated, use one of explicit hash type fields instead. Algorithm used for + # calculating the hash. As of 2011/01/21, "MD5" is the only possible value for + # this field. New values may be added at any time. # Corresponds to the JSON property `algorithm` # @return [String] attr_accessor :algorithm @@ -2076,11 +2025,10 @@ module Google # @return [String] attr_accessor :bigstore_object_ref - # Blobstore v1 reference, set if reference_type is BLOBSTORE_REF - # This should be the byte representation of a blobstore.BlobRef. - # Since Blobstore is deprecating v1, use blobstore2_info instead. - # For now, any v2 blob will also be represented in this field as - # v1 BlobRef. + # Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be + # the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating + # v1, use blobstore2_info instead. For now, any v2 blob will also be represented + # in this field as v1 BlobRef. # Corresponds to the JSON property `blobRef` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -2091,10 +2039,10 @@ module Google # @return [Google::Apis::YoutubePartnerV1::Blobstore2Info] attr_accessor :blobstore2_info - # A composite media composed of one or more media objects, set if - # reference_type is COMPOSITE_MEDIA. The media length field must be set - # to the sum of the lengths of all composite media objects. - # Note: All composite media must have length specified. + # A composite media composed of one or more media objects, set if reference_type + # is COMPOSITE_MEDIA. The media length field must be set to the sum of the + # lengths of all composite media objects. Note: All composite media must have + # length specified. # Corresponds to the JSON property `compositeMedia` # @return [Array] attr_accessor :composite_media @@ -2106,66 +2054,59 @@ module Google # Detailed Content-Type information from Scotty. The Content-Type of the media # will typically be filled in by the header or Scotty's best_guess, but this - # extended information provides the backend with more information so that it - # can make a better decision if needed. This is only used on media upload - # requests from Scotty. + # extended information provides the backend with more information so that it can + # make a better decision if needed. This is only used on media upload requests + # from Scotty. # Corresponds to the JSON property `contentTypeInfo` # @return [Google::Apis::YoutubePartnerV1::ContentTypeInfo] attr_accessor :content_type_info - # A binary data reference for a media download. Serves as a - # technology-agnostic binary reference in some Google infrastructure. - # This value is a serialized storage_cosmo.BinaryReference proto. Storing - # it as bytes is a hack to get around the fact that the cosmo proto - # (as well as others it includes) doesn't support JavaScript. This - # prevents us from including the actual type of this field. + # A binary data reference for a media download. Serves as a technology-agnostic + # binary reference in some Google infrastructure. This value is a serialized + # storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get + # around the fact that the cosmo proto (as well as others it includes) doesn't + # support JavaScript. This prevents us from including the actual type of this + # field. # Corresponds to the JSON property `cosmoBinaryReference` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :cosmo_binary_reference - # For Scotty Uploads: - # Scotty-provided hashes for uploads - # For Scotty Downloads: - # (WARNING: DO NOT USE WITHOUT PERMISSION FROM THE SCOTTY TEAM.) - # A Hash provided by the agent to be used to verify the data being - # downloaded. Currently only supported for inline payloads. - # Further, only crc32c_hash is currently supported. + # For Scotty Uploads: Scotty-provided hashes for uploads For Scotty Downloads: ( + # WARNING: DO NOT USE WITHOUT PERMISSION FROM THE SCOTTY TEAM.) A Hash provided + # by the agent to be used to verify the data being downloaded. Currently only + # supported for inline payloads. Further, only crc32c_hash is currently + # supported. # Corresponds to the JSON property `crc32cHash` # @return [Fixnum] attr_accessor :crc32c_hash - # Backend response for a Diff get checksums response. - # For details on the Scotty Diff protocol, - # visit http://go/scotty-diff-protocol. + # Backend response for a Diff get checksums response. For details on the Scotty + # Diff protocol, visit http://go/scotty-diff-protocol. # Corresponds to the JSON property `diffChecksumsResponse` # @return [Google::Apis::YoutubePartnerV1::DiffChecksumsResponse] attr_accessor :diff_checksums_response - # Backend response for a Diff download response. - # For details on the Scotty Diff protocol, - # visit http://go/scotty-diff-protocol. + # Backend response for a Diff download response. For details on the Scotty Diff + # protocol, visit http://go/scotty-diff-protocol. # Corresponds to the JSON property `diffDownloadResponse` # @return [Google::Apis::YoutubePartnerV1::DiffDownloadResponse] attr_accessor :diff_download_response - # A Diff upload request. - # For details on the Scotty Diff protocol, - # visit http://go/scotty-diff-protocol. + # A Diff upload request. For details on the Scotty Diff protocol, visit http:// + # go/scotty-diff-protocol. # Corresponds to the JSON property `diffUploadRequest` # @return [Google::Apis::YoutubePartnerV1::DiffUploadRequest] attr_accessor :diff_upload_request - # Backend response for a Diff upload request. - # For details on the Scotty Diff protocol, - # visit http://go/scotty-diff-protocol. + # Backend response for a Diff upload request. For details on the Scotty Diff + # protocol, visit http://go/scotty-diff-protocol. # Corresponds to the JSON property `diffUploadResponse` # @return [Google::Apis::YoutubePartnerV1::DiffUploadResponse] attr_accessor :diff_upload_response - # Backend response for a Diff get version response. - # For details on the Scotty Diff protocol, - # visit http://go/scotty-diff-protocol. + # Backend response for a Diff get version response. For details on the Scotty + # Diff protocol, visit http://go/scotty-diff-protocol. # Corresponds to the JSON property `diffVersionResponse` # @return [Google::Apis::YoutubePartnerV1::DiffVersionResponse] attr_accessor :diff_version_response @@ -2180,21 +2121,19 @@ module Google # @return [String] attr_accessor :filename - # Deprecated, use one of explicit hash type fields instead. - # These two hash related fields will only be populated on Scotty based media - # uploads and will contain the content of the hash group in the - # NotificationRequest: - # http://cs/#google3/uploader/service/proto/upload_listener.proto&q=class:Hash - # Hex encoded hash value of the uploaded media. + # Deprecated, use one of explicit hash type fields instead. These two hash + # related fields will only be populated on Scotty based media uploads and will + # contain the content of the hash group in the NotificationRequest: http://cs/# + # google3/uploader/service/proto/upload_listener.proto&q=class:Hash Hex encoded + # hash value of the uploaded media. # Corresponds to the JSON property `hash` # @return [String] attr_accessor :hash_prop # For Scotty uploads only. If a user sends a hash code and the backend has - # requested that Scotty verify the upload against the client hash, - # Scotty will perform the check on behalf of the backend and will reject it - # if the hashes don't match. This is set to true if Scotty performed - # this verification. + # requested that Scotty verify the upload against the client hash, Scotty will + # perform the check on behalf of the backend and will reject it if the hashes + # don't match. This is set to true if Scotty performed this verification. # Corresponds to the JSON property `hashVerified` # @return [Boolean] attr_accessor :hash_verified @@ -2206,11 +2145,11 @@ module Google # @return [String] attr_accessor :inline - # |is_potential_retry| is set false only when Scotty is - # certain that it has not sent the request before. When a client resumes - # an upload, this field must be set true in agent calls, because Scotty - # cannot be certain that it has never sent the request before due - # to potential failure in the session state persistence. + # |is_potential_retry| is set false only when Scotty is certain that it has not + # sent the request before. When a client resumes an upload, this field must be + # set true in agent calls, because Scotty cannot be certain that it has never + # sent the request before due to potential failure in the session state + # persistence. # Corresponds to the JSON property `isPotentialRetry` # @return [Boolean] attr_accessor :is_potential_retry @@ -2227,16 +2166,16 @@ module Google # @return [String] attr_accessor :md5_hash - # Media id to forward to the operation GetMedia. - # Can be set if reference_type is GET_MEDIA. + # Media id to forward to the operation GetMedia. Can be set if reference_type is + # GET_MEDIA. # Corresponds to the JSON property `mediaId` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :media_id - # This is a copy of the tech.blob.ObjectId proto, which could not - # be used directly here due to transitive closure issues with - # JavaScript support; see http://b/8801763. + # This is a copy of the tech.blob.ObjectId proto, which could not be used + # directly here due to transitive closure issues with JavaScript support; see + # http://b/8801763. # Corresponds to the JSON property `objectId` # @return [Google::Apis::YoutubePartnerV1::ObjectIdProp] attr_accessor :object_id_prop @@ -2263,8 +2202,8 @@ module Google # @return [String] attr_accessor :sha256_hash - # Time at which the media data was last updated, - # in milliseconds since UNIX epoch + # Time at which the media data was last updated, in milliseconds since UNIX + # epoch # Corresponds to the JSON property `timestamp` # @return [Fixnum] attr_accessor :timestamp @@ -2329,12 +2268,11 @@ module Google # @return [String] attr_accessor :custom_data - # Set if the http request info is diff encoded. The value of - # this field is the version number of the base revision. - # This is corresponding to Apiary's mediaDiffObjectVersion - # (//depot/google3/java/com/google/api/server/media/variable/ - # DiffObjectVersionVariable.java). - # See go/esf-scotty-diff-upload for more information. + # Set if the http request info is diff encoded. The value of this field is the + # version number of the base revision. This is corresponding to Apiary's + # mediaDiffObjectVersion (//depot/google3/java/com/google/api/server/media/ + # variable/DiffObjectVersionVariable.java). See go/esf-scotty-diff-upload for + # more information. # Corresponds to the JSON property `diffObjectVersion` # @return [String] attr_accessor :diff_object_version @@ -2376,30 +2314,27 @@ module Google end end - # This message is for backends to pass their scotty media specific fields to - # ESF. Backend will include this in their response message to ESF. - # Example: - # ExportFile is an rpc defined for upload using scotty from ESF. - # rpc ExportFile(ExportFileRequest) returns (ExportFileResponse) - # Message ExportFileResponse will include apiserving.MediaResponseInfo to tell - # ESF about data like dynamic_dropzone it needs to pass to Scotty. - # message ExportFileResponse ` - # optional gdata.Media blob = 1; - # optional apiserving.MediaResponseInfo media_response_info = 2 - # ` + # This message is for backends to pass their scotty media specific fields to ESF. + # Backend will include this in their response message to ESF. Example: + # ExportFile is an rpc defined for upload using scotty from ESF. rpc ExportFile( + # ExportFileRequest) returns (ExportFileResponse) Message ExportFileResponse + # will include apiserving.MediaResponseInfo to tell ESF about data like + # dynamic_dropzone it needs to pass to Scotty. message ExportFileResponse ` + # optional gdata.Media blob = 1; optional apiserving.MediaResponseInfo + # media_response_info = 2 ` class MediaResponseInfo include Google::Apis::Core::Hashable - # Data to copy from backend response to the next backend requests. Custom - # data is returned to Scotty in the agent_state field, which Scotty will then - # provide in subsequent upload notifications. + # Data to copy from backend response to the next backend requests. Custom data + # is returned to Scotty in the agent_state field, which Scotty will then provide + # in subsequent upload notifications. # Corresponds to the JSON property `customData` # @return [String] attr_accessor :custom_data # Specifies any transformation to be applied to data before persisting it or - # retrieving from storage. E.g., encryption options for blobstore2. - # This should be of the form uploader_service.DataStorageTransform. + # retrieving from storage. E.g., encryption options for blobstore2. This should + # be of the form uploader_service.DataStorageTransform. # Corresponds to the JSON property `dataStorageTransform` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -2408,13 +2343,13 @@ module Google # Specifies the Scotty Drop Target to use for uploads. If present in a media # response, Scotty does not upload to a standard drop zone. Instead, Scotty # saves the upload directly to the location specified in this drop target. - # Unlike drop zones, the drop target is the final storage location for an - # upload. So, the agent does not need to clone the blob at the end of the - # upload. The agent is responsible for garbage collecting any orphaned blobs - # that may occur due to aborted uploads. For more information, see the drop - # target design doc here: http://goto/ScottyDropTarget This field will be - # preferred to dynamicDropzone. If provided, the identified field in the - # response must be of the type uploader.agent.DropTarget. + # Unlike drop zones, the drop target is the final storage location for an upload. + # So, the agent does not need to clone the blob at the end of the upload. The + # agent is responsible for garbage collecting any orphaned blobs that may occur + # due to aborted uploads. For more information, see the drop target design doc + # here: http://goto/ScottyDropTarget This field will be preferred to + # dynamicDropzone. If provided, the identified field in the response must be of + # the type uploader.agent.DropTarget. # Corresponds to the JSON property `dynamicDropTarget` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -2438,15 +2373,14 @@ module Google # Specifies the TrafficClass that Scotty should use for any RPCs to fetch the # response bytes. Will override the traffic class GTOS of the incoming http # request. This is a temporary field to facilitate whitelisting and - # experimentation by the bigstore agent only. For instance, this does not - # apply to RTMP reads. - # WARNING: DO NOT USE WITHOUT PERMISSION FROM THE SCOTTY TEAM. + # experimentation by the bigstore agent only. For instance, this does not apply + # to RTMP reads. WARNING: DO NOT USE WITHOUT PERMISSION FROM THE SCOTTY TEAM. # Corresponds to the JSON property `trafficClassField` # @return [String] attr_accessor :traffic_class_field - # Tells Scotty to verify hashes on the agent's behalf by parsing out the - # X-Goog-Hash header. + # Tells Scotty to verify hashes on the agent's behalf by parsing out the X-Goog- + # Hash header. # Corresponds to the JSON property `verifyHashFromHeader` # @return [Boolean] attr_accessor :verify_hash_from_header @@ -2473,8 +2407,8 @@ module Google class Metadata include Google::Apis::Core::Hashable - # A list that identifies actors associated with the asset. You can specify up - # to 50 actors for an asset. + # A list that identifies actors associated with the asset. You can specify up to + # 50 actors for an asset. # Corresponds to the JSON property `actor` # @return [Array] attr_accessor :actor @@ -2485,18 +2419,18 @@ module Google # @return [String] attr_accessor :album - # The artist associated with a music video or sound recording asset. This - # field is only valid for music video and sound recording assets. It is - # required for sound recordings included in the AudioSwap program. + # The artist associated with a music video or sound recording asset. This field + # is only valid for music video and sound recording assets. It is required for + # sound recordings included in the AudioSwap program. # Corresponds to the JSON property `artist` # @return [Array] attr_accessor :artist - # Identifies the network or channel that originally broadcast a show or a - # season of a show. This field should only be included for an asset if the - # broadcaster associated with the asset is different from the partner - # uploading the asset to YouTube. Note that a show may have multiple - # broadcasters; for example, a show may switch networks between seasons. + # Identifies the network or channel that originally broadcast a show or a season + # of a show. This field should only be included for an asset if the broadcaster + # associated with the asset is different from the partner uploading the asset to + # YouTube. Note that a show may have multiple broadcasters; for example, a show + # may switch networks between seasons. # Corresponds to the JSON property `broadcaster` # @return [Array] attr_accessor :broadcaster @@ -2506,12 +2440,10 @@ module Google # @return [String] attr_accessor :category - # The type of video content that the asset represents. This field is only - # valid for movie and episode assets, and is required for the following types - # of those assets:
  • Episode assets that are linked to a show
    • - #
  • Movie assets that appear in - # YouTube's Movies category
    • - #
+ # The type of video content that the asset represents. This field is only valid + # for movie and episode assets, and is required for the following types of those + # assets: - Episode assets that are linked to a show - Movie assets that appear + # in YouTube's Movies category # Corresponds to the JSON property `contentType` # @return [String] attr_accessor :content_type @@ -2521,116 +2453,110 @@ module Google # @return [Google::Apis::YoutubePartnerV1::Date] attr_accessor :copyright_date - # A unique value that you, the metadata provider, use to identify an asset. - # The value could be a unique ID that you created for the asset or a standard + # A unique value that you, the metadata provider, use to identify an asset. The + # value could be a unique ID that you created for the asset or a standard # identifier, such as an ISRC. The value has a maximum length of 64 bytes and - # may contain alphanumeric characters, hyphens (-), underscores - # (_), periods (.), "at" symbols (@), - # or forward slashes (/). + # may contain alphanumeric characters, hyphens (-), underscores (_), periods ( .) + # , "at" symbols (@), or forward slashes (/). # Corresponds to the JSON property `customId` # @return [String] attr_accessor :custom_id - # A description of the asset. The description may be displayed on YouTube or - # in CMS. This field has a maximum length of 5,000 bytes. + # A description of the asset. The description may be displayed on YouTube or in + # CMS. This field has a maximum length of 5,000 bytes. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # A list that identifies directors associated with the asset. You can specify - # up to 50 directors for an asset. + # A list that identifies directors associated with the asset. You can specify up + # to 50 directors for an asset. # Corresponds to the JSON property `director` # @return [Array] attr_accessor :director - # The Entertainment Identifier Registry (EIDR) assigned to an asset. This - # value is only used for episode and movie assets and is optional in both - # cases. The value contains a standard prefix for EIDR registry, followed by - # a forward slash, a 20-character hexadecimal string, and an alphanumeric - # (0-9A-Z) check character. + # The Entertainment Identifier Registry (EIDR) assigned to an asset. This value + # is only used for episode and movie assets and is optional in both cases. The + # value contains a standard prefix for EIDR registry, followed by a forward + # slash, a 20-character hexadecimal string, and an alphanumeric (0-9A-Z) check + # character. # Corresponds to the JSON property `eidr` # @return [String] attr_accessor :eidr - # The last year that a television show aired. This value is only used for - # show assets, for which it is optional. Do not specify a value if new show - # episodes are still being created. + # The last year that a television show aired. This value is only used for show + # assets, for which it is optional. Do not specify a value if new show episodes + # are still being created. # Corresponds to the JSON property `endYear` # @return [Fixnum] attr_accessor :end_year # The episode number associated with an episode asset. This field is required - # for and only used for episode assets that are linked to show assets. It has - # a maximum length of 5 bytes. + # for and only used for episode assets that are linked to show assets. It has a + # maximum length of 5 bytes. # Corresponds to the JSON property `episodeNumber` # @return [String] attr_accessor :episode_number - # This value indicates that the episodes associated with a particular show - # asset or a particular season asset are untitled. An untitled show (or - # season) has episodes which are identified by their episode number or date. - # If this field is set to true, then YouTube will optimize the - # title displayed for associated episodes. + # This value indicates that the episodes associated with a particular show asset + # or a particular season asset are untitled. An untitled show (or season) has + # episodes which are identified by their episode number or date. If this field + # is set to true, then YouTube will optimize the title displayed for associated + # episodes. # Corresponds to the JSON property `episodesAreUntitled` # @return [Boolean] attr_accessor :episodes_are_untitled alias_method :episodes_are_untitled?, :episodes_are_untitled - # This field specifies a genre that can be used to categorize an asset. - # Assets may be categorized in more than one genre, and YouTube uses - # different sets of genres to categorize different types of assets. For - # example, Soaps might be a valid genre for a show but not for a - # movie or sound recording.
  • Show assets
  • Movie assets that - # appear in - # YouTube's Movies category
    • - #
  • Sound recordings included in the AudioSwap program
+ # This field specifies a genre that can be used to categorize an asset. Assets + # may be categorized in more than one genre, and YouTube uses different sets of + # genres to categorize different types of assets. For example, Soaps might be a + # valid genre for a show but not for a movie or sound recording. - Show assets - + # Movie assets that appear in YouTube's Movies category - Sound recordings + # included in the AudioSwap program # Corresponds to the JSON property `genre` # @return [Array] attr_accessor :genre - # The GRID (Global Release Identifier) of a music video or sound recording. - # This field's value must contain exactly 18 alphanumeric characters. + # The GRID (Global Release Identifier) of a music video or sound recording. This + # field's value must contain exactly 18 alphanumeric characters. # Corresponds to the JSON property `grid` # @return [String] attr_accessor :grid - # The six-character Harry Fox Agency (HFA) song code issued to uniquely - # identify a composition. This value is only valid for composition assets. + # The six-character Harry Fox Agency (HFA) song code issued to uniquely identify + # a composition. This value is only valid for composition assets. # Corresponds to the JSON property `hfa` # @return [String] attr_accessor :hfa - # An official URL associated with the asset. This field has a maximum length - # of 1536 bytes. Please do not submit a 1537-byte URL. Your efforts would be - # futile. + # An official URL associated with the asset. This field has a maximum length of + # 1536 bytes. Please do not submit a 1537-byte URL. Your efforts would be futile. # Corresponds to the JSON property `infoUrl` # @return [String] attr_accessor :info_url - # The ISAN (International Standard Audiovisual Number) for the asset. This - # value is only used for episode and movie assets and is optional in both - # cases. The value contains 26 characters, which includes the 24 hexadecimal - # characters of the ISAN as well as two check characters, in the following - # format:
  • The first 16 characters in the tag value contain - # hexadecimal characters specifying the 'root' and 'episode' components of - # the ISAN.
  • The seventeenth character is a check character (a letter - # from A-Z).
  • Characters 18 to 25 are the remaining eight characters - # of the ISAN, which specify the 'version' component of the ISAN.
    • - #
  • The twenty-sixth character is another check character (A-Z).
+ # The ISAN (International Standard Audiovisual Number) for the asset. This value + # is only used for episode and movie assets and is optional in both cases. The + # value contains 26 characters, which includes the 24 hexadecimal characters of + # the ISAN as well as two check characters, in the following format: - The first + # 16 characters in the tag value contain hexadecimal characters specifying the ' + # root' and 'episode' components of the ISAN. - The seventeenth character is a + # check character (a letter from A-Z). - Characters 18 to 25 are the remaining + # eight characters of the ISAN, which specify the 'version' component of the + # ISAN. - The twenty-sixth character is another check character (A-Z). # Corresponds to the JSON property `isan` # @return [String] attr_accessor :isan # The ISRC (International Standard Recording Code) of a music video or sound - # recording asset. This - # field's value must contain exactly 12 alphanumeric characters. + # recording asset. This field's value must contain exactly 12 alphanumeric + # characters. # Corresponds to the JSON property `isrc` # @return [String] attr_accessor :isrc - # The ISWC (International Standard Musical Work Code) for a composition - # asset. The - # field's value must contain exactly 11 characters in the format of a letter + # The ISWC (International Standard Musical Work Code) for a composition asset. + # The field's value must contain exactly 11 characters in the format of a letter # (T) followed by 10 digits. # Corresponds to the JSON property `iswc` # @return [String] @@ -2648,18 +2574,16 @@ module Google # @return [String] attr_accessor :label - # Additional information that does not map directly to one of the other - # metadata fields. This field has a maximum length of 255 bytes. + # Additional information that does not map directly to one of the other metadata + # fields. This field has a maximum length of 255 bytes. # Corresponds to the JSON property `notes` # @return [String] attr_accessor :notes # The method by which people first had the opportunity to see a video asset. - # This value is only used for episode and movie assets. It is required for - # the assets listed below and otherwise optional:
  • Episode assets - # that are linked to a show
  • Movie assets that appear in - # YouTube's Movies category
    • - #
+ # This value is only used for episode and movie assets. It is required for the + # assets listed below and otherwise optional: - Episode assets that are linked + # to a show - Movie assets that appear in YouTube's Movies category # Corresponds to the JSON property `originalReleaseMedium` # @return [String] attr_accessor :original_release_medium @@ -2670,55 +2594,49 @@ module Google # @return [Array] attr_accessor :producer - # A list of ratings that an asset received. The rating must be valid under - # the specified rating system. + # A list of ratings that an asset received. The rating must be valid under the + # specified rating system. # Corresponds to the JSON property `ratings` # @return [Array] attr_accessor :ratings # The date that an asset was publicly released. For season assets, this value - # specifies the first date that the season aired. Dates prior to the year - # 1902 are not supported. This value is valid for episode, season, movie, - # music video, and sound recording assets. It is required for the assets - # listed below and otherwise optional:
  • Episode assets that are - # linked to a show
  • Movie assets that appear in - # YouTube's Movies category
    • - #
+ # specifies the first date that the season aired. Dates prior to the year 1902 + # are not supported. This value is valid for episode, season, movie, music video, + # and sound recording assets. It is required for the assets listed below and + # otherwise optional: - Episode assets that are linked to a show - Movie assets + # that appear in YouTube's Movies category # Corresponds to the JSON property `releaseDate` # @return [Google::Apis::YoutubePartnerV1::Date] attr_accessor :release_date - # The season number that identifies a season asset, or the season number that - # is associated with an episode asset. This field has a maximum length of 5 - # bytes. + # The season number that identifies a season asset, or the season number that is + # associated with an episode asset. This field has a maximum length of 5 bytes. # Corresponds to the JSON property `seasonNumber` # @return [String] attr_accessor :season_number - # The customId of the show asset that a season or episode asset - # is associated with. It is required for season and episode assets that - # appear in the Shows category on - # YouTube, and it is not valid for other types of assets. This field has a - # maximum length of 64 bytes and may contain alphanumeric characters, hyphens - # (-), underscores (_), periods (.), - # "at" symbols (@), or forward slashes (/). + # The customId of the show asset that a season or episode asset is associated + # with. It is required for season and episode assets that appear in the Shows + # category on YouTube, and it is not valid for other types of assets. This field + # has a maximum length of 64 bytes and may contain alphanumeric characters, + # hyphens (-), underscores (_), periods (.), "at" symbols (@), or forward + # slashes (/). # Corresponds to the JSON property `showCustomId` # @return [String] attr_accessor :show_custom_id - # The name of the show that an episode asset is associated with. - # Note: This tag is only used for and valid for episodes - # that are not associated with show assets and enables those assets to still - # display a show title in the asset metadata section of CMS. This field has a - # maximum length of 120 bytes. + # The name of the show that an episode asset is associated with. *Note:* This + # tag is only used for and valid for episodes that are not associated with show + # assets and enables those assets to still display a show title in the asset + # metadata section of CMS. This field has a maximum length of 120 bytes. # Corresponds to the JSON property `showTitle` # @return [String] attr_accessor :show_title - # The video's primary spoken language. The value can be any ISO 639-1 - # two-letter language code. This value is only used for episode and movie - # assets and is not valid for other types of assets. + # The video's primary spoken language. The value can be any ISO 639-1 two-letter + # language code. This value is only used for episode and movie assets and is not + # valid for other types of assets. # Corresponds to the JSON property `spokenLanguage` # @return [String] attr_accessor :spoken_language @@ -2729,22 +2647,19 @@ module Google # @return [Fixnum] attr_accessor :start_year - # A list of languages for which the video has either a separate caption track - # or burnt-in captions that are part of the video. Each value in the list - # should be an ISO 639-1 - # two-letter language code. This value is only used for episode and movie - # assets and is not valid for other types of assets. + # A list of languages for which the video has either a separate caption track or + # burnt-in captions that are part of the video. Each value in the list should be + # an ISO 639-1 two-letter language code. This value is only used for episode and + # movie assets and is not valid for other types of assets. # Corresponds to the JSON property `subtitledLanguage` # @return [Array] attr_accessor :subtitled_language - # The asset's title or name. The value has a maximum length of 255 bytes. - # This value is required for the assets listed below and optional for all - # other assets:
  • Show assets
  • Episode assets that are linked - # to a show
  • Movie assets that appear in - # YouTube's Movies category
    • - #
  • Sound recordings included in the AudioSwap program
+ # The asset's title or name. The value has a maximum length of 255 bytes. This + # value is required for the assets listed below and optional for all other + # assets: - Show assets - Episode assets that are linked to a show - Movie + # assets that appear in YouTube's Movies category - Sound recordings included in + # the AudioSwap program # Corresponds to the JSON property `title` # @return [String] attr_accessor :title @@ -2754,8 +2669,8 @@ module Google # @return [String] attr_accessor :tms_id - # Specifies the total number of full-length episodes in the season. This - # value is used only for season assets. + # Specifies the total number of full-length episodes in the season. This value + # is used only for season assets. # Corresponds to the JSON property `totalEpisodesExpected` # @return [Fixnum] attr_accessor :total_episodes_expected @@ -2765,8 +2680,8 @@ module Google # @return [String] attr_accessor :upc - # A list that identifies writers associated with the asset. You can specify - # up to 50 writers for an asset. + # A list that identifies writers associated with the asset. You can specify up + # to 50 writers for an asset. # Corresponds to the JSON property `writer` # @return [Array] attr_accessor :writer @@ -2824,20 +2739,18 @@ module Google include Google::Apis::Core::Hashable # The type of the API resource. For metadata history resources, the value is - # youtubePartner#metadataHistory. + # youtubePartner#metadataHistory. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # The metadata object contains the metadata provided by the - # specified source (origination) at the specified time - # (timeProvided). + # The metadata object contains the metadata provided by the specified source ( + # origination) at the specified time (timeProvided). # Corresponds to the JSON property `metadata` # @return [Google::Apis::YoutubePartnerV1::Metadata] attr_accessor :metadata - # The origination object contains information that describes the - # metadata source. + # The origination object contains information that describes the metadata source. # Corresponds to the JSON property `origination` # @return [Google::Apis::YoutubePartnerV1::Origination] attr_accessor :origination @@ -2864,14 +2777,14 @@ module Google class MetadataHistoryListResponse include Google::Apis::Core::Hashable - # A list of metadata history (youtubePartner#metadataHistory) - # resources that match the request criteria. + # A list of metadata history (youtubePartner#metadataHistory) resources that + # match the request criteria. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items - # The type of the API response. For this operation, the value is - # youtubePartner#metadataHistoryList. + # The type of the API response. For this operation, the value is youtubePartner# + # metadataHistoryList. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -2887,9 +2800,9 @@ module Google end end - # This is a copy of the tech.blob.ObjectId proto, which could not - # be used directly here due to transitive closure issues with - # JavaScript support; see http://b/8801763. + # This is a copy of the tech.blob.ObjectId proto, which could not be used + # directly here due to transitive closure issues with JavaScript support; see + # http://b/8801763. class ObjectIdProp include Google::Apis::Core::Hashable @@ -2898,11 +2811,10 @@ module Google # @return [String] attr_accessor :bucket_name - # Generation of the object. Generations are monotonically increasing - # across writes, allowing them to be be compared to determine which - # generation is newer. If this is omitted in a request, then you are - # requesting the live object. - # See http://go/bigstore-versions + # Generation of the object. Generations are monotonically increasing across + # writes, allowing them to be be compared to determine which generation is newer. + # If this is omitted in a request, then you are requesting the live object. See + # http://go/bigstore-versions # Corresponds to the JSON property `generation` # @return [Fixnum] attr_accessor :generation @@ -2979,29 +2891,26 @@ module Google # @return [Array] attr_accessor :general - # The type of the API resource. For ownershipConflicts - # resources, the value is youtubePartner#ownershipConflicts. + # The type of the API resource. For ownershipConflicts resources, the value is + # youtubePartner#ownershipConflicts. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # A list that identifies ownership conflicts of the mechanical rights for a - # composition asset and the territories where conflicting ownership is - # inserted. + # composition asset and the territories where conflicting ownership is inserted. # Corresponds to the JSON property `mechanical` # @return [Array] attr_accessor :mechanical # A list that identifies ownership conflicts of the performance rights for a - # composition asset and the territories where conflicting ownership is - # inserted. + # composition asset and the territories where conflicting ownership is inserted. # Corresponds to the JSON property `performance` # @return [Array] attr_accessor :performance - # A list that identifies ownership conflicts of the synchronization rights - # for a composition asset and the territories where conflicting ownership is - # inserted. + # A list that identifies ownership conflicts of the synchronization rights for a + # composition asset and the territories where conflicting ownership is inserted. # Corresponds to the JSON property `synchronization` # @return [Array] attr_accessor :synchronization @@ -3024,14 +2933,14 @@ module Google class OwnershipHistoryListResponse include Google::Apis::Core::Hashable - # A list of ownership history (youtubePartner#ownershipHistory) - # resources that match the request criteria. + # A list of ownership history (youtubePartner#ownershipHistory) resources that + # match the request criteria. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items - # The type of the API response. For this operation, the value is - # youtubePartner#ownershipHistoryList. + # The type of the API response. For this operation, the value is youtubePartner# + # ownershipHistoryList. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -3066,16 +2975,15 @@ module Google # @return [String] attr_accessor :id - # The type of the API resource. For package resources, this - # value is youtubePartner#package. + # The type of the API resource. For package resources, this value is + # youtubePartner#package. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # The desired locale of the error messages as defined in BCP 47 - # (http: - # //tools.ietf.org/html/bcp47). For example, "en-US" or "de". If not - # // specified we will return the error messages in English ("en"). + # The desired locale of the error messages as defined in BCP 47 (http: //tools. + # ietf.org/html/bcp47). For example, "en-US" or "de". If not // specified we + # will return the error messages in English ("en"). # Corresponds to the JSON property `locale` # @return [String] attr_accessor :locale @@ -3095,9 +3003,8 @@ module Google # @return [Array] attr_accessor :status_reports - # The package creation time. The value is specified in RFC 3339 - # (YYYY-MM-DDThh:mm:ss.000Z) format. + # The package creation time. The value is specified in RFC 3339 ( YYYY-MM-DDThh: + # mm:ss.000Z) format. # Corresponds to the JSON property `timeCreated` # @return [String] attr_accessor :time_created @@ -3141,23 +3048,22 @@ module Google # @return [Array] attr_accessor :errors - # The type of the API response. For this operation, the value is - # youtubePartner#packageInsert. + # The type of the API response. For this operation, the value is youtubePartner# + # packageInsert. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # The package resource. + # The package resource. # Corresponds to the JSON property `resource` # @return [Google::Apis::YoutubePartnerV1::Package] attr_accessor :resource # The package insert status. Indicates whether the insert operation completed - # successfully or identifies the general cause of failure. For most cases - # where the insert operation failed, the errors are described in the API - # response's errors object. However, if the operation failed - # because the package contained non-metadata files, the errors - # object is not included in the response. + # successfully or identifies the general cause of failure. For most cases where + # the insert operation failed, the errors are described in the API response's + # errors object. However, if the operation failed because the package contained + # non-metadata files, the errors object is not included in the response. # Corresponds to the JSON property `status` # @return [String] attr_accessor :status @@ -3220,7 +3126,7 @@ module Google # @return [String] attr_accessor :id - # Identifies this as a policy. Value: "youtubePartner#policy" + # Identifies this as a policy. Value: "youtubePartner#policy" # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -3265,8 +3171,8 @@ module Google # @return [Array] attr_accessor :items - # The type of the API response. For this operation, the value is - # youtubePartner#policyList. + # The type of the API response. For this operation, the value is youtubePartner# + # policyList. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -3286,20 +3192,20 @@ module Google class PolicyRule include Google::Apis::Core::Hashable - # The policy that YouTube should enforce if the rule's conditions are all - # valid for an asset or for an attempt to view that asset on YouTube. + # The policy that YouTube should enforce if the rule's conditions are all valid + # for an asset or for an attempt to view that asset on YouTube. # Corresponds to the JSON property `action` # @return [String] attr_accessor :action - # A set of conditions that must be met for the rule's action (and subactions) - # to be enforced. For a rule to be valid, all of its conditions must be met. + # A set of conditions that must be met for the rule's action (and subactions) to + # be enforced. For a rule to be valid, all of its conditions must be met. # Corresponds to the JSON property `conditions` # @return [Google::Apis::YoutubePartnerV1::Conditions] attr_accessor :conditions - # A list of additional actions that YouTube should take if the conditions in - # the rule are met. + # A list of additional actions that YouTube should take if the conditions in the + # rule are met. # Corresponds to the JSON property `subaction` # @return [Array] attr_accessor :subaction @@ -3320,11 +3226,9 @@ module Google class PromotedContent include Google::Apis::Core::Hashable - # A list of link targets that will be used to generate the annotation link - # that appears on videos included in the - # campaign. If more than one link is specified, the link that is - # displayed to viewers will be randomly selected from the list. + # A list of link targets that will be used to generate the annotation link that + # appears on videos included in the campaign. If more than one link is specified, + # the link that is displayed to viewers will be randomly selected from the list. # Corresponds to the JSON property `link` # @return [Array] attr_accessor :link @@ -3374,18 +3278,17 @@ module Google # @return [String] attr_accessor :asset_id - # Set this field's value to true to indicate that the reference - # content should be included in YouTube's AudioSwap program. + # Set this field's value to true to indicate that the reference content should + # be included in YouTube's AudioSwap program. # Corresponds to the JSON property `audioswapEnabled` # @return [Boolean] attr_accessor :audioswap_enabled alias_method :audioswap_enabled?, :audioswap_enabled # This field is present if the reference was created by associating an asset - # with an existing YouTube video that was uploaded to a YouTube channel - # linked to your CMS account. In that case, this field contains the ID of the - # claim representing the resulting association between the asset and the - # video. + # with an existing YouTube video that was uploaded to a YouTube channel linked + # to your CMS account. In that case, this field contains the ID of the claim + # representing the resulting association between the asset and the video. # Corresponds to the JSON property `claimId` # @return [String] attr_accessor :claim_id @@ -3395,22 +3298,21 @@ module Google # @return [String] attr_accessor :content_type - # The ID that uniquely identifies the reference that this reference - # duplicates. This field is only present if the - # reference's status is inactive with reason - # REASON_DUPLICATE_FOR_OWNERS. + # The ID that uniquely identifies the reference that this reference duplicates. + # This field is only present if the reference's status is inactive with reason + # REASON_DUPLICATE_FOR_OWNERS. # Corresponds to the JSON property `duplicateLeader` # @return [String] attr_accessor :duplicate_leader - # The list of time intervals from this reference that will be ignored during - # the match process. + # The list of time intervals from this reference that will be ignored during the + # match process. # Corresponds to the JSON property `excludedIntervals` # @return [Array] attr_accessor :excluded_intervals - # When uploading a reference, set this value to true to indicate - # that the reference is a pre-generated fingerprint. + # When uploading a reference, set this value to true to indicate that the + # reference is a pre-generated fingerprint. # Corresponds to the JSON property `fpDirect` # @return [Boolean] attr_accessor :fp_direct @@ -3421,7 +3323,7 @@ module Google # @return [Google::Apis::YoutubePartnerV1::Media] attr_accessor :gdata_media - # The MD5 hashcode of the reference content. Deprecated! This is no longer + # The MD5 hashcode of the reference content. Deprecated! This is no longer # populated. # Corresponds to the JSON property `hashCode` # @return [String] @@ -3432,16 +3334,15 @@ module Google # @return [String] attr_accessor :id - # Set this value to true to indicate that the reference should - # not be used to generate claims. This field is only used on AudioSwap - # references. + # Set this value to true to indicate that the reference should not be used to + # generate claims. This field is only used on AudioSwap references. # Corresponds to the JSON property `ignoreFpMatch` # @return [Boolean] attr_accessor :ignore_fp_match alias_method :ignore_fp_match?, :ignore_fp_match - # The type of the API resource. For reference resources, the - # value is youtubePartner#reference. + # The type of the API resource. For reference resources, the value is + # youtubePartner#reference. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -3456,23 +3357,20 @@ module Google # @return [Google::Apis::YoutubePartnerV1::MediaRequestInfo] attr_accessor :media_request_info - # This message is for backends to pass their scotty media specific fields to - # ESF. Backend will include this in their response message to ESF. - # Example: - # ExportFile is an rpc defined for upload using scotty from ESF. - # rpc ExportFile(ExportFileRequest) returns (ExportFileResponse) - # Message ExportFileResponse will include apiserving.MediaResponseInfo to tell - # ESF about data like dynamic_dropzone it needs to pass to Scotty. - # message ExportFileResponse ` - # optional gdata.Media blob = 1; - # optional apiserving.MediaResponseInfo media_response_info = 2 - # ` + # This message is for backends to pass their scotty media specific fields to ESF. + # Backend will include this in their response message to ESF. Example: + # ExportFile is an rpc defined for upload using scotty from ESF. rpc ExportFile( + # ExportFileRequest) returns (ExportFileResponse) Message ExportFileResponse + # will include apiserving.MediaResponseInfo to tell ESF about data like + # dynamic_dropzone it needs to pass to Scotty. message ExportFileResponse ` + # optional gdata.Media blob = 1; optional apiserving.MediaResponseInfo + # media_response_info = 2 ` # Corresponds to the JSON property `mediaResponseInfo` # @return [Google::Apis::YoutubePartnerV1::MediaResponseInfo] attr_accessor :media_response_info - # The origination object contains information that describes the - # reference source. + # The origination object contains information that describes the reference + # source. # Corresponds to the JSON property `origination` # @return [Google::Apis::YoutubePartnerV1::Origination] attr_accessor :origination @@ -3483,29 +3381,27 @@ module Google attr_accessor :status # An explanation of how a reference entered its current state. This value is - # only present if the - # reference's status is either inactive or deleted. + # only present if the reference's status is either inactive or deleted. # Corresponds to the JSON property `statusReason` # @return [String] attr_accessor :status_reason - # Set this value to true to indicate that YouTube should - # prioritize Content ID processing for a video file. YouTube processes urgent - # video files before other files that are not marked as urgent. This setting - # is primarily used for videos of live events or other videos that require - # time-sensitive processing. The sooner YouTube completes Content ID - # processing for a video, the sooner YouTube can match user-uploaded videos - # to that video.

Note that marking all of your files as urgent could - # delay processing for those files. + # Set this value to true to indicate that YouTube should prioritize Content ID + # processing for a video file. YouTube processes urgent video files before other + # files that are not marked as urgent. This setting is primarily used for videos + # of live events or other videos that require time-sensitive processing. The + # sooner YouTube completes Content ID processing for a video, the sooner YouTube + # can match user-uploaded videos to that video. Note that marking all of your + # files as urgent could delay processing for those files. # Corresponds to the JSON property `urgent` # @return [Boolean] attr_accessor :urgent alias_method :urgent?, :urgent # This field is present if the reference was created by associating an asset - # with an existing YouTube video that was uploaded to a YouTube channel - # linked to your CMS account. In that case, this field contains the ID of the - # source video. + # with an existing YouTube video that was uploaded to a YouTube channel linked + # to your CMS account. In that case, this field contains the ID of the source + # video. # Corresponds to the JSON property `videoId` # @return [String] attr_accessor :video_id @@ -3559,14 +3455,14 @@ module Google # @return [String] attr_accessor :id - # The type of the API resource. For referenceConflict resources, - # the value is youtubePartner#referenceConflict. + # The type of the API resource. For referenceConflict resources, the value is + # youtubePartner#referenceConflict. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # The list of matches between conflicting and original references at the time - # of conflict creation. + # The list of matches between conflicting and original references at the time of + # conflict creation. # Corresponds to the JSON property `matches` # @return [Array] attr_accessor :matches @@ -3606,20 +3502,19 @@ module Google # @return [Array] attr_accessor :items - # The type of the API response. For this operation, the value is - # youtubePartner#referenceConflictList. + # The type of the API response. For this operation, the value is youtubePartner# + # referenceConflictList. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # The token that can be used as the value of the pageToken - # parameter to retrieve the next page in the result set. + # The token that can be used as the value of the pageToken parameter to retrieve + # the next page in the result set. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token - # The pageInfo object encapsulates paging information for the - # result set. + # The pageInfo object encapsulates paging information for the result set. # Corresponds to the JSON property `pageInfo` # @return [Google::Apis::YoutubePartnerV1::PageInfo] attr_accessor :page_info @@ -3683,20 +3578,19 @@ module Google # @return [Array] attr_accessor :items - # The type of the API response. For this operation, the value is - # youtubePartner#referenceList. + # The type of the API response. For this operation, the value is youtubePartner# + # referenceList. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # The token that can be used as the value of the pageToken - # parameter to retrieve the next page in the result set. + # The token that can be used as the value of the pageToken parameter to retrieve + # the next page in the result set. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token - # The pageInfo object encapsulates paging information for the - # result set. + # The pageInfo object encapsulates paging information for the result set. # Corresponds to the JSON property `pageInfo` # @return [Google::Apis::YoutubePartnerV1::PageInfo] attr_accessor :page_info @@ -3718,24 +3612,22 @@ module Google class RightsOwnership include Google::Apis::Core::Hashable - # A list that identifies the owners of an asset and the territories where - # each owner has ownership. General asset ownership is used for all types of - # assets and is the only type of ownership data that can be provided for - # assets that are not compositions.

Note: You - # cannot specify general ownership rights and also specify either mechanical, - # performance, or synchronization rights. + # A list that identifies the owners of an asset and the territories where each + # owner has ownership. General asset ownership is used for all types of assets + # and is the only type of ownership data that can be provided for assets that + # are not compositions. *Note:* You cannot specify general ownership rights and + # also specify either mechanical, performance, or synchronization rights. # Corresponds to the JSON property `general` # @return [Array] attr_accessor :general - # The type of the API resource. For rightsOwnership resources, - # the value is youtubePartner#rightsOwnership. + # The type of the API resource. For rightsOwnership resources, the value is + # youtubePartner#rightsOwnership. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # A list that identifies owners of the mechanical rights for a composition - # asset. + # A list that identifies owners of the mechanical rights for a composition asset. # Corresponds to the JSON property `mechanical` # @return [Array] attr_accessor :mechanical @@ -3746,8 +3638,8 @@ module Google # @return [Array] attr_accessor :performance - # A list that identifies owners of the synchronization rights for a - # composition asset. + # A list that identifies owners of the synchronization rights for a composition + # asset. # Corresponds to the JSON property `synchronization` # @return [Array] attr_accessor :synchronization @@ -3771,20 +3663,18 @@ module Google include Google::Apis::Core::Hashable # The type of the API resource. For ownership history resources, the value is - # youtubePartner#rightsOwnershipHistory. + # youtubePartner#rightsOwnershipHistory. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # The origination object contains information that describes the - # metadata source. + # The origination object contains information that describes the metadata source. # Corresponds to the JSON property `origination` # @return [Google::Apis::YoutubePartnerV1::Origination] attr_accessor :origination - # The ownership object contains the ownership data provided by - # the specified source (origination) at the specified time - # (timeProvided). + # The ownership object contains the ownership data provided by the specified + # source (origination) at the specified time (timeProvided). # Corresponds to the JSON property `ownership` # @return [Google::Apis::YoutubePartnerV1::RightsOwnership] attr_accessor :ownership @@ -3817,7 +3707,7 @@ module Google attr_accessor :duration # The type of the API resource. For segment resources, the value is - # youtubePartner#segment. + # youtubePartner#segment. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -3843,14 +3733,13 @@ module Google class Segment2 include Google::Apis::Core::Hashable - # The finish time of the segment, measured in milliseconds from the - # beginning. + # The finish time of the segment, measured in milliseconds from the beginning. # Corresponds to the JSON property `finish` # @return [String] attr_accessor :finish # The type of the API resource. For segment resources, the value is - # youtubePartner#segment. + # youtubePartner#segment. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -3907,8 +3796,8 @@ module Google class SpreadsheetTemplate include Google::Apis::Core::Hashable - # The type of the API resource. For spreadsheet template resources, the value - # is youtubePartner#spreadsheetTemplate. + # The type of the API resource. For spreadsheet template resources, the value is + # youtubePartner#spreadsheetTemplate. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -3951,15 +3840,14 @@ module Google class SpreadsheetTemplateListResponse include Google::Apis::Core::Hashable - # A list of spreadsheet templates - # (youtubePartner#spreadsheetTemplate) resources that match the - # request criteria. + # A list of spreadsheet templates (youtubePartner#spreadsheetTemplate) resources + # that match the request criteria. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items - # The type of the API response. For this operation, the value is - # youtubePartner#spreadsheetTemplateList. + # The type of the API response. For this operation, the value is youtubePartner# + # spreadsheetTemplateList. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -4010,16 +3898,13 @@ module Google class TerritoryCondition include Google::Apis::Core::Hashable - # A list of territories. Each territory is an ISO - # 3166 two-letter country code.. + # A list of territories. Each territory is an ISO 3166 two-letter country code.. # Corresponds to the JSON property `territories` # @return [Array] attr_accessor :territories - # This field indicates whether the associated policy rule is or is not valid - # in the specified territories. + # This field indicates whether the associated policy rule is or is not valid in + # the specified territories. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -4044,10 +3929,8 @@ module Google # @return [Array] attr_accessor :conflicting_ownership - # A territories where the ownership conflict is present. Territory is an ISO - # 3166 two-letter country code.. + # A territories where the ownership conflict is present. Territory is an ISO + # 3166 two-letter country code.. # Corresponds to the JSON property `territory` # @return [String] attr_accessor :territory @@ -4080,26 +3963,23 @@ module Google attr_accessor :publisher # The percentage of the asset that the owner controls or administers. For - # composition assets, the value can be any value between 0 and - # 100 inclusive. For all other assets, the only valid values are - # 100, which indicates that the owner completely owns the asset - # in the specified territories, and 0, which indicates that you - # are removing ownership of the asset in the specified territories. + # composition assets, the value can be any value between 0 and 100 inclusive. + # For all other assets, the only valid values are 100, which indicates that the + # owner completely owns the asset in the specified territories, and 0, which + # indicates that you are removing ownership of the asset in the specified + # territories. # Corresponds to the JSON property `ratio` # @return [Float] attr_accessor :ratio - # A list of territories where the owner owns (or does not own) the asset. - # Each territory is an ISO - # 3166 two-letter country code.. + # A list of territories where the owner owns (or does not own) the asset. Each + # territory is an ISO 3166 two-letter country code.. # Corresponds to the JSON property `territories` # @return [Array] attr_accessor :territories - # This field indicates whether the ownership data applies or does not apply - # in the specified territories. + # This field indicates whether the ownership data applies or does not apply in + # the specified territories. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -4122,14 +4002,14 @@ module Google class TotalMatch include Google::Apis::Core::Hashable - # The total amount of content in the reference which matched the user - # video in seconds. + # The total amount of content in the reference which matched the user video in + # seconds. # Corresponds to the JSON property `referenceDurationSecs` # @return [Fixnum] attr_accessor :reference_duration_secs - # The total amount of content in the user video which matched the - # reference in seconds. + # The total amount of content in the user video which matched the reference in + # seconds. # Corresponds to the JSON property `userVideoDurationSecs` # @return [Fixnum] attr_accessor :user_video_duration_secs @@ -4149,23 +4029,22 @@ module Google class TypeDetails include Google::Apis::Core::Hashable - # Appeal explanations for dispute_appeal event. + # Appeal explanations for dispute_appeal event. # Corresponds to the JSON property `appealExplanation` # @return [String] attr_accessor :appeal_explanation - # Dispute notes for dispute_create events. + # Dispute notes for dispute_create events. # Corresponds to the JSON property `disputeNotes` # @return [String] attr_accessor :dispute_notes - # Dispute reason for dispute_create and - # dispute_appeal events. + # Dispute reason for dispute_create and dispute_appeal events. # Corresponds to the JSON property `disputeReason` # @return [String] attr_accessor :dispute_reason - # Status that was a result of update for claim_update event. + # Status that was a result of update for claim_update event. # Corresponds to the JSON property `updateStatus` # @return [String] attr_accessor :update_status @@ -4188,7 +4067,7 @@ module Google include Google::Apis::Core::Hashable # The type of the API resource. For uploader resources, the value is - # youtubePartner#uploader. + # youtubePartner#uploader. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -4213,14 +4092,14 @@ module Google class UploaderListResponse include Google::Apis::Core::Hashable - # A list of uploader (youtubePartner#uploader) resources that - # match the request criteria. + # A list of uploader (youtubePartner#uploader) resources that match the request + # criteria. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items - # The type of the API response. For this operation, the value is - # youtubePartner#uploaderList. + # The type of the API response. For this operation, the value is youtubePartner# + # uploaderList. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -4245,8 +4124,8 @@ module Google # @return [String] attr_accessor :content - # The type of the API resource. For this operation, the value is - # youtubePartner#validateAsyncRequest. + # The type of the API resource. For this operation, the value is youtubePartner# + # validateAsyncRequest. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -4272,8 +4151,8 @@ module Google class ValidateAsyncResponse include Google::Apis::Core::Hashable - # The type of the API resource. For this operation, the value is - # youtubePartner#validateAsyncResponse. + # The type of the API resource. For this operation, the value is youtubePartner# + # validateAsyncResponse. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -4358,16 +4237,15 @@ module Google # @return [String] attr_accessor :content - # The type of the API resource. For this operation, the value is - # youtubePartner#validateRequest. + # The type of the API resource. For this operation, the value is youtubePartner# + # validateRequest. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # The desired locale of the error messages as defined in BCP 47 - # (http: - # //tools.ietf.org/html/bcp47). For example, "en-US" or "de". If not - # // specified we will return the error messages in English ("en"). + # The desired locale of the error messages as defined in BCP 47 (http: //tools. + # ietf.org/html/bcp47). For example, "en-US" or "de". If not // specified we + # will return the error messages in English ("en"). # Corresponds to the JSON property `locale` # @return [String] attr_accessor :locale @@ -4399,8 +4277,8 @@ module Google # @return [Array] attr_accessor :errors - # The type of the API resource. For this operation, the value is - # youtubePartner#validateResponse. + # The type of the API resource. For this operation, the value is youtubePartner# + # validateResponse. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -4426,16 +4304,15 @@ module Google class ValidateStatusRequest include Google::Apis::Core::Hashable - # The type of the API resource. For this operation, the value is - # youtubePartner#validateStatusRequest. + # The type of the API resource. For this operation, the value is youtubePartner# + # validateStatusRequest. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # The desired locale of the error messages as defined in BCP 47 - # (http: - # //tools.ietf.org/html/bcp47). For example, "en-US" or "de". If not - # // specified we will return the error messages in English ("en"). + # The desired locale of the error messages as defined in BCP 47 (http: //tools. + # ietf.org/html/bcp47). For example, "en-US" or "de". If not // specified we + # will return the error messages in English ("en"). # Corresponds to the JSON property `locale` # @return [String] attr_accessor :locale @@ -4472,8 +4349,8 @@ module Google attr_accessor :is_metadata_only alias_method :is_metadata_only?, :is_metadata_only - # The type of the API resource. For this operation, the value is - # youtubePartner#validateStatusResponse. + # The type of the API resource. For this operation, the value is youtubePartner# + # validateStatusResponse. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -4528,8 +4405,8 @@ module Google # @return [String] attr_accessor :id - # The type of the API resource. For this resource, the value is - # youtubePartner#videoAdvertisingOption. + # The type of the API resource. For this resource, the value is youtubePartner# + # videoAdvertisingOption. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -4539,14 +4416,14 @@ module Google # @return [String] attr_accessor :tp_ad_server_video_id - # The base URL for a third-party ad server from which YouTube can retrieve - # in-stream ads for the video. + # The base URL for a third-party ad server from which YouTube can retrieve in- + # stream ads for the video. # Corresponds to the JSON property `tpTargetingUrl` # @return [String] attr_accessor :tp_targeting_url - # A parameter string to append to the end of the request to the third-party - # ad server. + # A parameter string to append to the end of the request to the third-party ad + # server. # Corresponds to the JSON property `tpUrlParameters` # @return [String] attr_accessor :tp_url_parameters @@ -4578,8 +4455,8 @@ module Google # @return [Array] attr_accessor :ad_breaks - # This field indicates whether YouTube can show ads when the video is played - # in an embedded player. + # This field indicates whether YouTube can show ads when the video is played in + # an embedded player. # Corresponds to the JSON property `adsOnEmbeds` # @return [Boolean] attr_accessor :ads_on_embeds @@ -4596,8 +4473,8 @@ module Google # @return [String] attr_accessor :id - # The type of the API resource. For this resource, the value is - # youtubePartner#videoAdvertisingOptionGetEnabledAds. + # The type of the API resource. For this resource, the value is youtubePartner# + # videoAdvertisingOptionGetEnabledAds. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -4625,8 +4502,8 @@ module Google # @return [String] attr_accessor :id - # The type of the API resource. For whitelist resources, this - # value is youtubePartner#whitelist. + # The type of the API resource. For whitelist resources, this value is + # youtubePartner#whitelist. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -4652,25 +4529,24 @@ module Google class WhitelistListResponse include Google::Apis::Core::Hashable - # A list of whitelist resources that match the request criteria. + # A list of whitelist resources that match the request criteria. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items - # The type of the API response. For this operation, the value is - # youtubePartner#whitelistList. + # The type of the API response. For this operation, the value is youtubePartner# + # whitelistList. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # The token that can be used as the value of the pageToken - # parameter to retrieve the next page of results. + # The token that can be used as the value of the pageToken parameter to retrieve + # the next page of results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token - # The pageInfo object encapsulates paging information for the - # result set. + # The pageInfo object encapsulates paging information for the result set. # Corresponds to the JSON property `pageInfo` # @return [Google::Apis::YoutubePartnerV1::PageInfo] attr_accessor :page_info diff --git a/generated/google/apis/youtube_partner_v1/service.rb b/generated/google/apis/youtube_partner_v1/service.rb index c10da97f5..5e1972820 100644 --- a/generated/google/apis/youtube_partner_v1/service.rb +++ b/generated/google/apis/youtube_partner_v1/service.rb @@ -51,10 +51,9 @@ module Google # Insert an asset label for an owner. # @param [Google::Apis::YoutubePartnerV1::AssetLabel] asset_label_object # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter - # identifies the content owner that the user is acting on behalf of. This - # parameter supports users whose accounts are associated with multiple - # content owners. + # The *onBehalfOfContentOwner* parameter identifies the content owner that the + # user is acting on behalf of. This parameter supports users whose accounts are + # associated with multiple content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -86,17 +85,14 @@ module Google # Retrieves a list of all asset labels for an owner. # @param [String] label_prefix - # The labelPrefix parameter identifies the - # prefix of asset labels to retrieve. + # The *labelPrefix* parameter identifies the prefix of asset labels to retrieve. # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter - # identifies the content owner that the user is acting on behalf of. This - # parameter supports users whose accounts are associated with multiple - # content owners. + # The *onBehalfOfContentOwner* parameter identifies the content owner that the + # user is acting on behalf of. This parameter supports users whose accounts are + # associated with multiple content owners. # @param [String] q - # The q parameter specifies the query string to - # use to filter search results. YouTube searches for the query string in the - # labelName field of asset labels. + # The *q* parameter specifies the query string to use to filter search results. + # YouTube searches for the query string in the *labelName* field of asset labels. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -130,13 +126,12 @@ module Google # owner associated with the authenticated user. This information is only # accessible to an owner of the asset. # @param [String] asset_id - # The assetId parameter specifies the YouTube - # asset ID of the asset for which you are retrieving the match policy. + # The *assetId* parameter specifies the YouTube asset ID of the asset for which + # you are retrieving the match policy. # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter - # identifies the content owner that the user is acting on behalf of. This - # parameter supports users whose accounts are associated with multiple - # content owners. + # The *onBehalfOfContentOwner* parameter identifies the content owner that the + # user is acting on behalf of. This parameter supports users whose accounts are + # associated with multiple content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -165,19 +160,18 @@ module Google execute_or_queue_command(command, &block) end - # Patches the asset's match policy. If an asset has multiple owners, each - # owner may set its own match policy for the asset. YouTube then computes the - # match policy that is actually applied for the asset based on the - # territories where each owner owns the asset. + # Patches the asset's match policy. If an asset has multiple owners, each owner + # may set its own match policy for the asset. YouTube then computes the match + # policy that is actually applied for the asset based on the territories where + # each owner owns the asset. # @param [String] asset_id - # The assetId parameter specifies the YouTube - # asset ID of the asset for which you are retrieving the match policy. + # The *assetId* parameter specifies the YouTube asset ID of the asset for which + # you are retrieving the match policy. # @param [Google::Apis::YoutubePartnerV1::AssetMatchPolicy] asset_match_policy_object # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter - # identifies the content owner that the user is acting on behalf of. This - # parameter supports users whose accounts are associated with multiple - # content owners. + # The *onBehalfOfContentOwner* parameter identifies the content owner that the + # user is acting on behalf of. This parameter supports users whose accounts are + # associated with multiple content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -208,19 +202,18 @@ module Google execute_or_queue_command(command, &block) end - # Updates the asset's match policy. If an asset has multiple owners, each - # owner may set its own match policy for the asset. YouTube then computes the - # match policy that is actually applied for the asset based on the - # territories where each owner owns the asset. + # Updates the asset's match policy. If an asset has multiple owners, each owner + # may set its own match policy for the asset. YouTube then computes the match + # policy that is actually applied for the asset based on the territories where + # each owner owns the asset. # @param [String] asset_id - # The assetId parameter specifies the YouTube - # asset ID of the asset for which you are retrieving the match policy. + # The *assetId* parameter specifies the YouTube asset ID of the asset for which + # you are retrieving the match policy. # @param [Google::Apis::YoutubePartnerV1::AssetMatchPolicy] asset_match_policy_object # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter - # identifies the content owner that the user is acting on behalf of. This - # parameter supports users whose accounts are associated with multiple - # content owners. + # The *onBehalfOfContentOwner* parameter identifies the content owner that the + # user is acting on behalf of. This parameter supports users whose accounts are + # associated with multiple content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -253,13 +246,12 @@ module Google # Deletes a relationship between two assets. # @param [String] asset_relationship_id - # The assetRelationshipId parameter specifies a - # value that uniquely identifies the relationship you are deleting. + # The *assetRelationshipId* parameter specifies a value that uniquely identifies + # the relationship you are deleting. # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter - # identifies the content owner that the user is acting on behalf of. This - # parameter supports users whose accounts are associated with multiple - # content owners. + # The *onBehalfOfContentOwner* parameter identifies the content owner that the + # user is acting on behalf of. This parameter supports users whose accounts are + # associated with multiple content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -291,10 +283,9 @@ module Google # Creates a relationship that links two assets. # @param [Google::Apis::YoutubePartnerV1::AssetRelationship] asset_relationship_object # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter - # identifies the content owner that the user is acting on behalf of. This - # parameter supports users whose accounts are associated with multiple - # content owners. + # The *onBehalfOfContentOwner* parameter identifies the content owner that the + # user is acting on behalf of. This parameter supports users whose accounts are + # associated with multiple content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -328,18 +319,17 @@ module Google # relationships where the specified asset is either the parent (embedding) or # child (embedded) asset in the relationship. # @param [String] asset_id - # The assetId parameter specifies the asset ID - # of the asset for which you are retrieving relationships. + # The *assetId* parameter specifies the asset ID of the asset for which you are + # retrieving relationships. # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter - # identifies the content owner that the user is acting on behalf of. This - # parameter supports users whose accounts are associated with multiple - # content owners. + # The *onBehalfOfContentOwner* parameter identifies the content owner that the + # user is acting on behalf of. This parameter supports users whose accounts are + # associated with multiple content owners. # @param [String] page_token - # The pageToken parameter specifies a token - # that identifies a particular page of results to return. Set this parameter - # to the value of the nextPageToken value from the previous API - # response to retrieve the next page of search results. + # The *pageToken* parameter specifies a token that identifies a particular page + # of results to return. Set this parameter to the value of the nextPageToken + # value from the previous API response to retrieve the next page of search + # results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -371,72 +361,60 @@ module Google # Searches for assets based on asset metadata. The method can retrieve all # assets or only assets owned by the content owner. This method mimics the - # functionality of the advanced search feature on the Assets page in CMS. + # functionality of the advanced search feature on the Assets page in CMS. # @param [String] created_after - # The createdAfter parameter restricts the set - # of returned assets to ones originally created on or after the specified - # datetime. For example: 2015-01-29T23:00:00Z + # The *createdAfter* parameter restricts the set of returned assets to ones + # originally created on or after the specified datetime. For example: 2015-01- + # 29T23:00:00Z # @param [String] created_before - # The createdBefore parameter restricts the set - # of returned assets to ones originally created on or before the specified - # datetime. For example: 2015-01-29T23:00:00Z + # The *createdBefore* parameter restricts the set of returned assets to ones + # originally created on or before the specified datetime. For example: 2015-01- + # 29T23:00:00Z # @param [Boolean] has_conflicts - # The hasConflicts parameter enables you to - # only retrieve assets that have ownership conflicts. The only valid value is - # true. Setting the parameter value to false does - # not affect the results. + # The *hasConflicts* parameter enables you to only retrieve assets that have + # ownership conflicts. The only valid value is true. Setting the parameter value + # to false does not affect the results. # @param [Boolean] include_any_providedlabel - # If includeAnyProvidedlabel parameter is set - # to true, will search for assets that contain any of the provided labels; - # else will search for assets that contain all the provided labels. + # If *includeAnyProvidedlabel* parameter is set to true, will search for assets + # that contain any of the provided labels; else will search for assets that + # contain all the provided labels. # @param [String] isrcs # A comma-separated list of up to 50 ISRCs. If you specify a value for this - # parameter, the API server ignores any values set for the following - # parameters: q, includeAnyProvidedLabel, - # hasConflicts, labels, - # metadataSearchFields, sort, and - # type. + # parameter, the API server ignores any values set for the following parameters: + # q, includeAnyProvidedLabel, hasConflicts, labels, metadataSearchFields, sort, + # and type. # @param [String] labels - # The labels parameter specifies the assets - # with certain asset labels that you want to retrieve. The parameter value is - # a comma-separated list of asset labels. + # The *labels* parameter specifies the assets with certain asset labels that you + # want to retrieve. The parameter value is a comma-separated list of asset + # labels. # @param [String] metadata_search_fields - # The metadataSearchField parameter specifies - # which metadata fields to search by. It is a comma-separated list of - # metadata field and value pairs connected by colon(:). For example: - # customId:my_custom_id,artist:Dandexx + # The *metadataSearchField* parameter specifies which metadata fields to search + # by. It is a comma-separated list of metadata field and value pairs connected + # by colon(:). For example: customId:my_custom_id,artist:Dandexx # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter - # identifies the content owner that the user is acting on behalf of. This - # parameter supports users whose accounts are associated with multiple - # content owners. + # The *onBehalfOfContentOwner* parameter identifies the content owner that the + # user is acting on behalf of. This parameter supports users whose accounts are + # associated with multiple content owners. # @param [String] ownership_restriction - # The ownershipRestriction parameter specifies - # the ownership filtering option for the search. By default the search is - # performed in the assets owned by currently authenticated user only. + # The *ownershipRestriction* parameter specifies the ownership filtering option + # for the search. By default the search is performed in the assets owned by + # currently authenticated user only. # @param [String] page_token - # The pageToken parameter specifies a token - # that identifies a particular page of results to return. Set this parameter - # to the value of the nextPageToken value from the previous API - # response to retrieve the next page of search results. + # The *pageToken* parameter specifies a token that identifies a particular page + # of results to return. Set this parameter to the value of the nextPageToken + # value from the previous API response to retrieve the next page of search + # results. # @param [String] q - # YouTube searches within the id, - # type, and - # customId fields for all assets as well as in - # numerous other metadata fields – such as - # actor, album, - # director, isrc, - # and tmsId – that vary for different - # types of assets (movies, music videos, etc.). + # YouTube searches within the *id*, *type*, and *customId* fields for all assets + # as well as in numerous other metadata fields – such as *actor*, *album*, * + # director*, *isrc*, and *tmsId* – that vary for different types of assets ( + # movies, music videos, etc.). # @param [String] sort - # The sort parameter specifies how the search - # results should be sorted. Note that results are always sorted in descending - # order. + # The *sort* parameter specifies how the search results should be sorted. Note + # that results are always sorted in descending order. # @param [String] type - # The type parameter specifies the types of - # assets that you want to retrieve. The parameter value is a comma-separated - # list of asset types. + # The *type* parameter specifies the types of assets that you want to retrieve. + # The parameter value is a comma-separated list of asset types. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -476,27 +454,24 @@ module Google execute_or_queue_command(command, &block) end - # This method either retrieves a list of asset shares the partner owns and - # that map to a specified asset view ID or it retrieves a list of - # asset views associated with a specified asset share ID owned by the - # partner. + # This method either retrieves a list of asset shares the partner owns and that + # map to a specified asset view ID *or* it retrieves a list of asset views + # associated with a specified asset share ID owned by the partner. # @param [String] asset_id - # The assetId parameter specifies the asset ID - # for which you are retrieving data. The parameter can be an asset view ID or - # an asset share ID.
  • If the value is an asset view ID, the API - # response identifies any asset share ids mapped to the asset - # view.
  • If the value is an asset share ID, the API response - # identifies any asset view ids that maps to that asset share.
+ # The *assetId* parameter specifies the asset ID for which you are retrieving + # data. The parameter can be an asset view ID or an asset share ID. - If the + # value is an asset view ID, the API response identifies any asset share ids + # mapped to the asset view. - If the value is an asset share ID, the API + # response identifies any asset view ids that maps to that asset share. # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter - # identifies the content owner that the user is acting on behalf of. This - # parameter supports users whose accounts are associated with multiple - # content owners. + # The *onBehalfOfContentOwner* parameter identifies the content owner that the + # user is acting on behalf of. This parameter supports users whose accounts are + # associated with multiple content owners. # @param [String] page_token - # The pageToken parameter specifies a token - # that identifies a particular page of results to return. Set this parameter - # to the value of the nextPageToken value from the previous API - # response to retrieve the next page of search results. + # The *pageToken* parameter specifies a token that identifies a particular page + # of results to return. Set this parameter to the value of the nextPageToken + # value from the previous API response to retrieve the next page of search + # results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -531,32 +506,27 @@ module Google # YouTube identified the requested asset as a duplicate, then the request # retrieves the merged, or synthesized, asset. # @param [String] asset_id - # The assetId parameter specifies the YouTube - # asset ID of the asset being retrieved. + # The *assetId* parameter specifies the YouTube asset ID of the asset being + # retrieved. # @param [String] fetch_match_policy - # The fetchMatchPolicy parameter specifies the - # version of the - # asset's match policy that should be returned in the API response. + # The *fetchMatchPolicy* parameter specifies the version of the asset's match + # policy that should be returned in the API response. # @param [String] fetch_metadata - # The fetchMetadata parameter specifies the - # version of the - # asset's metadata that should be returned in the API response. In some - # cases, YouTube receives metadata for an asset from multiple sources, such - # as when different partners own the asset in different territories. + # The *fetchMetadata* parameter specifies the version of the asset's metadata + # that should be returned in the API response. In some cases, YouTube receives + # metadata for an asset from multiple sources, such as when different partners + # own the asset in different territories. # @param [String] fetch_ownership - # The fetchOwnership parameter specifies the - # version of the - # asset's ownership data that should be returned in the API response. As with - # asset metadata, YouTube can receive asset ownership data from multiple - # sources. + # The *fetchOwnership* parameter specifies the version of the asset's ownership + # data that should be returned in the API response. As with asset metadata, + # YouTube can receive asset ownership data from multiple sources. # @param [Boolean] fetch_ownership_conflicts - # The fetchOwnershipConflicts parameter allows - # you to retrieve information about ownership conflicts. + # The *fetchOwnershipConflicts* parameter allows you to retrieve information + # about ownership conflicts. # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter - # identifies the content owner that the user is acting on behalf of. This - # parameter supports users whose accounts are associated with multiple - # content owners. + # The *onBehalfOfContentOwner* parameter identifies the content owner that the + # user is acting on behalf of. This parameter supports users whose accounts are + # associated with multiple content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -590,15 +560,12 @@ module Google end # Inserts an asset with the specified metadata. After inserting an asset, you - # can set its ownership - # data and match policy. + # can set its ownership data and match policy. # @param [Google::Apis::YoutubePartnerV1::Asset] asset_object # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter - # identifies the content owner that the user is acting on behalf of. This - # parameter supports users whose accounts are associated with multiple - # content owners. + # The *onBehalfOfContentOwner* parameter identifies the content owner that the + # user is acting on behalf of. This parameter supports users whose accounts are + # associated with multiple content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -629,46 +596,39 @@ module Google end # Retrieves a list of assets based on asset metadata. The method can retrieve - # all assets or only assets owned by the content owner.

Note that in - # cases where duplicate assets have been merged, the API response only - # contains the synthesized asset. (It does not contain the constituent assets - # that were merged into the synthesized asset.) + # all assets or only assets owned by the content owner. Note that in cases where + # duplicate assets have been merged, the API response only contains the + # synthesized asset. (It does not contain the constituent assets that were + # merged into the synthesized asset.) # @param [String] fetch_match_policy - # The fetchMatchPolicy parameter specifies the - # version of the - # asset's match policy that should be returned in the API response. + # The *fetchMatchPolicy* parameter specifies the version of the asset's match + # policy that should be returned in the API response. # @param [String] fetch_metadata - # The fetchMetadata parameter specifies the - # version of the - # asset's metadata that should be returned in the API response. In some - # cases, YouTube receives metadata for an asset from multiple sources, such - # as when different partners own the asset in different territories. + # The *fetchMetadata* parameter specifies the version of the asset's metadata + # that should be returned in the API response. In some cases, YouTube receives + # metadata for an asset from multiple sources, such as when different partners + # own the asset in different territories. # @param [String] fetch_ownership - # The fetchOwnership parameter specifies the - # version of the - # asset's ownership data that should be returned in the API response. As with - # asset metadata, YouTube can receive asset ownership data from multiple - # sources. + # The *fetchOwnership* parameter specifies the version of the asset's ownership + # data that should be returned in the API response. As with asset metadata, + # YouTube can receive asset ownership data from multiple sources. # @param [Boolean] fetch_ownership_conflicts - # The fetchOwnershipConflicts parameter allows - # you to retrieve information about ownership conflicts. + # The *fetchOwnershipConflicts* parameter allows you to retrieve information + # about ownership conflicts. # @param [String] id - # The id parameter specifies a comma-separated - # list of YouTube Asset IDs that identify the assets you want to retrieve. As - # noted in the method description, if you try to retrieve an asset that - # YouTube identified as a duplicate and merged with another asset, the API - # response only returns the synthesized asset. In that case, the - # aliasId property in the asset resource specifies - # a list of other asset IDs that can be used to identify that - # asset.

Also note that the API response does not contain - # duplicates. As such, if your request identifies three asset IDs, and all of - # those have been merged into a single asset, then the API response - # identifies one matching asset. + # The *id* parameter specifies a comma-separated list of YouTube Asset IDs that + # identify the assets you want to retrieve. As noted in the method description, + # if you try to retrieve an asset that YouTube identified as a duplicate and + # merged with another asset, the API response only returns the synthesized asset. + # In that case, the aliasId property in the asset resource specifies a list of + # other asset IDs that can be used to identify that asset. Also note that the + # API response does not contain duplicates. As such, if your request identifies + # three asset IDs, and all of those have been merged into a single asset, then + # the API response identifies one matching asset. # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter - # identifies the content owner that the user is acting on behalf of. This - # parameter supports users whose accounts are associated with multiple - # content owners. + # The *onBehalfOfContentOwner* parameter identifies the content owner that the + # user is acting on behalf of. This parameter supports users whose accounts are + # associated with multiple content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -703,14 +663,13 @@ module Google # Patches the metadata for the specified asset. # @param [String] asset_id - # The assetId parameter specifies the YouTube - # asset ID of the asset being patched. + # The *assetId* parameter specifies the YouTube asset ID of the asset being + # patched. # @param [Google::Apis::YoutubePartnerV1::Asset] asset_object # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter - # identifies the content owner that the user is acting on behalf of. This - # parameter supports users whose accounts are associated with multiple - # content owners. + # The *onBehalfOfContentOwner* parameter identifies the content owner that the + # user is acting on behalf of. This parameter supports users whose accounts are + # associated with multiple content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -743,14 +702,13 @@ module Google # Updates the metadata for the specified asset. # @param [String] asset_id - # The assetId parameter specifies the YouTube - # asset ID of the asset being updated. + # The *assetId* parameter specifies the YouTube asset ID of the asset being + # updated. # @param [Google::Apis::YoutubePartnerV1::Asset] asset_object # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter - # identifies the content owner that the user is acting on behalf of. This - # parameter supports users whose accounts are associated with multiple - # content owners. + # The *onBehalfOfContentOwner* parameter identifies the content owner that the + # user is acting on behalf of. This parameter supports users whose accounts are + # associated with multiple content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -783,13 +741,12 @@ module Google # Deletes a specified campaign for an owner. # @param [String] campaign_id - # The campaignId parameter specifies the - # YouTube campaign ID of the campaign being deleted. + # The *campaignId* parameter specifies the YouTube campaign ID of the campaign + # being deleted. # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter - # identifies the content owner that the user is acting on behalf of. This - # parameter supports users whose accounts are associated with multiple - # content owners. + # The *onBehalfOfContentOwner* parameter identifies the content owner that the + # user is acting on behalf of. This parameter supports users whose accounts are + # associated with multiple content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -820,13 +777,12 @@ module Google # Retrieves a particular campaign for an owner. # @param [String] campaign_id - # The campaignId parameter specifies the - # YouTube campaign ID of the campaign being retrieved. + # The *campaignId* parameter specifies the YouTube campaign ID of the campaign + # being retrieved. # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter - # identifies the content owner that the user is acting on behalf of. This - # parameter supports users whose accounts are associated with multiple - # content owners. + # The *onBehalfOfContentOwner* parameter identifies the content owner that the + # user is acting on behalf of. This parameter supports users whose accounts are + # associated with multiple content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -858,10 +814,9 @@ module Google # Insert a new campaign for an owner using the specified campaign data. # @param [Google::Apis::YoutubePartnerV1::Campaign] campaign_object # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter - # identifies the content owner that the user is acting on behalf of. This - # parameter supports users whose accounts are associated with multiple - # content owners. + # The *onBehalfOfContentOwner* parameter identifies the content owner that the + # user is acting on behalf of. This parameter supports users whose accounts are + # associated with multiple content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -893,15 +848,14 @@ module Google # Retrieves a list of campaigns for an owner. # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter - # identifies the content owner that the user is acting on behalf of. This - # parameter supports users whose accounts are associated with multiple - # content owners. + # The *onBehalfOfContentOwner* parameter identifies the content owner that the + # user is acting on behalf of. This parameter supports users whose accounts are + # associated with multiple content owners. # @param [String] page_token - # The pageToken parameter specifies a token - # that identifies a particular page of results to return. For example, set - # this parameter to the value of the nextPageToken value from - # the previous API response to retrieve the next page of search results. + # The *pageToken* parameter specifies a token that identifies a particular page + # of results to return. For example, set this parameter to the value of the + # nextPageToken value from the previous API response to retrieve the next page + # of search results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -932,14 +886,13 @@ module Google # Patch the data for a specific campaign. # @param [String] campaign_id - # The campaignId parameter specifies the - # YouTube campaign ID of the campaign being retrieved. + # The *campaignId* parameter specifies the YouTube campaign ID of the campaign + # being retrieved. # @param [Google::Apis::YoutubePartnerV1::Campaign] campaign_object # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter - # identifies the content owner that the user is acting on behalf of. This - # parameter supports users whose accounts are associated with multiple - # content owners. + # The *onBehalfOfContentOwner* parameter identifies the content owner that the + # user is acting on behalf of. This parameter supports users whose accounts are + # associated with multiple content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -972,14 +925,13 @@ module Google # Update the data for a specific campaign. # @param [String] campaign_id - # The campaignId parameter specifies the - # YouTube campaign ID of the campaign being retrieved. + # The *campaignId* parameter specifies the YouTube campaign ID of the campaign + # being retrieved. # @param [Google::Apis::YoutubePartnerV1::Campaign] campaign_object # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter - # identifies the content owner that the user is acting on behalf of. This - # parameter supports users whose accounts are associated with multiple - # content owners. + # The *onBehalfOfContentOwner* parameter identifies the content owner that the + # user is acting on behalf of. This parameter supports users whose accounts are + # associated with multiple content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1012,13 +964,12 @@ module Google # Retrieves the claim history for a specified claim. # @param [String] claim_id - # The claimId parameter specifies the YouTube - # claim ID of the claim for which you are retrieving the claim history. + # The *claimId* parameter specifies the YouTube claim ID of the claim for which + # you are retrieving the claim history. # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter - # identifies the content owner that the user is acting on behalf of. This - # parameter supports users whose accounts are associated with multiple - # content owners. + # The *onBehalfOfContentOwner* parameter identifies the content owner that the + # user is acting on behalf of. This parameter supports users whose accounts are + # associated with multiple content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1047,87 +998,72 @@ module Google execute_or_queue_command(command, &block) end - # Retrieves a list of claims that match the search criteria. You can search - # for claims that are associated with a specific asset or video or that match - # a specified query string. + # Retrieves a list of claims that match the search criteria. You can search for + # claims that are associated with a specific asset or video or that match a + # specified query string. # @param [String] asset_id - # The assetId parameter specifies the YouTube - # asset ID of the asset for which you are retrieving claims. + # The *assetId* parameter specifies the YouTube asset ID of the asset for which + # you are retrieving claims. # @param [String] content_type - # The contentType parameter specifies the - # content type of claims that you want to retrieve. + # The *contentType* parameter specifies the content type of claims that you want + # to retrieve. # @param [String] created_after - # The createdAfter parameter allows you to - # restrict the set of returned claims to ones created on or after the - # specified date (inclusive). + # The *createdAfter* parameter allows you to restrict the set of returned claims + # to ones created on or after the specified date (inclusive). # @param [String] created_before - # The createdBefore parameter allows you to - # restrict the set of returned claims to ones created before the specified - # date (exclusive). + # The *createdBefore* parameter allows you to restrict the set of returned + # claims to ones created before the specified date (exclusive). # @param [String] inactive_reasons - # The inactiveReasons parameter allows you to - # specify what kind of inactive claims you want to find based on the reasons - # why the claims became inactive. + # The *inactiveReasons* parameter allows you to specify what kind of inactive + # claims you want to find based on the reasons why the claims became inactive. # @param [Boolean] include_third_party_claims - # Used along with the videoId parameter this - # parameter determines whether or not to include third party claims in the - # search results. + # Used along with the *videoId* parameter this parameter determines whether or + # not to include third party claims in the search results. # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter - # identifies the content owner that the user is acting on behalf of. This - # parameter supports users whose accounts are associated with multiple - # content owners. + # The *onBehalfOfContentOwner* parameter identifies the content owner that the + # user is acting on behalf of. This parameter supports users whose accounts are + # associated with multiple content owners. # @param [String] origin - # The origin parameter specifies the origins - # you want to find claims for. It is a comma-separated list of origin values. + # The *origin* parameter specifies the origins you want to find claims for. It + # is a comma-separated list of origin values. # @param [String] page_token - # The pageToken parameter specifies a token - # that identifies a particular page of results to return. For example, set - # this parameter to the value of the nextPageToken value from - # the previous API response to retrieve the next page of search results. + # The *pageToken* parameter specifies a token that identifies a particular page + # of results to return. For example, set this parameter to the value of the + # nextPageToken value from the previous API response to retrieve the next page + # of search results. # @param [Boolean] partner_uploaded - # The partnerUploaded parameter specifies - # whether you want to filter your search results to only partner uploaded or - # non partner uploaded claims. + # The *partnerUploaded* parameter specifies whether you want to filter your + # search results to only partner uploaded or non partner uploaded claims. # @param [String] q - # The q parameter specifies the query string to - # use to filter search results. YouTube searches for the query string in the - # following claim fields: video_title, - # video_keywords, - # user_name, - # isrc, iswc, - # grid, - # custom_id, and in the content - # owner's email address. + # The *q* parameter specifies the query string to use to filter search results. + # YouTube searches for the query string in the following claim fields: * + # video_title*, *video_keywords*, *user_name*, *isrc*, *iswc*, *grid*, * + # custom_id*, and in the content owner's email address. # @param [String] reference_id - # The referenceId parameter specifies the - # YouTube reference ID of the reference for which you are retrieving claims. + # The *referenceId* parameter specifies the YouTube reference ID of the + # reference for which you are retrieving claims. # @param [String] sort - # The sort parameter specifies the method that - # will be used to order resources in the API response. The default value is - # date. However, if the status parameter value is - # either appealed, disputed, pending, - # potential, or routedForReview, then results will - # be sorted by the time that the claim review period expires. + # The *sort* parameter specifies the method that will be used to order resources + # in the API response. The default value is date. However, if the status + # parameter value is either appealed, disputed, pending, potential, or + # routedForReview, then results will be sorted by the time that the claim review + # period expires. # @param [String] status - # The status parameter restricts your results - # to only claims in the specified status. + # The *status* parameter restricts your results to only claims in the specified + # status. # @param [String] status_modified_after - # The statusModifiedAfter parameter allows you - # to restrict the result set to only include claims that have had their - # status modified on or after the specified date (inclusive). The date - # specified must be on or after June 30, 2016 (2016-06-30). The parameter - # value's format is YYYY-MM-DD. + # The *statusModifiedAfter* parameter allows you to restrict the result set to + # only include claims that have had their status modified on or after the + # specified date (inclusive). The date specified must be on or after June 30, + # 2016 (2016-06-30). The parameter value's format is YYYY-MM-DD. # @param [String] status_modified_before - # The statusModifiedBefore parameter allows you - # to restrict the result set to only include claims that have had their - # status modified before the specified date (exclusive). The date specified - # must be on or after July 1, 2016 (2016-07-01). The parameter - # value's format is YYYY-MM-DD. + # The *statusModifiedBefore* parameter allows you to restrict the result set to + # only include claims that have had their status modified before the specified + # date (exclusive). The date specified must be on or after July 1, 2016 (2016-07- + # 01). The parameter value's format is YYYY-MM-DD. # @param [String] video_id - # The videoId parameter specifies - # comma-separated list of YouTube video IDs for which you are retrieving - # claims. + # The *videoId* parameter specifies comma-separated list of YouTube video IDs + # for which you are retrieving claims. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1173,13 +1109,11 @@ module Google # Retrieves a specific claim by ID. # @param [String] claim_id - # The claimId parameter specifies the claim ID - # of the claim being retrieved. + # The *claimId* parameter specifies the claim ID of the claim being retrieved. # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter - # identifies the content owner that the user is acting on behalf of. This - # parameter supports users whose accounts are associated with multiple - # content owners. + # The *onBehalfOfContentOwner* parameter identifies the content owner that the + # user is acting on behalf of. This parameter supports users whose accounts are + # associated with multiple content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1208,22 +1142,18 @@ module Google execute_or_queue_command(command, &block) end - # Creates a claim. The video being claimed must have been uploaded to a - # channel associated with the same content owner as the API user sending the - # request. You can set the - # claim's policy in any of the following ways:
  • Use the - # claim resource's policy property to identify a - # saved policy by its unique ID.
  • Use the claim - # resource's policy property to specify a custom set of - # rules.
+ # Creates a claim. The video being claimed must have been uploaded to a channel + # associated with the same content owner as the API user sending the request. + # You can set the claim's policy in any of the following ways: - Use the claim + # resource's policy property to identify a saved policy by its unique ID. - Use + # the claim resource's policy property to specify a custom set of rules. # @param [Google::Apis::YoutubePartnerV1::Claim] claim_object # @param [Boolean] is_manual_claim # restricted # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter - # identifies the content owner that the user is acting on behalf of. This - # parameter supports users whose accounts are associated with multiple - # content owners. + # The *onBehalfOfContentOwner* parameter identifies the content owner that the + # user is acting on behalf of. This parameter supports users whose accounts are + # associated with multiple content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1254,44 +1184,36 @@ module Google execute_or_queue_command(command, &block) end - # Retrieves a list of claims administered by the content owner associated - # with the currently authenticated user. Results are sorted in descending - # order of creation time. + # Retrieves a list of claims administered by the content owner associated with + # the currently authenticated user. Results are sorted in descending order of + # creation time. # @param [String] asset_id - # Use the claimSearch.list method's assetId - # parameter to search for claim snippets by asset ID. You can then retrieve - # the claim resources for those claims by using this - # method's id parameter to specify a - # comma-separated list of claim IDs. + # Use the claimSearch.list method's assetId parameter to search for claim + # snippets by asset ID. You can then retrieve the claim resources for those + # claims by using this method's *id* parameter to specify a comma-separated list + # of claim IDs. # @param [String] id - # The id parameter specifies a list of - # comma-separated YouTube claim IDs to retrieve. + # The *id* parameter specifies a list of comma-separated YouTube claim IDs to + # retrieve. # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter - # identifies the content owner that the user is acting on behalf of. This - # parameter supports users whose accounts are associated with multiple - # content owners. + # The *onBehalfOfContentOwner* parameter identifies the content owner that the + # user is acting on behalf of. This parameter supports users whose accounts are + # associated with multiple content owners. # @param [String] page_token - # The pageToken parameter specifies a token - # that identifies a particular page of results to return. For example, set - # this parameter to the value of the nextPageToken value from - # the previous API response to retrieve the next page of search results. + # The *pageToken* parameter specifies a token that identifies a particular page + # of results to return. For example, set this parameter to the value of the + # nextPageToken value from the previous API response to retrieve the next page + # of search results. # @param [String] q - # Use the claimSearch.list method's q parameter - # to search for claim snippets that match a particular query string. You can - # then retrieve the claim resources for those claims by using - # this - # method's id parameter to specify a + # Use the claimSearch.list method's q parameter to search for claim snippets + # that match a particular query string. You can then retrieve the claim + # resources for those claims by using this method's *id* parameter to specify a # comma-separated list of claim IDs. # @param [String] video_id - # Use the claimSearch.list method's videoId - # parameter to search for claim snippets by video ID. You can then retrieve - # the claim resources for those claims by using this - # method's id parameter to specify a - # comma-separated list of claim IDs. + # Use the claimSearch.list method's videoId parameter to search for claim + # snippets by video ID. You can then retrieve the claim resources for those + # claims by using this method's *id* parameter to specify a comma-separated list + # of claim IDs. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1324,19 +1246,16 @@ module Google execute_or_queue_command(command, &block) end - # Patches an existing claim by either changing its policy or its status. You - # can update a - # claim's status from active to inactive to - # effectively release the claim. + # Patches an existing claim by either changing its policy or its status. You can + # update a claim's status from active to inactive to effectively release the + # claim. # @param [String] claim_id - # The claimId parameter specifies the claim ID - # of the claim being updated. + # The *claimId* parameter specifies the claim ID of the claim being updated. # @param [Google::Apis::YoutubePartnerV1::Claim] claim_object # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter - # identifies the content owner that the user is acting on behalf of. This - # parameter supports users whose accounts are associated with multiple - # content owners. + # The *onBehalfOfContentOwner* parameter identifies the content owner that the + # user is acting on behalf of. This parameter supports users whose accounts are + # associated with multiple content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1367,19 +1286,16 @@ module Google execute_or_queue_command(command, &block) end - # Updates an existing claim by either changing its policy or its status. You - # can update a - # claim's status from active to inactive to - # effectively release the claim. + # Updates an existing claim by either changing its policy or its status. You can + # update a claim's status from active to inactive to effectively release the + # claim. # @param [String] claim_id - # The claimId parameter specifies the claim ID - # of the claim being updated. + # The *claimId* parameter specifies the claim ID of the claim being updated. # @param [Google::Apis::YoutubePartnerV1::Claim] claim_object # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter - # identifies the content owner that the user is acting on behalf of. This - # parameter supports users whose accounts are associated with multiple - # content owners. + # The *onBehalfOfContentOwner* parameter identifies the content owner that the + # user is acting on behalf of. This parameter supports users whose accounts are + # associated with multiple content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1412,13 +1328,12 @@ module Google # Retrieves information about the specified content owner. # @param [String] content_owner_id - # The contentOwnerId parameter specifies a - # value that uniquely identifies the content owner. + # The *contentOwnerId* parameter specifies a value that uniquely identifies the + # content owner. # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter - # identifies the content owner that the user is acting on behalf of. This - # parameter supports users whose accounts are associated with multiple - # content owners. + # The *onBehalfOfContentOwner* parameter identifies the content owner that the + # user is acting on behalf of. This parameter supports users whose accounts are + # associated with multiple content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1447,20 +1362,17 @@ module Google execute_or_queue_command(command, &block) end - # Retrieves a list of content owners - # that match the request criteria. + # Retrieves a list of content owners that match the request criteria. # @param [Boolean] fetch_mine - # The fetchMine parameter restricts the result - # set to content owners associated with the currently authenticated API user. + # The *fetchMine* parameter restricts the result set to content owners + # associated with the currently authenticated API user. # @param [String] id - # The id parameter specifies a comma-separated - # list of YouTube content owner IDs to retrieve. + # The *id* parameter specifies a comma-separated list of YouTube content owner + # IDs to retrieve. # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter - # identifies the content owner that the user is acting on behalf of. This - # parameter supports users whose accounts are associated with multiple - # content owners. + # The *onBehalfOfContentOwner* parameter identifies the content owner that the + # user is acting on behalf of. This parameter supports users whose accounts are + # associated with multiple content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1493,18 +1405,14 @@ module Google # Inserts a cuepoint into a live broadcast. # @param [Google::Apis::YoutubePartnerV1::LiveCuepoint] live_cuepoint_object # @param [String] channel_id - # The channelId parameter identifies the - # channel that owns the broadcast into which the cuepoint is being inserted. + # The *channelId* parameter identifies the channel that owns the broadcast into + # which the cuepoint is being inserted. # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter - # identifies the content owner that the user is acting on behalf of. This - # parameter supports users whose accounts are associated with multiple - # content owners. You can obtain the content owner ID that will serve as the - # parameter value by calling the YouTube Content ID - # API's contentOwners.list - # method. + # The *onBehalfOfContentOwner* parameter identifies the content owner that the + # user is acting on behalf of. This parameter supports users whose accounts are + # associated with multiple content owners. You can obtain the content owner ID + # that will serve as the parameter value by calling the YouTube Content ID API's + # contentOwners.list method. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1538,13 +1446,12 @@ module Google # Retrieves a list of all metadata provided for an asset, regardless of which # content owner provided the data. # @param [String] asset_id - # The assetId parameter specifies the YouTube - # asset ID of the asset for which you are retrieving a metadata history. + # The *assetId* parameter specifies the YouTube asset ID of the asset for which + # you are retrieving a metadata history. # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter - # identifies the content owner that the user is acting on behalf of. This - # parameter supports users whose accounts are associated with multiple - # content owners. + # The *onBehalfOfContentOwner* parameter identifies the content owner that the + # user is acting on behalf of. This parameter supports users whose accounts are + # associated with multiple content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1573,16 +1480,15 @@ module Google execute_or_queue_command(command, &block) end - # Retrieves the ownership data provided for the specified asset by the - # content owner associated with the authenticated user. + # Retrieves the ownership data provided for the specified asset by the content + # owner associated with the authenticated user. # @param [String] asset_id - # The assetId parameter specifies the YouTube - # asset ID for which you are retrieving ownership data. + # The *assetId* parameter specifies the YouTube asset ID for which you are + # retrieving ownership data. # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter - # identifies the content owner that the user is acting on behalf of. This - # parameter supports users whose accounts are associated with multiple - # content owners. + # The *onBehalfOfContentOwner* parameter identifies the content owner that the + # user is acting on behalf of. This parameter supports users whose accounts are + # associated with multiple content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1611,22 +1517,20 @@ module Google execute_or_queue_command(command, &block) end - # Provides new ownership information for the specified asset. Note that - # YouTube may receive ownership information from multiple sources. For - # example, if an asset has multiple owners, each owner might send ownership - # data for the asset. YouTube algorithmically combines the ownership data - # received from all of those sources to generate the - # asset's canonical ownership data, which should provide the most - # comprehensive and accurate representation of the asset's ownership. + # Provides new ownership information for the specified asset. Note that YouTube + # may receive ownership information from multiple sources. For example, if an + # asset has multiple owners, each owner might send ownership data for the asset. + # YouTube algorithmically combines the ownership data received from all of those + # sources to generate the asset's canonical ownership data, which should provide + # the most comprehensive and accurate representation of the asset's ownership. # @param [String] asset_id - # The assetId parameter specifies the YouTube - # asset ID of the asset being updated. + # The *assetId* parameter specifies the YouTube asset ID of the asset being + # updated. # @param [Google::Apis::YoutubePartnerV1::RightsOwnership] rights_ownership_object # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter - # identifies the content owner that the user is acting on behalf of. This - # parameter supports users whose accounts are associated with multiple - # content owners. + # The *onBehalfOfContentOwner* parameter identifies the content owner that the + # user is acting on behalf of. This parameter supports users whose accounts are + # associated with multiple content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1657,22 +1561,20 @@ module Google execute_or_queue_command(command, &block) end - # Provides new ownership information for the specified asset. Note that - # YouTube may receive ownership information from multiple sources. For - # example, if an asset has multiple owners, each owner might send ownership - # data for the asset. YouTube algorithmically combines the ownership data - # received from all of those sources to generate the - # asset's canonical ownership data, which should provide the most - # comprehensive and accurate representation of the asset's ownership. + # Provides new ownership information for the specified asset. Note that YouTube + # may receive ownership information from multiple sources. For example, if an + # asset has multiple owners, each owner might send ownership data for the asset. + # YouTube algorithmically combines the ownership data received from all of those + # sources to generate the asset's canonical ownership data, which should provide + # the most comprehensive and accurate representation of the asset's ownership. # @param [String] asset_id - # The assetId parameter specifies the YouTube - # asset ID of the asset being updated. + # The *assetId* parameter specifies the YouTube asset ID of the asset being + # updated. # @param [Google::Apis::YoutubePartnerV1::RightsOwnership] rights_ownership_object # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter - # identifies the content owner that the user is acting on behalf of. This - # parameter supports users whose accounts are associated with multiple - # content owners. + # The *onBehalfOfContentOwner* parameter identifies the content owner that the + # user is acting on behalf of. This parameter supports users whose accounts are + # associated with multiple content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1707,17 +1609,15 @@ module Google # content owner provided the data. The list only includes the most recent # ownership data for each content owner. However, if the content owner has # submitted ownership data through multiple data sources (API, content feeds, - # etc.), the list will contain the most recent data for each content owner - # and data source. + # etc.), the list will contain the most recent data for each content owner and + # data source. # @param [String] asset_id - # The assetId parameter specifies the YouTube - # asset ID of the asset for which you are retrieving an ownership data - # history. + # The *assetId* parameter specifies the YouTube asset ID of the asset for which + # you are retrieving an ownership data history. # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter - # identifies the content owner that the user is acting on behalf of. This - # parameter supports users whose accounts are associated with multiple - # content owners. + # The *onBehalfOfContentOwner* parameter identifies the content owner that the + # user is acting on behalf of. This parameter supports users whose accounts are + # associated with multiple content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1748,13 +1648,12 @@ module Google # Retrieves information for the specified package. # @param [String] package_id - # The packageId parameter specifies the Content - # Delivery package ID of the package being retrieved. + # The *packageId* parameter specifies the Content Delivery package ID of the + # package being retrieved. # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter - # identifies the content owner that the user is acting on behalf of. This - # parameter supports users whose accounts are associated with multiple - # content owners. + # The *onBehalfOfContentOwner* parameter identifies the content owner that the + # user is acting on behalf of. This parameter supports users whose accounts are + # associated with multiple content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1786,10 +1685,9 @@ module Google # Inserts a metadata-only package. # @param [Google::Apis::YoutubePartnerV1::Package] package_object # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter - # identifies the content owner that the user is acting on behalf of. This - # parameter supports users whose accounts are associated with multiple - # content owners. + # The *onBehalfOfContentOwner* parameter identifies the content owner that the + # user is acting on behalf of. This parameter supports users whose accounts are + # associated with multiple content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1821,13 +1719,12 @@ module Google # Retrieves the specified saved policy. # @param [String] policy_id - # The policyId parameter specifies a value that - # uniquely identifies the policy being retrieved. + # The *policyId* parameter specifies a value that uniquely identifies the policy + # being retrieved. # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter - # identifies the content owner that the user is acting on behalf of. This - # parameter supports users whose accounts are associated with multiple - # content owners. + # The *onBehalfOfContentOwner* parameter identifies the content owner that the + # user is acting on behalf of. This parameter supports users whose accounts are + # associated with multiple content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1859,10 +1756,9 @@ module Google # Creates a saved policy. # @param [Google::Apis::YoutubePartnerV1::Policy] policy_object # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter - # identifies the content owner that the user is acting on behalf of. This - # parameter supports users whose accounts are associated with multiple - # content owners. + # The *onBehalfOfContentOwner* parameter identifies the content owner that the + # user is acting on behalf of. This parameter supports users whose accounts are + # associated with multiple content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1894,17 +1790,15 @@ module Google # Retrieves a list of the content owner's saved policies. # @param [String] id - # The id parameter specifies a comma-separated - # list of saved policy IDs to retrieve. Only policies belonging to the - # currently authenticated content owner will be available. + # The *id* parameter specifies a comma-separated list of saved policy IDs to + # retrieve. Only policies belonging to the currently authenticated content owner + # will be available. # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter - # identifies the content owner that the user is acting on behalf of. This - # parameter supports users whose accounts are associated with multiple - # content owners. + # The *onBehalfOfContentOwner* parameter identifies the content owner that the + # user is acting on behalf of. This parameter supports users whose accounts are + # associated with multiple content owners. # @param [String] sort - # The sort parameter specifies how the search - # results should be sorted. + # The *sort* parameter specifies how the search results should be sorted. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1936,14 +1830,13 @@ module Google # Patches the specified saved policy. # @param [String] policy_id - # The policyId parameter specifies a value that - # uniquely identifies the policy being updated. + # The *policyId* parameter specifies a value that uniquely identifies the policy + # being updated. # @param [Google::Apis::YoutubePartnerV1::Policy] policy_object # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter - # identifies the content owner that the user is acting on behalf of. This - # parameter supports users whose accounts are associated with multiple - # content owners. + # The *onBehalfOfContentOwner* parameter identifies the content owner that the + # user is acting on behalf of. This parameter supports users whose accounts are + # associated with multiple content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1976,14 +1869,13 @@ module Google # Updates the specified saved policy. # @param [String] policy_id - # The policyId parameter specifies a value that - # uniquely identifies the policy being updated. + # The *policyId* parameter specifies a value that uniquely identifies the policy + # being updated. # @param [Google::Apis::YoutubePartnerV1::Policy] policy_object # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter - # identifies the content owner that the user is acting on behalf of. This - # parameter supports users whose accounts are associated with multiple - # content owners. + # The *onBehalfOfContentOwner* parameter identifies the content owner that the + # user is acting on behalf of. This parameter supports users whose accounts are + # associated with multiple content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2016,14 +1908,12 @@ module Google # Retrieves information about the specified reference conflict. # @param [String] reference_conflict_id - # The referenceConflictId parameter specifies - # the YouTube reference conflict ID of the reference conflict being - # retrieved. + # The *referenceConflictId* parameter specifies the YouTube reference conflict + # ID of the reference conflict being retrieved. # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter - # identifies the content owner that the user is acting on behalf of. This - # parameter supports users whose accounts are associated with multiple - # content owners. + # The *onBehalfOfContentOwner* parameter identifies the content owner that the + # user is acting on behalf of. This parameter supports users whose accounts are + # associated with multiple content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2054,15 +1944,14 @@ module Google # Retrieves a list of unresolved reference conflicts. # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter - # identifies the content owner that the user is acting on behalf of. This - # parameter supports users whose accounts are associated with multiple - # content owners. + # The *onBehalfOfContentOwner* parameter identifies the content owner that the + # user is acting on behalf of. This parameter supports users whose accounts are + # associated with multiple content owners. # @param [String] page_token - # The pageToken parameter specifies a token - # that identifies a particular page of results to return. Set this parameter - # to the value of the nextPageToken value from the previous API - # response to retrieve the next page of search results. + # The *pageToken* parameter specifies a token that identifies a particular page + # of results to return. Set this parameter to the value of the nextPageToken + # value from the previous API response to retrieve the next page of search + # results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2093,13 +1982,12 @@ module Google # Retrieves information about the specified reference. # @param [String] reference_id - # The referenceId parameter specifies the - # YouTube reference ID of the reference being retrieved. + # The *referenceId* parameter specifies the YouTube reference ID of the + # reference being retrieved. # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter - # identifies the content owner that the user is acting on behalf of. This - # parameter supports users whose accounts are associated with multiple - # content owners. + # The *onBehalfOfContentOwner* parameter identifies the content owner that the + # user is acting on behalf of. This parameter supports users whose accounts are + # associated with multiple content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2128,30 +2016,24 @@ module Google execute_or_queue_command(command, &block) end - # Creates a reference in one of the following ways:
  • If your request is + # Creates a reference in one of the following ways: - If your request is # uploading a reference file, YouTube creates the reference from the provided # content. You can provide either a video/audio file or a pre-generated # fingerprint. If you are providing a pre-generated fingerprint, set the - # reference - # resource's fpDirect - # property to true in the request body. In this flow, you can - # use either the multipart or resumable upload flows - # to provide the reference content.
  • If you want to create a reference - # using a claimed video as the reference content, use the - # claimId parameter to identify the claim.
+ # reference resource's fpDirect property to true in the request body. In this + # flow, you can use either the multipart or resumable upload flows to provide + # the reference content. - If you want to create a reference using a claimed + # video as the reference content, use the claimId parameter to identify the + # claim. # @param [Google::Apis::YoutubePartnerV1::Reference] reference_object # @param [String] claim_id - # The claimId parameter specifies the YouTube - # claim ID of an existing claim from which a reference should be created. - # (The claimed video is used as the reference content.) + # The *claimId* parameter specifies the YouTube claim ID of an existing claim + # from which a reference should be created. (The claimed video is used as the + # reference content.) # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter - # identifies the content owner that the user is acting on behalf of. This - # parameter supports users whose accounts are associated with multiple - # content owners. + # The *onBehalfOfContentOwner* parameter identifies the content owner that the + # user is acting on behalf of. This parameter supports users whose accounts are + # associated with multiple content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2195,21 +2077,20 @@ module Google # Retrieves a list of references by ID or the list of references for the # specified asset. # @param [String] asset_id - # The assetId parameter specifies the YouTube - # asset ID of the asset for which you are retrieving references. + # The *assetId* parameter specifies the YouTube asset ID of the asset for which + # you are retrieving references. # @param [String] id - # The id parameter specifies a comma-separated - # list of YouTube reference IDs to retrieve. + # The *id* parameter specifies a comma-separated list of YouTube reference IDs + # to retrieve. # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter - # identifies the content owner that the user is acting on behalf of. This - # parameter supports users whose accounts are associated with multiple - # content owners. + # The *onBehalfOfContentOwner* parameter identifies the content owner that the + # user is acting on behalf of. This parameter supports users whose accounts are + # associated with multiple content owners. # @param [String] page_token - # The pageToken parameter specifies a token - # that identifies a particular page of results to return. Set this parameter - # to the value of the nextPageToken value from the previous API - # response to retrieve the next page of search results. + # The *pageToken* parameter specifies a token that identifies a particular page + # of results to return. Set this parameter to the value of the nextPageToken + # value from the previous API response to retrieve the next page of search + # results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2242,21 +2123,18 @@ module Google # Patches a reference. # @param [String] reference_id - # The referenceId parameter specifies the - # YouTube reference ID of the reference being updated. + # The *referenceId* parameter specifies the YouTube reference ID of the + # reference being updated. # @param [Google::Apis::YoutubePartnerV1::Reference] reference_object # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter - # identifies the content owner that the user is acting on behalf of. This - # parameter supports users whose accounts are associated with multiple - # content owners. + # The *onBehalfOfContentOwner* parameter identifies the content owner that the + # user is acting on behalf of. This parameter supports users whose accounts are + # associated with multiple content owners. # @param [Boolean] release_claims - # The releaseClaims parameter indicates that - # you want to release all match claims associated with this reference. This - # parameter only works when the - # claim's status is being updated to 'inactive' - you can then set the - # parameter's value to true to release all match claims produced - # by this reference. + # The *releaseClaims* parameter indicates that you want to release all match + # claims associated with this reference. This parameter only works when the + # claim's status is being updated to 'inactive' - you can then set the parameter' + # s value to true to release all match claims produced by this reference. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2290,21 +2168,18 @@ module Google # Updates a reference. # @param [String] reference_id - # The referenceId parameter specifies the - # YouTube reference ID of the reference being updated. + # The *referenceId* parameter specifies the YouTube reference ID of the + # reference being updated. # @param [Google::Apis::YoutubePartnerV1::Reference] reference_object # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter - # identifies the content owner that the user is acting on behalf of. This - # parameter supports users whose accounts are associated with multiple - # content owners. + # The *onBehalfOfContentOwner* parameter identifies the content owner that the + # user is acting on behalf of. This parameter supports users whose accounts are + # associated with multiple content owners. # @param [Boolean] release_claims - # The releaseClaims parameter indicates that - # you want to release all match claims associated with this reference. This - # parameter only works when the - # claim's status is being updated to 'inactive' - you can then set the - # parameter's value to true to release all match claims produced - # by this reference. + # The *releaseClaims* parameter indicates that you want to release all match + # claims associated with this reference. This parameter only works when the + # claim's status is being updated to 'inactive' - you can then set the parameter' + # s value to true to release all match claims produced by this reference. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2338,14 +2213,13 @@ module Google # Retrieves a list of spreadsheet templates for a content owner. # @param [String] locale - # The locale parameter identifies the desired - # language for templates in the API response. The value is a string that - # contains a BCP-47 language code. The default value is en. + # The *locale* parameter identifies the desired language for templates in the + # API response. The value is a string that contains a BCP-47 language code. The + # default value is en. # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter - # identifies the content owner that the user is acting on behalf of. This - # parameter supports users whose accounts are associated with multiple - # content owners. + # The *onBehalfOfContentOwner* parameter identifies the content owner that the + # user is acting on behalf of. This parameter supports users whose accounts are + # associated with multiple content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2376,10 +2250,9 @@ module Google # Retrieves a list of uploaders for a content owner. # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter - # identifies the content owner that the user is acting on behalf of. This - # parameter supports users whose accounts are associated with multiple - # content owners. + # The *onBehalfOfContentOwner* parameter identifies the content owner that the + # user is acting on behalf of. This parameter supports users whose accounts are + # associated with multiple content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2410,10 +2283,9 @@ module Google # Validate a metadata file. # @param [Google::Apis::YoutubePartnerV1::ValidateRequest] validate_request_object # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter - # identifies the content owner that the user is acting on behalf of. This - # parameter supports users whose accounts are associated with multiple - # content owners. + # The *onBehalfOfContentOwner* parameter identifies the content owner that the + # user is acting on behalf of. This parameter supports users whose accounts are + # associated with multiple content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2446,10 +2318,9 @@ module Google # Validate a metadata file asynchronously. # @param [Google::Apis::YoutubePartnerV1::ValidateAsyncRequest] validate_async_request_object # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter - # identifies the content owner that the user is acting on behalf of. This - # parameter supports users whose accounts are associated with multiple - # content owners. + # The *onBehalfOfContentOwner* parameter identifies the content owner that the + # user is acting on behalf of. This parameter supports users whose accounts are + # associated with multiple content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2482,10 +2353,9 @@ module Google # Get the asynchronous validation status. # @param [Google::Apis::YoutubePartnerV1::ValidateStatusRequest] validate_status_request_object # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter - # identifies the content owner that the user is acting on behalf of. This - # parameter supports users whose accounts are associated with multiple - # content owners. + # The *onBehalfOfContentOwner* parameter identifies the content owner that the + # user is acting on behalf of. This parameter supports users whose accounts are + # associated with multiple content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2517,13 +2387,12 @@ module Google # Retrieves advertising settings for the specified video. # @param [String] video_id - # The videoId parameter specifies the YouTube - # video ID of the video for which you are retrieving advertising settings. + # The *videoId* parameter specifies the YouTube video ID of the video for which + # you are retrieving advertising settings. # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter - # identifies the content owner that the user is acting on behalf of. This - # parameter supports users whose accounts are associated with multiple - # content owners. + # The *onBehalfOfContentOwner* parameter identifies the content owner that the + # user is acting on behalf of. This parameter supports users whose accounts are + # associated with multiple content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2552,16 +2421,15 @@ module Google execute_or_queue_command(command, &block) end - # Retrieves details about the types of allowed ads for a specified partner- - # or user-uploaded video. + # Retrieves details about the types of allowed ads for a specified partner- or + # user-uploaded video. # @param [String] video_id - # The videoId parameter specifies the YouTube - # video ID of the video for which you are retrieving advertising options. + # The *videoId* parameter specifies the YouTube video ID of the video for which + # you are retrieving advertising options. # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter - # identifies the content owner that the user is acting on behalf of. This - # parameter supports users whose accounts are associated with multiple - # content owners. + # The *onBehalfOfContentOwner* parameter identifies the content owner that the + # user is acting on behalf of. This parameter supports users whose accounts are + # associated with multiple content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2592,14 +2460,13 @@ module Google # Patches the advertising settings for the specified video. # @param [String] video_id - # The videoId parameter specifies the YouTube - # video ID of the video for which you are updating advertising settings. + # The *videoId* parameter specifies the YouTube video ID of the video for which + # you are updating advertising settings. # @param [Google::Apis::YoutubePartnerV1::VideoAdvertisingOption] video_advertising_option_object # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter - # identifies the content owner that the user is acting on behalf of. This - # parameter supports users whose accounts are associated with multiple - # content owners. + # The *onBehalfOfContentOwner* parameter identifies the content owner that the + # user is acting on behalf of. This parameter supports users whose accounts are + # associated with multiple content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2632,14 +2499,13 @@ module Google # Updates the advertising settings for the specified video. # @param [String] video_id - # The videoId parameter specifies the YouTube - # video ID of the video for which you are updating advertising settings. + # The *videoId* parameter specifies the YouTube video ID of the video for which + # you are updating advertising settings. # @param [Google::Apis::YoutubePartnerV1::VideoAdvertisingOption] video_advertising_option_object # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter - # identifies the content owner that the user is acting on behalf of. This - # parameter supports users whose accounts are associated with multiple - # content owners. + # The *onBehalfOfContentOwner* parameter identifies the content owner that the + # user is acting on behalf of. This parameter supports users whose accounts are + # associated with multiple content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2672,13 +2538,12 @@ module Google # Removes a whitelisted channel for a content owner. # @param [String] id - # The id parameter specifies the YouTube - # channel ID of the channel being removed from whitelist. + # The *id* parameter specifies the YouTube channel ID of the channel being + # removed from whitelist. # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter - # identifies the content owner that the user is acting on behalf of. This - # parameter supports users whose accounts are associated with multiple - # content owners. + # The *onBehalfOfContentOwner* parameter identifies the content owner that the + # user is acting on behalf of. This parameter supports users whose accounts are + # associated with multiple content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2709,13 +2574,12 @@ module Google # Retrieves a specific whitelisted channel by ID. # @param [String] id - # The id parameter specifies the YouTube - # channel ID of the whitelisted channel being retrieved. + # The *id* parameter specifies the YouTube channel ID of the whitelisted channel + # being retrieved. # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter - # identifies the content owner that the user is acting on behalf of. This - # parameter supports users whose accounts are associated with multiple - # content owners. + # The *onBehalfOfContentOwner* parameter identifies the content owner that the + # user is acting on behalf of. This parameter supports users whose accounts are + # associated with multiple content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2744,16 +2608,15 @@ module Google execute_or_queue_command(command, &block) end - # Whitelist a YouTube channel for your content owner. Whitelisted channels - # are channels that are not owned or managed by you, but you would like to - # whitelist so that no claims from your assets are placed on videos uploaded - # to these channels. + # Whitelist a YouTube channel for your content owner. Whitelisted channels are + # channels that are not owned or managed by you, but you would like to whitelist + # so that no claims from your assets are placed on videos uploaded to these + # channels. # @param [Google::Apis::YoutubePartnerV1::Whitelist] whitelist_object # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter - # identifies the content owner that the user is acting on behalf of. This - # parameter supports users whose accounts are associated with multiple - # content owners. + # The *onBehalfOfContentOwner* parameter identifies the content owner that the + # user is acting on behalf of. This parameter supports users whose accounts are + # associated with multiple content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2785,19 +2648,16 @@ module Google # Retrieves a list of whitelisted channels for a content owner. # @param [String] id - # The id parameter specifies a comma-separated - # list of YouTube channel IDs that identify the whitelisted channels you want - # to retrieve. + # The *id* parameter specifies a comma-separated list of YouTube channel IDs + # that identify the whitelisted channels you want to retrieve. # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter - # identifies the content owner that the user is acting on behalf of. This - # parameter supports users whose accounts are associated with multiple - # content owners. + # The *onBehalfOfContentOwner* parameter identifies the content owner that the + # user is acting on behalf of. This parameter supports users whose accounts are + # associated with multiple content owners. # @param [String] page_token - # The pageToken parameter specifies a token - # that identifies a particular page of results to return. Set this parameter - # to the value of the nextPageToken value from the previous API - # response to retrieve the next page of results. + # The *pageToken* parameter specifies a token that identifies a particular page + # of results to return. Set this parameter to the value of the nextPageToken + # value from the previous API response to retrieve the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user diff --git a/generated/google/apis/youtube_v3.rb b/generated/google/apis/youtube_v3.rb index 563682d57..bd6aef63b 100644 --- a/generated/google/apis/youtube_v3.rb +++ b/generated/google/apis/youtube_v3.rb @@ -26,7 +26,7 @@ module Google # @see https://developers.google.com/youtube/ module YoutubeV3 VERSION = 'V3' - REVISION = '20200715' + REVISION = '20200719' # Manage your YouTube account AUTH_YOUTUBE = 'https://www.googleapis.com/auth/youtube' diff --git a/generated/google/apis/youtube_v3/service.rb b/generated/google/apis/youtube_v3/service.rb index d41ccf560..b8082115f 100644 --- a/generated/google/apis/youtube_v3/service.rb +++ b/generated/google/apis/youtube_v3/service.rb @@ -3450,6 +3450,38 @@ module Google execute_or_queue_command(command, &block) end + # POST method. + # @param [Array, String] part + # @param [Google::Apis::YoutubeV3::TestItem] test_item_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::YoutubeV3::TestItem] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::YoutubeV3::TestItem] + # + # @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_test(part, test_item_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'youtube/v3/tests', options) + command.request_representation = Google::Apis::YoutubeV3::TestItem::Representation + command.request_object = test_item_object + command.response_representation = Google::Apis::YoutubeV3::TestItem::Representation + command.response_class = Google::Apis::YoutubeV3::TestItem + command.query['part'] = part unless part.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # Deletes a resource. # @param [String] linking_token # Delete the partner links with the given linking token. @@ -4318,38 +4350,6 @@ module Google command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end - - # POST method. - # @param [Google::Apis::YoutubeV3::TestItem] test_item_object - # @param [Array, String] part - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # 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. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::YoutubeV3::TestItem] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::YoutubeV3::TestItem] - # - # @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 create_youtube_v3_test(test_item_object = nil, part: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'youtube/v3/tests', options) - command.request_representation = Google::Apis::YoutubeV3::TestItem::Representation - command.request_object = test_item_object - command.response_representation = Google::Apis::YoutubeV3::TestItem::Representation - command.response_class = Google::Apis::YoutubeV3::TestItem - command.query['part'] = part unless part.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end protected