google-api-client 0.42.2 → 0.43.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +129 -0
- data/generated/google/apis/abusiveexperiencereport_v1.rb +1 -1
- data/generated/google/apis/abusiveexperiencereport_v1/classes.rb +8 -13
- data/generated/google/apis/abusiveexperiencereport_v1/service.rb +2 -3
- data/generated/google/apis/accessapproval_v1.rb +1 -1
- data/generated/google/apis/accessapproval_v1/classes.rb +9 -0
- data/generated/google/apis/accessapproval_v1/representations.rb +1 -0
- data/generated/google/apis/adexchangebuyer2_v2beta1.rb +1 -1
- data/generated/google/apis/adexchangebuyer2_v2beta1/classes.rb +523 -653
- data/generated/google/apis/adexchangebuyer2_v2beta1/service.rb +467 -631
- data/generated/google/apis/adexperiencereport_v1.rb +1 -1
- data/generated/google/apis/adexperiencereport_v1/classes.rb +11 -18
- data/generated/google/apis/adexperiencereport_v1/service.rb +2 -3
- data/generated/google/apis/admob_v1.rb +1 -1
- data/generated/google/apis/admob_v1/classes.rb +139 -270
- data/generated/google/apis/admob_v1/service.rb +11 -13
- data/generated/google/apis/alertcenter_v1beta1.rb +1 -1
- data/generated/google/apis/alertcenter_v1beta1/classes.rb +107 -138
- data/generated/google/apis/alertcenter_v1beta1/service.rb +50 -55
- data/generated/google/apis/analyticsreporting_v4.rb +1 -1
- data/generated/google/apis/analyticsreporting_v4/classes.rb +315 -399
- data/generated/google/apis/androiddeviceprovisioning_v1.rb +1 -1
- data/generated/google/apis/androiddeviceprovisioning_v1/classes.rb +193 -220
- data/generated/google/apis/androiddeviceprovisioning_v1/service.rb +55 -61
- data/generated/google/apis/androidenterprise_v1.rb +1 -1
- data/generated/google/apis/androidenterprise_v1/classes.rb +452 -557
- data/generated/google/apis/androidenterprise_v1/service.rb +181 -240
- data/generated/google/apis/androidmanagement_v1.rb +1 -1
- data/generated/google/apis/androidpublisher_v3.rb +1 -1
- data/generated/google/apis/androidpublisher_v3/classes.rb +281 -342
- data/generated/google/apis/androidpublisher_v3/service.rb +125 -153
- data/generated/google/apis/apigee_v1.rb +6 -7
- data/generated/google/apis/apigee_v1/classes.rb +733 -1180
- data/generated/google/apis/apigee_v1/service.rb +879 -1133
- data/generated/google/apis/appsmarket_v2.rb +1 -1
- data/generated/google/apis/bigtableadmin_v2.rb +1 -1
- data/generated/google/apis/bigtableadmin_v2/service.rb +1 -1
- data/generated/google/apis/billingbudgets_v1beta1.rb +1 -1
- data/generated/google/apis/billingbudgets_v1beta1/classes.rb +97 -118
- data/generated/google/apis/billingbudgets_v1beta1/service.rb +30 -33
- data/generated/google/apis/blogger_v2.rb +2 -3
- data/generated/google/apis/blogger_v2/classes.rb +1 -2
- data/generated/google/apis/blogger_v2/service.rb +1 -2
- data/generated/google/apis/blogger_v3.rb +2 -3
- data/generated/google/apis/blogger_v3/classes.rb +1 -2
- data/generated/google/apis/blogger_v3/service.rb +1 -2
- data/generated/google/apis/chromeuxreport_v1.rb +1 -1
- data/generated/google/apis/chromeuxreport_v1/classes.rb +55 -66
- data/generated/google/apis/classroom_v1.rb +1 -1
- data/generated/google/apis/classroom_v1/classes.rb +250 -365
- data/generated/google/apis/classroom_v1/service.rb +643 -902
- data/generated/google/apis/cloudasset_v1.rb +1 -1
- data/generated/google/apis/cloudasset_v1/classes.rb +15 -11
- data/generated/google/apis/cloudasset_v1/service.rb +62 -45
- data/generated/google/apis/cloudasset_v1beta1.rb +1 -1
- data/generated/google/apis/cloudasset_v1beta1/classes.rb +3 -1
- data/generated/google/apis/cloudasset_v1p4beta1.rb +1 -1
- data/generated/google/apis/cloudasset_v1p5beta1.rb +1 -1
- data/generated/google/apis/cloudasset_v1p5beta1/classes.rb +3 -1
- data/generated/google/apis/clouderrorreporting_v1beta1.rb +1 -1
- data/generated/google/apis/clouderrorreporting_v1beta1/classes.rb +7 -0
- data/generated/google/apis/clouderrorreporting_v1beta1/representations.rb +1 -0
- data/generated/google/apis/cloudsearch_v1.rb +1 -1
- data/generated/google/apis/cloudsearch_v1/classes.rb +1 -2
- data/generated/google/apis/compute_alpha.rb +1 -1
- data/generated/google/apis/compute_alpha/classes.rb +350 -20
- data/generated/google/apis/compute_alpha/representations.rb +100 -0
- data/generated/google/apis/compute_alpha/service.rb +15 -7
- data/generated/google/apis/compute_beta.rb +1 -1
- data/generated/google/apis/compute_beta/classes.rb +39 -14
- data/generated/google/apis/compute_beta/representations.rb +2 -0
- data/generated/google/apis/compute_beta/service.rb +15 -7
- data/generated/google/apis/compute_v1.rb +1 -1
- data/generated/google/apis/compute_v1/classes.rb +65 -42
- data/generated/google/apis/compute_v1/representations.rb +18 -15
- data/generated/google/apis/compute_v1/service.rb +63 -19
- data/generated/google/apis/container_v1.rb +1 -1
- data/generated/google/apis/container_v1/classes.rb +26 -0
- data/generated/google/apis/container_v1/representations.rb +15 -0
- data/generated/google/apis/content_v2.rb +1 -1
- data/generated/google/apis/content_v2/classes.rb +9 -0
- data/generated/google/apis/content_v2_1.rb +1 -1
- data/generated/google/apis/content_v2_1/classes.rb +9 -0
- data/generated/google/apis/customsearch_v1.rb +1 -1
- data/generated/google/apis/customsearch_v1/classes.rb +303 -492
- data/generated/google/apis/customsearch_v1/service.rb +184 -341
- data/generated/google/apis/datacatalog_v1beta1.rb +1 -1
- data/generated/google/apis/datacatalog_v1beta1/classes.rb +572 -380
- data/generated/google/apis/datacatalog_v1beta1/service.rb +440 -319
- data/generated/google/apis/datafusion_v1.rb +43 -0
- data/generated/google/apis/datafusion_v1/classes.rb +1154 -0
- data/generated/google/apis/datafusion_v1/representations.rb +390 -0
- data/generated/google/apis/datafusion_v1/service.rb +680 -0
- data/generated/google/apis/dataproc_v1.rb +1 -1
- data/generated/google/apis/dataproc_v1/classes.rb +192 -316
- data/generated/google/apis/dataproc_v1/service.rb +134 -168
- data/generated/google/apis/dataproc_v1beta2.rb +1 -1
- data/generated/google/apis/dataproc_v1beta2/classes.rb +198 -317
- data/generated/google/apis/dataproc_v1beta2/service.rb +137 -192
- data/generated/google/apis/deploymentmanager_alpha.rb +1 -1
- data/generated/google/apis/deploymentmanager_v2beta.rb +1 -1
- data/generated/google/apis/dialogflow_v2.rb +1 -1
- data/generated/google/apis/dialogflow_v2/classes.rb +1238 -1589
- data/generated/google/apis/dialogflow_v2/service.rb +324 -448
- data/generated/google/apis/dialogflow_v2beta1.rb +1 -1
- data/generated/google/apis/dialogflow_v2beta1/classes.rb +1313 -1681
- data/generated/google/apis/dialogflow_v2beta1/service.rb +742 -998
- data/generated/google/apis/displayvideo_v1.rb +1 -1
- data/generated/google/apis/displayvideo_v1/classes.rb +104 -0
- data/generated/google/apis/displayvideo_v1/representations.rb +36 -0
- data/generated/google/apis/displayvideo_v1/service.rb +104 -0
- data/generated/google/apis/dlp_v2.rb +1 -1
- data/generated/google/apis/dlp_v2/classes.rb +5 -4
- data/generated/google/apis/dns_v1.rb +1 -1
- data/generated/google/apis/dns_v1/classes.rb +7 -7
- data/generated/google/apis/dns_v1beta2.rb +1 -1
- data/generated/google/apis/dns_v1beta2/classes.rb +7 -7
- data/generated/google/apis/dns_v2beta1.rb +1 -1
- data/generated/google/apis/dns_v2beta1/classes.rb +7 -7
- data/generated/google/apis/domainsrdap_v1.rb +1 -1
- data/generated/google/apis/domainsrdap_v1/classes.rb +42 -69
- data/generated/google/apis/domainsrdap_v1/service.rb +16 -16
- data/generated/google/apis/doubleclickbidmanager_v1.rb +1 -1
- data/generated/google/apis/doubleclickbidmanager_v1/classes.rb +1 -1
- data/generated/google/apis/doubleclickbidmanager_v1/service.rb +4 -2
- data/generated/google/apis/doubleclickbidmanager_v1_1.rb +1 -1
- data/generated/google/apis/doubleclickbidmanager_v1_1/classes.rb +196 -1
- data/generated/google/apis/doubleclickbidmanager_v1_1/representations.rb +107 -0
- data/generated/google/apis/doubleclickbidmanager_v1_1/service.rb +4 -2
- data/generated/google/apis/drive_v2.rb +1 -1
- data/generated/google/apis/drive_v2/classes.rb +3 -1
- data/generated/google/apis/drive_v3.rb +1 -1
- data/generated/google/apis/drive_v3/classes.rb +9 -1
- data/generated/google/apis/drive_v3/representations.rb +1 -0
- data/generated/google/apis/driveactivity_v2.rb +1 -1
- data/generated/google/apis/driveactivity_v2/classes.rb +55 -68
- data/generated/google/apis/factchecktools_v1alpha1.rb +1 -1
- data/generated/google/apis/factchecktools_v1alpha1/classes.rb +46 -56
- data/generated/google/apis/factchecktools_v1alpha1/service.rb +30 -33
- data/generated/google/apis/firebase_v1beta1.rb +1 -1
- data/generated/google/apis/firebase_v1beta1/classes.rb +313 -345
- data/generated/google/apis/firebase_v1beta1/representations.rb +1 -0
- data/generated/google/apis/firebase_v1beta1/service.rb +356 -420
- data/generated/google/apis/firebasedynamiclinks_v1.rb +1 -1
- data/generated/google/apis/firebasedynamiclinks_v1/classes.rb +89 -112
- data/generated/google/apis/firebasedynamiclinks_v1/service.rb +18 -21
- data/generated/google/apis/firebasehosting_v1.rb +1 -1
- data/generated/google/apis/firebasehosting_v1/classes.rb +36 -40
- data/generated/google/apis/firebasehosting_v1/service.rb +19 -22
- data/generated/google/apis/firebasehosting_v1beta1.rb +1 -1
- data/generated/google/apis/firebasehosting_v1beta1/classes.rb +148 -177
- data/generated/google/apis/firebasehosting_v1beta1/service.rb +112 -145
- data/generated/google/apis/firebaseml_v1.rb +1 -1
- data/generated/google/apis/firebaseml_v1/classes.rb +39 -44
- data/generated/google/apis/firebaseml_v1/service.rb +19 -22
- data/generated/google/apis/firebaseml_v1beta2.rb +1 -1
- data/generated/google/apis/firebaseml_v1beta2/classes.rb +60 -70
- data/generated/google/apis/firebaseml_v1beta2/service.rb +16 -18
- data/generated/google/apis/gameservices_v1.rb +1 -1
- data/generated/google/apis/gameservices_v1/classes.rb +344 -523
- data/generated/google/apis/gameservices_v1/service.rb +167 -207
- data/generated/google/apis/gameservices_v1beta.rb +1 -1
- data/generated/google/apis/gameservices_v1beta/classes.rb +344 -523
- data/generated/google/apis/gameservices_v1beta/service.rb +167 -207
- data/generated/google/apis/genomics_v1.rb +1 -1
- data/generated/google/apis/genomics_v1alpha2.rb +1 -1
- data/generated/google/apis/genomics_v2alpha1.rb +1 -1
- data/generated/google/apis/genomics_v2alpha1/classes.rb +3 -75
- data/generated/google/apis/genomics_v2alpha1/representations.rb +0 -27
- data/generated/google/apis/genomics_v2alpha1/service.rb +0 -34
- data/generated/google/apis/gmail_v1.rb +3 -3
- data/generated/google/apis/gmail_v1/classes.rb +216 -269
- data/generated/google/apis/gmail_v1/service.rb +257 -286
- data/generated/google/apis/gmailpostmastertools_v1beta1.rb +1 -1
- data/generated/google/apis/gmailpostmastertools_v1beta1/classes.rb +37 -42
- data/generated/google/apis/gmailpostmastertools_v1beta1/service.rb +34 -40
- data/generated/google/apis/healthcare_v1.rb +1 -1
- data/generated/google/apis/healthcare_v1/service.rb +26 -14
- data/generated/google/apis/healthcare_v1beta1.rb +1 -1
- data/generated/google/apis/healthcare_v1beta1/classes.rb +85 -17
- data/generated/google/apis/healthcare_v1beta1/representations.rb +39 -0
- data/generated/google/apis/healthcare_v1beta1/service.rb +87 -16
- data/generated/google/apis/language_v1.rb +1 -1
- data/generated/google/apis/language_v1/classes.rb +93 -111
- data/generated/google/apis/language_v1/service.rb +4 -4
- data/generated/google/apis/language_v1beta1.rb +1 -1
- data/generated/google/apis/language_v1beta1/classes.rb +78 -90
- data/generated/google/apis/language_v1beta1/service.rb +2 -2
- data/generated/google/apis/language_v1beta2.rb +1 -1
- data/generated/google/apis/language_v1beta2/classes.rb +95 -112
- data/generated/google/apis/language_v1beta2/service.rb +4 -4
- data/generated/google/apis/libraryagent_v1.rb +1 -1
- data/generated/google/apis/libraryagent_v1/classes.rb +10 -16
- data/generated/google/apis/libraryagent_v1/service.rb +13 -16
- data/generated/google/apis/logging_v2.rb +1 -1
- data/generated/google/apis/logging_v2/classes.rb +6 -6
- data/generated/google/apis/managedidentities_v1.rb +1 -1
- data/generated/google/apis/managedidentities_v1/classes.rb +326 -452
- data/generated/google/apis/managedidentities_v1/service.rb +78 -99
- data/generated/google/apis/managedidentities_v1alpha1.rb +1 -1
- data/generated/google/apis/managedidentities_v1alpha1/classes.rb +336 -457
- data/generated/google/apis/managedidentities_v1alpha1/service.rb +88 -112
- data/generated/google/apis/managedidentities_v1beta1.rb +1 -1
- data/generated/google/apis/managedidentities_v1beta1/classes.rb +332 -456
- data/generated/google/apis/managedidentities_v1beta1/service.rb +76 -96
- data/generated/google/apis/memcache_v1.rb +35 -0
- data/generated/google/apis/memcache_v1/classes.rb +1157 -0
- data/generated/google/apis/memcache_v1/representations.rb +471 -0
- data/generated/google/apis/memcache_v1/service.rb +558 -0
- data/generated/google/apis/memcache_v1beta2.rb +1 -1
- data/generated/google/apis/memcache_v1beta2/classes.rb +41 -502
- data/generated/google/apis/memcache_v1beta2/representations.rb +9 -110
- data/generated/google/apis/memcache_v1beta2/service.rb +0 -119
- data/generated/google/apis/monitoring_v1.rb +1 -1
- data/generated/google/apis/monitoring_v1/classes.rb +12 -11
- data/generated/google/apis/monitoring_v3.rb +1 -1
- data/generated/google/apis/monitoring_v3/classes.rb +31 -14
- data/generated/google/apis/monitoring_v3/representations.rb +2 -0
- data/generated/google/apis/osconfig_v1.rb +1 -1
- data/generated/google/apis/osconfig_v1/classes.rb +721 -0
- data/generated/google/apis/osconfig_v1/representations.rb +337 -0
- data/generated/google/apis/people_v1.rb +1 -1
- data/generated/google/apis/people_v1/classes.rb +148 -13
- data/generated/google/apis/people_v1/representations.rb +57 -0
- data/generated/google/apis/people_v1/service.rb +60 -48
- data/generated/google/apis/playcustomapp_v1.rb +1 -1
- data/generated/google/apis/playcustomapp_v1/classes.rb +2 -2
- data/generated/google/apis/policytroubleshooter_v1.rb +1 -1
- data/generated/google/apis/policytroubleshooter_v1/classes.rb +232 -394
- data/generated/google/apis/policytroubleshooter_v1/service.rb +2 -2
- data/generated/google/apis/policytroubleshooter_v1beta.rb +1 -1
- data/generated/google/apis/policytroubleshooter_v1beta/classes.rb +232 -393
- data/generated/google/apis/policytroubleshooter_v1beta/service.rb +2 -2
- data/generated/google/apis/prod_tt_sasportal_v1alpha1.rb +1 -1
- data/generated/google/apis/prod_tt_sasportal_v1alpha1/classes.rb +122 -146
- data/generated/google/apis/prod_tt_sasportal_v1alpha1/service.rb +38 -49
- data/generated/google/apis/realtimebidding_v1.rb +1 -4
- data/generated/google/apis/realtimebidding_v1/classes.rb +198 -291
- data/generated/google/apis/realtimebidding_v1/service.rb +98 -135
- data/generated/google/apis/recommendationengine_v1beta1.rb +2 -2
- data/generated/google/apis/recommendationengine_v1beta1/classes.rb +10 -8
- data/generated/google/apis/recommendationengine_v1beta1/service.rb +1 -1
- data/generated/google/apis/recommender_v1.rb +1 -1
- data/generated/google/apis/recommender_v1/classes.rb +76 -100
- data/generated/google/apis/recommender_v1/service.rb +43 -58
- data/generated/google/apis/recommender_v1beta1.rb +1 -1
- data/generated/google/apis/recommender_v1beta1/classes.rb +75 -99
- data/generated/google/apis/recommender_v1beta1/service.rb +43 -58
- data/generated/google/apis/run_v1.rb +1 -1
- data/generated/google/apis/run_v1/classes.rb +2 -2
- data/generated/google/apis/run_v1/service.rb +38 -2
- data/generated/google/apis/runtimeconfig_v1.rb +1 -1
- data/generated/google/apis/runtimeconfig_v1/classes.rb +36 -40
- data/generated/google/apis/runtimeconfig_v1/service.rb +19 -22
- data/generated/google/apis/sasportal_v1alpha1.rb +1 -1
- data/generated/google/apis/sasportal_v1alpha1/classes.rb +122 -146
- data/generated/google/apis/sasportal_v1alpha1/service.rb +38 -49
- data/generated/google/apis/searchconsole_v1.rb +1 -1
- data/generated/google/apis/searchconsole_v1/classes.rb +2 -2
- data/generated/google/apis/securitycenter_v1.rb +1 -1
- data/generated/google/apis/securitycenter_v1/classes.rb +574 -826
- data/generated/google/apis/securitycenter_v1/service.rb +250 -332
- data/generated/google/apis/securitycenter_v1beta1.rb +1 -1
- data/generated/google/apis/securitycenter_v1beta1/classes.rb +521 -746
- data/generated/google/apis/securitycenter_v1beta1/service.rb +160 -202
- data/generated/google/apis/securitycenter_v1p1alpha1.rb +1 -1
- data/generated/google/apis/securitycenter_v1p1alpha1/classes.rb +176 -208
- data/generated/google/apis/securitycenter_v1p1alpha1/service.rb +21 -25
- data/generated/google/apis/securitycenter_v1p1beta1.rb +1 -1
- data/generated/google/apis/securitycenter_v1p1beta1/classes.rb +545 -791
- data/generated/google/apis/securitycenter_v1p1beta1/service.rb +247 -330
- data/generated/google/apis/serviceconsumermanagement_v1.rb +1 -1
- data/generated/google/apis/serviceconsumermanagement_v1/classes.rb +1149 -1783
- data/generated/google/apis/serviceconsumermanagement_v1/service.rb +111 -138
- data/generated/google/apis/serviceconsumermanagement_v1beta1.rb +1 -1
- data/generated/google/apis/serviceconsumermanagement_v1beta1/classes.rb +1137 -1774
- data/generated/google/apis/serviceconsumermanagement_v1beta1/service.rb +52 -66
- data/generated/google/apis/servicecontrol_v2.rb +38 -0
- data/generated/google/apis/servicecontrol_v2/classes.rb +1121 -0
- data/generated/google/apis/servicecontrol_v2/representations.rb +405 -0
- data/generated/google/apis/servicecontrol_v2/service.rb +165 -0
- data/generated/google/apis/servicemanagement_v1.rb +1 -1
- data/generated/google/apis/servicemanagement_v1/classes.rb +49 -1
- data/generated/google/apis/servicemanagement_v1/representations.rb +14 -0
- data/generated/google/apis/servicenetworking_v1.rb +1 -1
- data/generated/google/apis/servicenetworking_v1/classes.rb +1119 -1758
- data/generated/google/apis/servicenetworking_v1/service.rb +94 -114
- data/generated/google/apis/servicenetworking_v1beta.rb +1 -1
- data/generated/google/apis/servicenetworking_v1beta/classes.rb +1065 -1684
- data/generated/google/apis/servicenetworking_v1beta/service.rb +52 -63
- data/generated/google/apis/serviceusage_v1.rb +1 -1
- data/generated/google/apis/serviceusage_v1/classes.rb +1140 -1823
- data/generated/google/apis/serviceusage_v1/service.rb +63 -80
- data/generated/google/apis/serviceusage_v1beta1.rb +1 -1
- data/generated/google/apis/serviceusage_v1beta1/classes.rb +1235 -1986
- data/generated/google/apis/serviceusage_v1beta1/service.rb +130 -162
- data/generated/google/apis/spanner_v1.rb +1 -1
- data/generated/google/apis/spanner_v1/classes.rb +3 -2
- data/generated/google/apis/storagetransfer_v1.rb +1 -1
- data/generated/google/apis/storagetransfer_v1/classes.rb +8 -10
- data/generated/google/apis/storagetransfer_v1/service.rb +26 -2
- data/generated/google/apis/tagmanager_v1.rb +2 -3
- data/generated/google/apis/tagmanager_v1/classes.rb +225 -288
- data/generated/google/apis/tagmanager_v1/service.rb +20 -21
- data/generated/google/apis/tagmanager_v2.rb +2 -3
- data/generated/google/apis/tagmanager_v2/classes.rb +240 -280
- data/generated/google/apis/tagmanager_v2/representations.rb +1 -0
- data/generated/google/apis/tagmanager_v2/service.rb +187 -283
- data/generated/google/apis/toolresults_v1beta3.rb +1 -1
- data/generated/google/apis/toolresults_v1beta3/classes.rb +665 -931
- data/generated/google/apis/toolresults_v1beta3/service.rb +231 -349
- data/generated/google/apis/tpu_v1.rb +1 -1
- data/generated/google/apis/tpu_v1/classes.rb +68 -78
- data/generated/google/apis/tpu_v1/service.rb +21 -25
- data/generated/google/apis/tpu_v1alpha1.rb +1 -1
- data/generated/google/apis/tpu_v1alpha1/classes.rb +68 -78
- data/generated/google/apis/tpu_v1alpha1/service.rb +21 -25
- data/generated/google/apis/translate_v3.rb +1 -1
- data/generated/google/apis/translate_v3/service.rb +14 -1
- data/generated/google/apis/translate_v3beta1.rb +1 -1
- data/generated/google/apis/translate_v3beta1/service.rb +14 -1
- data/generated/google/apis/vision_v1.rb +1 -1
- data/generated/google/apis/vision_v1/classes.rb +1304 -1870
- data/generated/google/apis/vision_v1/service.rb +254 -340
- data/generated/google/apis/vision_v1p1beta1.rb +1 -1
- data/generated/google/apis/vision_v1p1beta1/classes.rb +1246 -1790
- data/generated/google/apis/vision_v1p1beta1/service.rb +91 -121
- data/generated/google/apis/vision_v1p2beta1.rb +1 -1
- data/generated/google/apis/vision_v1p2beta1/classes.rb +1246 -1790
- data/generated/google/apis/vision_v1p2beta1/service.rb +91 -121
- data/generated/google/apis/websecurityscanner_v1.rb +1 -1
- data/generated/google/apis/websecurityscanner_v1/classes.rb +71 -95
- data/generated/google/apis/websecurityscanner_v1/service.rb +46 -65
- data/generated/google/apis/websecurityscanner_v1alpha.rb +1 -1
- data/generated/google/apis/websecurityscanner_v1alpha/classes.rb +55 -63
- data/generated/google/apis/websecurityscanner_v1alpha/service.rb +46 -65
- data/generated/google/apis/websecurityscanner_v1beta.rb +1 -1
- data/generated/google/apis/websecurityscanner_v1beta/classes.rb +77 -92
- data/generated/google/apis/websecurityscanner_v1beta/service.rb +46 -65
- data/generated/google/apis/youtube_analytics_v2.rb +1 -1
- data/generated/google/apis/youtube_analytics_v2/classes.rb +77 -104
- data/generated/google/apis/youtube_analytics_v2/service.rb +106 -126
- data/generated/google/apis/youtube_partner_v1.rb +1 -1
- data/generated/google/apis/youtube_partner_v1/service.rb +19 -19
- data/generated/google/apis/youtube_v3.rb +1 -1
- data/generated/google/apis/youtube_v3/classes.rb +937 -1175
- data/generated/google/apis/youtube_v3/service.rb +975 -1284
- data/generated/google/apis/youtubereporting_v1.rb +1 -1
- data/generated/google/apis/youtubereporting_v1/classes.rb +20 -29
- data/generated/google/apis/youtubereporting_v1/service.rb +40 -43
- data/lib/google/apis/core/base_service.rb +7 -1
- data/lib/google/apis/version.rb +1 -1
- metadata +15 -7
- data/generated/google/apis/fitness_v1.rb +0 -85
- data/generated/google/apis/fitness_v1/classes.rb +0 -1020
- data/generated/google/apis/fitness_v1/representations.rb +0 -398
- data/generated/google/apis/fitness_v1/service.rb +0 -647
@@ -47,18 +47,13 @@ module Google
|
|
47
47
|
@batch_path = 'batch'
|
48
48
|
end
|
49
49
|
|
50
|
-
# Creates a course.
|
51
|
-
#
|
52
|
-
#
|
53
|
-
#
|
54
|
-
# * `
|
55
|
-
#
|
56
|
-
#
|
57
|
-
# * `FAILED_PRECONDITION` if the course owner's account is disabled or for
|
58
|
-
# the following request errors:
|
59
|
-
# * UserGroupsMembershipLimitReached
|
60
|
-
# * `ALREADY_EXISTS` if an alias was specified in the `id` and
|
61
|
-
# already exists.
|
50
|
+
# Creates a course. The user specified in `ownerId` is the owner of the created
|
51
|
+
# course and added as a teacher. This method returns the following error codes: *
|
52
|
+
# `PERMISSION_DENIED` if the requesting user is not permitted to create courses
|
53
|
+
# or for access errors. * `NOT_FOUND` if the primary teacher is not a valid user.
|
54
|
+
# * `FAILED_PRECONDITION` if the course owner's account is disabled or for the
|
55
|
+
# following request errors: * UserGroupsMembershipLimitReached * `ALREADY_EXISTS`
|
56
|
+
# if an alias was specified in the `id` and already exists.
|
62
57
|
# @param [Google::Apis::ClassroomV1::Course] course_object
|
63
58
|
# @param [String] fields
|
64
59
|
# Selector specifying which fields to include in a partial response.
|
@@ -88,15 +83,13 @@ module Google
|
|
88
83
|
execute_or_queue_command(command, &block)
|
89
84
|
end
|
90
85
|
|
91
|
-
# Deletes a course.
|
92
|
-
#
|
93
|
-
#
|
94
|
-
# requested
|
95
|
-
# * `NOT_FOUND` if no course exists with the requested ID.
|
86
|
+
# Deletes a course. This method returns the following error codes: * `
|
87
|
+
# PERMISSION_DENIED` if the requesting user is not permitted to delete the
|
88
|
+
# requested course or for access errors. * `NOT_FOUND` if no course exists with
|
89
|
+
# the requested ID.
|
96
90
|
# @param [String] id
|
97
|
-
# Identifier of the course to delete.
|
98
|
-
#
|
99
|
-
# alias.
|
91
|
+
# Identifier of the course to delete. This identifier can be either the
|
92
|
+
# Classroom-assigned identifier or an alias.
|
100
93
|
# @param [String] fields
|
101
94
|
# Selector specifying which fields to include in a partial response.
|
102
95
|
# @param [String] quota_user
|
@@ -124,15 +117,13 @@ module Google
|
|
124
117
|
execute_or_queue_command(command, &block)
|
125
118
|
end
|
126
119
|
|
127
|
-
# Returns a course.
|
128
|
-
#
|
129
|
-
#
|
130
|
-
# requested
|
131
|
-
# * `NOT_FOUND` if no course exists with the requested ID.
|
120
|
+
# Returns a course. This method returns the following error codes: * `
|
121
|
+
# PERMISSION_DENIED` if the requesting user is not permitted to access the
|
122
|
+
# requested course or for access errors. * `NOT_FOUND` if no course exists with
|
123
|
+
# the requested ID.
|
132
124
|
# @param [String] id
|
133
|
-
# Identifier of the course to return.
|
134
|
-
#
|
135
|
-
# alias.
|
125
|
+
# Identifier of the course to return. This identifier can be either the
|
126
|
+
# Classroom-assigned identifier or an alias.
|
136
127
|
# @param [String] fields
|
137
128
|
# Selector specifying which fields to include in a partial response.
|
138
129
|
# @param [String] quota_user
|
@@ -162,37 +153,31 @@ module Google
|
|
162
153
|
|
163
154
|
# Returns a list of courses that the requesting user is permitted to view,
|
164
155
|
# restricted to those that match the request. Returned courses are ordered by
|
165
|
-
# creation time, with the most recently created coming first.
|
166
|
-
#
|
167
|
-
# * `
|
168
|
-
#
|
169
|
-
# * `NOT_FOUND` if any users specified in the query arguments do not exist.
|
156
|
+
# creation time, with the most recently created coming first. This method
|
157
|
+
# returns the following error codes: * `PERMISSION_DENIED` for access errors. * `
|
158
|
+
# INVALID_ARGUMENT` if the query argument is malformed. * `NOT_FOUND` if any
|
159
|
+
# users specified in the query arguments do not exist.
|
170
160
|
# @param [Array<String>, String] course_states
|
171
|
-
# Restricts returned courses to those in one of the specified states
|
172
|
-
#
|
161
|
+
# Restricts returned courses to those in one of the specified states The default
|
162
|
+
# value is ACTIVE, ARCHIVED, PROVISIONED, DECLINED.
|
173
163
|
# @param [Fixnum] page_size
|
174
164
|
# Maximum number of items to return. Zero or unspecified indicates that the
|
175
|
-
# server may assign a maximum.
|
176
|
-
#
|
165
|
+
# server may assign a maximum. The server may return fewer than the specified
|
166
|
+
# number of results.
|
177
167
|
# @param [String] page_token
|
178
|
-
# nextPageToken
|
179
|
-
#
|
180
|
-
# list call,
|
181
|
-
# indicating that the subsequent page of results should be returned.
|
182
|
-
# The list request must be
|
168
|
+
# nextPageToken value returned from a previous list call, indicating that the
|
169
|
+
# subsequent page of results should be returned. The list request must be
|
183
170
|
# otherwise identical to the one that resulted in this token.
|
184
171
|
# @param [String] student_id
|
185
172
|
# Restricts returned courses to those having a student with the specified
|
186
|
-
# identifier. The identifier can be one of the following:
|
187
|
-
# * the
|
188
|
-
#
|
189
|
-
# * the string literal `"me"`, indicating the requesting user
|
173
|
+
# identifier. The identifier can be one of the following: * the numeric
|
174
|
+
# identifier for the user * the email address of the user * the string literal `"
|
175
|
+
# me"`, indicating the requesting user
|
190
176
|
# @param [String] teacher_id
|
191
177
|
# Restricts returned courses to those having a teacher with the specified
|
192
|
-
# identifier. The identifier can be one of the following:
|
193
|
-
# * the
|
194
|
-
#
|
195
|
-
# * the string literal `"me"`, indicating the requesting user
|
178
|
+
# identifier. The identifier can be one of the following: * the numeric
|
179
|
+
# identifier for the user * the email address of the user * the string literal `"
|
180
|
+
# me"`, indicating the requesting user
|
196
181
|
# @param [String] fields
|
197
182
|
# Selector specifying which fields to include in a partial response.
|
198
183
|
# @param [String] quota_user
|
@@ -224,36 +209,24 @@ module Google
|
|
224
209
|
execute_or_queue_command(command, &block)
|
225
210
|
end
|
226
211
|
|
227
|
-
# Updates one or more fields in a course.
|
228
|
-
#
|
229
|
-
#
|
230
|
-
# requested
|
231
|
-
#
|
232
|
-
#
|
233
|
-
# if no update mask is supplied.
|
234
|
-
# * `FAILED_PRECONDITION` for the following request errors:
|
235
|
-
# * CourseNotModifiable
|
212
|
+
# Updates one or more fields in a course. This method returns the following
|
213
|
+
# error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to
|
214
|
+
# modify the requested course or for access errors. * `NOT_FOUND` if no course
|
215
|
+
# exists with the requested ID. * `INVALID_ARGUMENT` if invalid fields are
|
216
|
+
# specified in the update mask or if no update mask is supplied. * `
|
217
|
+
# FAILED_PRECONDITION` for the following request errors: * CourseNotModifiable
|
236
218
|
# @param [String] id
|
237
|
-
# Identifier of the course to update.
|
238
|
-
#
|
239
|
-
# alias.
|
219
|
+
# Identifier of the course to update. This identifier can be either the
|
220
|
+
# Classroom-assigned identifier or an alias.
|
240
221
|
# @param [Google::Apis::ClassroomV1::Course] course_object
|
241
222
|
# @param [String] update_mask
|
242
|
-
# Mask that identifies which fields on the course to update.
|
243
|
-
#
|
244
|
-
#
|
245
|
-
# * `
|
246
|
-
#
|
247
|
-
#
|
248
|
-
#
|
249
|
-
# * `room`
|
250
|
-
# * `courseState`
|
251
|
-
# * `ownerId`
|
252
|
-
# Note: patches to ownerId are treated as being effective immediately, but in
|
253
|
-
# practice it may take some time for the ownership transfer of all affected
|
254
|
-
# resources to complete.
|
255
|
-
# When set in a query parameter, this field should be specified as
|
256
|
-
# `updateMask=<field1>,<field2>,...`
|
223
|
+
# Mask that identifies which fields on the course to update. This field is
|
224
|
+
# required to do an update. The update will fail if invalid fields are specified.
|
225
|
+
# The following fields are valid: * `name` * `section` * `descriptionHeading` *
|
226
|
+
# `description` * `room` * `courseState` * `ownerId` Note: patches to ownerId
|
227
|
+
# are treated as being effective immediately, but in practice it may take some
|
228
|
+
# time for the ownership transfer of all affected resources to complete. When
|
229
|
+
# set in a query parameter, this field should be specified as `updateMask=,,...`
|
257
230
|
# @param [String] fields
|
258
231
|
# Selector specifying which fields to include in a partial response.
|
259
232
|
# @param [String] quota_user
|
@@ -284,17 +257,14 @@ module Google
|
|
284
257
|
execute_or_queue_command(command, &block)
|
285
258
|
end
|
286
259
|
|
287
|
-
# Updates a course.
|
288
|
-
#
|
289
|
-
#
|
290
|
-
# requested
|
291
|
-
#
|
292
|
-
# * `FAILED_PRECONDITION` for the following request errors:
|
293
|
-
# * CourseNotModifiable
|
260
|
+
# Updates a course. This method returns the following error codes: * `
|
261
|
+
# PERMISSION_DENIED` if the requesting user is not permitted to modify the
|
262
|
+
# requested course or for access errors. * `NOT_FOUND` if no course exists with
|
263
|
+
# the requested ID. * `FAILED_PRECONDITION` for the following request errors: *
|
264
|
+
# CourseNotModifiable
|
294
265
|
# @param [String] id
|
295
|
-
# Identifier of the course to update.
|
296
|
-
#
|
297
|
-
# alias.
|
266
|
+
# Identifier of the course to update. This identifier can be either the
|
267
|
+
# Classroom-assigned identifier or an alias.
|
298
268
|
# @param [Google::Apis::ClassroomV1::Course] course_object
|
299
269
|
# @param [String] fields
|
300
270
|
# Selector specifying which fields to include in a partial response.
|
@@ -325,19 +295,15 @@ module Google
|
|
325
295
|
execute_or_queue_command(command, &block)
|
326
296
|
end
|
327
297
|
|
328
|
-
# Creates an alias for a course.
|
329
|
-
#
|
330
|
-
# * `
|
331
|
-
# alias
|
332
|
-
#
|
333
|
-
#
|
334
|
-
# * `FAILED_PRECONDITION` if the alias requested does not make sense for the
|
335
|
-
# requesting user or course (for example, if a user not in a domain
|
336
|
-
# attempts to access a domain-scoped alias).
|
298
|
+
# Creates an alias for a course. This method returns the following error codes: *
|
299
|
+
# `PERMISSION_DENIED` if the requesting user is not permitted to create the
|
300
|
+
# alias or for access errors. * `NOT_FOUND` if the course does not exist. * `
|
301
|
+
# ALREADY_EXISTS` if the alias already exists. * `FAILED_PRECONDITION` if the
|
302
|
+
# alias requested does not make sense for the requesting user or course (for
|
303
|
+
# example, if a user not in a domain attempts to access a domain-scoped alias).
|
337
304
|
# @param [String] course_id
|
338
|
-
# Identifier of the course to alias.
|
339
|
-
#
|
340
|
-
# alias.
|
305
|
+
# Identifier of the course to alias. This identifier can be either the Classroom-
|
306
|
+
# assigned identifier or an alias.
|
341
307
|
# @param [Google::Apis::ClassroomV1::CourseAlias] course_alias_object
|
342
308
|
# @param [String] fields
|
343
309
|
# Selector specifying which fields to include in a partial response.
|
@@ -368,21 +334,17 @@ module Google
|
|
368
334
|
execute_or_queue_command(command, &block)
|
369
335
|
end
|
370
336
|
|
371
|
-
# Deletes an alias of a course.
|
372
|
-
#
|
373
|
-
# * `
|
374
|
-
# alias
|
375
|
-
#
|
376
|
-
#
|
377
|
-
# requesting user or course (for example, if a user not in a domain
|
378
|
-
# attempts to delete a domain-scoped alias).
|
337
|
+
# Deletes an alias of a course. This method returns the following error codes: *
|
338
|
+
# `PERMISSION_DENIED` if the requesting user is not permitted to remove the
|
339
|
+
# alias or for access errors. * `NOT_FOUND` if the alias does not exist. * `
|
340
|
+
# FAILED_PRECONDITION` if the alias requested does not make sense for the
|
341
|
+
# requesting user or course (for example, if a user not in a domain attempts to
|
342
|
+
# delete a domain-scoped alias).
|
379
343
|
# @param [String] course_id
|
380
|
-
# Identifier of the course whose alias should be deleted.
|
381
|
-
#
|
382
|
-
# alias.
|
344
|
+
# Identifier of the course whose alias should be deleted. This identifier can be
|
345
|
+
# either the Classroom-assigned identifier or an alias.
|
383
346
|
# @param [String] alias_
|
384
|
-
# Alias to delete.
|
385
|
-
# This may not be the Classroom-assigned identifier.
|
347
|
+
# Alias to delete. This may not be the Classroom-assigned identifier.
|
386
348
|
# @param [String] fields
|
387
349
|
# Selector specifying which fields to include in a partial response.
|
388
350
|
# @param [String] quota_user
|
@@ -411,26 +373,21 @@ module Google
|
|
411
373
|
execute_or_queue_command(command, &block)
|
412
374
|
end
|
413
375
|
|
414
|
-
# Returns a list of aliases for a course.
|
415
|
-
#
|
416
|
-
# * `
|
417
|
-
#
|
418
|
-
# * `NOT_FOUND` if the course does not exist.
|
376
|
+
# Returns a list of aliases for a course. This method returns the following
|
377
|
+
# error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to
|
378
|
+
# access the course or for access errors. * `NOT_FOUND` if the course does not
|
379
|
+
# exist.
|
419
380
|
# @param [String] course_id
|
420
|
-
# The identifier of the course.
|
421
|
-
#
|
422
|
-
# alias.
|
381
|
+
# The identifier of the course. This identifier can be either the Classroom-
|
382
|
+
# assigned identifier or an alias.
|
423
383
|
# @param [Fixnum] page_size
|
424
384
|
# Maximum number of items to return. Zero or unspecified indicates that the
|
425
|
-
# server may assign a maximum.
|
426
|
-
#
|
385
|
+
# server may assign a maximum. The server may return fewer than the specified
|
386
|
+
# number of results.
|
427
387
|
# @param [String] page_token
|
428
|
-
# nextPageToken
|
429
|
-
#
|
430
|
-
#
|
431
|
-
# indicating that the subsequent page of results should be returned.
|
432
|
-
# The list request
|
433
|
-
# must be otherwise identical to the one that resulted in this token.
|
388
|
+
# nextPageToken value returned from a previous list call, indicating that the
|
389
|
+
# subsequent page of results should be returned. The list request must be
|
390
|
+
# otherwise identical to the one that resulted in this token.
|
434
391
|
# @param [String] fields
|
435
392
|
# Selector specifying which fields to include in a partial response.
|
436
393
|
# @param [String] quota_user
|
@@ -460,19 +417,15 @@ module Google
|
|
460
417
|
execute_or_queue_command(command, &block)
|
461
418
|
end
|
462
419
|
|
463
|
-
# Creates an announcement.
|
464
|
-
#
|
465
|
-
#
|
466
|
-
#
|
467
|
-
#
|
468
|
-
#
|
469
|
-
# * `NOT_FOUND` if the requested course does not exist.
|
470
|
-
# * `FAILED_PRECONDITION` for the following request error:
|
471
|
-
# * AttachmentNotVisible
|
420
|
+
# Creates an announcement. This method returns the following error codes: * `
|
421
|
+
# PERMISSION_DENIED` if the requesting user is not permitted to access the
|
422
|
+
# requested course, create announcements in the requested course, share a Drive
|
423
|
+
# attachment, or for access errors. * `INVALID_ARGUMENT` if the request is
|
424
|
+
# malformed. * `NOT_FOUND` if the requested course does not exist. * `
|
425
|
+
# FAILED_PRECONDITION` for the following request error: * AttachmentNotVisible
|
472
426
|
# @param [String] course_id
|
473
|
-
# Identifier of the course.
|
474
|
-
#
|
475
|
-
# alias.
|
427
|
+
# Identifier of the course. This identifier can be either the Classroom-assigned
|
428
|
+
# identifier or an alias.
|
476
429
|
# @param [Google::Apis::ClassroomV1::Announcement] announcement_object
|
477
430
|
# @param [String] fields
|
478
431
|
# Selector specifying which fields to include in a partial response.
|
@@ -503,24 +456,20 @@ module Google
|
|
503
456
|
execute_or_queue_command(command, &block)
|
504
457
|
end
|
505
458
|
|
506
|
-
# Deletes an announcement.
|
507
|
-
#
|
508
|
-
#
|
509
|
-
#
|
510
|
-
#
|
511
|
-
#
|
512
|
-
#
|
513
|
-
#
|
514
|
-
# * `FAILED_PRECONDITION` if the requested announcement has already been
|
515
|
-
# deleted.
|
516
|
-
# * `NOT_FOUND` if no course exists with the requested ID.
|
459
|
+
# Deletes an announcement. This request must be made by the Developer Console
|
460
|
+
# project of the [OAuth client ID](https://support.google.com/cloud/answer/
|
461
|
+
# 6158849) used to create the corresponding announcement item. This method
|
462
|
+
# returns the following error codes: * `PERMISSION_DENIED` if the requesting
|
463
|
+
# developer project did not create the corresponding announcement, if the
|
464
|
+
# requesting user is not permitted to delete the requested course or for access
|
465
|
+
# errors. * `FAILED_PRECONDITION` if the requested announcement has already been
|
466
|
+
# deleted. * `NOT_FOUND` if no course exists with the requested ID.
|
517
467
|
# @param [String] course_id
|
518
|
-
# Identifier of the course.
|
519
|
-
#
|
520
|
-
# alias.
|
468
|
+
# Identifier of the course. This identifier can be either the Classroom-assigned
|
469
|
+
# identifier or an alias.
|
521
470
|
# @param [String] id
|
522
|
-
# Identifier of the announcement to delete.
|
523
|
-
#
|
471
|
+
# Identifier of the announcement to delete. This identifier is a Classroom-
|
472
|
+
# assigned identifier.
|
524
473
|
# @param [String] fields
|
525
474
|
# Selector specifying which fields to include in a partial response.
|
526
475
|
# @param [String] quota_user
|
@@ -549,16 +498,14 @@ module Google
|
|
549
498
|
execute_or_queue_command(command, &block)
|
550
499
|
end
|
551
500
|
|
552
|
-
# Returns an announcement.
|
553
|
-
#
|
554
|
-
#
|
555
|
-
#
|
556
|
-
#
|
557
|
-
# * `NOT_FOUND` if the requested course or announcement does not exist.
|
501
|
+
# Returns an announcement. This method returns the following error codes: * `
|
502
|
+
# PERMISSION_DENIED` if the requesting user is not permitted to access the
|
503
|
+
# requested course or announcement, or for access errors. * `INVALID_ARGUMENT`
|
504
|
+
# if the request is malformed. * `NOT_FOUND` if the requested course or
|
505
|
+
# announcement does not exist.
|
558
506
|
# @param [String] course_id
|
559
|
-
# Identifier of the course.
|
560
|
-
#
|
561
|
-
# alias.
|
507
|
+
# Identifier of the course. This identifier can be either the Classroom-assigned
|
508
|
+
# identifier or an alias.
|
562
509
|
# @param [String] id
|
563
510
|
# Identifier of the announcement.
|
564
511
|
# @param [String] fields
|
@@ -590,37 +537,31 @@ module Google
|
|
590
537
|
end
|
591
538
|
|
592
539
|
# Returns a list of announcements that the requester is permitted to view.
|
593
|
-
# Course students may only view `PUBLISHED` announcements. Course teachers
|
594
|
-
#
|
595
|
-
#
|
596
|
-
#
|
597
|
-
# the
|
598
|
-
#
|
599
|
-
# * `NOT_FOUND` if the requested course does not exist.
|
540
|
+
# Course students may only view `PUBLISHED` announcements. Course teachers and
|
541
|
+
# domain administrators may view all announcements. This method returns the
|
542
|
+
# following error codes: * `PERMISSION_DENIED` if the requesting user is not
|
543
|
+
# permitted to access the requested course or for access errors. * `
|
544
|
+
# INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested
|
545
|
+
# course does not exist.
|
600
546
|
# @param [String] course_id
|
601
|
-
# Identifier of the course.
|
602
|
-
#
|
603
|
-
# alias.
|
547
|
+
# Identifier of the course. This identifier can be either the Classroom-assigned
|
548
|
+
# identifier or an alias.
|
604
549
|
# @param [Array<String>, String] announcement_states
|
605
|
-
# Restriction on the `state` of announcements returned.
|
606
|
-
#
|
550
|
+
# Restriction on the `state` of announcements returned. If this argument is left
|
551
|
+
# unspecified, the default value is `PUBLISHED`.
|
607
552
|
# @param [String] order_by
|
608
|
-
# Optional sort ordering for results. A comma-separated list of fields with
|
609
|
-
#
|
610
|
-
#
|
611
|
-
#
|
612
|
-
# Examples: `updateTime asc`, `updateTime`
|
553
|
+
# Optional sort ordering for results. A comma-separated list of fields with an
|
554
|
+
# optional sort direction keyword. Supported field is `updateTime`. Supported
|
555
|
+
# direction keywords are `asc` and `desc`. If not specified, `updateTime desc`
|
556
|
+
# is the default behavior. Examples: `updateTime asc`, `updateTime`
|
613
557
|
# @param [Fixnum] page_size
|
614
558
|
# Maximum number of items to return. Zero or unspecified indicates that the
|
615
|
-
# server may assign a maximum.
|
616
|
-
#
|
559
|
+
# server may assign a maximum. The server may return fewer than the specified
|
560
|
+
# number of results.
|
617
561
|
# @param [String] page_token
|
618
|
-
# nextPageToken
|
619
|
-
#
|
620
|
-
#
|
621
|
-
# indicating that the subsequent page of results should be returned.
|
622
|
-
# The list request
|
623
|
-
# must be otherwise identical to the one that resulted in this token.
|
562
|
+
# nextPageToken value returned from a previous list call, indicating that the
|
563
|
+
# subsequent page of results should be returned. The list request must be
|
564
|
+
# otherwise identical to the one that resulted in this token.
|
624
565
|
# @param [String] fields
|
625
566
|
# Selector specifying which fields to include in a partial response.
|
626
567
|
# @param [String] quota_user
|
@@ -652,18 +593,15 @@ module Google
|
|
652
593
|
execute_or_queue_command(command, &block)
|
653
594
|
end
|
654
595
|
|
655
|
-
# Modifies assignee mode and options of an announcement.
|
656
|
-
#
|
657
|
-
#
|
658
|
-
#
|
659
|
-
# * `
|
660
|
-
# requested course or course work
|
661
|
-
# * `INVALID_ARGUMENT` if the request is malformed.
|
662
|
-
# * `NOT_FOUND` if the requested course or course work does not exist.
|
596
|
+
# Modifies assignee mode and options of an announcement. Only a teacher of the
|
597
|
+
# course that contains the announcement may call this method. This method
|
598
|
+
# returns the following error codes: * `PERMISSION_DENIED` if the requesting
|
599
|
+
# user is not permitted to access the requested course or course work or for
|
600
|
+
# access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND`
|
601
|
+
# if the requested course or course work does not exist.
|
663
602
|
# @param [String] course_id
|
664
|
-
# Identifier of the course.
|
665
|
-
#
|
666
|
-
# alias.
|
603
|
+
# Identifier of the course. This identifier can be either the Classroom-assigned
|
604
|
+
# identifier or an alias.
|
667
605
|
# @param [String] id
|
668
606
|
# Identifier of the announcement.
|
669
607
|
# @param [Google::Apis::ClassroomV1::ModifyAnnouncementAssigneesRequest] modify_announcement_assignees_request_object
|
@@ -697,33 +635,26 @@ module Google
|
|
697
635
|
execute_or_queue_command(command, &block)
|
698
636
|
end
|
699
637
|
|
700
|
-
# Updates one or more fields of an announcement.
|
701
|
-
#
|
702
|
-
#
|
703
|
-
# the
|
704
|
-
# * `
|
705
|
-
#
|
706
|
-
# deleted.
|
707
|
-
# * `NOT_FOUND` if the requested course or announcement does not exist
|
638
|
+
# Updates one or more fields of an announcement. This method returns the
|
639
|
+
# following error codes: * `PERMISSION_DENIED` if the requesting developer
|
640
|
+
# project did not create the corresponding announcement or for access errors. * `
|
641
|
+
# INVALID_ARGUMENT` if the request is malformed. * `FAILED_PRECONDITION` if the
|
642
|
+
# requested announcement has already been deleted. * `NOT_FOUND` if the
|
643
|
+
# requested course or announcement does not exist
|
708
644
|
# @param [String] course_id
|
709
|
-
# Identifier of the course.
|
710
|
-
#
|
711
|
-
# alias.
|
645
|
+
# Identifier of the course. This identifier can be either the Classroom-assigned
|
646
|
+
# identifier or an alias.
|
712
647
|
# @param [String] id
|
713
648
|
# Identifier of the announcement.
|
714
649
|
# @param [Google::Apis::ClassroomV1::Announcement] announcement_object
|
715
650
|
# @param [String] update_mask
|
716
|
-
# Mask that identifies which fields on the announcement to update.
|
717
|
-
#
|
718
|
-
#
|
719
|
-
#
|
720
|
-
#
|
721
|
-
#
|
722
|
-
#
|
723
|
-
# The following fields may be specified by teachers:
|
724
|
-
# * `text`
|
725
|
-
# * `state`
|
726
|
-
# * `scheduled_time`
|
651
|
+
# Mask that identifies which fields on the announcement to update. This field is
|
652
|
+
# required to do an update. The update fails if invalid fields are specified. If
|
653
|
+
# a field supports empty values, it can be cleared by specifying it in the
|
654
|
+
# update mask and not in the Announcement object. If a field that does not
|
655
|
+
# support empty values is included in the update mask and not set in the
|
656
|
+
# Announcement object, an `INVALID_ARGUMENT` error is returned. The following
|
657
|
+
# fields may be specified by teachers: * `text` * `state` * `scheduled_time`
|
727
658
|
# @param [String] fields
|
728
659
|
# Selector specifying which fields to include in a partial response.
|
729
660
|
# @param [String] quota_user
|
@@ -755,25 +686,20 @@ module Google
|
|
755
686
|
execute_or_queue_command(command, &block)
|
756
687
|
end
|
757
688
|
|
758
|
-
# Creates course work.
|
759
|
-
#
|
760
|
-
#
|
761
|
-
#
|
762
|
-
#
|
763
|
-
#
|
764
|
-
#
|
765
|
-
#
|
766
|
-
# * `
|
767
|
-
# requested course
|
768
|
-
#
|
769
|
-
# * `INVALID_ARGUMENT` if the request is malformed.
|
770
|
-
# * `NOT_FOUND` if the requested course does not exist.
|
771
|
-
# * `FAILED_PRECONDITION` for the following request error:
|
772
|
-
# * AttachmentNotVisible
|
689
|
+
# Creates course work. The resulting course work (and corresponding student
|
690
|
+
# submissions) are associated with the Developer Console project of the [OAuth
|
691
|
+
# client ID](https://support.google.com/cloud/answer/6158849) used to make the
|
692
|
+
# request. Classroom API requests to modify course work and student submissions
|
693
|
+
# must be made with an OAuth client ID from the associated Developer Console
|
694
|
+
# project. This method returns the following error codes: * `PERMISSION_DENIED`
|
695
|
+
# if the requesting user is not permitted to access the requested course, create
|
696
|
+
# course work in the requested course, share a Drive attachment, or for access
|
697
|
+
# errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the
|
698
|
+
# requested course does not exist. * `FAILED_PRECONDITION` for the following
|
699
|
+
# request error: * AttachmentNotVisible
|
773
700
|
# @param [String] course_id
|
774
|
-
# Identifier of the course.
|
775
|
-
#
|
776
|
-
# alias.
|
701
|
+
# Identifier of the course. This identifier can be either the Classroom-assigned
|
702
|
+
# identifier or an alias.
|
777
703
|
# @param [Google::Apis::ClassroomV1::CourseWork] course_work_object
|
778
704
|
# @param [String] fields
|
779
705
|
# Selector specifying which fields to include in a partial response.
|
@@ -804,24 +730,20 @@ module Google
|
|
804
730
|
execute_or_queue_command(command, &block)
|
805
731
|
end
|
806
732
|
|
807
|
-
# Deletes a course work.
|
808
|
-
#
|
809
|
-
#
|
810
|
-
#
|
811
|
-
#
|
812
|
-
#
|
813
|
-
#
|
814
|
-
#
|
815
|
-
# * `FAILED_PRECONDITION` if the requested course work has already been
|
816
|
-
# deleted.
|
817
|
-
# * `NOT_FOUND` if no course exists with the requested ID.
|
733
|
+
# Deletes a course work. This request must be made by the Developer Console
|
734
|
+
# project of the [OAuth client ID](https://support.google.com/cloud/answer/
|
735
|
+
# 6158849) used to create the corresponding course work item. This method
|
736
|
+
# returns the following error codes: * `PERMISSION_DENIED` if the requesting
|
737
|
+
# developer project did not create the corresponding course work, if the
|
738
|
+
# requesting user is not permitted to delete the requested course or for access
|
739
|
+
# errors. * `FAILED_PRECONDITION` if the requested course work has already been
|
740
|
+
# deleted. * `NOT_FOUND` if no course exists with the requested ID.
|
818
741
|
# @param [String] course_id
|
819
|
-
# Identifier of the course.
|
820
|
-
#
|
821
|
-
# alias.
|
742
|
+
# Identifier of the course. This identifier can be either the Classroom-assigned
|
743
|
+
# identifier or an alias.
|
822
744
|
# @param [String] id
|
823
|
-
# Identifier of the course work to delete.
|
824
|
-
#
|
745
|
+
# Identifier of the course work to delete. This identifier is a Classroom-
|
746
|
+
# assigned identifier.
|
825
747
|
# @param [String] fields
|
826
748
|
# Selector specifying which fields to include in a partial response.
|
827
749
|
# @param [String] quota_user
|
@@ -850,16 +772,14 @@ module Google
|
|
850
772
|
execute_or_queue_command(command, &block)
|
851
773
|
end
|
852
774
|
|
853
|
-
# Returns course work.
|
854
|
-
#
|
855
|
-
#
|
856
|
-
# requested course or course work
|
857
|
-
#
|
858
|
-
# * `NOT_FOUND` if the requested course or course work does not exist.
|
775
|
+
# Returns course work. This method returns the following error codes: * `
|
776
|
+
# PERMISSION_DENIED` if the requesting user is not permitted to access the
|
777
|
+
# requested course or course work, or for access errors. * `INVALID_ARGUMENT` if
|
778
|
+
# the request is malformed. * `NOT_FOUND` if the requested course or course work
|
779
|
+
# does not exist.
|
859
780
|
# @param [String] course_id
|
860
|
-
# Identifier of the course.
|
861
|
-
#
|
862
|
-
# alias.
|
781
|
+
# Identifier of the course. This identifier can be either the Classroom-assigned
|
782
|
+
# identifier or an alias.
|
863
783
|
# @param [String] id
|
864
784
|
# Identifier of the course work.
|
865
785
|
# @param [String] fields
|
@@ -890,39 +810,32 @@ module Google
|
|
890
810
|
execute_or_queue_command(command, &block)
|
891
811
|
end
|
892
812
|
|
893
|
-
# Returns a list of course work that the requester is permitted to view.
|
894
|
-
#
|
895
|
-
#
|
896
|
-
#
|
897
|
-
#
|
898
|
-
# the requested course
|
899
|
-
# * `INVALID_ARGUMENT` if the request is malformed.
|
900
|
-
# * `NOT_FOUND` if the requested course does not exist.
|
813
|
+
# Returns a list of course work that the requester is permitted to view. Course
|
814
|
+
# students may only view `PUBLISHED` course work. Course teachers and domain
|
815
|
+
# administrators may view all course work. This method returns the following
|
816
|
+
# error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to
|
817
|
+
# access the requested course or for access errors. * `INVALID_ARGUMENT` if the
|
818
|
+
# request is malformed. * `NOT_FOUND` if the requested course does not exist.
|
901
819
|
# @param [String] course_id
|
902
|
-
# Identifier of the course.
|
903
|
-
#
|
904
|
-
# alias.
|
820
|
+
# Identifier of the course. This identifier can be either the Classroom-assigned
|
821
|
+
# identifier or an alias.
|
905
822
|
# @param [Array<String>, String] course_work_states
|
906
|
-
# Restriction on the work status to return. Only courseWork that matches
|
907
|
-
#
|
908
|
-
# is returned.
|
823
|
+
# Restriction on the work status to return. Only courseWork that matches is
|
824
|
+
# returned. If unspecified, items with a work status of `PUBLISHED` is returned.
|
909
825
|
# @param [String] order_by
|
910
|
-
# Optional sort ordering for results. A comma-separated list of fields with
|
911
|
-
#
|
912
|
-
#
|
913
|
-
#
|
914
|
-
#
|
826
|
+
# Optional sort ordering for results. A comma-separated list of fields with an
|
827
|
+
# optional sort direction keyword. Supported fields are `updateTime` and `
|
828
|
+
# dueDate`. Supported direction keywords are `asc` and `desc`. If not specified,
|
829
|
+
# `updateTime desc` is the default behavior. Examples: `dueDate asc,updateTime
|
830
|
+
# desc`, `updateTime,dueDate desc`
|
915
831
|
# @param [Fixnum] page_size
|
916
832
|
# Maximum number of items to return. Zero or unspecified indicates that the
|
917
|
-
# server may assign a maximum.
|
918
|
-
#
|
833
|
+
# server may assign a maximum. The server may return fewer than the specified
|
834
|
+
# number of results.
|
919
835
|
# @param [String] page_token
|
920
|
-
# nextPageToken
|
921
|
-
#
|
922
|
-
#
|
923
|
-
# indicating that the subsequent page of results should be returned.
|
924
|
-
# The list request
|
925
|
-
# must be otherwise identical to the one that resulted in this token.
|
836
|
+
# nextPageToken value returned from a previous list call, indicating that the
|
837
|
+
# subsequent page of results should be returned. The list request must be
|
838
|
+
# otherwise identical to the one that resulted in this token.
|
926
839
|
# @param [String] fields
|
927
840
|
# Selector specifying which fields to include in a partial response.
|
928
841
|
# @param [String] quota_user
|
@@ -954,18 +867,15 @@ module Google
|
|
954
867
|
execute_or_queue_command(command, &block)
|
955
868
|
end
|
956
869
|
|
957
|
-
# Modifies assignee mode and options of a coursework.
|
958
|
-
#
|
959
|
-
#
|
960
|
-
#
|
961
|
-
#
|
962
|
-
# requested course or course work
|
963
|
-
# * `INVALID_ARGUMENT` if the request is malformed.
|
964
|
-
# * `NOT_FOUND` if the requested course or course work does not exist.
|
870
|
+
# Modifies assignee mode and options of a coursework. Only a teacher of the
|
871
|
+
# course that contains the coursework may call this method. This method returns
|
872
|
+
# the following error codes: * `PERMISSION_DENIED` if the requesting user is not
|
873
|
+
# permitted to access the requested course or course work or for access errors. *
|
874
|
+
# `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the
|
875
|
+
# requested course or course work does not exist.
|
965
876
|
# @param [String] course_id
|
966
|
-
# Identifier of the course.
|
967
|
-
#
|
968
|
-
# alias.
|
877
|
+
# Identifier of the course. This identifier can be either the Classroom-assigned
|
878
|
+
# identifier or an alias.
|
969
879
|
# @param [String] id
|
970
880
|
# Identifier of the coursework.
|
971
881
|
# @param [Google::Apis::ClassroomV1::ModifyCourseWorkAssigneesRequest] modify_course_work_assignees_request_object
|
@@ -999,47 +909,33 @@ module Google
|
|
999
909
|
execute_or_queue_command(command, &block)
|
1000
910
|
end
|
1001
911
|
|
1002
|
-
# Updates one or more fields of a course work.
|
1003
|
-
#
|
1004
|
-
#
|
1005
|
-
#
|
1006
|
-
#
|
1007
|
-
#
|
1008
|
-
#
|
1009
|
-
#
|
1010
|
-
#
|
1011
|
-
# requested
|
1012
|
-
#
|
1013
|
-
# * `INVALID_ARGUMENT` if the request is malformed.
|
1014
|
-
# * `FAILED_PRECONDITION` if the requested course work has already been
|
1015
|
-
# deleted.
|
1016
|
-
# * `NOT_FOUND` if the requested course, course work, or student submission
|
1017
|
-
# does not exist.
|
912
|
+
# Updates one or more fields of a course work. See google.classroom.v1.
|
913
|
+
# CourseWork for details of which fields may be updated and who may change them.
|
914
|
+
# This request must be made by the Developer Console project of the [OAuth
|
915
|
+
# client ID](https://support.google.com/cloud/answer/6158849) used to create the
|
916
|
+
# corresponding course work item. This method returns the following error codes:
|
917
|
+
# * `PERMISSION_DENIED` if the requesting developer project did not create the
|
918
|
+
# corresponding course work, if the user is not permitted to make the requested
|
919
|
+
# modification to the student submission, or for access errors. * `
|
920
|
+
# INVALID_ARGUMENT` if the request is malformed. * `FAILED_PRECONDITION` if the
|
921
|
+
# requested course work has already been deleted. * `NOT_FOUND` if the requested
|
922
|
+
# course, course work, or student submission does not exist.
|
1018
923
|
# @param [String] course_id
|
1019
|
-
# Identifier of the course.
|
1020
|
-
#
|
1021
|
-
# alias.
|
924
|
+
# Identifier of the course. This identifier can be either the Classroom-assigned
|
925
|
+
# identifier or an alias.
|
1022
926
|
# @param [String] id
|
1023
927
|
# Identifier of the course work.
|
1024
928
|
# @param [Google::Apis::ClassroomV1::CourseWork] course_work_object
|
1025
929
|
# @param [String] update_mask
|
1026
|
-
# Mask that identifies which fields on the course work to update.
|
1027
|
-
#
|
1028
|
-
#
|
1029
|
-
#
|
1030
|
-
#
|
1031
|
-
#
|
1032
|
-
#
|
1033
|
-
#
|
1034
|
-
#
|
1035
|
-
# * `description`
|
1036
|
-
# * `state`
|
1037
|
-
# * `due_date`
|
1038
|
-
# * `due_time`
|
1039
|
-
# * `max_points`
|
1040
|
-
# * `scheduled_time`
|
1041
|
-
# * `submission_modification_mode`
|
1042
|
-
# * `topic_id`
|
930
|
+
# Mask that identifies which fields on the course work to update. This field is
|
931
|
+
# required to do an update. The update fails if invalid fields are specified. If
|
932
|
+
# a field supports empty values, it can be cleared by specifying it in the
|
933
|
+
# update mask and not in the CourseWork object. If a field that does not support
|
934
|
+
# empty values is included in the update mask and not set in the CourseWork
|
935
|
+
# object, an `INVALID_ARGUMENT` error is returned. The following fields may be
|
936
|
+
# specified by teachers: * `title` * `description` * `state` * `due_date` * `
|
937
|
+
# due_time` * `max_points` * `scheduled_time` * `submission_modification_mode` *
|
938
|
+
# `topic_id`
|
1043
939
|
# @param [String] fields
|
1044
940
|
# Selector specifying which fields to include in a partial response.
|
1045
941
|
# @param [String] quota_user
|
@@ -1071,17 +967,14 @@ module Google
|
|
1071
967
|
execute_or_queue_command(command, &block)
|
1072
968
|
end
|
1073
969
|
|
1074
|
-
# Returns a student submission.
|
1075
|
-
#
|
1076
|
-
#
|
1077
|
-
#
|
1078
|
-
#
|
1079
|
-
# * `NOT_FOUND` if the requested course, course work, or student submission
|
1080
|
-
# does not exist.
|
970
|
+
# Returns a student submission. * `PERMISSION_DENIED` if the requesting user is
|
971
|
+
# not permitted to access the requested course, course work, or student
|
972
|
+
# submission or for access errors. * `INVALID_ARGUMENT` if the request is
|
973
|
+
# malformed. * `NOT_FOUND` if the requested course, course work, or student
|
974
|
+
# submission does not exist.
|
1081
975
|
# @param [String] course_id
|
1082
|
-
# Identifier of the course.
|
1083
|
-
#
|
1084
|
-
# alias.
|
976
|
+
# Identifier of the course. This identifier can be either the Classroom-assigned
|
977
|
+
# identifier or an alias.
|
1085
978
|
# @param [String] course_work_id
|
1086
979
|
# Identifier of the course work.
|
1087
980
|
# @param [String] id
|
@@ -1115,50 +1008,42 @@ module Google
|
|
1115
1008
|
execute_or_queue_command(command, &block)
|
1116
1009
|
end
|
1117
1010
|
|
1118
|
-
# Returns a list of student submissions that the requester is permitted to
|
1119
|
-
#
|
1120
|
-
#
|
1121
|
-
#
|
1122
|
-
#
|
1123
|
-
#
|
1124
|
-
#
|
1125
|
-
# * `
|
1126
|
-
# requested course
|
1127
|
-
# * `INVALID_ARGUMENT` if the request is malformed.
|
1128
|
-
# * `NOT_FOUND` if the requested course does not exist.
|
1011
|
+
# Returns a list of student submissions that the requester is permitted to view,
|
1012
|
+
# factoring in the OAuth scopes of the request. `-` may be specified as the `
|
1013
|
+
# course_work_id` to include student submissions for multiple course work items.
|
1014
|
+
# Course students may only view their own work. Course teachers and domain
|
1015
|
+
# administrators may view all student submissions. This method returns the
|
1016
|
+
# following error codes: * `PERMISSION_DENIED` if the requesting user is not
|
1017
|
+
# permitted to access the requested course or course work, or for access errors.
|
1018
|
+
# * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the
|
1019
|
+
# requested course does not exist.
|
1129
1020
|
# @param [String] course_id
|
1130
|
-
# Identifier of the course.
|
1131
|
-
#
|
1132
|
-
# alias.
|
1021
|
+
# Identifier of the course. This identifier can be either the Classroom-assigned
|
1022
|
+
# identifier or an alias.
|
1133
1023
|
# @param [String] course_work_id
|
1134
|
-
# Identifier of the student work to request.
|
1135
|
-
#
|
1136
|
-
#
|
1024
|
+
# Identifier of the student work to request. This may be set to the string
|
1025
|
+
# literal `"-"` to request student work for all course work in the specified
|
1026
|
+
# course.
|
1137
1027
|
# @param [String] late
|
1138
1028
|
# Requested lateness value. If specified, returned student submissions are
|
1139
|
-
# restricted by the requested value.
|
1140
|
-
#
|
1029
|
+
# restricted by the requested value. If unspecified, submissions are returned
|
1030
|
+
# regardless of `late` value.
|
1141
1031
|
# @param [Fixnum] page_size
|
1142
1032
|
# Maximum number of items to return. Zero or unspecified indicates that the
|
1143
|
-
# server may assign a maximum.
|
1144
|
-
#
|
1033
|
+
# server may assign a maximum. The server may return fewer than the specified
|
1034
|
+
# number of results.
|
1145
1035
|
# @param [String] page_token
|
1146
|
-
# nextPageToken
|
1147
|
-
#
|
1148
|
-
#
|
1149
|
-
# indicating that the subsequent page of results should be returned.
|
1150
|
-
# The list request
|
1151
|
-
# must be otherwise identical to the one that resulted in this token.
|
1036
|
+
# nextPageToken value returned from a previous list call, indicating that the
|
1037
|
+
# subsequent page of results should be returned. The list request must be
|
1038
|
+
# otherwise identical to the one that resulted in this token.
|
1152
1039
|
# @param [Array<String>, String] states
|
1153
|
-
# Requested submission states. If specified, returned student submissions
|
1154
|
-
#
|
1040
|
+
# Requested submission states. If specified, returned student submissions match
|
1041
|
+
# one of the specified submission states.
|
1155
1042
|
# @param [String] user_id
|
1156
1043
|
# Optional argument to restrict returned student work to those owned by the
|
1157
1044
|
# student with the specified identifier. The identifier can be one of the
|
1158
|
-
# following:
|
1159
|
-
# * the
|
1160
|
-
# * the email address of the user
|
1161
|
-
# * the string literal `"me"`, indicating the requesting user
|
1045
|
+
# following: * the numeric identifier for the user * the email address of the
|
1046
|
+
# user * the string literal `"me"`, indicating the requesting user
|
1162
1047
|
# @param [String] fields
|
1163
1048
|
# Selector specifying which fields to include in a partial response.
|
1164
1049
|
# @param [String] quota_user
|
@@ -1192,24 +1077,19 @@ module Google
|
|
1192
1077
|
execute_or_queue_command(command, &block)
|
1193
1078
|
end
|
1194
1079
|
|
1195
|
-
# Modifies attachments of student submission.
|
1196
|
-
#
|
1197
|
-
#
|
1198
|
-
# This request must be made by the Developer Console project of the
|
1080
|
+
# Modifies attachments of student submission. Attachments may only be added to
|
1081
|
+
# student submissions belonging to course work objects with a `workType` of `
|
1082
|
+
# ASSIGNMENT`. This request must be made by the Developer Console project of the
|
1199
1083
|
# [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to
|
1200
|
-
# create the corresponding course work item.
|
1201
|
-
#
|
1202
|
-
#
|
1203
|
-
#
|
1204
|
-
#
|
1205
|
-
#
|
1206
|
-
# * `INVALID_ARGUMENT` if the request is malformed.
|
1207
|
-
# * `NOT_FOUND` if the requested course, course work, or student submission
|
1208
|
-
# does not exist.
|
1084
|
+
# create the corresponding course work item. This method returns the following
|
1085
|
+
# error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to
|
1086
|
+
# access the requested course or course work, if the user is not permitted to
|
1087
|
+
# modify attachments on the requested student submission, or for access errors. *
|
1088
|
+
# `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the
|
1089
|
+
# requested course, course work, or student submission does not exist.
|
1209
1090
|
# @param [String] course_id
|
1210
|
-
# Identifier of the course.
|
1211
|
-
#
|
1212
|
-
# alias.
|
1091
|
+
# Identifier of the course. This identifier can be either the Classroom-assigned
|
1092
|
+
# identifier or an alias.
|
1213
1093
|
# @param [String] course_work_id
|
1214
1094
|
# Identifier of the course work.
|
1215
1095
|
# @param [String] id
|
@@ -1246,36 +1126,29 @@ module Google
|
|
1246
1126
|
execute_or_queue_command(command, &block)
|
1247
1127
|
end
|
1248
1128
|
|
1249
|
-
# Updates one or more fields of a student submission.
|
1250
|
-
#
|
1251
|
-
#
|
1252
|
-
# This request must be made by the Developer Console project of the
|
1129
|
+
# Updates one or more fields of a student submission. See google.classroom.v1.
|
1130
|
+
# StudentSubmission for details of which fields may be updated and who may
|
1131
|
+
# change them. This request must be made by the Developer Console project of the
|
1253
1132
|
# [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to
|
1254
|
-
# create the corresponding course work item.
|
1255
|
-
#
|
1256
|
-
#
|
1257
|
-
#
|
1258
|
-
#
|
1259
|
-
#
|
1260
|
-
# * `INVALID_ARGUMENT` if the request is malformed.
|
1261
|
-
# * `NOT_FOUND` if the requested course, course work, or student submission
|
1262
|
-
# does not exist.
|
1133
|
+
# create the corresponding course work item. This method returns the following
|
1134
|
+
# error codes: * `PERMISSION_DENIED` if the requesting developer project did not
|
1135
|
+
# create the corresponding course work, if the user is not permitted to make the
|
1136
|
+
# requested modification to the student submission, or for access errors. * `
|
1137
|
+
# INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested
|
1138
|
+
# course, course work, or student submission does not exist.
|
1263
1139
|
# @param [String] course_id
|
1264
|
-
# Identifier of the course.
|
1265
|
-
#
|
1266
|
-
# alias.
|
1140
|
+
# Identifier of the course. This identifier can be either the Classroom-assigned
|
1141
|
+
# identifier or an alias.
|
1267
1142
|
# @param [String] course_work_id
|
1268
1143
|
# Identifier of the course work.
|
1269
1144
|
# @param [String] id
|
1270
1145
|
# Identifier of the student submission.
|
1271
1146
|
# @param [Google::Apis::ClassroomV1::StudentSubmission] student_submission_object
|
1272
1147
|
# @param [String] update_mask
|
1273
|
-
# Mask that identifies which fields on the student submission to update.
|
1274
|
-
#
|
1275
|
-
# fields
|
1276
|
-
#
|
1277
|
-
# * `draft_grade`
|
1278
|
-
# * `assigned_grade`
|
1148
|
+
# Mask that identifies which fields on the student submission to update. This
|
1149
|
+
# field is required to do an update. The update fails if invalid fields are
|
1150
|
+
# specified. The following fields may be specified by teachers: * `draft_grade` *
|
1151
|
+
# `assigned_grade`
|
1279
1152
|
# @param [String] fields
|
1280
1153
|
# Selector specifying which fields to include in a partial response.
|
1281
1154
|
# @param [String] quota_user
|
@@ -1309,25 +1182,21 @@ module Google
|
|
1309
1182
|
end
|
1310
1183
|
|
1311
1184
|
# Reclaims a student submission on behalf of the student that owns it.
|
1312
|
-
# Reclaiming a student submission transfers ownership of attached Drive
|
1313
|
-
#
|
1314
|
-
#
|
1315
|
-
#
|
1316
|
-
#
|
1317
|
-
#
|
1318
|
-
#
|
1319
|
-
#
|
1320
|
-
#
|
1321
|
-
#
|
1322
|
-
#
|
1323
|
-
#
|
1324
|
-
# * `INVALID_ARGUMENT` if the request is malformed.
|
1325
|
-
# * `NOT_FOUND` if the requested course, course work, or student submission
|
1326
|
-
# does not exist.
|
1185
|
+
# Reclaiming a student submission transfers ownership of attached Drive files to
|
1186
|
+
# the student and updates the submission state. Only the student that owns the
|
1187
|
+
# requested student submission may call this method, and only for a student
|
1188
|
+
# submission that has been turned in. This request must be made by the Developer
|
1189
|
+
# Console project of the [OAuth client ID](https://support.google.com/cloud/
|
1190
|
+
# answer/6158849) used to create the corresponding course work item. This method
|
1191
|
+
# returns the following error codes: * `PERMISSION_DENIED` if the requesting
|
1192
|
+
# user is not permitted to access the requested course or course work, unsubmit
|
1193
|
+
# the requested student submission, or for access errors. * `FAILED_PRECONDITION`
|
1194
|
+
# if the student submission has not been turned in. * `INVALID_ARGUMENT` if the
|
1195
|
+
# request is malformed. * `NOT_FOUND` if the requested course, course work, or
|
1196
|
+
# student submission does not exist.
|
1327
1197
|
# @param [String] course_id
|
1328
|
-
# Identifier of the course.
|
1329
|
-
#
|
1330
|
-
# alias.
|
1198
|
+
# Identifier of the course. This identifier can be either the Classroom-assigned
|
1199
|
+
# identifier or an alias.
|
1331
1200
|
# @param [String] course_work_id
|
1332
1201
|
# Identifier of the course work.
|
1333
1202
|
# @param [String] id
|
@@ -1364,27 +1233,22 @@ module Google
|
|
1364
1233
|
execute_or_queue_command(command, &block)
|
1365
1234
|
end
|
1366
1235
|
|
1367
|
-
# Returns a student submission.
|
1368
|
-
#
|
1369
|
-
#
|
1370
|
-
#
|
1371
|
-
#
|
1372
|
-
#
|
1373
|
-
#
|
1374
|
-
#
|
1375
|
-
#
|
1376
|
-
#
|
1377
|
-
#
|
1378
|
-
# * `
|
1379
|
-
#
|
1380
|
-
# or for access errors.
|
1381
|
-
# * `INVALID_ARGUMENT` if the request is malformed.
|
1382
|
-
# * `NOT_FOUND` if the requested course, course work, or student submission
|
1383
|
-
# does not exist.
|
1236
|
+
# Returns a student submission. Returning a student submission transfers
|
1237
|
+
# ownership of attached Drive files to the student and may also update the
|
1238
|
+
# submission state. Unlike the Classroom application, returning a student
|
1239
|
+
# submission does not set assignedGrade to the draftGrade value. Only a teacher
|
1240
|
+
# of the course that contains the requested student submission may call this
|
1241
|
+
# method. This request must be made by the Developer Console project of the [
|
1242
|
+
# OAuth client ID](https://support.google.com/cloud/answer/6158849) used to
|
1243
|
+
# create the corresponding course work item. This method returns the following
|
1244
|
+
# error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to
|
1245
|
+
# access the requested course or course work, return the requested student
|
1246
|
+
# submission, or for access errors. * `INVALID_ARGUMENT` if the request is
|
1247
|
+
# malformed. * `NOT_FOUND` if the requested course, course work, or student
|
1248
|
+
# submission does not exist.
|
1384
1249
|
# @param [String] course_id
|
1385
|
-
# Identifier of the course.
|
1386
|
-
#
|
1387
|
-
# alias.
|
1250
|
+
# Identifier of the course. This identifier can be either the Classroom-assigned
|
1251
|
+
# identifier or an alias.
|
1388
1252
|
# @param [String] course_work_id
|
1389
1253
|
# Identifier of the course work.
|
1390
1254
|
# @param [String] id
|
@@ -1421,25 +1285,20 @@ module Google
|
|
1421
1285
|
execute_or_queue_command(command, &block)
|
1422
1286
|
end
|
1423
1287
|
|
1424
|
-
# Turns in a student submission.
|
1425
|
-
#
|
1426
|
-
#
|
1427
|
-
# This
|
1428
|
-
#
|
1429
|
-
#
|
1430
|
-
#
|
1431
|
-
#
|
1432
|
-
#
|
1433
|
-
#
|
1434
|
-
#
|
1435
|
-
# or for access errors.
|
1436
|
-
# * `INVALID_ARGUMENT` if the request is malformed.
|
1437
|
-
# * `NOT_FOUND` if the requested course, course work, or student submission
|
1438
|
-
# does not exist.
|
1288
|
+
# Turns in a student submission. Turning in a student submission transfers
|
1289
|
+
# ownership of attached Drive files to the teacher and may also update the
|
1290
|
+
# submission state. This may only be called by the student that owns the
|
1291
|
+
# specified student submission. This request must be made by the Developer
|
1292
|
+
# Console project of the [OAuth client ID](https://support.google.com/cloud/
|
1293
|
+
# answer/6158849) used to create the corresponding course work item. This method
|
1294
|
+
# returns the following error codes: * `PERMISSION_DENIED` if the requesting
|
1295
|
+
# user is not permitted to access the requested course or course work, turn in
|
1296
|
+
# the requested student submission, or for access errors. * `INVALID_ARGUMENT`
|
1297
|
+
# if the request is malformed. * `NOT_FOUND` if the requested course, course
|
1298
|
+
# work, or student submission does not exist.
|
1439
1299
|
# @param [String] course_id
|
1440
|
-
# Identifier of the course.
|
1441
|
-
#
|
1442
|
-
# alias.
|
1300
|
+
# Identifier of the course. This identifier can be either the Classroom-assigned
|
1301
|
+
# identifier or an alias.
|
1443
1302
|
# @param [String] course_work_id
|
1444
1303
|
# Identifier of the course work.
|
1445
1304
|
# @param [String] id
|
@@ -1476,28 +1335,22 @@ module Google
|
|
1476
1335
|
execute_or_queue_command(command, &block)
|
1477
1336
|
end
|
1478
1337
|
|
1479
|
-
# Adds a user as a student of a course.
|
1480
|
-
#
|
1481
|
-
#
|
1482
|
-
#
|
1483
|
-
#
|
1484
|
-
# *
|
1485
|
-
#
|
1486
|
-
#
|
1487
|
-
# * CourseNotModifiable
|
1488
|
-
# * UserGroupsMembershipLimitReached
|
1489
|
-
# * `ALREADY_EXISTS` if the user is already a student or teacher in the
|
1490
|
-
# course.
|
1338
|
+
# Adds a user as a student of a course. This method returns the following error
|
1339
|
+
# codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create
|
1340
|
+
# students in this course or for access errors. * `NOT_FOUND` if the requested
|
1341
|
+
# course ID does not exist. * `FAILED_PRECONDITION` if the requested user's
|
1342
|
+
# account is disabled, for the following request errors: *
|
1343
|
+
# CourseMemberLimitReached * CourseNotModifiable *
|
1344
|
+
# UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if the user is already a
|
1345
|
+
# student or teacher in the course.
|
1491
1346
|
# @param [String] course_id
|
1492
|
-
# Identifier of the course to create the student in.
|
1493
|
-
#
|
1494
|
-
# alias.
|
1347
|
+
# Identifier of the course to create the student in. This identifier can be
|
1348
|
+
# either the Classroom-assigned identifier or an alias.
|
1495
1349
|
# @param [Google::Apis::ClassroomV1::Student] student_object
|
1496
1350
|
# @param [String] enrollment_code
|
1497
|
-
# Enrollment code of the course to create the student in.
|
1498
|
-
#
|
1499
|
-
#
|
1500
|
-
# user has administrative permissions to create students for any user.
|
1351
|
+
# Enrollment code of the course to create the student in. This code is required
|
1352
|
+
# if userId corresponds to the requesting user; it may be omitted if the
|
1353
|
+
# requesting user has administrative permissions to create students for any user.
|
1501
1354
|
# @param [String] fields
|
1502
1355
|
# Selector specifying which fields to include in a partial response.
|
1503
1356
|
# @param [String] quota_user
|
@@ -1528,22 +1381,17 @@ module Google
|
|
1528
1381
|
execute_or_queue_command(command, &block)
|
1529
1382
|
end
|
1530
1383
|
|
1531
|
-
# Deletes a student of a course.
|
1532
|
-
#
|
1533
|
-
#
|
1534
|
-
#
|
1535
|
-
# * `NOT_FOUND` if no student of this course has the requested ID or if the
|
1536
|
-
# course does not exist.
|
1384
|
+
# Deletes a student of a course. This method returns the following error codes: *
|
1385
|
+
# `PERMISSION_DENIED` if the requesting user is not permitted to delete
|
1386
|
+
# students of this course or for access errors. * `NOT_FOUND` if no student of
|
1387
|
+
# this course has the requested ID or if the course does not exist.
|
1537
1388
|
# @param [String] course_id
|
1538
|
-
# Identifier of the course.
|
1539
|
-
#
|
1540
|
-
# alias.
|
1389
|
+
# Identifier of the course. This identifier can be either the Classroom-assigned
|
1390
|
+
# identifier or an alias.
|
1541
1391
|
# @param [String] user_id
|
1542
1392
|
# Identifier of the student to delete. The identifier can be one of the
|
1543
|
-
# following:
|
1544
|
-
# * the
|
1545
|
-
# * the email address of the user
|
1546
|
-
# * the string literal `"me"`, indicating the requesting user
|
1393
|
+
# following: * the numeric identifier for the user * the email address of the
|
1394
|
+
# user * the string literal `"me"`, indicating the requesting user
|
1547
1395
|
# @param [String] fields
|
1548
1396
|
# Selector specifying which fields to include in a partial response.
|
1549
1397
|
# @param [String] quota_user
|
@@ -1572,22 +1420,17 @@ module Google
|
|
1572
1420
|
execute_or_queue_command(command, &block)
|
1573
1421
|
end
|
1574
1422
|
|
1575
|
-
# Returns a student of a course.
|
1576
|
-
#
|
1577
|
-
# * `
|
1578
|
-
#
|
1579
|
-
# * `NOT_FOUND` if no student of this course has the requested ID or if the
|
1580
|
-
# course does not exist.
|
1423
|
+
# Returns a student of a course. This method returns the following error codes: *
|
1424
|
+
# `PERMISSION_DENIED` if the requesting user is not permitted to view students
|
1425
|
+
# of this course or for access errors. * `NOT_FOUND` if no student of this
|
1426
|
+
# course has the requested ID or if the course does not exist.
|
1581
1427
|
# @param [String] course_id
|
1582
|
-
# Identifier of the course.
|
1583
|
-
#
|
1584
|
-
# alias.
|
1428
|
+
# Identifier of the course. This identifier can be either the Classroom-assigned
|
1429
|
+
# identifier or an alias.
|
1585
1430
|
# @param [String] user_id
|
1586
1431
|
# Identifier of the student to return. The identifier can be one of the
|
1587
|
-
# following:
|
1588
|
-
# * the
|
1589
|
-
# * the email address of the user
|
1590
|
-
# * the string literal `"me"`, indicating the requesting user
|
1432
|
+
# following: * the numeric identifier for the user * the email address of the
|
1433
|
+
# user * the string literal `"me"`, indicating the requesting user
|
1591
1434
|
# @param [String] fields
|
1592
1435
|
# Selector specifying which fields to include in a partial response.
|
1593
1436
|
# @param [String] quota_user
|
@@ -1616,24 +1459,18 @@ module Google
|
|
1616
1459
|
execute_or_queue_command(command, &block)
|
1617
1460
|
end
|
1618
1461
|
|
1619
|
-
# Returns a list of students of this course that the requester
|
1620
|
-
#
|
1621
|
-
#
|
1622
|
-
# * `NOT_FOUND` if the course does not exist.
|
1623
|
-
# * `PERMISSION_DENIED` for access errors.
|
1462
|
+
# Returns a list of students of this course that the requester is permitted to
|
1463
|
+
# view. This method returns the following error codes: * `NOT_FOUND` if the
|
1464
|
+
# course does not exist. * `PERMISSION_DENIED` for access errors.
|
1624
1465
|
# @param [String] course_id
|
1625
|
-
# Identifier of the course.
|
1626
|
-
#
|
1627
|
-
# alias.
|
1466
|
+
# Identifier of the course. This identifier can be either the Classroom-assigned
|
1467
|
+
# identifier or an alias.
|
1628
1468
|
# @param [Fixnum] page_size
|
1629
1469
|
# Maximum number of items to return. The default is 30 if unspecified or `0`.
|
1630
1470
|
# The server may return fewer than the specified number of results.
|
1631
1471
|
# @param [String] page_token
|
1632
|
-
# nextPageToken
|
1633
|
-
#
|
1634
|
-
# list call, indicating that
|
1635
|
-
# the subsequent page of results should be returned.
|
1636
|
-
# The list request must be
|
1472
|
+
# nextPageToken value returned from a previous list call, indicating that the
|
1473
|
+
# subsequent page of results should be returned. The list request must be
|
1637
1474
|
# otherwise identical to the one that resulted in this token.
|
1638
1475
|
# @param [String] fields
|
1639
1476
|
# Selector specifying which fields to include in a partial response.
|
@@ -1664,23 +1501,17 @@ module Google
|
|
1664
1501
|
execute_or_queue_command(command, &block)
|
1665
1502
|
end
|
1666
1503
|
|
1667
|
-
# Creates a teacher of a course.
|
1668
|
-
#
|
1669
|
-
# * `
|
1670
|
-
#
|
1671
|
-
#
|
1672
|
-
# *
|
1673
|
-
#
|
1674
|
-
#
|
1675
|
-
# * CourseNotModifiable
|
1676
|
-
# * CourseTeacherLimitReached
|
1677
|
-
# * UserGroupsMembershipLimitReached
|
1678
|
-
# * `ALREADY_EXISTS` if the user is already a teacher or student in the
|
1679
|
-
# course.
|
1504
|
+
# Creates a teacher of a course. This method returns the following error codes: *
|
1505
|
+
# `PERMISSION_DENIED` if the requesting user is not permitted to create
|
1506
|
+
# teachers in this course or for access errors. * `NOT_FOUND` if the requested
|
1507
|
+
# course ID does not exist. * `FAILED_PRECONDITION` if the requested user's
|
1508
|
+
# account is disabled, for the following request errors: *
|
1509
|
+
# CourseMemberLimitReached * CourseNotModifiable * CourseTeacherLimitReached *
|
1510
|
+
# UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if the user is already a
|
1511
|
+
# teacher or student in the course.
|
1680
1512
|
# @param [String] course_id
|
1681
|
-
# Identifier of the course.
|
1682
|
-
#
|
1683
|
-
# alias.
|
1513
|
+
# Identifier of the course. This identifier can be either the Classroom-assigned
|
1514
|
+
# identifier or an alias.
|
1684
1515
|
# @param [Google::Apis::ClassroomV1::Teacher] teacher_object
|
1685
1516
|
# @param [String] fields
|
1686
1517
|
# Selector specifying which fields to include in a partial response.
|
@@ -1711,24 +1542,19 @@ module Google
|
|
1711
1542
|
execute_or_queue_command(command, &block)
|
1712
1543
|
end
|
1713
1544
|
|
1714
|
-
# Deletes a teacher of a course.
|
1715
|
-
#
|
1716
|
-
#
|
1717
|
-
#
|
1718
|
-
#
|
1719
|
-
# course
|
1720
|
-
# * `FAILED_PRECONDITION` if the requested ID belongs to the primary teacher
|
1721
|
-
# of this course.
|
1545
|
+
# Deletes a teacher of a course. This method returns the following error codes: *
|
1546
|
+
# `PERMISSION_DENIED` if the requesting user is not permitted to delete
|
1547
|
+
# teachers of this course or for access errors. * `NOT_FOUND` if no teacher of
|
1548
|
+
# this course has the requested ID or if the course does not exist. * `
|
1549
|
+
# FAILED_PRECONDITION` if the requested ID belongs to the primary teacher of
|
1550
|
+
# this course.
|
1722
1551
|
# @param [String] course_id
|
1723
|
-
# Identifier of the course.
|
1724
|
-
#
|
1725
|
-
# alias.
|
1552
|
+
# Identifier of the course. This identifier can be either the Classroom-assigned
|
1553
|
+
# identifier or an alias.
|
1726
1554
|
# @param [String] user_id
|
1727
1555
|
# Identifier of the teacher to delete. The identifier can be one of the
|
1728
|
-
# following:
|
1729
|
-
# * the
|
1730
|
-
# * the email address of the user
|
1731
|
-
# * the string literal `"me"`, indicating the requesting user
|
1556
|
+
# following: * the numeric identifier for the user * the email address of the
|
1557
|
+
# user * the string literal `"me"`, indicating the requesting user
|
1732
1558
|
# @param [String] fields
|
1733
1559
|
# Selector specifying which fields to include in a partial response.
|
1734
1560
|
# @param [String] quota_user
|
@@ -1757,22 +1583,17 @@ module Google
|
|
1757
1583
|
execute_or_queue_command(command, &block)
|
1758
1584
|
end
|
1759
1585
|
|
1760
|
-
# Returns a teacher of a course.
|
1761
|
-
#
|
1762
|
-
# * `
|
1763
|
-
#
|
1764
|
-
# * `NOT_FOUND` if no teacher of this course has the requested ID or if the
|
1765
|
-
# course does not exist.
|
1586
|
+
# Returns a teacher of a course. This method returns the following error codes: *
|
1587
|
+
# `PERMISSION_DENIED` if the requesting user is not permitted to view teachers
|
1588
|
+
# of this course or for access errors. * `NOT_FOUND` if no teacher of this
|
1589
|
+
# course has the requested ID or if the course does not exist.
|
1766
1590
|
# @param [String] course_id
|
1767
|
-
# Identifier of the course.
|
1768
|
-
#
|
1769
|
-
# alias.
|
1591
|
+
# Identifier of the course. This identifier can be either the Classroom-assigned
|
1592
|
+
# identifier or an alias.
|
1770
1593
|
# @param [String] user_id
|
1771
1594
|
# Identifier of the teacher to return. The identifier can be one of the
|
1772
|
-
# following:
|
1773
|
-
# * the
|
1774
|
-
# * the email address of the user
|
1775
|
-
# * the string literal `"me"`, indicating the requesting user
|
1595
|
+
# following: * the numeric identifier for the user * the email address of the
|
1596
|
+
# user * the string literal `"me"`, indicating the requesting user
|
1776
1597
|
# @param [String] fields
|
1777
1598
|
# Selector specifying which fields to include in a partial response.
|
1778
1599
|
# @param [String] quota_user
|
@@ -1801,24 +1622,18 @@ module Google
|
|
1801
1622
|
execute_or_queue_command(command, &block)
|
1802
1623
|
end
|
1803
1624
|
|
1804
|
-
# Returns a list of teachers of this course that the requester
|
1805
|
-
#
|
1806
|
-
#
|
1807
|
-
# * `NOT_FOUND` if the course does not exist.
|
1808
|
-
# * `PERMISSION_DENIED` for access errors.
|
1625
|
+
# Returns a list of teachers of this course that the requester is permitted to
|
1626
|
+
# view. This method returns the following error codes: * `NOT_FOUND` if the
|
1627
|
+
# course does not exist. * `PERMISSION_DENIED` for access errors.
|
1809
1628
|
# @param [String] course_id
|
1810
|
-
# Identifier of the course.
|
1811
|
-
#
|
1812
|
-
# alias.
|
1629
|
+
# Identifier of the course. This identifier can be either the Classroom-assigned
|
1630
|
+
# identifier or an alias.
|
1813
1631
|
# @param [Fixnum] page_size
|
1814
1632
|
# Maximum number of items to return. The default is 30 if unspecified or `0`.
|
1815
1633
|
# The server may return fewer than the specified number of results.
|
1816
1634
|
# @param [String] page_token
|
1817
|
-
# nextPageToken
|
1818
|
-
#
|
1819
|
-
# list call, indicating that
|
1820
|
-
# the subsequent page of results should be returned.
|
1821
|
-
# The list request must be
|
1635
|
+
# nextPageToken value returned from a previous list call, indicating that the
|
1636
|
+
# subsequent page of results should be returned. The list request must be
|
1822
1637
|
# otherwise identical to the one that resulted in this token.
|
1823
1638
|
# @param [String] fields
|
1824
1639
|
# Selector specifying which fields to include in a partial response.
|
@@ -1849,17 +1664,14 @@ module Google
|
|
1849
1664
|
execute_or_queue_command(command, &block)
|
1850
1665
|
end
|
1851
1666
|
|
1852
|
-
# Creates a topic.
|
1853
|
-
#
|
1854
|
-
#
|
1855
|
-
#
|
1856
|
-
#
|
1857
|
-
# * `INVALID_ARGUMENT` if the request is malformed.
|
1858
|
-
# * `NOT_FOUND` if the requested course does not exist.
|
1667
|
+
# Creates a topic. This method returns the following error codes: * `
|
1668
|
+
# PERMISSION_DENIED` if the requesting user is not permitted to access the
|
1669
|
+
# requested course, create a topic in the requested course, or for access errors.
|
1670
|
+
# * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the
|
1671
|
+
# requested course does not exist.
|
1859
1672
|
# @param [String] course_id
|
1860
|
-
# Identifier of the course.
|
1861
|
-
#
|
1862
|
-
# alias.
|
1673
|
+
# Identifier of the course. This identifier can be either the Classroom-assigned
|
1674
|
+
# identifier or an alias.
|
1863
1675
|
# @param [Google::Apis::ClassroomV1::Topic] topic_object
|
1864
1676
|
# @param [String] fields
|
1865
1677
|
# Selector specifying which fields to include in a partial response.
|
@@ -1890,17 +1702,14 @@ module Google
|
|
1890
1702
|
execute_or_queue_command(command, &block)
|
1891
1703
|
end
|
1892
1704
|
|
1893
|
-
# Deletes a topic.
|
1894
|
-
#
|
1895
|
-
#
|
1896
|
-
#
|
1897
|
-
#
|
1898
|
-
# deleted.
|
1899
|
-
# * `NOT_FOUND` if no course or topic exists with the requested ID.
|
1705
|
+
# Deletes a topic. This method returns the following error codes: * `
|
1706
|
+
# PERMISSION_DENIED` if the requesting user is not allowed to delete the
|
1707
|
+
# requested topic or for access errors. * `FAILED_PRECONDITION` if the requested
|
1708
|
+
# topic has already been deleted. * `NOT_FOUND` if no course or topic exists
|
1709
|
+
# with the requested ID.
|
1900
1710
|
# @param [String] course_id
|
1901
|
-
# Identifier of the course.
|
1902
|
-
#
|
1903
|
-
# alias.
|
1711
|
+
# Identifier of the course. This identifier can be either the Classroom-assigned
|
1712
|
+
# identifier or an alias.
|
1904
1713
|
# @param [String] id
|
1905
1714
|
# Identifier of the topic to delete.
|
1906
1715
|
# @param [String] fields
|
@@ -1931,12 +1740,11 @@ module Google
|
|
1931
1740
|
execute_or_queue_command(command, &block)
|
1932
1741
|
end
|
1933
1742
|
|
1934
|
-
# Returns a topic.
|
1935
|
-
#
|
1936
|
-
#
|
1937
|
-
# requested course or topic
|
1938
|
-
#
|
1939
|
-
# * `NOT_FOUND` if the requested course or topic does not exist.
|
1743
|
+
# Returns a topic. This method returns the following error codes: * `
|
1744
|
+
# PERMISSION_DENIED` if the requesting user is not permitted to access the
|
1745
|
+
# requested course or topic, or for access errors. * `INVALID_ARGUMENT` if the
|
1746
|
+
# request is malformed. * `NOT_FOUND` if the requested course or topic does not
|
1747
|
+
# exist.
|
1940
1748
|
# @param [String] course_id
|
1941
1749
|
# Identifier of the course.
|
1942
1750
|
# @param [String] id
|
@@ -1969,27 +1777,22 @@ module Google
|
|
1969
1777
|
execute_or_queue_command(command, &block)
|
1970
1778
|
end
|
1971
1779
|
|
1972
|
-
# Returns the list of topics that the requester is permitted to view.
|
1973
|
-
#
|
1974
|
-
#
|
1975
|
-
# the
|
1976
|
-
#
|
1977
|
-
# * `NOT_FOUND` if the requested course does not exist.
|
1780
|
+
# Returns the list of topics that the requester is permitted to view. This
|
1781
|
+
# method returns the following error codes: * `PERMISSION_DENIED` if the
|
1782
|
+
# requesting user is not permitted to access the requested course or for access
|
1783
|
+
# errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the
|
1784
|
+
# requested course does not exist.
|
1978
1785
|
# @param [String] course_id
|
1979
|
-
# Identifier of the course.
|
1980
|
-
#
|
1981
|
-
# alias.
|
1786
|
+
# Identifier of the course. This identifier can be either the Classroom-assigned
|
1787
|
+
# identifier or an alias.
|
1982
1788
|
# @param [Fixnum] page_size
|
1983
1789
|
# Maximum number of items to return. Zero or unspecified indicates that the
|
1984
|
-
# server may assign a maximum.
|
1985
|
-
#
|
1790
|
+
# server may assign a maximum. The server may return fewer than the specified
|
1791
|
+
# number of results.
|
1986
1792
|
# @param [String] page_token
|
1987
|
-
# nextPageToken
|
1988
|
-
#
|
1989
|
-
#
|
1990
|
-
# indicating that the subsequent page of results should be returned.
|
1991
|
-
# The list request
|
1992
|
-
# must be otherwise identical to the one that resulted in this token.
|
1793
|
+
# nextPageToken value returned from a previous list call, indicating that the
|
1794
|
+
# subsequent page of results should be returned. The list request must be
|
1795
|
+
# otherwise identical to the one that resulted in this token.
|
1993
1796
|
# @param [String] fields
|
1994
1797
|
# Selector specifying which fields to include in a partial response.
|
1995
1798
|
# @param [String] quota_user
|
@@ -2019,28 +1822,24 @@ module Google
|
|
2019
1822
|
execute_or_queue_command(command, &block)
|
2020
1823
|
end
|
2021
1824
|
|
2022
|
-
# Updates one or more fields of a topic.
|
2023
|
-
#
|
2024
|
-
#
|
2025
|
-
# the
|
2026
|
-
#
|
2027
|
-
# * `NOT_FOUND` if the requested course or topic does not exist
|
1825
|
+
# Updates one or more fields of a topic. This method returns the following error
|
1826
|
+
# codes: * `PERMISSION_DENIED` if the requesting developer project did not
|
1827
|
+
# create the corresponding topic or for access errors. * `INVALID_ARGUMENT` if
|
1828
|
+
# the request is malformed. * `NOT_FOUND` if the requested course or topic does
|
1829
|
+
# not exist
|
2028
1830
|
# @param [String] course_id
|
2029
|
-
# Identifier of the course.
|
2030
|
-
#
|
2031
|
-
# alias.
|
1831
|
+
# Identifier of the course. This identifier can be either the Classroom-assigned
|
1832
|
+
# identifier or an alias.
|
2032
1833
|
# @param [String] id
|
2033
1834
|
# Identifier of the topic.
|
2034
1835
|
# @param [Google::Apis::ClassroomV1::Topic] topic_object
|
2035
1836
|
# @param [String] update_mask
|
2036
|
-
# Mask that identifies which fields on the topic to update.
|
2037
|
-
#
|
2038
|
-
#
|
2039
|
-
#
|
2040
|
-
#
|
2041
|
-
#
|
2042
|
-
# returned.
|
2043
|
-
# The following fields may be specified:
|
1837
|
+
# Mask that identifies which fields on the topic to update. This field is
|
1838
|
+
# required to do an update. The update fails if invalid fields are specified. If
|
1839
|
+
# a field supports empty values, it can be cleared by specifying it in the
|
1840
|
+
# update mask and not in the Topic object. If a field that does not support
|
1841
|
+
# empty values is included in the update mask and not set in the Topic object,
|
1842
|
+
# an `INVALID_ARGUMENT` error is returned. The following fields may be specified:
|
2044
1843
|
# * `name`
|
2045
1844
|
# @param [String] fields
|
2046
1845
|
# Selector specifying which fields to include in a partial response.
|
@@ -2073,18 +1872,14 @@ module Google
|
|
2073
1872
|
execute_or_queue_command(command, &block)
|
2074
1873
|
end
|
2075
1874
|
|
2076
|
-
# Accepts an invitation, removing it and adding the invited user to the
|
2077
|
-
#
|
2078
|
-
#
|
2079
|
-
#
|
2080
|
-
#
|
2081
|
-
#
|
2082
|
-
# * `
|
2083
|
-
#
|
2084
|
-
# * CourseNotModifiable
|
2085
|
-
# * CourseTeacherLimitReached
|
2086
|
-
# * UserGroupsMembershipLimitReached
|
2087
|
-
# * `NOT_FOUND` if no invitation exists with the requested ID.
|
1875
|
+
# Accepts an invitation, removing it and adding the invited user to the teachers
|
1876
|
+
# or students (as appropriate) of the specified course. Only the invited user
|
1877
|
+
# may accept an invitation. This method returns the following error codes: * `
|
1878
|
+
# PERMISSION_DENIED` if the requesting user is not permitted to accept the
|
1879
|
+
# requested invitation or for access errors. * `FAILED_PRECONDITION` for the
|
1880
|
+
# following request errors: * CourseMemberLimitReached * CourseNotModifiable *
|
1881
|
+
# CourseTeacherLimitReached * UserGroupsMembershipLimitReached * `NOT_FOUND` if
|
1882
|
+
# no invitation exists with the requested ID.
|
2088
1883
|
# @param [String] id
|
2089
1884
|
# Identifier of the invitation to accept.
|
2090
1885
|
# @param [String] fields
|
@@ -2114,16 +1909,15 @@ module Google
|
|
2114
1909
|
execute_or_queue_command(command, &block)
|
2115
1910
|
end
|
2116
1911
|
|
2117
|
-
# Creates an invitation. Only one invitation for a user and course may exist
|
2118
|
-
#
|
2119
|
-
#
|
2120
|
-
#
|
2121
|
-
#
|
2122
|
-
#
|
2123
|
-
#
|
2124
|
-
#
|
2125
|
-
#
|
2126
|
-
# already exists.
|
1912
|
+
# Creates an invitation. Only one invitation for a user and course may exist at
|
1913
|
+
# a time. Delete and re-create an invitation to make changes. This method
|
1914
|
+
# returns the following error codes: * `PERMISSION_DENIED` if the requesting
|
1915
|
+
# user is not permitted to create invitations for this course or for access
|
1916
|
+
# errors. * `NOT_FOUND` if the course or the user does not exist. * `
|
1917
|
+
# FAILED_PRECONDITION` if the requested user's account is disabled or if the
|
1918
|
+
# user already has this role or a role with greater permissions. * `
|
1919
|
+
# ALREADY_EXISTS` if an invitation for the specified user and course already
|
1920
|
+
# exists.
|
2127
1921
|
# @param [Google::Apis::ClassroomV1::Invitation] invitation_object
|
2128
1922
|
# @param [String] fields
|
2129
1923
|
# Selector specifying which fields to include in a partial response.
|
@@ -2153,11 +1947,10 @@ module Google
|
|
2153
1947
|
execute_or_queue_command(command, &block)
|
2154
1948
|
end
|
2155
1949
|
|
2156
|
-
# Deletes an invitation.
|
2157
|
-
#
|
2158
|
-
#
|
2159
|
-
#
|
2160
|
-
# * `NOT_FOUND` if no invitation exists with the requested ID.
|
1950
|
+
# Deletes an invitation. This method returns the following error codes: * `
|
1951
|
+
# PERMISSION_DENIED` if the requesting user is not permitted to delete the
|
1952
|
+
# requested invitation or for access errors. * `NOT_FOUND` if no invitation
|
1953
|
+
# exists with the requested ID.
|
2161
1954
|
# @param [String] id
|
2162
1955
|
# Identifier of the invitation to delete.
|
2163
1956
|
# @param [String] fields
|
@@ -2187,11 +1980,10 @@ module Google
|
|
2187
1980
|
execute_or_queue_command(command, &block)
|
2188
1981
|
end
|
2189
1982
|
|
2190
|
-
# Returns an invitation.
|
2191
|
-
#
|
2192
|
-
#
|
2193
|
-
#
|
2194
|
-
# * `NOT_FOUND` if no invitation exists with the requested ID.
|
1983
|
+
# Returns an invitation. This method returns the following error codes: * `
|
1984
|
+
# PERMISSION_DENIED` if the requesting user is not permitted to view the
|
1985
|
+
# requested invitation or for access errors. * `NOT_FOUND` if no invitation
|
1986
|
+
# exists with the requested ID.
|
2195
1987
|
# @param [String] id
|
2196
1988
|
# Identifier of the invitation to return.
|
2197
1989
|
# @param [String] fields
|
@@ -2221,32 +2013,26 @@ module Google
|
|
2221
2013
|
execute_or_queue_command(command, &block)
|
2222
2014
|
end
|
2223
2015
|
|
2224
|
-
# Returns a list of invitations that the requesting user is permitted to
|
2225
|
-
#
|
2226
|
-
#
|
2227
|
-
#
|
2228
|
-
#
|
2229
|
-
# * `PERMISSION_DENIED` for access errors.
|
2016
|
+
# Returns a list of invitations that the requesting user is permitted to view,
|
2017
|
+
# restricted to those that match the list request. *Note:* At least one of `
|
2018
|
+
# user_id` or `course_id` must be supplied. Both fields can be supplied. This
|
2019
|
+
# method returns the following error codes: * `PERMISSION_DENIED` for access
|
2020
|
+
# errors.
|
2230
2021
|
# @param [String] course_id
|
2231
2022
|
# Restricts returned invitations to those for a course with the specified
|
2232
2023
|
# identifier.
|
2233
2024
|
# @param [Fixnum] page_size
|
2234
|
-
# Maximum number of items to return. The default is 500 if unspecified or
|
2235
|
-
# `0`.
|
2025
|
+
# Maximum number of items to return. The default is 500 if unspecified or `0`.
|
2236
2026
|
# The server may return fewer than the specified number of results.
|
2237
2027
|
# @param [String] page_token
|
2238
|
-
# nextPageToken
|
2239
|
-
#
|
2240
|
-
# list call, indicating
|
2241
|
-
# that the subsequent page of results should be returned.
|
2242
|
-
# The list request must be
|
2028
|
+
# nextPageToken value returned from a previous list call, indicating that the
|
2029
|
+
# subsequent page of results should be returned. The list request must be
|
2243
2030
|
# otherwise identical to the one that resulted in this token.
|
2244
2031
|
# @param [String] user_id
|
2245
2032
|
# Restricts returned invitations to those for a specific user. The identifier
|
2246
|
-
# can be one of the following:
|
2247
|
-
# * the
|
2248
|
-
#
|
2249
|
-
# * the string literal `"me"`, indicating the requesting user
|
2033
|
+
# can be one of the following: * the numeric identifier for the user * the email
|
2034
|
+
# address of the user * the string literal `"me"`, indicating the requesting
|
2035
|
+
# user
|
2250
2036
|
# @param [String] fields
|
2251
2037
|
# Selector specifying which fields to include in a partial response.
|
2252
2038
|
# @param [String] quota_user
|
@@ -2279,33 +2065,25 @@ module Google
|
|
2279
2065
|
|
2280
2066
|
# Creates a `Registration`, causing Classroom to start sending notifications
|
2281
2067
|
# from the provided `feed` to the destination provided in `cloudPubSubTopic`.
|
2282
|
-
# Returns the created `Registration`. Currently, this will be the same as
|
2283
|
-
#
|
2284
|
-
# `id`
|
2285
|
-
#
|
2286
|
-
#
|
2287
|
-
#
|
2288
|
-
#
|
2289
|
-
#
|
2290
|
-
#
|
2291
|
-
#
|
2292
|
-
#
|
2293
|
-
#
|
2294
|
-
#
|
2295
|
-
#
|
2296
|
-
#
|
2297
|
-
#
|
2298
|
-
#
|
2299
|
-
# *
|
2300
|
-
#
|
2301
|
-
# * no `cloudPubsubTopic` is specified, or the specified
|
2302
|
-
# `cloudPubsubTopic` is not valid; or
|
2303
|
-
# * no `feed` is specified, or the specified `feed` is not valid.
|
2304
|
-
# * `NOT_FOUND` if:
|
2305
|
-
# * the specified `feed` cannot be located, or the requesting user does
|
2306
|
-
# not have permission to determine whether or not it exists; or
|
2307
|
-
# * the specified `cloudPubsubTopic` cannot be located, or Classroom has
|
2308
|
-
# not been granted permission to publish to it.
|
2068
|
+
# Returns the created `Registration`. Currently, this will be the same as the
|
2069
|
+
# argument, but with server-assigned fields such as `expiry_time` and `id`
|
2070
|
+
# filled in. Note that any value specified for the `expiry_time` or `id` fields
|
2071
|
+
# will be ignored. While Classroom may validate the `cloudPubSubTopic` and
|
2072
|
+
# return errors on a best effort basis, it is the caller's responsibility to
|
2073
|
+
# ensure that it exists and that Classroom has permission to publish to it. This
|
2074
|
+
# method may return the following error codes: * `PERMISSION_DENIED` if: * the
|
2075
|
+
# authenticated user does not have permission to receive notifications from the
|
2076
|
+
# requested field; or * the current user has not granted access to the current
|
2077
|
+
# Cloud project with the appropriate scope for the requested feed. Note that
|
2078
|
+
# domain-wide delegation of authority is not currently supported for this
|
2079
|
+
# purpose. If the request has the appropriate scope, but no grant exists, a
|
2080
|
+
# Request Errors is returned. * another access error is encountered. * `
|
2081
|
+
# INVALID_ARGUMENT` if: * no `cloudPubsubTopic` is specified, or the specified `
|
2082
|
+
# cloudPubsubTopic` is not valid; or * no `feed` is specified, or the specified `
|
2083
|
+
# feed` is not valid. * `NOT_FOUND` if: * the specified `feed` cannot be located,
|
2084
|
+
# or the requesting user does not have permission to determine whether or not
|
2085
|
+
# it exists; or * the specified `cloudPubsubTopic` cannot be located, or
|
2086
|
+
# Classroom has not been granted permission to publish to it.
|
2309
2087
|
# @param [Google::Apis::ClassroomV1::Registration] registration_object
|
2310
2088
|
# @param [String] fields
|
2311
2089
|
# Selector specifying which fields to include in a partial response.
|
@@ -2335,8 +2113,8 @@ module Google
|
|
2335
2113
|
execute_or_queue_command(command, &block)
|
2336
2114
|
end
|
2337
2115
|
|
2338
|
-
# Deletes a `Registration`, causing Classroom to stop sending notifications
|
2339
|
-
#
|
2116
|
+
# Deletes a `Registration`, causing Classroom to stop sending notifications for
|
2117
|
+
# that `Registration`.
|
2340
2118
|
# @param [String] registration_id
|
2341
2119
|
# The `registration_id` of the `Registration` to be deleted.
|
2342
2120
|
# @param [String] fields
|
@@ -2366,17 +2144,13 @@ module Google
|
|
2366
2144
|
execute_or_queue_command(command, &block)
|
2367
2145
|
end
|
2368
2146
|
|
2369
|
-
# Returns a user profile.
|
2370
|
-
#
|
2371
|
-
#
|
2372
|
-
# this user profile, if no profile exists with the requested ID, or for
|
2373
|
-
# access errors.
|
2147
|
+
# Returns a user profile. This method returns the following error codes: * `
|
2148
|
+
# PERMISSION_DENIED` if the requesting user is not permitted to access this user
|
2149
|
+
# profile, if no profile exists with the requested ID, or for access errors.
|
2374
2150
|
# @param [String] user_id
|
2375
2151
|
# Identifier of the profile to return. The identifier can be one of the
|
2376
|
-
# following:
|
2377
|
-
# * the
|
2378
|
-
# * the email address of the user
|
2379
|
-
# * the string literal `"me"`, indicating the requesting user
|
2152
|
+
# following: * the numeric identifier for the user * the email address of the
|
2153
|
+
# user * the string literal `"me"`, indicating the requesting user
|
2380
2154
|
# @param [String] fields
|
2381
2155
|
# Selector specifying which fields to include in a partial response.
|
2382
2156
|
# @param [String] quota_user
|
@@ -2404,32 +2178,28 @@ module Google
|
|
2404
2178
|
execute_or_queue_command(command, &block)
|
2405
2179
|
end
|
2406
2180
|
|
2407
|
-
# Creates a guardian invitation, and sends an email to the guardian asking
|
2408
|
-
#
|
2409
|
-
#
|
2410
|
-
# `
|
2411
|
-
#
|
2412
|
-
#
|
2413
|
-
#
|
2414
|
-
#
|
2415
|
-
#
|
2416
|
-
#
|
2417
|
-
#
|
2418
|
-
#
|
2419
|
-
#
|
2420
|
-
# * `RESOURCE_EXHAUSTED` if the student or guardian has exceeded the guardian
|
2421
|
-
# link limit.
|
2422
|
-
# * `INVALID_ARGUMENT` if the guardian email address is not valid (for
|
2181
|
+
# Creates a guardian invitation, and sends an email to the guardian asking them
|
2182
|
+
# to confirm that they are the student's guardian. Once the guardian accepts the
|
2183
|
+
# invitation, their `state` will change to `COMPLETED` and they will start
|
2184
|
+
# receiving guardian notifications. A `Guardian` resource will also be created
|
2185
|
+
# to represent the active guardian. The request object must have the `student_id`
|
2186
|
+
# and `invited_email_address` fields set. Failing to set these fields, or
|
2187
|
+
# setting any other fields in the request, will result in an error. This method
|
2188
|
+
# returns the following error codes: * `PERMISSION_DENIED` if the current user
|
2189
|
+
# does not have permission to manage guardians, if the guardian in question has
|
2190
|
+
# already rejected too many requests for that student, if guardians are not
|
2191
|
+
# enabled for the domain in question, or for other access errors. * `
|
2192
|
+
# RESOURCE_EXHAUSTED` if the student or guardian has exceeded the guardian link
|
2193
|
+
# limit. * `INVALID_ARGUMENT` if the guardian email address is not valid (for
|
2423
2194
|
# example, if it is too long), or if the format of the student ID provided
|
2424
|
-
# cannot be recognized (it is not an email address, nor a `user_id` from
|
2425
|
-
#
|
2426
|
-
#
|
2427
|
-
#
|
2428
|
-
#
|
2429
|
-
#
|
2430
|
-
#
|
2431
|
-
#
|
2432
|
-
# `Guardian` for this user.
|
2195
|
+
# cannot be recognized (it is not an email address, nor a `user_id` from this
|
2196
|
+
# API). This error will also be returned if read-only fields are set, or if the `
|
2197
|
+
# state` field is set to to a value other than `PENDING`. * `NOT_FOUND` if the
|
2198
|
+
# student ID provided is a valid student ID, but Classroom has no record of that
|
2199
|
+
# student. * `ALREADY_EXISTS` if there is already a pending guardian invitation
|
2200
|
+
# for the student and `invited_email_address` provided, or if the provided `
|
2201
|
+
# invited_email_address` matches the Google account of an existing `Guardian`
|
2202
|
+
# for this user.
|
2433
2203
|
# @param [String] student_id
|
2434
2204
|
# ID of the student (in standard format)
|
2435
2205
|
# @param [Google::Apis::ClassroomV1::GuardianInvitation] guardian_invitation_object
|
@@ -2462,18 +2232,16 @@ module Google
|
|
2462
2232
|
execute_or_queue_command(command, &block)
|
2463
2233
|
end
|
2464
2234
|
|
2465
|
-
# Returns a specific guardian invitation.
|
2466
|
-
#
|
2467
|
-
#
|
2468
|
-
#
|
2469
|
-
#
|
2470
|
-
#
|
2471
|
-
#
|
2472
|
-
#
|
2473
|
-
#
|
2474
|
-
#
|
2475
|
-
# `invitation_id`. May also be returned if the student exists, but the
|
2476
|
-
# requesting user does not have access to see that student.
|
2235
|
+
# Returns a specific guardian invitation. This method returns the following
|
2236
|
+
# error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to
|
2237
|
+
# view guardian invitations for the student identified by the `student_id`, if
|
2238
|
+
# guardians are not enabled for the domain in question, or for other access
|
2239
|
+
# errors. * `INVALID_ARGUMENT` if a `student_id` is specified, but its format
|
2240
|
+
# cannot be recognized (it is not an email address, nor a `student_id` from the
|
2241
|
+
# API, nor the literal string `me`). * `NOT_FOUND` if Classroom cannot find any
|
2242
|
+
# record of the given student or `invitation_id`. May also be returned if the
|
2243
|
+
# student exists, but the requesting user does not have access to see that
|
2244
|
+
# student.
|
2477
2245
|
# @param [String] student_id
|
2478
2246
|
# The ID of the student whose guardian invitation is being requested.
|
2479
2247
|
# @param [String] invitation_id
|
@@ -2506,46 +2274,39 @@ module Google
|
|
2506
2274
|
execute_or_queue_command(command, &block)
|
2507
2275
|
end
|
2508
2276
|
|
2509
|
-
# Returns a list of guardian invitations that the requesting user is
|
2510
|
-
#
|
2511
|
-
#
|
2512
|
-
#
|
2513
|
-
#
|
2514
|
-
#
|
2515
|
-
#
|
2516
|
-
#
|
2517
|
-
#
|
2518
|
-
#
|
2519
|
-
#
|
2520
|
-
#
|
2521
|
-
# * `NOT_FOUND` if a `student_id` is specified, and its format can be
|
2522
|
-
# recognized, but Classroom has no record of that student.
|
2277
|
+
# Returns a list of guardian invitations that the requesting user is permitted
|
2278
|
+
# to view, filtered by the parameters provided. This method returns the
|
2279
|
+
# following error codes: * `PERMISSION_DENIED` if a `student_id` is specified,
|
2280
|
+
# and the requesting user is not permitted to view guardian invitations for that
|
2281
|
+
# student, if `"-"` is specified as the `student_id` and the user is not a
|
2282
|
+
# domain administrator, if guardians are not enabled for the domain in question,
|
2283
|
+
# or for other access errors. * `INVALID_ARGUMENT` if a `student_id` is
|
2284
|
+
# specified, but its format cannot be recognized (it is not an email address,
|
2285
|
+
# nor a `student_id` from the API, nor the literal string `me`). May also be
|
2286
|
+
# returned if an invalid `page_token` or `state` is provided. * `NOT_FOUND` if a
|
2287
|
+
# `student_id` is specified, and its format can be recognized, but Classroom has
|
2288
|
+
# no record of that student.
|
2523
2289
|
# @param [String] student_id
|
2524
|
-
# The ID of the student whose guardian invitations are to be returned.
|
2525
|
-
#
|
2526
|
-
# * the
|
2527
|
-
# * the
|
2528
|
-
#
|
2529
|
-
#
|
2530
|
-
# all students that the requesting user is permitted to view guardian
|
2531
|
-
# invitations.
|
2290
|
+
# The ID of the student whose guardian invitations are to be returned. The
|
2291
|
+
# identifier can be one of the following: * the numeric identifier for the user *
|
2292
|
+
# the email address of the user * the string literal `"me"`, indicating the
|
2293
|
+
# requesting user * the string literal `"-"`, indicating that results should be
|
2294
|
+
# returned for all students that the requesting user is permitted to view
|
2295
|
+
# guardian invitations.
|
2532
2296
|
# @param [String] invited_email_address
|
2533
|
-
# If specified, only results with the specified `invited_email_address`
|
2534
|
-
#
|
2297
|
+
# If specified, only results with the specified `invited_email_address` are
|
2298
|
+
# returned.
|
2535
2299
|
# @param [Fixnum] page_size
|
2536
2300
|
# Maximum number of items to return. Zero or unspecified indicates that the
|
2537
|
-
# server may assign a maximum.
|
2538
|
-
#
|
2301
|
+
# server may assign a maximum. The server may return fewer than the specified
|
2302
|
+
# number of results.
|
2539
2303
|
# @param [String] page_token
|
2540
|
-
# nextPageToken
|
2541
|
-
#
|
2542
|
-
#
|
2543
|
-
# call, indicating that the subsequent page of results should be returned.
|
2544
|
-
# The list
|
2545
|
-
# request must be otherwise identical to the one that resulted in this token.
|
2304
|
+
# nextPageToken value returned from a previous list call, indicating that the
|
2305
|
+
# subsequent page of results should be returned. The list request must be
|
2306
|
+
# otherwise identical to the one that resulted in this token.
|
2546
2307
|
# @param [Array<String>, String] states
|
2547
|
-
# If specified, only results with the specified `state` values are
|
2548
|
-
#
|
2308
|
+
# If specified, only results with the specified `state` values are returned.
|
2309
|
+
# Otherwise, results with a `state` of `PENDING` are returned.
|
2549
2310
|
# @param [String] fields
|
2550
2311
|
# Selector specifying which fields to include in a partial response.
|
2551
2312
|
# @param [String] quota_user
|
@@ -2577,33 +2338,29 @@ module Google
|
|
2577
2338
|
execute_or_queue_command(command, &block)
|
2578
2339
|
end
|
2579
2340
|
|
2580
|
-
# Modifies a guardian invitation.
|
2581
|
-
#
|
2582
|
-
#
|
2583
|
-
#
|
2584
|
-
#
|
2585
|
-
#
|
2586
|
-
#
|
2587
|
-
#
|
2588
|
-
#
|
2589
|
-
#
|
2590
|
-
#
|
2591
|
-
#
|
2592
|
-
#
|
2593
|
-
# Classroom has no record of that student, or if the `id` field does not
|
2594
|
-
# refer to a guardian invitation known to Classroom.
|
2341
|
+
# Modifies a guardian invitation. Currently, the only valid modification is to
|
2342
|
+
# change the `state` from `PENDING` to `COMPLETE`. This has the effect of
|
2343
|
+
# withdrawing the invitation. This method returns the following error codes: * `
|
2344
|
+
# PERMISSION_DENIED` if the current user does not have permission to manage
|
2345
|
+
# guardians, if guardians are not enabled for the domain in question or for
|
2346
|
+
# other access errors. * `FAILED_PRECONDITION` if the guardian link is not in
|
2347
|
+
# the `PENDING` state. * `INVALID_ARGUMENT` if the format of the student ID
|
2348
|
+
# provided cannot be recognized (it is not an email address, nor a `user_id`
|
2349
|
+
# from this API), or if the passed `GuardianInvitation` has a `state` other than
|
2350
|
+
# `COMPLETE`, or if it modifies fields other than `state`. * `NOT_FOUND` if the
|
2351
|
+
# student ID provided is a valid student ID, but Classroom has no record of that
|
2352
|
+
# student, or if the `id` field does not refer to a guardian invitation known to
|
2353
|
+
# Classroom.
|
2595
2354
|
# @param [String] student_id
|
2596
2355
|
# The ID of the student whose guardian invitation is to be modified.
|
2597
2356
|
# @param [String] invitation_id
|
2598
2357
|
# The `id` field of the `GuardianInvitation` to be modified.
|
2599
2358
|
# @param [Google::Apis::ClassroomV1::GuardianInvitation] guardian_invitation_object
|
2600
2359
|
# @param [String] update_mask
|
2601
|
-
# Mask that identifies which fields on the course to update.
|
2602
|
-
#
|
2603
|
-
#
|
2604
|
-
#
|
2605
|
-
# When set in a query parameter, this field should be specified as
|
2606
|
-
# `updateMask=<field1>,<field2>,...`
|
2360
|
+
# Mask that identifies which fields on the course to update. This field is
|
2361
|
+
# required to do an update. The update fails if invalid fields are specified.
|
2362
|
+
# The following fields are valid: * `state` When set in a query parameter, this
|
2363
|
+
# field should be specified as `updateMask=,,...`
|
2607
2364
|
# @param [String] fields
|
2608
2365
|
# Selector specifying which fields to include in a partial response.
|
2609
2366
|
# @param [String] quota_user
|
@@ -2635,26 +2392,21 @@ module Google
|
|
2635
2392
|
execute_or_queue_command(command, &block)
|
2636
2393
|
end
|
2637
2394
|
|
2638
|
-
# Deletes a guardian.
|
2639
|
-
#
|
2640
|
-
#
|
2641
|
-
#
|
2642
|
-
#
|
2643
|
-
#
|
2644
|
-
#
|
2645
|
-
#
|
2646
|
-
#
|
2647
|
-
#
|
2648
|
-
#
|
2649
|
-
# API).
|
2650
|
-
# * `NOT_FOUND` if the requesting user is permitted to modify guardians for
|
2651
|
-
# the requested `student_id`, but no `Guardian` record exists for that
|
2652
|
-
# student with the provided `guardian_id`.
|
2395
|
+
# Deletes a guardian. The guardian will no longer receive guardian notifications
|
2396
|
+
# and the guardian will no longer be accessible via the API. This method returns
|
2397
|
+
# the following error codes: * `PERMISSION_DENIED` if no user that matches the
|
2398
|
+
# provided `student_id` is visible to the requesting user, if the requesting
|
2399
|
+
# user is not permitted to manage guardians for the student identified by the `
|
2400
|
+
# student_id`, if guardians are not enabled for the domain in question, or for
|
2401
|
+
# other access errors. * `INVALID_ARGUMENT` if a `student_id` is specified, but
|
2402
|
+
# its format cannot be recognized (it is not an email address, nor a `student_id`
|
2403
|
+
# from the API). * `NOT_FOUND` if the requesting user is permitted to modify
|
2404
|
+
# guardians for the requested `student_id`, but no `Guardian` record exists for
|
2405
|
+
# that student with the provided `guardian_id`.
|
2653
2406
|
# @param [String] student_id
|
2654
|
-
# The student whose guardian is to be deleted. One of the following:
|
2655
|
-
# * the
|
2656
|
-
#
|
2657
|
-
# * the string literal `"me"`, indicating the requesting user
|
2407
|
+
# The student whose guardian is to be deleted. One of the following: * the
|
2408
|
+
# numeric identifier for the user * the email address of the user * the string
|
2409
|
+
# literal `"me"`, indicating the requesting user
|
2658
2410
|
# @param [String] guardian_id
|
2659
2411
|
# The `id` field from a `Guardian`.
|
2660
2412
|
# @param [String] fields
|
@@ -2685,24 +2437,20 @@ module Google
|
|
2685
2437
|
execute_or_queue_command(command, &block)
|
2686
2438
|
end
|
2687
2439
|
|
2688
|
-
# Returns a specific guardian.
|
2689
|
-
#
|
2690
|
-
#
|
2691
|
-
#
|
2692
|
-
#
|
2693
|
-
# `
|
2694
|
-
#
|
2695
|
-
#
|
2696
|
-
#
|
2697
|
-
#
|
2698
|
-
# * `NOT_FOUND` if the requesting user is permitted to view guardians for
|
2699
|
-
# the requested `student_id`, but no `Guardian` record exists for that
|
2700
|
-
# student that matches the provided `guardian_id`.
|
2440
|
+
# Returns a specific guardian. This method returns the following error codes: * `
|
2441
|
+
# PERMISSION_DENIED` if no user that matches the provided `student_id` is
|
2442
|
+
# visible to the requesting user, if the requesting user is not permitted to
|
2443
|
+
# view guardian information for the student identified by the `student_id`, if
|
2444
|
+
# guardians are not enabled for the domain in question, or for other access
|
2445
|
+
# errors. * `INVALID_ARGUMENT` if a `student_id` is specified, but its format
|
2446
|
+
# cannot be recognized (it is not an email address, nor a `student_id` from the
|
2447
|
+
# API, nor the literal string `me`). * `NOT_FOUND` if the requesting user is
|
2448
|
+
# permitted to view guardians for the requested `student_id`, but no `Guardian`
|
2449
|
+
# record exists for that student that matches the provided `guardian_id`.
|
2701
2450
|
# @param [String] student_id
|
2702
|
-
# The student whose guardian is being requested. One of the following:
|
2703
|
-
# * the
|
2704
|
-
#
|
2705
|
-
# * the string literal `"me"`, indicating the requesting user
|
2451
|
+
# The student whose guardian is being requested. One of the following: * the
|
2452
|
+
# numeric identifier for the user * the email address of the user * the string
|
2453
|
+
# literal `"me"`, indicating the requesting user
|
2706
2454
|
# @param [String] guardian_id
|
2707
2455
|
# The `id` field from a `Guardian`.
|
2708
2456
|
# @param [String] fields
|
@@ -2733,46 +2481,39 @@ module Google
|
|
2733
2481
|
execute_or_queue_command(command, &block)
|
2734
2482
|
end
|
2735
2483
|
|
2736
|
-
# Returns a list of guardians that the requesting user is permitted to
|
2737
|
-
#
|
2738
|
-
#
|
2739
|
-
#
|
2740
|
-
#
|
2741
|
-
#
|
2742
|
-
#
|
2743
|
-
#
|
2744
|
-
#
|
2745
|
-
#
|
2746
|
-
#
|
2747
|
-
#
|
2748
|
-
#
|
2749
|
-
#
|
2750
|
-
#
|
2751
|
-
# * `NOT_FOUND` if a `student_id` is specified, and its format can be
|
2752
|
-
# recognized, but Classroom has no record of that student.
|
2484
|
+
# Returns a list of guardians that the requesting user is permitted to view,
|
2485
|
+
# restricted to those that match the request. To list guardians for any student
|
2486
|
+
# that the requesting user may view guardians for, use the literal character `-`
|
2487
|
+
# for the student ID. This method returns the following error codes: * `
|
2488
|
+
# PERMISSION_DENIED` if a `student_id` is specified, and the requesting user is
|
2489
|
+
# not permitted to view guardian information for that student, if `"-"` is
|
2490
|
+
# specified as the `student_id` and the user is not a domain administrator, if
|
2491
|
+
# guardians are not enabled for the domain in question, if the `
|
2492
|
+
# invited_email_address` filter is set by a user who is not a domain
|
2493
|
+
# administrator, or for other access errors. * `INVALID_ARGUMENT` if a `
|
2494
|
+
# student_id` is specified, but its format cannot be recognized (it is not an
|
2495
|
+
# email address, nor a `student_id` from the API, nor the literal string `me`).
|
2496
|
+
# May also be returned if an invalid `page_token` is provided. * `NOT_FOUND` if
|
2497
|
+
# a `student_id` is specified, and its format can be recognized, but Classroom
|
2498
|
+
# has no record of that student.
|
2753
2499
|
# @param [String] student_id
|
2754
|
-
# Filter results by the student who the guardian is linked to.
|
2755
|
-
#
|
2756
|
-
# * the
|
2757
|
-
# * the
|
2758
|
-
#
|
2759
|
-
# * the string literal `"-"`, indicating that results should be returned for
|
2760
|
-
# all students that the requesting user has access to view.
|
2500
|
+
# Filter results by the student who the guardian is linked to. The identifier
|
2501
|
+
# can be one of the following: * the numeric identifier for the user * the email
|
2502
|
+
# address of the user * the string literal `"me"`, indicating the requesting
|
2503
|
+
# user * the string literal `"-"`, indicating that results should be returned
|
2504
|
+
# for all students that the requesting user has access to view.
|
2761
2505
|
# @param [String] invited_email_address
|
2762
|
-
# Filter results by the email address that the original invitation was sent
|
2763
|
-
#
|
2764
|
-
#
|
2506
|
+
# Filter results by the email address that the original invitation was sent to,
|
2507
|
+
# resulting in this guardian link. This filter can only be used by domain
|
2508
|
+
# administrators.
|
2765
2509
|
# @param [Fixnum] page_size
|
2766
2510
|
# Maximum number of items to return. Zero or unspecified indicates that the
|
2767
|
-
# server may assign a maximum.
|
2768
|
-
#
|
2511
|
+
# server may assign a maximum. The server may return fewer than the specified
|
2512
|
+
# number of results.
|
2769
2513
|
# @param [String] page_token
|
2770
|
-
# nextPageToken
|
2771
|
-
#
|
2772
|
-
#
|
2773
|
-
# indicating that the subsequent page of results should be returned.
|
2774
|
-
# The list request
|
2775
|
-
# must be otherwise identical to the one that resulted in this token.
|
2514
|
+
# nextPageToken value returned from a previous list call, indicating that the
|
2515
|
+
# subsequent page of results should be returned. The list request must be
|
2516
|
+
# otherwise identical to the one that resulted in this token.
|
2776
2517
|
# @param [String] fields
|
2777
2518
|
# Selector specifying which fields to include in a partial response.
|
2778
2519
|
# @param [String] quota_user
|