google-api-client 0.8.7 → 0.9
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.gitignore +20 -0
- data/.rspec +2 -0
- data/.rubocop.yml +7 -0
- data/.rubocop_todo.yml +63 -0
- data/.travis.yml +22 -0
- data/.yardopts +12 -0
- data/CHANGELOG.md +40 -4
- data/CONTRIBUTING.md +31 -0
- data/Gemfile +32 -2
- data/MIGRATING.md +171 -0
- data/README.md +181 -148
- data/Rakefile +1 -40
- data/api_names.yaml +1036 -0
- data/api_names_out.yaml +26053 -0
- data/bin/generate-api +95 -0
- data/generated/google/apis/adexchangebuyer_v1_3/classes.rb +1335 -0
- data/generated/google/apis/adexchangebuyer_v1_3/representations.rb +446 -0
- data/generated/google/apis/adexchangebuyer_v1_3/service.rb +872 -0
- data/generated/google/apis/adexchangebuyer_v1_3.rb +35 -0
- data/generated/google/apis/adexchangeseller_v2_0/classes.rb +792 -0
- data/generated/google/apis/adexchangeseller_v2_0/representations.rb +309 -0
- data/generated/google/apis/adexchangeseller_v2_0/service.rb +668 -0
- data/generated/google/apis/adexchangeseller_v2_0.rb +38 -0
- data/generated/google/apis/admin_datatransfer_v1/classes.rb +267 -0
- data/generated/google/apis/admin_datatransfer_v1/representations.rb +118 -0
- data/generated/google/apis/admin_datatransfer_v1/service.rb +262 -0
- data/generated/google/apis/admin_datatransfer_v1.rb +37 -0
- data/generated/google/apis/admin_directory_v1/classes.rb +3141 -0
- data/generated/google/apis/admin_directory_v1/representations.rb +1029 -0
- data/generated/google/apis/admin_directory_v1/service.rb +3818 -0
- data/generated/google/apis/admin_directory_v1.rb +113 -0
- data/generated/google/apis/admin_reports_v1/classes.rb +582 -0
- data/generated/google/apis/admin_reports_v1/representations.rb +231 -0
- data/generated/google/apis/admin_reports_v1/service.rb +336 -0
- data/generated/google/apis/admin_reports_v1.rb +38 -0
- data/generated/google/apis/adsense_v1_4/classes.rb +1285 -0
- data/generated/google/apis/adsense_v1_4/representations.rb +494 -0
- data/generated/google/apis/adsense_v1_4/service.rb +1714 -0
- data/generated/google/apis/adsense_v1_4.rb +38 -0
- data/generated/google/apis/adsensehost_v4_1/classes.rb +834 -0
- data/generated/google/apis/adsensehost_v4_1/representations.rb +327 -0
- data/generated/google/apis/adsensehost_v4_1/service.rb +1164 -0
- data/generated/google/apis/adsensehost_v4_1.rb +35 -0
- data/generated/google/apis/analytics_v3/classes.rb +5118 -0
- data/generated/google/apis/analytics_v3/representations.rb +1662 -0
- data/generated/google/apis/analytics_v3/service.rb +3568 -0
- data/generated/google/apis/analytics_v3.rb +49 -0
- data/generated/google/apis/androidenterprise_v1/classes.rb +1443 -0
- data/generated/google/apis/androidenterprise_v1/representations.rb +538 -0
- data/generated/google/apis/androidenterprise_v1/service.rb +2602 -0
- data/generated/google/apis/androidenterprise_v1.rb +35 -0
- data/generated/google/apis/androidpublisher_v2/classes.rb +1411 -0
- data/generated/google/apis/androidpublisher_v2/representations.rb +646 -0
- data/generated/google/apis/androidpublisher_v2/service.rb +2338 -0
- data/generated/google/apis/androidpublisher_v2.rb +34 -0
- data/generated/google/apis/appengine_v1beta4/classes.rb +1532 -0
- data/generated/google/apis/appengine_v1beta4/representations.rb +526 -0
- data/generated/google/apis/appengine_v1beta4/service.rb +476 -0
- data/generated/google/apis/appengine_v1beta4.rb +35 -0
- data/generated/google/apis/appsactivity_v1/classes.rb +392 -0
- data/generated/google/apis/appsactivity_v1/representations.rb +184 -0
- data/generated/google/apis/appsactivity_v1/service.rb +128 -0
- data/generated/google/apis/appsactivity_v1.rb +46 -0
- data/generated/google/apis/appstate_v1/classes.rb +154 -0
- data/generated/google/apis/appstate_v1/representations.rb +79 -0
- data/generated/google/apis/appstate_v1/service.rb +260 -0
- data/generated/google/apis/appstate_v1.rb +34 -0
- data/generated/google/apis/autoscaler_v1beta2/classes.rb +747 -0
- data/generated/google/apis/autoscaler_v1beta2/representations.rb +281 -0
- data/generated/google/apis/autoscaler_v1beta2/service.rb +478 -0
- data/generated/google/apis/autoscaler_v1beta2.rb +38 -0
- data/generated/google/apis/bigquery_v2/classes.rb +2471 -0
- data/generated/google/apis/bigquery_v2/representations.rb +816 -0
- data/generated/google/apis/bigquery_v2/service.rb +982 -0
- data/generated/google/apis/bigquery_v2.rb +52 -0
- data/generated/google/apis/blogger_v3/classes.rb +1354 -0
- data/generated/google/apis/blogger_v3/representations.rb +562 -0
- data/generated/google/apis/blogger_v3/service.rb +1587 -0
- data/generated/google/apis/blogger_v3.rb +37 -0
- data/generated/google/apis/books_v1/classes.rb +3956 -0
- data/generated/google/apis/books_v1/representations.rb +1538 -0
- data/generated/google/apis/books_v1/service.rb +2290 -0
- data/generated/google/apis/books_v1.rb +34 -0
- data/generated/google/apis/calendar_v3/classes.rb +1742 -0
- data/generated/google/apis/calendar_v3/representations.rb +567 -0
- data/generated/google/apis/calendar_v3/service.rb +1968 -0
- data/generated/google/apis/calendar_v3.rb +37 -0
- data/generated/google/apis/civicinfo_v2/classes.rb +1127 -0
- data/generated/google/apis/civicinfo_v2/representations.rb +383 -0
- data/generated/google/apis/civicinfo_v2/service.rb +279 -0
- data/{lib/google/api_client/service_account.rb → generated/google/apis/civicinfo_v2.rb} +18 -8
- data/generated/google/apis/classroom_v1/classes.rb +512 -0
- data/generated/google/apis/classroom_v1/representations.rb +217 -0
- data/generated/google/apis/classroom_v1/service.rb +970 -0
- data/generated/google/apis/classroom_v1.rb +49 -0
- data/generated/google/apis/classroom_v1beta1/classes.rb +447 -0
- data/generated/google/apis/classroom_v1beta1/representations.rb +190 -0
- data/generated/google/apis/classroom_v1beta1/service.rb +791 -0
- data/generated/google/apis/classroom_v1beta1.rb +49 -0
- data/generated/google/apis/cloudbilling_v1/classes.rb +169 -0
- data/generated/google/apis/cloudbilling_v1/representations.rb +79 -0
- data/generated/google/apis/cloudbilling_v1/service.rb +258 -0
- data/generated/google/apis/cloudbilling_v1.rb +35 -0
- data/generated/google/apis/clouddebugger_v2/classes.rb +1004 -0
- data/generated/google/apis/clouddebugger_v2/representations.rb +410 -0
- data/generated/google/apis/clouddebugger_v2/service.rb +370 -0
- data/generated/google/apis/clouddebugger_v2.rb +41 -0
- data/generated/google/apis/cloudmonitoring_v2beta2/classes.rb +679 -0
- data/generated/google/apis/cloudmonitoring_v2beta2/representations.rb +311 -0
- data/generated/google/apis/cloudmonitoring_v2beta2/service.rb +452 -0
- data/generated/google/apis/cloudmonitoring_v2beta2.rb +37 -0
- data/generated/google/apis/cloudresourcemanager_v1beta1/classes.rb +437 -0
- data/generated/google/apis/cloudresourcemanager_v1beta1/representations.rb +188 -0
- data/generated/google/apis/cloudresourcemanager_v1beta1/service.rb +623 -0
- data/generated/google/apis/cloudresourcemanager_v1beta1.rb +38 -0
- data/generated/google/apis/cloudtrace_v1/classes.rb +188 -0
- data/generated/google/apis/cloudtrace_v1/representations.rb +92 -0
- data/generated/google/apis/cloudtrace_v1/service.rb +190 -0
- data/generated/google/apis/cloudtrace_v1.rb +35 -0
- data/generated/google/apis/clouduseraccounts_beta/classes.rb +823 -0
- data/generated/google/apis/clouduseraccounts_beta/representations.rb +313 -0
- data/generated/google/apis/clouduseraccounts_beta/service.rb +854 -0
- data/generated/google/apis/clouduseraccounts_beta.rb +43 -0
- data/generated/google/apis/compute_beta/classes.rb +9128 -0
- data/generated/google/apis/compute_beta/representations.rb +3048 -0
- data/generated/google/apis/compute_beta/service.rb +10154 -0
- data/generated/google/apis/compute_beta.rb +49 -0
- data/generated/google/apis/compute_v1/classes.rb +8681 -0
- data/generated/google/apis/compute_v1/representations.rb +2895 -0
- data/generated/google/apis/compute_v1/service.rb +9252 -0
- data/generated/google/apis/compute_v1.rb +49 -0
- data/generated/google/apis/container_v1/classes.rb +463 -0
- data/generated/google/apis/container_v1/representations.rb +175 -0
- data/generated/google/apis/container_v1/service.rb +367 -0
- data/generated/google/apis/container_v1.rb +35 -0
- data/generated/google/apis/container_v1beta1/classes.rb +466 -0
- data/generated/google/apis/container_v1beta1/representations.rb +177 -0
- data/generated/google/apis/container_v1beta1/service.rb +394 -0
- data/generated/google/apis/container_v1beta1.rb +35 -0
- data/generated/google/apis/content_v2/classes.rb +5986 -0
- data/generated/google/apis/content_v2/representations.rb +2288 -0
- data/generated/google/apis/content_v2/service.rb +2338 -0
- data/generated/google/apis/content_v2.rb +35 -0
- data/generated/google/apis/coordinate_v1/classes.rb +669 -0
- data/generated/google/apis/coordinate_v1/representations.rb +285 -0
- data/generated/google/apis/coordinate_v1/service.rb +678 -0
- data/generated/google/apis/coordinate_v1.rb +37 -0
- data/generated/google/apis/customsearch_v1/classes.rb +771 -0
- data/generated/google/apis/customsearch_v1/representations.rb +276 -0
- data/generated/google/apis/customsearch_v1/service.rb +207 -0
- data/{lib/google/api_client/auth/compute_service_account.rb → generated/google/apis/customsearch_v1.rb} +13 -10
- data/generated/google/apis/datastore_v1beta2/classes.rb +1186 -0
- data/generated/google/apis/datastore_v1beta2/representations.rb +526 -0
- data/generated/google/apis/datastore_v1beta2/service.rb +294 -0
- data/generated/google/apis/datastore_v1beta2.rb +40 -0
- data/generated/google/apis/deploymentmanager_v2/classes.rb +1091 -0
- data/generated/google/apis/deploymentmanager_v2/representations.rb +422 -0
- data/generated/google/apis/deploymentmanager_v2/service.rb +857 -0
- data/generated/google/apis/deploymentmanager_v2.rb +44 -0
- data/generated/google/apis/deploymentmanager_v2beta2/classes.rb +843 -0
- data/generated/google/apis/deploymentmanager_v2beta2/representations.rb +306 -0
- data/generated/google/apis/deploymentmanager_v2beta2/service.rb +689 -0
- data/generated/google/apis/deploymentmanager_v2beta2.rb +44 -0
- data/generated/google/apis/dfareporting_v2_1/classes.rb +10770 -0
- data/generated/google/apis/dfareporting_v2_1/representations.rb +3438 -0
- data/generated/google/apis/dfareporting_v2_1/service.rb +8585 -0
- data/generated/google/apis/dfareporting_v2_1.rb +37 -0
- data/generated/google/apis/discovery_v1/classes.rb +961 -0
- data/generated/google/apis/discovery_v1/representations.rb +357 -0
- data/generated/google/apis/discovery_v1/service.rb +142 -0
- data/generated/google/apis/discovery_v1.rb +32 -0
- data/generated/google/apis/dns_v1/classes.rb +406 -0
- data/generated/google/apis/dns_v1/representations.rb +151 -0
- data/generated/google/apis/dns_v1/service.rb +454 -0
- data/generated/google/apis/dns_v1.rb +44 -0
- data/generated/google/apis/doubleclickbidmanager_v1/classes.rb +716 -0
- data/generated/google/apis/doubleclickbidmanager_v1/representations.rb +298 -0
- data/generated/google/apis/doubleclickbidmanager_v1/service.rb +341 -0
- data/generated/google/apis/doubleclickbidmanager_v1.rb +31 -0
- data/generated/google/apis/doubleclicksearch_v2/classes.rb +956 -0
- data/generated/google/apis/doubleclicksearch_v2/representations.rb +316 -0
- data/generated/google/apis/doubleclicksearch_v2/service.rb +480 -0
- data/generated/google/apis/doubleclicksearch_v2.rb +35 -0
- data/generated/google/apis/drive_v2/classes.rb +2562 -0
- data/generated/google/apis/drive_v2/representations.rb +795 -0
- data/generated/google/apis/drive_v2/service.rb +2696 -0
- data/generated/google/apis/drive_v2.rb +58 -0
- data/generated/google/apis/drive_v3/classes.rb +1534 -0
- data/generated/google/apis/drive_v3/representations.rb +497 -0
- data/generated/google/apis/drive_v3/service.rb +1541 -0
- data/generated/google/apis/drive_v3.rb +55 -0
- data/generated/google/apis/fitness_v1/classes.rb +885 -0
- data/generated/google/apis/fitness_v1/representations.rb +320 -0
- data/generated/google/apis/fitness_v1/service.rb +675 -0
- data/generated/google/apis/fitness_v1.rb +49 -0
- data/generated/google/apis/fusiontables_v2/classes.rb +1048 -0
- data/generated/google/apis/fusiontables_v2/representations.rb +409 -0
- data/generated/google/apis/fusiontables_v2/service.rb +1463 -0
- data/generated/google/apis/fusiontables_v2.rb +37 -0
- data/generated/google/apis/games_configuration_v1configuration/classes.rb +506 -0
- data/generated/google/apis/games_configuration_v1configuration/representations.rb +206 -0
- data/generated/google/apis/games_configuration_v1configuration/service.rb +565 -0
- data/generated/google/apis/games_configuration_v1configuration.rb +34 -0
- data/generated/google/apis/games_management_v1management/classes.rb +524 -0
- data/generated/google/apis/games_management_v1management/representations.rb +231 -0
- data/generated/google/apis/games_management_v1management/service.rb +994 -0
- data/generated/google/apis/games_management_v1management.rb +37 -0
- data/generated/google/apis/games_v1/classes.rb +4617 -0
- data/generated/google/apis/games_v1/representations.rb +1584 -0
- data/generated/google/apis/games_v1/service.rb +2290 -0
- data/generated/google/apis/games_v1.rb +40 -0
- data/generated/google/apis/gan_v1beta1/classes.rb +1428 -0
- data/generated/google/apis/gan_v1beta1/representations.rb +428 -0
- data/generated/google/apis/gan_v1beta1/service.rb +682 -0
- data/generated/google/apis/gan_v1beta1.rb +31 -0
- data/generated/google/apis/genomics_v1/classes.rb +2609 -0
- data/generated/google/apis/genomics_v1/representations.rb +909 -0
- data/generated/google/apis/genomics_v1/service.rb +1676 -0
- data/generated/google/apis/genomics_v1.rb +49 -0
- data/generated/google/apis/genomics_v1beta2/classes.rb +3288 -0
- data/generated/google/apis/genomics_v1beta2/representations.rb +1194 -0
- data/generated/google/apis/genomics_v1beta2/service.rb +2392 -0
- data/generated/google/apis/genomics_v1beta2.rb +46 -0
- data/generated/google/apis/gmail_v1/classes.rb +794 -0
- data/generated/google/apis/gmail_v1/representations.rb +339 -0
- data/generated/google/apis/gmail_v1/service.rb +1470 -0
- data/generated/google/apis/gmail_v1.rb +52 -0
- data/generated/google/apis/groupsmigration_v1/classes.rb +51 -0
- data/generated/google/apis/groupsmigration_v1/representations.rb +38 -0
- data/generated/google/apis/groupsmigration_v1/service.rb +110 -0
- data/generated/google/apis/groupsmigration_v1.rb +34 -0
- data/generated/google/apis/groupssettings_v1/classes.rb +221 -0
- data/generated/google/apis/groupssettings_v1/representations.rb +64 -0
- data/generated/google/apis/groupssettings_v1/service.rb +179 -0
- data/generated/google/apis/groupssettings_v1.rb +34 -0
- data/generated/google/apis/identitytoolkit_v3/classes.rb +1466 -0
- data/generated/google/apis/identitytoolkit_v3/representations.rb +509 -0
- data/generated/google/apis/identitytoolkit_v3/service.rb +581 -0
- data/generated/google/apis/identitytoolkit_v3.rb +31 -0
- data/generated/google/apis/kgsearch_v1/classes.rb +59 -0
- data/generated/google/apis/kgsearch_v1/representations.rb +39 -0
- data/generated/google/apis/kgsearch_v1/service.rb +111 -0
- data/{spec/google/api_client/request_spec.rb → generated/google/apis/kgsearch_v1.rb} +16 -13
- data/generated/google/apis/licensing_v1/classes.rb +132 -0
- data/generated/google/apis/licensing_v1/representations.rb +68 -0
- data/generated/google/apis/licensing_v1/service.rb +369 -0
- data/generated/google/apis/licensing_v1.rb +34 -0
- data/generated/google/apis/logging_v1beta3/classes.rb +1079 -0
- data/generated/google/apis/logging_v1beta3/representations.rb +366 -0
- data/generated/google/apis/logging_v1beta3/service.rb +1001 -0
- data/generated/google/apis/logging_v1beta3.rb +47 -0
- data/generated/google/apis/manager_v1beta2/classes.rb +1287 -0
- data/generated/google/apis/manager_v1beta2/representations.rb +536 -0
- data/generated/google/apis/manager_v1beta2/service.rb +372 -0
- data/generated/google/apis/manager_v1beta2.rb +53 -0
- data/generated/google/apis/mapsengine_v1/classes.rb +2873 -0
- data/generated/google/apis/mapsengine_v1/representations.rb +1235 -0
- data/generated/google/apis/mapsengine_v1/service.rb +3388 -0
- data/generated/google/apis/mapsengine_v1.rb +38 -0
- data/generated/google/apis/mirror_v1/classes.rb +1072 -0
- data/generated/google/apis/mirror_v1/representations.rb +350 -0
- data/generated/google/apis/mirror_v1/service.rb +977 -0
- data/generated/google/apis/mirror_v1.rb +37 -0
- data/generated/google/apis/oauth2_v2/classes.rb +245 -0
- data/generated/google/apis/oauth2_v2/representations.rb +94 -0
- data/generated/google/apis/oauth2_v2/service.rb +199 -0
- data/generated/google/apis/oauth2_v2.rb +43 -0
- data/generated/google/apis/pagespeedonline_v2/classes.rb +614 -0
- data/generated/google/apis/pagespeedonline_v2/representations.rb +244 -0
- data/generated/google/apis/pagespeedonline_v2/service.rb +119 -0
- data/generated/google/apis/pagespeedonline_v2.rb +32 -0
- data/generated/google/apis/partners_v2/classes.rb +942 -0
- data/generated/google/apis/partners_v2/representations.rb +402 -0
- data/generated/google/apis/partners_v2/service.rb +400 -0
- data/generated/google/apis/partners_v2.rb +32 -0
- data/generated/google/apis/plus_domains_v1/classes.rb +2609 -0
- data/generated/google/apis/plus_domains_v1/representations.rb +987 -0
- data/generated/google/apis/plus_domains_v1/service.rb +904 -0
- data/generated/google/apis/plus_domains_v1.rb +61 -0
- data/generated/google/apis/plus_v1/classes.rb +2094 -0
- data/generated/google/apis/plus_v1/representations.rb +805 -0
- data/generated/google/apis/plus_v1/service.rb +470 -0
- data/generated/google/apis/plus_v1.rb +43 -0
- data/generated/google/apis/prediction_v1_6/classes.rb +751 -0
- data/generated/google/apis/prediction_v1_6/representations.rb +327 -0
- data/generated/google/apis/prediction_v1_6/service.rb +380 -0
- data/generated/google/apis/prediction_v1_6.rb +44 -0
- data/generated/google/apis/proximitybeacon_v1beta1/classes.rb +639 -0
- data/generated/google/apis/proximitybeacon_v1beta1/representations.rb +274 -0
- data/generated/google/apis/proximitybeacon_v1beta1/service.rb +591 -0
- data/generated/google/apis/proximitybeacon_v1beta1.rb +31 -0
- data/generated/google/apis/pubsub_v1/classes.rb +614 -0
- data/generated/google/apis/pubsub_v1/representations.rb +281 -0
- data/generated/google/apis/pubsub_v1/service.rb +774 -0
- data/generated/google/apis/pubsub_v1.rb +37 -0
- data/generated/google/apis/pubsub_v1beta2/classes.rb +620 -0
- data/generated/google/apis/pubsub_v1beta2/representations.rb +282 -0
- data/generated/google/apis/pubsub_v1beta2/service.rb +774 -0
- data/generated/google/apis/pubsub_v1beta2.rb +37 -0
- data/generated/google/apis/qpx_express_v1/classes.rb +1268 -0
- data/generated/google/apis/qpx_express_v1/representations.rb +424 -0
- data/generated/google/apis/qpx_express_v1/service.rb +100 -0
- data/generated/google/apis/qpx_express_v1.rb +31 -0
- data/generated/google/apis/replicapool_v1beta2/classes.rb +631 -0
- data/generated/google/apis/replicapool_v1beta2/representations.rb +236 -0
- data/generated/google/apis/replicapool_v1beta2/service.rb +608 -0
- data/generated/google/apis/replicapool_v1beta2.rb +44 -0
- data/generated/google/apis/replicapoolupdater_v1beta1/classes.rb +733 -0
- data/generated/google/apis/replicapoolupdater_v1beta1/representations.rb +264 -0
- data/generated/google/apis/replicapoolupdater_v1beta1/service.rb +508 -0
- data/generated/google/apis/replicapoolupdater_v1beta1.rb +44 -0
- data/generated/google/apis/reseller_v1/classes.rb +520 -0
- data/generated/google/apis/reseller_v1/representations.rb +200 -0
- data/generated/google/apis/reseller_v1/service.rb +623 -0
- data/generated/google/apis/reseller_v1.rb +37 -0
- data/generated/google/apis/resourceviews_v1beta2/classes.rb +660 -0
- data/generated/google/apis/resourceviews_v1beta2/representations.rb +269 -0
- data/generated/google/apis/resourceviews_v1beta2/service.rb +563 -0
- data/generated/google/apis/resourceviews_v1beta2.rb +50 -0
- data/generated/google/apis/script_v1/classes.rb +259 -0
- data/generated/google/apis/script_v1/representations.rb +106 -0
- data/generated/google/apis/script_v1/service.rb +98 -0
- data/generated/google/apis/script_v1.rb +61 -0
- data/generated/google/apis/site_verification_v1/classes.rb +185 -0
- data/generated/google/apis/site_verification_v1/representations.rb +101 -0
- data/generated/google/apis/site_verification_v1/service.rb +315 -0
- data/generated/google/apis/site_verification_v1.rb +37 -0
- data/generated/google/apis/sqladmin_v1beta4/classes.rb +2001 -0
- data/generated/google/apis/sqladmin_v1beta4/representations.rb +758 -0
- data/generated/google/apis/sqladmin_v1beta4/service.rb +1625 -0
- data/generated/google/apis/sqladmin_v1beta4.rb +37 -0
- data/generated/google/apis/storage_v1/classes.rb +1222 -0
- data/generated/google/apis/storage_v1/representations.rb +445 -0
- data/generated/google/apis/storage_v1/service.rb +1903 -0
- data/generated/google/apis/storage_v1.rb +46 -0
- data/generated/google/apis/storagetransfer_v1/classes.rb +1046 -0
- data/generated/google/apis/storagetransfer_v1/representations.rb +370 -0
- data/generated/google/apis/storagetransfer_v1/service.rb +473 -0
- data/generated/google/apis/storagetransfer_v1.rb +35 -0
- data/generated/google/apis/tagmanager_v1/classes.rb +1384 -0
- data/generated/google/apis/tagmanager_v1/representations.rb +515 -0
- data/generated/google/apis/tagmanager_v1/service.rb +1817 -0
- data/generated/google/apis/tagmanager_v1.rb +52 -0
- data/generated/google/apis/taskqueue_v1beta2/classes.rb +254 -0
- data/generated/google/apis/taskqueue_v1beta2/representations.rb +114 -0
- data/generated/google/apis/taskqueue_v1beta2/service.rb +408 -0
- data/generated/google/apis/taskqueue_v1beta2.rb +37 -0
- data/generated/google/apis/tasks_v1/classes.rb +296 -0
- data/generated/google/apis/tasks_v1/representations.rb +115 -0
- data/generated/google/apis/tasks_v1/service.rb +643 -0
- data/generated/google/apis/tasks_v1.rb +37 -0
- data/generated/google/apis/translate_v2/classes.rb +168 -0
- data/generated/google/apis/translate_v2/representations.rb +109 -0
- data/generated/google/apis/translate_v2/service.rb +182 -0
- data/generated/google/apis/translate_v2.rb +31 -0
- data/generated/google/apis/urlshortener_v1/classes.rb +246 -0
- data/generated/google/apis/urlshortener_v1/representations.rb +111 -0
- data/generated/google/apis/urlshortener_v1/service.rb +176 -0
- data/generated/google/apis/urlshortener_v1.rb +34 -0
- data/generated/google/apis/webmasters_v3/classes.rb +563 -0
- data/generated/google/apis/webmasters_v3/representations.rb +250 -0
- data/generated/google/apis/webmasters_v3/service.rb +573 -0
- data/generated/google/apis/webmasters_v3.rb +37 -0
- data/generated/google/apis/youtube_analytics_v1/classes.rb +546 -0
- data/generated/google/apis/youtube_analytics_v1/representations.rb +243 -0
- data/generated/google/apis/youtube_analytics_v1/service.rb +562 -0
- data/generated/google/apis/youtube_analytics_v1.rb +46 -0
- data/generated/google/apis/youtube_v3/classes.rb +8136 -0
- data/generated/google/apis/youtube_v3/representations.rb +2838 -0
- data/generated/google/apis/youtube_v3/service.rb +4403 -0
- data/generated/google/apis/youtube_v3.rb +49 -0
- data/generated/google/apis/youtubereporting_v1/classes.rb +258 -0
- data/generated/google/apis/youtubereporting_v1/representations.rb +128 -0
- data/generated/google/apis/youtubereporting_v1/service.rb +364 -0
- data/generated/google/apis/youtubereporting_v1.rb +38 -0
- data/google-api-client.gemspec +27 -39
- data/lib/google/api_client/auth/installed_app.rb +7 -5
- data/lib/google/api_client/auth/key_utils.rb +1 -0
- data/lib/google/api_client/auth/storage.rb +4 -2
- data/lib/google/api_client/auth/storages/file_store.rb +2 -3
- data/lib/google/api_client/auth/storages/redis_store.rb +7 -2
- data/lib/google/api_client/client_secrets.rb +4 -5
- data/lib/google/apis/core/api_command.rb +135 -0
- data/lib/google/apis/core/base_service.rb +317 -0
- data/lib/google/apis/core/batch.rb +239 -0
- data/lib/google/apis/core/download.rb +94 -0
- data/lib/google/apis/core/hashable.rb +44 -0
- data/lib/google/apis/core/http_client_adapter.rb +82 -0
- data/lib/google/apis/core/http_command.rb +312 -0
- data/lib/google/apis/core/json_representation.rb +127 -0
- data/lib/google/{api_client/version.rb → apis/core/logging.rb} +12 -8
- data/lib/google/apis/core/multipart.rb +187 -0
- data/lib/google/apis/core/upload.rb +288 -0
- data/lib/google/{api_client → apis}/errors.rb +39 -28
- data/lib/google/apis/generator/annotator.rb +295 -0
- data/lib/google/apis/generator/helpers.rb +74 -0
- data/lib/google/apis/generator/model.rb +143 -0
- data/lib/google/apis/generator/template.rb +124 -0
- data/lib/google/apis/generator/templates/_class.tmpl +40 -0
- data/lib/google/apis/generator/templates/_method.tmpl +92 -0
- data/lib/google/apis/generator/templates/_representation.tmpl +51 -0
- data/lib/google/apis/generator/templates/_representation_stub.tmpl +15 -0
- data/lib/google/apis/generator/templates/_representation_type.tmpl +10 -0
- data/lib/google/{api_client/reference.rb → apis/generator/templates/classes.rb.tmpl} +11 -9
- data/lib/google/apis/generator/templates/module.rb.tmpl +40 -0
- data/lib/google/apis/generator/templates/representations.rb.tmpl +32 -0
- data/lib/google/apis/generator/templates/service.rb.tmpl +60 -0
- data/lib/google/apis/generator.rb +70 -0
- data/lib/google/apis/options.rb +85 -0
- data/lib/google/apis/version.rb +39 -0
- data/lib/google/apis.rb +48 -0
- data/rakelib/metrics.rake +22 -0
- data/rakelib/rubocop.rake +10 -0
- data/rakelib/spec.rake +11 -0
- data/rakelib/yard.rake +11 -0
- data/samples/Gemfile +7 -0
- data/samples/README.md +51 -0
- data/samples/google-api-samples +32 -0
- data/samples/lib/base_cli.rb +94 -0
- data/samples/lib/samples/analytics.rb +62 -0
- data/samples/lib/samples/calendar.rb +83 -0
- data/samples/lib/samples/drive.rb +82 -0
- data/samples/lib/samples/gmail.rb +50 -0
- data/samples/lib/samples/pubsub.rb +114 -0
- data/samples/lib/samples/translate.rb +44 -0
- data/samples/lib/samples/you_tube.rb +44 -0
- data/script/generate +95 -0
- data/script/package +8 -0
- data/script/release +15 -0
- data/spec/fixtures/files/api_names.yaml +3 -0
- data/spec/fixtures/files/auth_stored_credentials.json +8 -0
- data/spec/fixtures/files/child/.gitignore +0 -0
- data/spec/fixtures/files/client_secrets.json +1 -0
- data/spec/fixtures/files/invalid.json +1 -0
- data/spec/fixtures/files/test.blah +1 -0
- data/spec/fixtures/files/test.txt +1 -0
- data/spec/fixtures/files/test_api.json +440 -0
- data/spec/google/api_client/auth/storage_spec.rb +1 -3
- data/spec/google/api_client/auth/storages/file_store_spec.rb +1 -2
- data/spec/google/api_client/auth/storages/redis_store_spec.rb +1 -3
- data/spec/google/api_client/client_secrets_spec.rb +38 -1
- data/spec/google/apis/core/api_command_spec.rb +209 -0
- data/spec/google/apis/core/batch_spec.rb +142 -0
- data/spec/google/apis/core/download_spec.rb +103 -0
- data/spec/google/apis/core/hashable_spec.rb +60 -0
- data/spec/google/apis/core/http_command_spec.rb +284 -0
- data/spec/google/apis/core/json_representation_spec.rb +192 -0
- data/spec/google/apis/core/service_spec.rb +247 -0
- data/spec/google/apis/core/upload_spec.rb +300 -0
- data/{lib/google/api_client/discovery.rb → spec/google/apis/generated_spec.rb} +13 -5
- data/spec/google/apis/generator/generator_spec.rb +272 -0
- data/spec/google/apis/logging_spec.rb +45 -0
- data/spec/google/apis/options_spec.rb +40 -0
- data/spec/integration_tests/adsense_spec.rb +29 -0
- data/spec/integration_tests/drive_spec.rb +35 -0
- data/spec/integration_tests/pubsub_spec.rb +48 -0
- data/spec/integration_tests/url_shortener_spec.rb +45 -0
- data/spec/spec_helper/load_path_spec.rb +33 -0
- data/spec/spec_helper.rb +131 -44
- data/third_party/hurley_patches.rb +103 -0
- metadata +533 -175
- data/lib/compat/multi_json.rb +0 -19
- data/lib/google/api_client/auth/file_storage.rb +0 -59
- data/lib/google/api_client/auth/jwt_asserter.rb +0 -126
- data/lib/google/api_client/auth/pkcs12.rb +0 -41
- data/lib/google/api_client/batch.rb +0 -326
- data/lib/google/api_client/charset.rb +0 -33
- data/lib/google/api_client/discovery/api.rb +0 -310
- data/lib/google/api_client/discovery/media.rb +0 -77
- data/lib/google/api_client/discovery/method.rb +0 -363
- data/lib/google/api_client/discovery/resource.rb +0 -156
- data/lib/google/api_client/discovery/schema.rb +0 -117
- data/lib/google/api_client/environment.rb +0 -42
- data/lib/google/api_client/gzip.rb +0 -28
- data/lib/google/api_client/logging.rb +0 -32
- data/lib/google/api_client/media.rb +0 -259
- data/lib/google/api_client/railtie.rb +0 -18
- data/lib/google/api_client/request.rb +0 -350
- data/lib/google/api_client/result.rb +0 -255
- data/lib/google/api_client/service/batch.rb +0 -110
- data/lib/google/api_client/service/request.rb +0 -144
- data/lib/google/api_client/service/resource.rb +0 -40
- data/lib/google/api_client/service/result.rb +0 -162
- data/lib/google/api_client/service/simple_file_store.rb +0 -151
- data/lib/google/api_client/service/stub_generator.rb +0 -61
- data/lib/google/api_client/service.rb +0 -233
- data/lib/google/api_client.rb +0 -750
- data/spec/google/api_client/batch_spec.rb +0 -248
- data/spec/google/api_client/discovery_spec.rb +0 -708
- data/spec/google/api_client/gzip_spec.rb +0 -98
- data/spec/google/api_client/media_spec.rb +0 -178
- data/spec/google/api_client/result_spec.rb +0 -207
- data/spec/google/api_client/service_account_spec.rb +0 -169
- data/spec/google/api_client/service_spec.rb +0 -618
- data/spec/google/api_client/simple_file_store_spec.rb +0 -133
- data/spec/google/api_client_spec.rb +0 -352
@@ -0,0 +1,682 @@
|
|
1
|
+
# Copyright 2015 Google Inc.
|
2
|
+
#
|
3
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
4
|
+
# you may not use this file except in compliance with the License.
|
5
|
+
# You may obtain a copy of the License at
|
6
|
+
#
|
7
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
8
|
+
#
|
9
|
+
# Unless required by applicable law or agreed to in writing, software
|
10
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
11
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
12
|
+
# See the License for the specific language governing permissions and
|
13
|
+
# limitations under the License.
|
14
|
+
|
15
|
+
require 'google/apis/core/base_service'
|
16
|
+
require 'google/apis/core/json_representation'
|
17
|
+
require 'google/apis/core/hashable'
|
18
|
+
require 'google/apis/errors'
|
19
|
+
|
20
|
+
module Google
|
21
|
+
module Apis
|
22
|
+
module GanV1beta1
|
23
|
+
# Google Affiliate Network API
|
24
|
+
#
|
25
|
+
# Lets you have programmatic access to your Google Affiliate Network data.
|
26
|
+
#
|
27
|
+
# @example
|
28
|
+
# require 'google/apis/gan_v1beta1'
|
29
|
+
#
|
30
|
+
# Gan = Google::Apis::GanV1beta1 # Alias the module
|
31
|
+
# service = Gan::GanService.new
|
32
|
+
#
|
33
|
+
# @see https://developers.google.com/affiliate-network/
|
34
|
+
class GanService < Google::Apis::Core::BaseService
|
35
|
+
# @return [String]
|
36
|
+
# API key. Your API key identifies your project and provides you with API access,
|
37
|
+
# quota, and reports. Required unless you provide an OAuth 2.0 token.
|
38
|
+
attr_accessor :key
|
39
|
+
|
40
|
+
# @return [String]
|
41
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
42
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
43
|
+
# Overrides userIp if both are provided.
|
44
|
+
attr_accessor :quota_user
|
45
|
+
|
46
|
+
# @return [String]
|
47
|
+
# IP address of the site where the request originates. Use this if you want to
|
48
|
+
# enforce per-user limits.
|
49
|
+
attr_accessor :user_ip
|
50
|
+
|
51
|
+
def initialize
|
52
|
+
super('https://www.googleapis.com/', 'gan/v1beta1/')
|
53
|
+
end
|
54
|
+
|
55
|
+
# Retrieves data about a single advertiser if that the requesting advertiser/
|
56
|
+
# publisher has access to it. Only publishers can lookup advertisers.
|
57
|
+
# Advertisers can request information about themselves by omitting the
|
58
|
+
# advertiserId query parameter.
|
59
|
+
# @param [String] role
|
60
|
+
# The role of the requester. Valid values: 'advertisers' or 'publishers'.
|
61
|
+
# @param [String] role_id
|
62
|
+
# The ID of the requesting advertiser or publisher.
|
63
|
+
# @param [String] advertiser_id
|
64
|
+
# The ID of the advertiser to look up. Optional.
|
65
|
+
# @param [String] fields
|
66
|
+
# Selector specifying which fields to include in a partial response.
|
67
|
+
# @param [String] quota_user
|
68
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
69
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
70
|
+
# Overrides userIp if both are provided.
|
71
|
+
# @param [String] user_ip
|
72
|
+
# IP address of the site where the request originates. Use this if you want to
|
73
|
+
# enforce per-user limits.
|
74
|
+
# @param [Google::Apis::RequestOptions] options
|
75
|
+
# Request-specific options
|
76
|
+
#
|
77
|
+
# @yield [result, err] Result & error if block supplied
|
78
|
+
# @yieldparam result [Google::Apis::GanV1beta1::Advertiser] parsed result object
|
79
|
+
# @yieldparam err [StandardError] error object if request failed
|
80
|
+
#
|
81
|
+
# @return [Google::Apis::GanV1beta1::Advertiser]
|
82
|
+
#
|
83
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
84
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
85
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
86
|
+
def get_advertiser(role, role_id, advertiser_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
87
|
+
command = make_simple_command(:get, '{role}/{roleId}/advertiser', options)
|
88
|
+
command.response_representation = Google::Apis::GanV1beta1::Advertiser::Representation
|
89
|
+
command.response_class = Google::Apis::GanV1beta1::Advertiser
|
90
|
+
command.params['role'] = role unless role.nil?
|
91
|
+
command.params['roleId'] = role_id unless role_id.nil?
|
92
|
+
command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
93
|
+
command.query['fields'] = fields unless fields.nil?
|
94
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
95
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
96
|
+
execute_or_queue_command(command, &block)
|
97
|
+
end
|
98
|
+
|
99
|
+
# Retrieves data about all advertisers that the requesting advertiser/publisher
|
100
|
+
# has access to.
|
101
|
+
# @param [String] role
|
102
|
+
# The role of the requester. Valid values: 'advertisers' or 'publishers'.
|
103
|
+
# @param [String] role_id
|
104
|
+
# The ID of the requesting advertiser or publisher.
|
105
|
+
# @param [String] advertiser_category
|
106
|
+
# Caret(^) delimted list of advertiser categories. Valid categories are defined
|
107
|
+
# here: http://www.google.com/support/affiliatenetwork/advertiser/bin/answer.py?
|
108
|
+
# hl=en&answer=107581. Filters out all advertisers not in one of the given
|
109
|
+
# advertiser categories. Optional.
|
110
|
+
# @param [Fixnum] max_results
|
111
|
+
# Max number of items to return in this page. Optional. Defaults to 20.
|
112
|
+
# @param [Float] min_ninety_day_epc
|
113
|
+
# Filters out all advertisers that have a ninety day EPC average lower than the
|
114
|
+
# given value (inclusive). Min value: 0.0. Optional.
|
115
|
+
# @param [Fixnum] min_payout_rank
|
116
|
+
# A value between 1 and 4, where 1 represents the quartile of advertisers with
|
117
|
+
# the lowest ranks and 4 represents the quartile of advertisers with the highest
|
118
|
+
# ranks. Filters out all advertisers with a lower rank than the given quartile.
|
119
|
+
# For example if a 2 was given only advertisers with a payout rank of 25 or
|
120
|
+
# higher would be included. Optional.
|
121
|
+
# @param [Float] min_seven_day_epc
|
122
|
+
# Filters out all advertisers that have a seven day EPC average lower than the
|
123
|
+
# given value (inclusive). Min value: 0.0. Optional.
|
124
|
+
# @param [String] page_token
|
125
|
+
# The value of 'nextPageToken' from the previous page. Optional.
|
126
|
+
# @param [String] relationship_status
|
127
|
+
# Filters out all advertisers for which do not have the given relationship
|
128
|
+
# status with the requesting publisher.
|
129
|
+
# @param [String] fields
|
130
|
+
# Selector specifying which fields to include in a partial response.
|
131
|
+
# @param [String] quota_user
|
132
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
133
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
134
|
+
# Overrides userIp if both are provided.
|
135
|
+
# @param [String] user_ip
|
136
|
+
# IP address of the site where the request originates. Use this if you want to
|
137
|
+
# enforce per-user limits.
|
138
|
+
# @param [Google::Apis::RequestOptions] options
|
139
|
+
# Request-specific options
|
140
|
+
#
|
141
|
+
# @yield [result, err] Result & error if block supplied
|
142
|
+
# @yieldparam result [Google::Apis::GanV1beta1::Advertisers] parsed result object
|
143
|
+
# @yieldparam err [StandardError] error object if request failed
|
144
|
+
#
|
145
|
+
# @return [Google::Apis::GanV1beta1::Advertisers]
|
146
|
+
#
|
147
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
148
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
149
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
150
|
+
def list_advertisers(role, role_id, advertiser_category: nil, max_results: nil, min_ninety_day_epc: nil, min_payout_rank: nil, min_seven_day_epc: nil, page_token: nil, relationship_status: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
151
|
+
command = make_simple_command(:get, '{role}/{roleId}/advertisers', options)
|
152
|
+
command.response_representation = Google::Apis::GanV1beta1::Advertisers::Representation
|
153
|
+
command.response_class = Google::Apis::GanV1beta1::Advertisers
|
154
|
+
command.params['role'] = role unless role.nil?
|
155
|
+
command.params['roleId'] = role_id unless role_id.nil?
|
156
|
+
command.query['advertiserCategory'] = advertiser_category unless advertiser_category.nil?
|
157
|
+
command.query['maxResults'] = max_results unless max_results.nil?
|
158
|
+
command.query['minNinetyDayEpc'] = min_ninety_day_epc unless min_ninety_day_epc.nil?
|
159
|
+
command.query['minPayoutRank'] = min_payout_rank unless min_payout_rank.nil?
|
160
|
+
command.query['minSevenDayEpc'] = min_seven_day_epc unless min_seven_day_epc.nil?
|
161
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
162
|
+
command.query['relationshipStatus'] = relationship_status unless relationship_status.nil?
|
163
|
+
command.query['fields'] = fields unless fields.nil?
|
164
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
165
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
166
|
+
execute_or_queue_command(command, &block)
|
167
|
+
end
|
168
|
+
|
169
|
+
# Retrieves credit card offers for the given publisher.
|
170
|
+
# @param [String] publisher
|
171
|
+
# The ID of the publisher in question.
|
172
|
+
# @param [Array<String>, String] advertiser
|
173
|
+
# The advertiser ID of a card issuer whose offers to include. Optional, may be
|
174
|
+
# repeated.
|
175
|
+
# @param [String] projection
|
176
|
+
# The set of fields to return.
|
177
|
+
# @param [String] fields
|
178
|
+
# Selector specifying which fields to include in a partial response.
|
179
|
+
# @param [String] quota_user
|
180
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
181
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
182
|
+
# Overrides userIp if both are provided.
|
183
|
+
# @param [String] user_ip
|
184
|
+
# IP address of the site where the request originates. Use this if you want to
|
185
|
+
# enforce per-user limits.
|
186
|
+
# @param [Google::Apis::RequestOptions] options
|
187
|
+
# Request-specific options
|
188
|
+
#
|
189
|
+
# @yield [result, err] Result & error if block supplied
|
190
|
+
# @yieldparam result [Google::Apis::GanV1beta1::CcOffers] parsed result object
|
191
|
+
# @yieldparam err [StandardError] error object if request failed
|
192
|
+
#
|
193
|
+
# @return [Google::Apis::GanV1beta1::CcOffers]
|
194
|
+
#
|
195
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
196
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
197
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
198
|
+
def list_cc_offers(publisher, advertiser: nil, projection: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
199
|
+
command = make_simple_command(:get, 'publishers/{publisher}/ccOffers', options)
|
200
|
+
command.response_representation = Google::Apis::GanV1beta1::CcOffers::Representation
|
201
|
+
command.response_class = Google::Apis::GanV1beta1::CcOffers
|
202
|
+
command.params['publisher'] = publisher unless publisher.nil?
|
203
|
+
command.query['advertiser'] = advertiser unless advertiser.nil?
|
204
|
+
command.query['projection'] = projection unless projection.nil?
|
205
|
+
command.query['fields'] = fields unless fields.nil?
|
206
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
207
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
208
|
+
execute_or_queue_command(command, &block)
|
209
|
+
end
|
210
|
+
|
211
|
+
# Retrieves event data for a given advertiser/publisher.
|
212
|
+
# @param [String] role
|
213
|
+
# The role of the requester. Valid values: 'advertisers' or 'publishers'.
|
214
|
+
# @param [String] role_id
|
215
|
+
# The ID of the requesting advertiser or publisher.
|
216
|
+
# @param [String] advertiser_id
|
217
|
+
# Caret(^) delimited list of advertiser IDs. Filters out all events that do not
|
218
|
+
# reference one of the given advertiser IDs. Only used when under publishers
|
219
|
+
# role. Optional.
|
220
|
+
# @param [String] charge_type
|
221
|
+
# Filters out all charge events that are not of the given charge type. Valid
|
222
|
+
# values: 'other', 'slotting_fee', 'monthly_minimum', 'tier_bonus', 'credit', '
|
223
|
+
# debit'. Optional.
|
224
|
+
# @param [String] event_date_max
|
225
|
+
# Filters out all events later than given date. Optional. Defaults to 24 hours
|
226
|
+
# after eventMin.
|
227
|
+
# @param [String] event_date_min
|
228
|
+
# Filters out all events earlier than given date. Optional. Defaults to 24 hours
|
229
|
+
# from current date/time.
|
230
|
+
# @param [String] link_id
|
231
|
+
# Caret(^) delimited list of link IDs. Filters out all events that do not
|
232
|
+
# reference one of the given link IDs. Optional.
|
233
|
+
# @param [Fixnum] max_results
|
234
|
+
# Max number of offers to return in this page. Optional. Defaults to 20.
|
235
|
+
# @param [String] member_id
|
236
|
+
# Caret(^) delimited list of member IDs. Filters out all events that do not
|
237
|
+
# reference one of the given member IDs. Optional.
|
238
|
+
# @param [String] modify_date_max
|
239
|
+
# Filters out all events modified later than given date. Optional. Defaults to
|
240
|
+
# 24 hours after modifyDateMin, if modifyDateMin is explicitly set.
|
241
|
+
# @param [String] modify_date_min
|
242
|
+
# Filters out all events modified earlier than given date. Optional. Defaults to
|
243
|
+
# 24 hours before the current modifyDateMax, if modifyDateMax is explicitly set.
|
244
|
+
# @param [String] order_id
|
245
|
+
# Caret(^) delimited list of order IDs. Filters out all events that do not
|
246
|
+
# reference one of the given order IDs. Optional.
|
247
|
+
# @param [String] page_token
|
248
|
+
# The value of 'nextPageToken' from the previous page. Optional.
|
249
|
+
# @param [String] product_category
|
250
|
+
# Caret(^) delimited list of product categories. Filters out all events that do
|
251
|
+
# not reference a product in one of the given product categories. Optional.
|
252
|
+
# @param [String] publisher_id
|
253
|
+
# Caret(^) delimited list of publisher IDs. Filters out all events that do not
|
254
|
+
# reference one of the given publishers IDs. Only used when under advertiser
|
255
|
+
# role. Optional.
|
256
|
+
# @param [String] sku
|
257
|
+
# Caret(^) delimited list of SKUs. Filters out all events that do not reference
|
258
|
+
# one of the given SKU. Optional.
|
259
|
+
# @param [String] status
|
260
|
+
# Filters out all events that do not have the given status. Valid values: '
|
261
|
+
# active', 'canceled'. Optional.
|
262
|
+
# @param [String] type
|
263
|
+
# Filters out all events that are not of the given type. Valid values: 'action',
|
264
|
+
# 'transaction', 'charge'. Optional.
|
265
|
+
# @param [String] fields
|
266
|
+
# Selector specifying which fields to include in a partial response.
|
267
|
+
# @param [String] quota_user
|
268
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
269
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
270
|
+
# Overrides userIp if both are provided.
|
271
|
+
# @param [String] user_ip
|
272
|
+
# IP address of the site where the request originates. Use this if you want to
|
273
|
+
# enforce per-user limits.
|
274
|
+
# @param [Google::Apis::RequestOptions] options
|
275
|
+
# Request-specific options
|
276
|
+
#
|
277
|
+
# @yield [result, err] Result & error if block supplied
|
278
|
+
# @yieldparam result [Google::Apis::GanV1beta1::Events] parsed result object
|
279
|
+
# @yieldparam err [StandardError] error object if request failed
|
280
|
+
#
|
281
|
+
# @return [Google::Apis::GanV1beta1::Events]
|
282
|
+
#
|
283
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
284
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
285
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
286
|
+
def list_events(role, role_id, advertiser_id: nil, charge_type: nil, event_date_max: nil, event_date_min: nil, link_id: nil, max_results: nil, member_id: nil, modify_date_max: nil, modify_date_min: nil, order_id: nil, page_token: nil, product_category: nil, publisher_id: nil, sku: nil, status: nil, type: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
287
|
+
command = make_simple_command(:get, '{role}/{roleId}/events', options)
|
288
|
+
command.response_representation = Google::Apis::GanV1beta1::Events::Representation
|
289
|
+
command.response_class = Google::Apis::GanV1beta1::Events
|
290
|
+
command.params['role'] = role unless role.nil?
|
291
|
+
command.params['roleId'] = role_id unless role_id.nil?
|
292
|
+
command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
293
|
+
command.query['chargeType'] = charge_type unless charge_type.nil?
|
294
|
+
command.query['eventDateMax'] = event_date_max unless event_date_max.nil?
|
295
|
+
command.query['eventDateMin'] = event_date_min unless event_date_min.nil?
|
296
|
+
command.query['linkId'] = link_id unless link_id.nil?
|
297
|
+
command.query['maxResults'] = max_results unless max_results.nil?
|
298
|
+
command.query['memberId'] = member_id unless member_id.nil?
|
299
|
+
command.query['modifyDateMax'] = modify_date_max unless modify_date_max.nil?
|
300
|
+
command.query['modifyDateMin'] = modify_date_min unless modify_date_min.nil?
|
301
|
+
command.query['orderId'] = order_id unless order_id.nil?
|
302
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
303
|
+
command.query['productCategory'] = product_category unless product_category.nil?
|
304
|
+
command.query['publisherId'] = publisher_id unless publisher_id.nil?
|
305
|
+
command.query['sku'] = sku unless sku.nil?
|
306
|
+
command.query['status'] = status unless status.nil?
|
307
|
+
command.query['type'] = type unless type.nil?
|
308
|
+
command.query['fields'] = fields unless fields.nil?
|
309
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
310
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
311
|
+
execute_or_queue_command(command, &block)
|
312
|
+
end
|
313
|
+
|
314
|
+
# Retrieves data about a single link if the requesting advertiser/publisher has
|
315
|
+
# access to it. Advertisers can look up their own links. Publishers can look up
|
316
|
+
# visible links or links belonging to advertisers they are in a relationship
|
317
|
+
# with.
|
318
|
+
# @param [String] role
|
319
|
+
# The role of the requester. Valid values: 'advertisers' or 'publishers'.
|
320
|
+
# @param [String] role_id
|
321
|
+
# The ID of the requesting advertiser or publisher.
|
322
|
+
# @param [String] link_id
|
323
|
+
# The ID of the link to look up.
|
324
|
+
# @param [String] fields
|
325
|
+
# Selector specifying which fields to include in a partial response.
|
326
|
+
# @param [String] quota_user
|
327
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
328
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
329
|
+
# Overrides userIp if both are provided.
|
330
|
+
# @param [String] user_ip
|
331
|
+
# IP address of the site where the request originates. Use this if you want to
|
332
|
+
# enforce per-user limits.
|
333
|
+
# @param [Google::Apis::RequestOptions] options
|
334
|
+
# Request-specific options
|
335
|
+
#
|
336
|
+
# @yield [result, err] Result & error if block supplied
|
337
|
+
# @yieldparam result [Google::Apis::GanV1beta1::Link] parsed result object
|
338
|
+
# @yieldparam err [StandardError] error object if request failed
|
339
|
+
#
|
340
|
+
# @return [Google::Apis::GanV1beta1::Link]
|
341
|
+
#
|
342
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
343
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
344
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
345
|
+
def get_link(role, role_id, link_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
346
|
+
command = make_simple_command(:get, '{role}/{roleId}/link/{linkId}', options)
|
347
|
+
command.response_representation = Google::Apis::GanV1beta1::Link::Representation
|
348
|
+
command.response_class = Google::Apis::GanV1beta1::Link
|
349
|
+
command.params['role'] = role unless role.nil?
|
350
|
+
command.params['roleId'] = role_id unless role_id.nil?
|
351
|
+
command.params['linkId'] = link_id unless link_id.nil?
|
352
|
+
command.query['fields'] = fields unless fields.nil?
|
353
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
354
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
355
|
+
execute_or_queue_command(command, &block)
|
356
|
+
end
|
357
|
+
|
358
|
+
# Inserts a new link.
|
359
|
+
# @param [String] role
|
360
|
+
# The role of the requester. Valid values: 'advertisers' or 'publishers'.
|
361
|
+
# @param [String] role_id
|
362
|
+
# The ID of the requesting advertiser or publisher.
|
363
|
+
# @param [Google::Apis::GanV1beta1::Link] link_object
|
364
|
+
# @param [String] fields
|
365
|
+
# Selector specifying which fields to include in a partial response.
|
366
|
+
# @param [String] quota_user
|
367
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
368
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
369
|
+
# Overrides userIp if both are provided.
|
370
|
+
# @param [String] user_ip
|
371
|
+
# IP address of the site where the request originates. Use this if you want to
|
372
|
+
# enforce per-user limits.
|
373
|
+
# @param [Google::Apis::RequestOptions] options
|
374
|
+
# Request-specific options
|
375
|
+
#
|
376
|
+
# @yield [result, err] Result & error if block supplied
|
377
|
+
# @yieldparam result [Google::Apis::GanV1beta1::Link] parsed result object
|
378
|
+
# @yieldparam err [StandardError] error object if request failed
|
379
|
+
#
|
380
|
+
# @return [Google::Apis::GanV1beta1::Link]
|
381
|
+
#
|
382
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
383
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
384
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
385
|
+
def insert_link(role, role_id, link_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
386
|
+
command = make_simple_command(:post, '{role}/{roleId}/link', options)
|
387
|
+
command.request_representation = Google::Apis::GanV1beta1::Link::Representation
|
388
|
+
command.request_object = link_object
|
389
|
+
command.response_representation = Google::Apis::GanV1beta1::Link::Representation
|
390
|
+
command.response_class = Google::Apis::GanV1beta1::Link
|
391
|
+
command.params['role'] = role unless role.nil?
|
392
|
+
command.params['roleId'] = role_id unless role_id.nil?
|
393
|
+
command.query['fields'] = fields unless fields.nil?
|
394
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
395
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
396
|
+
execute_or_queue_command(command, &block)
|
397
|
+
end
|
398
|
+
|
399
|
+
# Retrieves all links that match the query parameters.
|
400
|
+
# @param [String] role
|
401
|
+
# The role of the requester. Valid values: 'advertisers' or 'publishers'.
|
402
|
+
# @param [String] role_id
|
403
|
+
# The ID of the requesting advertiser or publisher.
|
404
|
+
# @param [Array<String>, String] advertiser_id
|
405
|
+
# Limits the resulting links to the ones belonging to the listed advertisers.
|
406
|
+
# @param [Array<String>, String] asset_size
|
407
|
+
# The size of the given asset.
|
408
|
+
# @param [String] authorship
|
409
|
+
# The role of the author of the link.
|
410
|
+
# @param [String] create_date_max
|
411
|
+
# The end of the create date range.
|
412
|
+
# @param [String] create_date_min
|
413
|
+
# The beginning of the create date range.
|
414
|
+
# @param [String] link_type
|
415
|
+
# The type of the link.
|
416
|
+
# @param [Fixnum] max_results
|
417
|
+
# Max number of items to return in this page. Optional. Defaults to 20.
|
418
|
+
# @param [String] page_token
|
419
|
+
# The value of 'nextPageToken' from the previous page. Optional.
|
420
|
+
# @param [Array<String>, String] promotion_type
|
421
|
+
# The promotion type.
|
422
|
+
# @param [String] relationship_status
|
423
|
+
# The status of the relationship.
|
424
|
+
# @param [String] search_text
|
425
|
+
# Field for full text search across title and merchandising text, supports link
|
426
|
+
# id search.
|
427
|
+
# @param [String] start_date_max
|
428
|
+
# The end of the start date range.
|
429
|
+
# @param [String] start_date_min
|
430
|
+
# The beginning of the start date range.
|
431
|
+
# @param [String] fields
|
432
|
+
# Selector specifying which fields to include in a partial response.
|
433
|
+
# @param [String] quota_user
|
434
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
435
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
436
|
+
# Overrides userIp if both are provided.
|
437
|
+
# @param [String] user_ip
|
438
|
+
# IP address of the site where the request originates. Use this if you want to
|
439
|
+
# enforce per-user limits.
|
440
|
+
# @param [Google::Apis::RequestOptions] options
|
441
|
+
# Request-specific options
|
442
|
+
#
|
443
|
+
# @yield [result, err] Result & error if block supplied
|
444
|
+
# @yieldparam result [Google::Apis::GanV1beta1::Links] parsed result object
|
445
|
+
# @yieldparam err [StandardError] error object if request failed
|
446
|
+
#
|
447
|
+
# @return [Google::Apis::GanV1beta1::Links]
|
448
|
+
#
|
449
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
450
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
451
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
452
|
+
def list_links(role, role_id, advertiser_id: nil, asset_size: nil, authorship: nil, create_date_max: nil, create_date_min: nil, link_type: nil, max_results: nil, page_token: nil, promotion_type: nil, relationship_status: nil, search_text: nil, start_date_max: nil, start_date_min: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
453
|
+
command = make_simple_command(:get, '{role}/{roleId}/links', options)
|
454
|
+
command.response_representation = Google::Apis::GanV1beta1::Links::Representation
|
455
|
+
command.response_class = Google::Apis::GanV1beta1::Links
|
456
|
+
command.params['role'] = role unless role.nil?
|
457
|
+
command.params['roleId'] = role_id unless role_id.nil?
|
458
|
+
command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
459
|
+
command.query['assetSize'] = asset_size unless asset_size.nil?
|
460
|
+
command.query['authorship'] = authorship unless authorship.nil?
|
461
|
+
command.query['createDateMax'] = create_date_max unless create_date_max.nil?
|
462
|
+
command.query['createDateMin'] = create_date_min unless create_date_min.nil?
|
463
|
+
command.query['linkType'] = link_type unless link_type.nil?
|
464
|
+
command.query['maxResults'] = max_results unless max_results.nil?
|
465
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
466
|
+
command.query['promotionType'] = promotion_type unless promotion_type.nil?
|
467
|
+
command.query['relationshipStatus'] = relationship_status unless relationship_status.nil?
|
468
|
+
command.query['searchText'] = search_text unless search_text.nil?
|
469
|
+
command.query['startDateMax'] = start_date_max unless start_date_max.nil?
|
470
|
+
command.query['startDateMin'] = start_date_min unless start_date_min.nil?
|
471
|
+
command.query['fields'] = fields unless fields.nil?
|
472
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
473
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
474
|
+
execute_or_queue_command(command, &block)
|
475
|
+
end
|
476
|
+
|
477
|
+
# Retrieves data about a single advertiser if that the requesting advertiser/
|
478
|
+
# publisher has access to it. Only advertisers can look up publishers.
|
479
|
+
# Publishers can request information about themselves by omitting the
|
480
|
+
# publisherId query parameter.
|
481
|
+
# @param [String] role
|
482
|
+
# The role of the requester. Valid values: 'advertisers' or 'publishers'.
|
483
|
+
# @param [String] role_id
|
484
|
+
# The ID of the requesting advertiser or publisher.
|
485
|
+
# @param [String] publisher_id
|
486
|
+
# The ID of the publisher to look up. Optional.
|
487
|
+
# @param [String] fields
|
488
|
+
# Selector specifying which fields to include in a partial response.
|
489
|
+
# @param [String] quota_user
|
490
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
491
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
492
|
+
# Overrides userIp if both are provided.
|
493
|
+
# @param [String] user_ip
|
494
|
+
# IP address of the site where the request originates. Use this if you want to
|
495
|
+
# enforce per-user limits.
|
496
|
+
# @param [Google::Apis::RequestOptions] options
|
497
|
+
# Request-specific options
|
498
|
+
#
|
499
|
+
# @yield [result, err] Result & error if block supplied
|
500
|
+
# @yieldparam result [Google::Apis::GanV1beta1::Publisher] parsed result object
|
501
|
+
# @yieldparam err [StandardError] error object if request failed
|
502
|
+
#
|
503
|
+
# @return [Google::Apis::GanV1beta1::Publisher]
|
504
|
+
#
|
505
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
506
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
507
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
508
|
+
def get_publisher(role, role_id, publisher_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
509
|
+
command = make_simple_command(:get, '{role}/{roleId}/publisher', options)
|
510
|
+
command.response_representation = Google::Apis::GanV1beta1::Publisher::Representation
|
511
|
+
command.response_class = Google::Apis::GanV1beta1::Publisher
|
512
|
+
command.params['role'] = role unless role.nil?
|
513
|
+
command.params['roleId'] = role_id unless role_id.nil?
|
514
|
+
command.query['publisherId'] = publisher_id unless publisher_id.nil?
|
515
|
+
command.query['fields'] = fields unless fields.nil?
|
516
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
517
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
518
|
+
execute_or_queue_command(command, &block)
|
519
|
+
end
|
520
|
+
|
521
|
+
# Retrieves data about all publishers that the requesting advertiser/publisher
|
522
|
+
# has access to.
|
523
|
+
# @param [String] role
|
524
|
+
# The role of the requester. Valid values: 'advertisers' or 'publishers'.
|
525
|
+
# @param [String] role_id
|
526
|
+
# The ID of the requesting advertiser or publisher.
|
527
|
+
# @param [Fixnum] max_results
|
528
|
+
# Max number of items to return in this page. Optional. Defaults to 20.
|
529
|
+
# @param [Float] min_ninety_day_epc
|
530
|
+
# Filters out all publishers that have a ninety day EPC average lower than the
|
531
|
+
# given value (inclusive). Min value: 0.0. Optional.
|
532
|
+
# @param [Fixnum] min_payout_rank
|
533
|
+
# A value between 1 and 4, where 1 represents the quartile of publishers with
|
534
|
+
# the lowest ranks and 4 represents the quartile of publishers with the highest
|
535
|
+
# ranks. Filters out all publishers with a lower rank than the given quartile.
|
536
|
+
# For example if a 2 was given only publishers with a payout rank of 25 or
|
537
|
+
# higher would be included. Optional.
|
538
|
+
# @param [Float] min_seven_day_epc
|
539
|
+
# Filters out all publishers that have a seven day EPC average lower than the
|
540
|
+
# given value (inclusive). Min value 0.0. Optional.
|
541
|
+
# @param [String] page_token
|
542
|
+
# The value of 'nextPageToken' from the previous page. Optional.
|
543
|
+
# @param [String] publisher_category
|
544
|
+
# Caret(^) delimted list of publisher categories. Valid categories: (
|
545
|
+
# unclassified|community_and_content|shopping_and_promotion|loyalty_and_rewards|
|
546
|
+
# network|search_specialist|comparison_shopping|email). Filters out all
|
547
|
+
# publishers not in one of the given advertiser categories. Optional.
|
548
|
+
# @param [String] relationship_status
|
549
|
+
# Filters out all publishers for which do not have the given relationship status
|
550
|
+
# with the requesting publisher.
|
551
|
+
# @param [String] fields
|
552
|
+
# Selector specifying which fields to include in a partial response.
|
553
|
+
# @param [String] quota_user
|
554
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
555
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
556
|
+
# Overrides userIp if both are provided.
|
557
|
+
# @param [String] user_ip
|
558
|
+
# IP address of the site where the request originates. Use this if you want to
|
559
|
+
# enforce per-user limits.
|
560
|
+
# @param [Google::Apis::RequestOptions] options
|
561
|
+
# Request-specific options
|
562
|
+
#
|
563
|
+
# @yield [result, err] Result & error if block supplied
|
564
|
+
# @yieldparam result [Google::Apis::GanV1beta1::Publishers] parsed result object
|
565
|
+
# @yieldparam err [StandardError] error object if request failed
|
566
|
+
#
|
567
|
+
# @return [Google::Apis::GanV1beta1::Publishers]
|
568
|
+
#
|
569
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
570
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
571
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
572
|
+
def list_publishers(role, role_id, max_results: nil, min_ninety_day_epc: nil, min_payout_rank: nil, min_seven_day_epc: nil, page_token: nil, publisher_category: nil, relationship_status: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
573
|
+
command = make_simple_command(:get, '{role}/{roleId}/publishers', options)
|
574
|
+
command.response_representation = Google::Apis::GanV1beta1::Publishers::Representation
|
575
|
+
command.response_class = Google::Apis::GanV1beta1::Publishers
|
576
|
+
command.params['role'] = role unless role.nil?
|
577
|
+
command.params['roleId'] = role_id unless role_id.nil?
|
578
|
+
command.query['maxResults'] = max_results unless max_results.nil?
|
579
|
+
command.query['minNinetyDayEpc'] = min_ninety_day_epc unless min_ninety_day_epc.nil?
|
580
|
+
command.query['minPayoutRank'] = min_payout_rank unless min_payout_rank.nil?
|
581
|
+
command.query['minSevenDayEpc'] = min_seven_day_epc unless min_seven_day_epc.nil?
|
582
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
583
|
+
command.query['publisherCategory'] = publisher_category unless publisher_category.nil?
|
584
|
+
command.query['relationshipStatus'] = relationship_status unless relationship_status.nil?
|
585
|
+
command.query['fields'] = fields unless fields.nil?
|
586
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
587
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
588
|
+
execute_or_queue_command(command, &block)
|
589
|
+
end
|
590
|
+
|
591
|
+
# Retrieves a report of the specified type.
|
592
|
+
# @param [String] role
|
593
|
+
# The role of the requester. Valid values: 'advertisers' or 'publishers'.
|
594
|
+
# @param [String] role_id
|
595
|
+
# The ID of the requesting advertiser or publisher.
|
596
|
+
# @param [String] report_type
|
597
|
+
# The type of report being requested. Valid values: 'order_delta'. Required.
|
598
|
+
# @param [Array<String>, String] advertiser_id
|
599
|
+
# The IDs of the advertisers to look up, if applicable.
|
600
|
+
# @param [Boolean] calculate_totals
|
601
|
+
# Whether or not to calculate totals rows. Optional.
|
602
|
+
# @param [String] end_date
|
603
|
+
# The end date (exclusive), in RFC 3339 format, for the report data to be
|
604
|
+
# returned. Defaults to one day after startDate, if that is given, or today.
|
605
|
+
# Optional.
|
606
|
+
# @param [String] event_type
|
607
|
+
# Filters out all events that are not of the given type. Valid values: 'action',
|
608
|
+
# 'transaction', or 'charge'. Optional.
|
609
|
+
# @param [Array<String>, String] link_id
|
610
|
+
# Filters to capture one of given link IDs. Optional.
|
611
|
+
# @param [Fixnum] max_results
|
612
|
+
# Max number of items to return in this page. Optional. Defaults to return all
|
613
|
+
# results.
|
614
|
+
# @param [Array<String>, String] order_id
|
615
|
+
# Filters to capture one of the given order IDs. Optional.
|
616
|
+
# @param [Array<String>, String] publisher_id
|
617
|
+
# The IDs of the publishers to look up, if applicable.
|
618
|
+
# @param [String] start_date
|
619
|
+
# The start date (inclusive), in RFC 3339 format, for the report data to be
|
620
|
+
# returned. Defaults to one day before endDate, if that is given, or yesterday.
|
621
|
+
# Optional.
|
622
|
+
# @param [Fixnum] start_index
|
623
|
+
# Offset on which to return results when paging. Optional.
|
624
|
+
# @param [String] status
|
625
|
+
# Filters out all events that do not have the given status. Valid values: '
|
626
|
+
# active', 'canceled', or 'invalid'. Optional.
|
627
|
+
# @param [String] fields
|
628
|
+
# Selector specifying which fields to include in a partial response.
|
629
|
+
# @param [String] quota_user
|
630
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
631
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
632
|
+
# Overrides userIp if both are provided.
|
633
|
+
# @param [String] user_ip
|
634
|
+
# IP address of the site where the request originates. Use this if you want to
|
635
|
+
# enforce per-user limits.
|
636
|
+
# @param [Google::Apis::RequestOptions] options
|
637
|
+
# Request-specific options
|
638
|
+
#
|
639
|
+
# @yield [result, err] Result & error if block supplied
|
640
|
+
# @yieldparam result [Google::Apis::GanV1beta1::Report] parsed result object
|
641
|
+
# @yieldparam err [StandardError] error object if request failed
|
642
|
+
#
|
643
|
+
# @return [Google::Apis::GanV1beta1::Report]
|
644
|
+
#
|
645
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
646
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
647
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
648
|
+
def get_report(role, role_id, report_type, advertiser_id: nil, calculate_totals: nil, end_date: nil, event_type: nil, link_id: nil, max_results: nil, order_id: nil, publisher_id: nil, start_date: nil, start_index: nil, status: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
649
|
+
command = make_simple_command(:get, '{role}/{roleId}/report/{reportType}', options)
|
650
|
+
command.response_representation = Google::Apis::GanV1beta1::Report::Representation
|
651
|
+
command.response_class = Google::Apis::GanV1beta1::Report
|
652
|
+
command.params['role'] = role unless role.nil?
|
653
|
+
command.params['roleId'] = role_id unless role_id.nil?
|
654
|
+
command.params['reportType'] = report_type unless report_type.nil?
|
655
|
+
command.query['advertiserId'] = advertiser_id unless advertiser_id.nil?
|
656
|
+
command.query['calculateTotals'] = calculate_totals unless calculate_totals.nil?
|
657
|
+
command.query['endDate'] = end_date unless end_date.nil?
|
658
|
+
command.query['eventType'] = event_type unless event_type.nil?
|
659
|
+
command.query['linkId'] = link_id unless link_id.nil?
|
660
|
+
command.query['maxResults'] = max_results unless max_results.nil?
|
661
|
+
command.query['orderId'] = order_id unless order_id.nil?
|
662
|
+
command.query['publisherId'] = publisher_id unless publisher_id.nil?
|
663
|
+
command.query['startDate'] = start_date unless start_date.nil?
|
664
|
+
command.query['startIndex'] = start_index unless start_index.nil?
|
665
|
+
command.query['status'] = status unless status.nil?
|
666
|
+
command.query['fields'] = fields unless fields.nil?
|
667
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
668
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
669
|
+
execute_or_queue_command(command, &block)
|
670
|
+
end
|
671
|
+
|
672
|
+
protected
|
673
|
+
|
674
|
+
def apply_command_defaults(command)
|
675
|
+
command.query['key'] = key unless key.nil?
|
676
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
677
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
678
|
+
end
|
679
|
+
end
|
680
|
+
end
|
681
|
+
end
|
682
|
+
end
|